doc: README.md, CHANGELOG.md

This commit is contained in:
cduvray 2023-02-13 08:40:22 +01:00
parent a8b510a03e
commit 857af52271
4 changed files with 30 additions and 18 deletions

View file

@ -7,13 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased ## Unreleased
## 0.7.0 (2023-02-14)
### Changed
- Refresh configuration - simplification, minimal_refresh_interval removed (replaced by refresh_interval in KeyNotFound refresh strategy)
### Added
- integration tests, unit tests
## 0.6.0 (2023-02-05) ## 0.6.0 (2023-02-05)
### Added ### Added
- JwtAuthorizer::from_oidc(issuer_uri) - building from oidc discovery page - JwtAuthorizer::from_oidc(issuer_uri) - building from oidc discovery page
### Chnaged ### Changed
- JwtAuthorizer::layer() becomes async - JwtAuthorizer::layer() becomes async

View file

@ -17,21 +17,7 @@ See documentation of the [`jwt-authorizer`](./jwt-authorizer/docs/README.md) mod
## Development ## Development
### Key generation ...
EC (ECDSA) - (algorigthm ES256 - ECDSA using SHA-256)
curve name: prime256v1 (secp256r1, secp384r1)
> openssl ecparam -genkey -noout -name prime256v1 | openssl pkcs8 -topk8 -nocrypt -out ec-private.pem
> openssl ec -in ec-private.pem -pubout -out ec-public-key.pem
EdDSA (Edwards-curve Digital Signature Algorithm)
(Ed25519 - implémentation spécifique de EdDSA, utilisant la Courbe d'Edwards tordue)
> openssl genpkey -algorithm ed25519
## Contributing ## Contributing

15
config/README.md Normal file
View file

@ -0,0 +1,15 @@
# Key generation
## EC (ECDSA) - (algorigthm ES256 - ECDSA using SHA-256)
curve name: prime256v1 (secp256r1, secp384r1)
> openssl ecparam -genkey -noout -name prime256v1 | openssl pkcs8 -topk8 -nocrypt -out ec-private.pem
> openssl ec -in ec-private.pem -pubout -out ec-public-key.pem
## EdDSA - Edwards-curve Digital Signature Algorithm
(Ed25519 - EdDSA signature scheme using SHA-512 (SHA-2) and Curve25519)
> openssl genpkey -algorithm ed25519

View file

@ -11,6 +11,7 @@ JWT authoriser Layer for Axum.
- OpenId Connect Discovery - OpenId Connect Discovery
- Claims extraction - Claims extraction
- Claims checker - Claims checker
- tracing support (error logging)
## Usage Example ## Usage Example