Skip to content

Commit

Permalink
Merge pull request #12 from mjc-gh/chore/release-v2.0.0
Browse files Browse the repository at this point in the history
updates prepping for a v2.0.0 release
  • Loading branch information
mjc-gh authored Jan 7, 2024
2 parents f6e0939 + ce341c3 commit ca422a7
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
*Version 2.0.0*

- Dependency updates from
[@seanlinsley](https://github.com/seanlinsley). This package now uses
more modern cryptographic crates from the
[@RustCrypto](https://github.com/RustCrypto) team.
- The `set_cipher_key_size` function was removed, instead just set the
encryptor's `key_size` property directly:
`e.key_size = KeySize::Aes256`
- `Verifier#generate` now returns a `Result<String>`

*Version 1.1.0*

- The `Encryptor` type is now a trait which is implemented by the
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[package]
name = "message_verifier"
version = "1.1.0"
version = "2.0.0"
edition = "2021"
description = "Rust Message Verifier library compatible with Rails' MessageVerifier and MessageEncryptor"
repository = "https://github.com/mikeycgto/message_verifier"
documentation = "https://docs.rs/message_verifier"
license = "MIT"
authors = ["Michael J Coyne <mikeycgto@gmail.com>"]
authors = ["Michael J Coyne <mjc@hey.com>", "Sean Linsley <code@seanlinsley.com>"]
keywords = ["crypto", "security", "rails", "cookies", "sessions"]

[dependencies]
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Michael J Coyne <mikeycgto@gmail.com>
Copyright (c) 2016 Michael J Coyne <mjc@hey.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# message_verifier

[![message_verifier](https://github.com/mjc-gh/message_verifier/actions/workflows/actions.yml/badge.svg)](https://github.com/mjc-gh/message_verifier/actions/workflows/actions.yml)
![Crates.io Version](https://img.shields.io/crates/v/message_verifier)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![Crates.io Version](https://img.shields.io/crates/v/message_verifier)](https://crates.io/crates/message_verifier)
[![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)

Message Verifier library compatible with Rails' [MessageVerifier](
http://api.rubyonrails.org/classes/ActiveSupport/MessageVerifier.html)
Expand All @@ -15,7 +15,7 @@ signing and encrypting messages. These interfaces are useful when
securely implementing various web application features like session
cookies or signed URL tokens.

This library handles all the formatting, encoding and cryptography. It
This library handles all the formatting, encoding, and cryptography. It
does not handle serialization aspects. The idea is to input and output
raw strings to and from this library and handle serialization on another
layer.
Expand Down Expand Up @@ -59,7 +59,7 @@ Verified Message: {"key":"value"}
Decrypted Message: {"key":"value"}
```

## Supported Ciphers
### Supported Ciphers

- AES-CBC with HMAC-SHA1
- 256, 192, or 128 bit keys
Expand Down

0 comments on commit ca422a7

Please sign in to comment.