Skip to content

Commit

Permalink
Prepare for v0.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
bluk committed Oct 18, 2022
1 parent 74ba94b commit 449c481
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Changelog

## [Unreleased] - 2022-09-14
## [0.6.0] - 2022-10-17

### Changed

- Use `base64ct` instead of `base64` for base64 encoding/decoding.

- Update dependency to `rsa` `0.7` and use `rsa::pkcs1v15::{SigningKey, VerifyingKey}` directly.

Removed wrappers for RSA keys and implement `Signer` and `Verifier` directly with the keys.

Requires `sha2` crate with `oid` feature and `signature` crate.

See updated tests for examples.

## [0.5.0] - 2022-06-09

### Added
Expand Down Expand Up @@ -64,7 +72,8 @@

- Initial implementation.

[Unreleased]: https://github.com/bluk/min_jwt/compare/v0.5.0...HEAD
[Unreleased]: https://github.com/bluk/min_jwt/compare/v0.6.0...HEAD
[0.6.0]: https://github.com/bluk/min_jwt/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/bluk/min_jwt/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/bluk/min_jwt/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/bluk/min_jwt/compare/v0.2.1...v0.3.0
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "min_jwt"
version = "0.5.0"
version = "0.6.0"
license = "MIT OR Apache-2.0"
description = "Minimal JSON Web Token library"
repository = "https://github.com/bluk/min_jwt"
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Find a supported crypto crate below which supports the algorithms required.
| ------------------ | ---------------------- | ----------
| [p256][p256] | ES256 | p256
| [ring][ring] | ES256, HS256, RS256 | ring
| [rsa][rsa], [sha2][sha2], [signature][signature] | RS256 | rsa, sha2
| [rsa][rsa], [sha2][sha2], [signature][signature] | RS256 | rsa, sha2, signature

For instance, if you need `ES256` support, you may choose to use the `p256`
crate and/or the `ring` crate. Suppose you chose the `p256` crate. In your
Expand All @@ -32,7 +32,7 @@ crate, depend on this crate and the relevant dependent crate in your

```toml
[dependencies]
min_jwt = { version = "0.5.0", features = [ "p256", "serde", "serde_json"] }
min_jwt = { version = "0.6.0", features = [ "p256", "serde", "serde_json"] }
p256 = { version = "0.11.0", features = [ "ecdsa", "jwk", "pem"] }
```

Expand Down Expand Up @@ -87,7 +87,7 @@ let jwt = min_jwt::encode_and_sign(header, claims, &signing_key)?;
# Ok::<(), min_jwt::Error>(())
```

### Verify using RS256 with `rsa` and `sha2` crates
### Verify using RS256 with `rsa`, `sha2`, and `signature` crates

```rust
# #[cfg(all(feature = "rsa", feature = "sha2", feature = "signature"))]
Expand Down

0 comments on commit 449c481

Please sign in to comment.