oauth_jwt_base.rdoc

doc/oauth_jwt_base.rdoc
Last Update: 2024-11-29 16:14:00 +0000

Documentation for OAuth JWT Base feature

The oauth_jwt_base feature overrides functionality from the oauth_base feature to enable the generation, signing, encryption and verification of JWT tokens as OAuth access tokens.

This feature depends on the oauth_base feature.

Value Methods

oauth_application_jwt_public_key_param

Form param for the oauth application client application public key.

oauth_application_jwks_param

Form param for the oauth application client application JSON Web Keys.

oauth_jwt_keys

collection of the auth server signing keys indexed by algo (must include oauth_jwt_key unless nil).

oauth_jwt_public_keys

collection of the auth server public signing keys, which will be exposed in the JWKs endpoint.

oauth_jwt_jwe_keys

collection of the auth server encryption keys indexed by algo/method tuple (must include oauth_jwe_key unless nil).

oauth_jwt_jwe_public_keys

collection of the auth server public encryption keys, which will be exposed in the JWKs endpoint.

oauth_jwt_jwe_copyright

copyright line to add in case JWT tokens are JWE-encrypted, nil by default (‘ruby-jwe` only).

oauth_jwt_jws_algorithms_supported

Supported JWS algorithms for signing JWT tokens.

oauth_jwt_jwe_algorithms_supported

Supported JWE algorithms for encrypting JWT tokens.

oauth_jwt_jwe_encryption_methods_supported

Supported JWE encryption methods for encrypting JWT tokens.

Auth Methods

jwt_encode

encodes a given JWT token.

jwt_decode

decodes a given JWT token.

jwt_decode_no_key

raw-decodes a given JWT token, while performing no signature validation.

generate_jti

generates a unique jti claimm.

oauth_jwt_issuer

JWT issuer claim, returns the authorization server url by default.

oauth_jwt_audience

JWT audience claim, returns the authorization server token url by default.

resource_owner_params_from_jwt_claims

conditionals, built from JWT claims, to filter grants by a given resource owner.