Package | Description |
---|---|
io.jsonwebtoken | |
io.jsonwebtoken.security |
Class and Description |
---|
AeadAlgorithm
A cryptographic algorithm that performs
Authenticated encryption with additional data.
|
DigestSupplier
A
DigestSupplier provides access to the result of a cryptographic digest algorithm, such as a
Message Digest, MAC, Signature, or Authentication Tag. |
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. |
KeyAlgorithm
A
KeyAlgorithm produces the SecretKey used to encrypt or decrypt a JWE. |
MacAlgorithm
A
SecureDigestAlgorithm that uses symmetric SecretKey s to both compute and verify digests as
message authentication codes (MACs). |
Password
A
Key suitable for use with password-based key derivation algorithms. |
PublicJwk
JWK representation of a
PublicKey . |
SecretKeyAlgorithm
A
KeyAlgorithm that uses symmetric SecretKey s to obtain AEAD encryption and decryption keys. |
SecureDigestAlgorithm
A
DigestAlgorithm that requires a Key to compute and verify the authenticity of digests using either
digital signature or
message
authentication code algorithms. |
SecurityException
A
JwtException attributed to a problem with security-related elements, such as
cryptographic keys, algorithms, or the underlying Java JCA API. |
SignatureAlgorithm
A digital signature algorithm computes and
verifies digests using asymmetric public/private key cryptography.
|
SignatureException
Exception thrown if there is problem calculating or verifying a 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
Additional X.509-specific builder methods for constructing an associated JWT Header or JWK, enabling method chaining.
|
X509Mutator
Mutation (modifications) of X.509-specific properties of an associated JWT Header or JWK, enabling method chaining.
|
Class and 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
JWK representation of an asymmetric (public or private) cryptographic key.
|
AsymmetricJwkBuilder
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
A
KeyRequest to obtain a decryption key that will be used to decrypt a JWE using an AeadAlgorithm . |
DigestAlgorithm
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
A
JwkBuilder that coerces to a more type-specific builder based on the Key that will be
represented as a JWK. |
EcPrivateJwkBuilder
A
PrivateJwkBuilder that creates EcPrivateJwk s. |
EcPublicJwkBuilder
A
PublicJwkBuilder that creates EcPublicJwk s. |
HashAlgorithm
A
DigestAlgorithm that computes and verifies digests without the use of a cryptographic key, such as for
thumbprints and digital fingerprints. |
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. |
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
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
A
SecurityBuilder that produces a JWK. |
JwkParserBuilder |
JwkSetBuilder |
JwkSetParserBuilder |
JwkThumbprint
A canonical cryptographic digest of a JWK as defined by the
JSON Web Key (JWK) Thumbprint specification.
|
KeyAlgorithm
A
KeyAlgorithm produces the SecretKey used to encrypt or decrypt a JWE. |
KeyBuilder
A
KeyBuilder produces new Key s suitable for use with an associated cryptographic algorithm. |
KeyBuilderSupplier
Interface implemented by components that support building/creating new
Key s suitable for use with
their associated cryptographic algorithm implementation. |
KeyException |
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
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
KeyOperation s may be assigned to a JWK. |
KeyOperationPolicyBuilder
A
KeyOperationPolicyBuilder produces a KeyOperationPolicy that determines
which KeyOperation s may be assigned to a JWK. |
KeyPair
Generics-capable and type-safe alternative to
KeyPair . |
KeyPairBuilder
A
KeyPairBuilder produces new KeyPair s suitable for use with an associated cryptographic algorithm. |
KeyPairBuilderSupplier
Interface implemented by components that support building/creating new
KeyPair s suitable for use with their
associated cryptographic algorithm implementation. |
KeyRequest
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
Provides access to a cryptographic
Key necessary for signing, wrapping, encryption or decryption algorithms. |
Message
A message contains a
payload used as input to or output from a cryptographic algorithm. |
OctetPrivateJwkBuilder
A
PrivateJwkBuilder that creates OctetPrivateJwk instances. |
OctetPublicJwkBuilder
A
PublicJwkBuilder that creates OctetPublicJwk instances. |
Password
A
Key suitable for use with password-based key derivation algorithms. |
PrivateJwk
JWK representation of a
PrivateKey . |
PrivateJwkBuilder
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
JWK representation of a
PublicKey . |
PublicJwkBuilder
An
AsymmetricJwkBuilder that creates PublicJwk instances. |
Request
A
Request aggregates various parameters that may be used by a particular cryptographic algorithm. |
RsaPrivateJwkBuilder
A
PrivateJwkBuilder that creates RsaPrivateJwk s. |
RsaPublicJwkBuilder
A
PublicJwkBuilder that creates RsaPublicJwk s. |
SecretJwkBuilder
A
JwkBuilder that creates SecretJwk s. |
SecretKeyBuilder
A
KeyBuilder that creates new secure-random SecretKey s with a length sufficient to be used by
the security algorithm that produced this builder. |
SecureDigestAlgorithm
A
DigestAlgorithm that requires a Key to compute and verify the authenticity of digests using either
digital signature or
message
authentication code algorithms. |
SecureRequest
A request to a cryptographic algorithm requiring a
Key . |
SecurityBuilder
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 . |
SecurityException
A
JwtException attributed to a problem with security-related elements, such as
cryptographic keys, algorithms, or the underlying Java JCA API. |
UnsupportedKeyException
Exception thrown when encountering a key or key material that is not supported or recognized.
|
VerifyDigestRequest
A request to verify a previously-computed cryptographic digest (available via
DigestSupplier.getDigest() ) against the
digest to be computed for the specified payload . |
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.
|
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
Additional X.509-specific builder methods for constructing an associated JWT Header or JWK, enabling method chaining.
|
X509Mutator
Mutation (modifications) of X.509-specific properties of an associated JWT Header or JWK, enabling method chaining.
|
Copyright © 2014–2025 jsonwebtoken.io. All rights reserved.