Package io.jsonwebtoken.security

Interface Summary

Interface	Description
AeadAlgorithm	A cryptographic algorithm that performs Authenticated encryption with additional data.
AeadRequest	A request to an AeadAlgorithm to perform authenticated encryption with a supplied symmetric SecretKey, allowing for additional data to be authenticated and integrity-protected.
AeadResult	The result of authenticated encryption, providing access to the ciphertext output stream and resulting AAD tag and initialization vector.
AssociatedDataSupplier	Provides any "associated data" that must be integrity protected (but not encrypted) when performing AEAD encryption or decryption.
AsymmetricJwk<K extends Key>	JWK representation of an asymmetric (public or private) cryptographic key.
AsymmetricJwkBuilder<K extends Key,J extends AsymmetricJwk<K>,T extends AsymmetricJwkBuilder<K,J,T>>	A JwkBuilder that builds asymmetric (public or private) JWKs.
Curve	A cryptographic Elliptic Curve for use with digital signature or key agreement algorithms.
DecryptAeadRequest	A request to an AeadAlgorithm to decrypt ciphertext and perform integrity-protection with a supplied decryption SecretKey.
DecryptionKeyRequest<K extends Key>	A KeyRequest to obtain a decryption key that will be used to decrypt a JWE using an AeadAlgorithm.
DigestAlgorithm<R extends Request<InputStream>,V extends VerifyDigestRequest>	A DigestAlgorithm is a Cryptographic Hash Function that computes and verifies cryptographic digests.
DigestSupplier	A DigestSupplier provides access to the result of a cryptographic digest algorithm, such as a Message Digest, MAC, Signature, or Authentication Tag.
DynamicJwkBuilder<K extends Key,J extends Jwk<K>>	A JwkBuilder that coerces to a more type-specific builder based on the Key that will be represented as a JWK.
EcPrivateJwk	JWK representation of an ECPrivateKey as defined by the JWA (RFC 7518) specification sections on Parameters for Elliptic Curve Keys and Parameters for Elliptic Curve Private Keys.
EcPrivateJwkBuilder	A PrivateJwkBuilder that creates EcPrivateJwks.
EcPublicJwk	JWK representation of an ECPublicKey as defined by the JWA (RFC 7518) specification sections on Parameters for Elliptic Curve Keys and Parameters for Elliptic Curve Public Keys.
EcPublicJwkBuilder	A PublicJwkBuilder that creates EcPublicJwks.
HashAlgorithm	A DigestAlgorithm that computes and verifies digests without the use of a cryptographic key, such as for thumbprints and digital fingerprints.
IvSupplier	An IvSupplier provides access to the secure-random Initialization Vector used during encryption, which must in turn be presented for use during decryption.
Jwk<K extends Key>	A JWK is an immutable set of name/value pairs that represent a cryptographic key as defined by RFC 7517: JSON Web Key (JWK).
JwkBuilder<K extends Key,J extends Jwk<K>,T extends JwkBuilder<K,J,T>>	A SecurityBuilder that produces a JWK.
JwkParserBuilder	A builder to construct a Parser that can parse Jwks.
JwkSet	A JWK Set is an immutable JSON Object that represents a Set of Jwks as defined by RFC 7517 JWK Set Format.
JwkSetBuilder	A builder that produces JwkSets containing Jwks.
JwkSetParserBuilder	A builder to construct a Parser that can parse JwkSets.
JwkThumbprint	A canonical cryptographic digest of a JWK as defined by the JSON Web Key (JWK) Thumbprint specification.
KeyAlgorithm<E extends Key,D extends Key>	A KeyAlgorithm produces the SecretKey used to encrypt or decrypt a JWE.
KeyBuilder<K extends Key,B extends KeyBuilder<K,B>>	A KeyBuilder produces new Keys suitable for use with an associated cryptographic algorithm.
KeyBuilderSupplier<K extends Key,B extends KeyBuilder<K,B>>	Interface implemented by components that support building/creating new Keys suitable for use with their associated cryptographic algorithm implementation.
KeyLengthSupplier	Provides access to the required length in bits (not bytes) of keys usable with the associated algorithm.
KeyOperation	A KeyOperation identifies a behavior for which a key may be used.
KeyOperationBuilder	A KeyOperationBuilder produces KeyOperation instances that may be added to a JWK's key operations parameter.
KeyOperationPolicied<T extends KeyOperationPolicied<T>>	A marker interface that indicates the implementing instance supports the ability to configure a KeyOperationPolicy used to validate JWK instances.
KeyOperationPolicy	A key operation policy determines which KeyOperations may be assigned to a JWK.
KeyOperationPolicyBuilder	A KeyOperationPolicyBuilder produces a KeyOperationPolicy that determines which KeyOperations may be assigned to a JWK.
KeyPair<A extends PublicKey,B extends PrivateKey>	Generics-capable and type-safe alternative to KeyPair.
KeyPairBuilder	A KeyPairBuilder produces new KeyPairs suitable for use with an associated cryptographic algorithm.
KeyPairBuilderSupplier	Interface implemented by components that support building/creating new KeyPairs suitable for use with their associated cryptographic algorithm implementation.
KeyRequest<T>	A request to a KeyAlgorithm to obtain the key necessary for AEAD encryption or decryption.
KeyResult	The result of a KeyAlgorithm encryption key request, containing the resulting JWE encrypted key and JWE Content Encryption Key (CEK), concepts defined in JWE Terminology.
KeySupplier<K extends Key>	Provides access to a cryptographic Key necessary for signing, wrapping, encryption or decryption algorithms.
MacAlgorithm	A SecureDigestAlgorithm that uses symmetric SecretKeys to both compute and verify digests as message authentication codes (MACs).
Message<T>	A message contains a payload used as input to or output from a cryptographic algorithm.
OctetPrivateJwk<K extends PrivateKey,L extends PublicKey>	JWK representation of an Edwards Curve PrivateKey as defined by RFC 8037, Section 2: Key Type "OKP".
OctetPrivateJwkBuilder<K extends PrivateKey,L extends PublicKey>	A PrivateJwkBuilder that creates OctetPrivateJwk instances.
OctetPublicJwk<K extends PublicKey>	JWK representation of an Edwards Curve PublicKey as defined by RFC 8037, Section 2: Key Type "OKP".
OctetPublicJwkBuilder<A extends PublicKey,B extends PrivateKey>	A PublicJwkBuilder that creates OctetPublicJwk instances.
Password	A Key suitable for use with password-based key derivation algorithms.
PrivateJwk<K extends PrivateKey,L extends PublicKey,M extends PublicJwk<L>>	JWK representation of a PrivateKey.
PrivateJwkBuilder<K extends PrivateKey,L extends PublicKey,J extends PublicJwk<L>,M extends PrivateJwk<K,L,J>,T extends PrivateJwkBuilder<K,L,J,M,T>>	An AsymmetricJwkBuilder that creates PrivateJwk instances.
PrivateKeyBuilder	A builder that allows a PrivateKey to be transparently associated with a SecurityBuilder.provider(Provider) or PrivateKeyBuilder.publicKey(PublicKey) if necessary for algorithms that require them.
PublicJwk<K extends PublicKey>	JWK representation of a PublicKey.
PublicJwkBuilder<K extends PublicKey,L extends PrivateKey,J extends PublicJwk<K>,M extends PrivateJwk<L,K,J>,P extends PrivateJwkBuilder<L,K,J,M,P>,T extends PublicJwkBuilder<K,L,J,M,P,T>>	An AsymmetricJwkBuilder that creates PublicJwk instances.
Request<T>	A Request aggregates various parameters that may be used by a particular cryptographic algorithm.
RsaPrivateJwk	JWK representation of an RSAPrivateKey as defined by the JWA (RFC 7518) specification sections on Parameters for RSA Keys and Parameters for RSA Private Keys.
RsaPrivateJwkBuilder	A PrivateJwkBuilder that creates RsaPrivateJwks.
RsaPublicJwk	JWK representation of an RSAPublicKey as defined by the JWA (RFC 7518) specification sections on Parameters for RSA Keys and Parameters for RSA Public Keys.
RsaPublicJwkBuilder	A PublicJwkBuilder that creates RsaPublicJwks.
SecretJwk	JWK representation of a SecretKey as defined by the JWA (RFC 7518) specification section on Parameters for Symmetric Keys.
SecretJwkBuilder	A JwkBuilder that creates SecretJwks.
SecretKeyAlgorithm	A KeyAlgorithm that uses symmetric SecretKeys to obtain AEAD encryption and decryption keys.
SecretKeyBuilder	A KeyBuilder that creates new secure-random SecretKeys with a length sufficient to be used by the security algorithm that produced this builder.
SecureDigestAlgorithm<S extends Key,V extends Key>	A DigestAlgorithm that requires a Key to compute and verify the authenticity of digests using either digital signature or message authentication code algorithms.
SecureRequest<T,K extends Key>	A request to a cryptographic algorithm requiring a Key.
SecurityBuilder<T,B extends SecurityBuilder<T,B>>	A Security-specific Builder that allows configuration of common JCA API parameters that might be used during instance creation, such as a Provider or SecureRandom.
SignatureAlgorithm	A digital signature algorithm computes and verifies digests using asymmetric public/private key cryptography.
VerifyDigestRequest	A request to verify a previously-computed cryptographic digest (available via DigestSupplier.getDigest()) against the digest to be computed for the specified payload.
VerifySecureDigestRequest<K extends Key>	A request to a SecureDigestAlgorithm to verify a previously-computed digital signature or message authentication code.
X509Accessor	Accessor methods of X.509-specific properties of a ProtectedHeader or AsymmetricJwk, guaranteeing consistent behavior across similar but distinct JWT concepts with identical parameter names.
X509Builder<T extends X509Builder<T>>	Additional X.509-specific builder methods for constructing an associated JWT Header or JWK, enabling method chaining.
X509Mutator<T extends X509Mutator<T>>	Mutation (modifications) of X.509-specific properties of an associated JWT Header or JWK, enabling method chaining.

Class Summary

Class	Description
Jwks	Utility methods for creating JWKs (JSON Web Keys) with a type-safe builder.
Jwks.CRV	Constants for all standard JWK crv (Curve) parameter values defined in the JSON Web Key Elliptic Curve Registry (including its Edwards Elliptic Curve additions).
Jwks.HASH	Various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.
Jwks.OP	Constants for all standard JWK key_ops (Key Operations) parameter values defined in the JSON Web Key Operations Registry.
Keys	Utility class for securely generating SecretKeys and KeyPairs.

Exception Summary

Exception	Description
InvalidKeyException	A KeyException thrown when encountering a key that is not suitable for the required functionality, or when attempting to use a Key in an incorrect or prohibited manner.
KeyException	General-purpose exception when encountering a problem with a cryptographic Key or Jwk.
MalformedKeyException	Exception thrown when encountering a key or key material that is incomplete or improperly configured or formatted and cannot be used as expected.
MalformedKeySetException	Exception thrown when encountering a JwkSet that is incomplete or improperly configured or formatted and cannot be used as expected.
SecurityException	A JwtException attributed to a problem with security-related elements, such as cryptographic keys, algorithms, or the underlying Java JCA API.
SignatureException	Exception thrown if there is problem calculating or verifying a digital signature or message authentication code.
UnsupportedKeyException	Exception thrown when encountering a key or key material that is not supported or recognized.
WeakKeyException	Exception thrown when encountering a key that is not strong enough (of sufficient length) to be used with a particular algorithm or in a particular security context.