From 7389bee2ffce6403524cd2967d201dada1f68633 Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Thu, 23 Apr 2020 13:58:36 +0200 Subject: [PATCH] docs: update readme.md --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5dec0ef72c..27e26cb490 100644 --- a/README.md +++ b/README.md @@ -141,8 +141,6 @@ jose.JWT.verify(
Verifying OIDC ID Tokens (Click to expand)
-#### ID Token Verifying - ID Token is a JWT, but profiled, there are additional requirements to a JWT to be accepted as an ID Token and it is pretty easy to omit some, use the `profile` option of `JWT.verify` or the `JWT.IdToken.verify` shorthand to make sure what you're accepting is really an ID Token meant to @@ -171,7 +169,9 @@ to validate those hashes after getting the ID Token payload and signature valida
Verifying OAuth 2.0 JWT Access Tokens (Click to expand)
-#### JWT Access Token Verifying +Draft specification profiles are updated as minor versions of the library, therefore, +since they may have breaking changes use the `~` semver operator when using these and pay close +attention to changelog and the drafts themselves. When accepting a JWT-formatted OAuth 2.0 Access Token there are additional requirements for the JWT to be accepted as an Access Token according to the [specification][draft-ietf-oauth-access-token-jwt] @@ -197,7 +197,9 @@ jose.JWT.AccessToken.verify(
Verifying OIDC Logout Token (Click to expand)
-#### Logout Token Verifying +Draft specification profiles are updated as minor versions of the library, therefore, +since they may have breaking changes use the `~` semver operator when using these and pay close +attention to changelog and the drafts themselves. Logout Token is a JWT, but profiled, there are additional requirements to a JWT to be accepted as an Logout Token and it is pretty easy to omit some, use the `profile` option of `JWT.verify` or the @@ -310,7 +312,7 @@ jose.JWE.decrypt( | JWT profile validation | Supported | Stable profile | profile option value | | -- | -- | -- | -- | | ID Token - [OpenID Connect Core 1.0][spec-oidc-id_token] | ✓ | ✓ | `id_token` | -| JWT Access Tokens [JWT Profile for OAuth 2.0 Access Tokens][draft-ietf-oauth-access-token-jwt] | ✓ | ✕5 | `at+JWT` | +| JWT Access Tokens - [JWT Profile for OAuth 2.0 Access Tokens][draft-ietf-oauth-access-token-jwt] | ✓ | ✕5 | `at+JWT` | | Logout Token - [OpenID Connect Back-Channel Logout 1.0][spec-oidc-logout_token] | ✓ | ✕5 | `logout_token` | | JARM - [JWT Secured Authorization Response Mode for OAuth 2.0][draft-jarm] | ◯ ||| | [JWT Response for OAuth Token Introspection][draft-jwtintrospection] | ◯ |||