Package | Description |
---|---|
com.nimbusds.jose |
Base Javascript Object Signing and Encryption (JOSE) interfaces and classes.
|
com.nimbusds.jose.crypto |
Implementations of standard Javascript Object Signing and Encryption (JOSE)
algorithms.
|
com.nimbusds.jose.crypto.factories |
JWS signer, JWS verifier, JWE encrypter and JWE decrypter factory
implementations.
|
com.nimbusds.jose.crypto.impl |
Cryptographic primitives for JWS signers, JWS verifiers, JWE encrypters and
JWE decrypters in the
com.nimbusds.jose.crypto package. |
com.nimbusds.jose.jca |
Java Cryptography Architecture (JCA) context interfaces and classes.
|
com.nimbusds.jose.jwk |
JSON Web Key (JWK) classes.
|
com.nimbusds.jose.proc |
Framework for application-specific verification and decryption of JOSE
objects (with arbitrary payloads).
|
com.nimbusds.jose.produce |
Framework for producing JOSE objects (with arbitrary payloads).
|
Modifier and Type | Field and Description |
---|---|
static JWSAlgorithm |
JWSAlgorithm.EdDSA
EdDSA signature algorithms (optional).
|
static JWSAlgorithm |
JWSAlgorithm.ES256
ECDSA using P-256 (secp256r1) curve and SHA-256 hash algorithm
(recommended).
|
static JWSAlgorithm |
JWSAlgorithm.ES256K
ECDSA using P-256K (secp256k1) curve and SHA-256 hash algorithm
(optional).
|
static JWSAlgorithm |
JWSAlgorithm.ES384
ECDSA using P-384 curve and SHA-384 hash algorithm (optional).
|
static JWSAlgorithm |
JWSAlgorithm.ES512
ECDSA using P-521 curve and SHA-512 hash algorithm (optional).
|
static JWSAlgorithm |
JWSAlgorithm.HS256
HMAC using SHA-256 hash algorithm (required).
|
static JWSAlgorithm |
JWSAlgorithm.HS384
HMAC using SHA-384 hash algorithm (optional).
|
static JWSAlgorithm |
JWSAlgorithm.HS512
HMAC using SHA-512 hash algorithm (optional).
|
static JWSAlgorithm |
JWSAlgorithm.PS256
RSASSA-PSS using SHA-256 hash algorithm and MGF1 mask generation
function with SHA-256 (optional).
|
static JWSAlgorithm |
JWSAlgorithm.PS384
RSASSA-PSS using SHA-384 hash algorithm and MGF1 mask generation
function with SHA-384 (optional).
|
static JWSAlgorithm |
JWSAlgorithm.PS512
RSASSA-PSS using SHA-512 hash algorithm and MGF1 mask generation
function with SHA-512 (optional).
|
static JWSAlgorithm |
JWSAlgorithm.RS256
RSASSA-PKCS-v1_5 using SHA-256 hash algorithm (recommended).
|
static JWSAlgorithm |
JWSAlgorithm.RS384
RSASSA-PKCS-v1_5 using SHA-384 hash algorithm (optional).
|
static JWSAlgorithm |
JWSAlgorithm.RS512
RSASSA-PKCS-v1_5 using SHA-512 hash algorithm (optional).
|
Modifier and Type | Method and Description |
---|---|
JWSAlgorithm |
JWSHeader.getAlgorithm()
Gets the algorithm (
alg ) parameter. |
static JWSAlgorithm |
JWSAlgorithm.parse(String s)
Parses a JWS algorithm from the specified string.
|
Modifier and Type | Method and Description |
---|---|
Set<JWSAlgorithm> |
JWSProvider.supportedJWSAlgorithms()
Returns the names of the supported algorithms by the JWS provider
instance.
|
Constructor and Description |
---|
Builder(JWSAlgorithm alg)
Creates a new JWS header builder.
|
Family(JWSAlgorithm... algs)
Creates a new JWS algorithm family.
|
JWSHeader(JWSAlgorithm alg)
Creates a new minimal JSON Web Signature (JWS) header.
|
JWSHeader(JWSAlgorithm alg,
JOSEObjectType typ,
String cty,
Set<String> crit,
URI jku,
JWK jwk,
URI x5u,
Base64URL x5t,
Base64URL x5t256,
List<Base64> x5c,
String kid,
boolean b64,
Map<String,Object> customParams,
Base64URL parsedBase64URL)
Creates a new JSON Web Signature (JWS) header.
|
JWSHeader(JWSAlgorithm alg,
JOSEObjectType typ,
String cty,
Set<String> crit,
URI jku,
JWK jwk,
URI x5u,
Base64URL x5t,
Base64URL x5t256,
List<Base64> x5c,
String kid,
Map<String,Object> customParams,
Base64URL parsedBase64URL)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Set<JWSAlgorithm> |
MACSigner.getCompatibleAlgorithms(int secretLength)
Returns the compatible JWS HMAC algorithms for the specified secret
length.
|
Modifier and Type | Method and Description |
---|---|
static int |
MACSigner.getMinRequiredSecretLength(JWSAlgorithm alg)
Returns the minimal required secret length for the specified HMAC
JWS algorithm.
|
Modifier and Type | Field and Description |
---|---|
static Set<JWSAlgorithm> |
DefaultJWSVerifierFactory.SUPPORTED_ALGORITHMS
The supported JWS algorithms.
|
static Set<JWSAlgorithm> |
DefaultJWSSignerFactory.SUPPORTED_ALGORITHMS
The supported JWS algorithms.
|
Modifier and Type | Method and Description |
---|---|
Set<JWSAlgorithm> |
DefaultJWSVerifierFactory.supportedJWSAlgorithms() |
Set<JWSAlgorithm> |
DefaultJWSSignerFactory.supportedJWSAlgorithms() |
Modifier and Type | Method and Description |
---|---|
JWSSigner |
DefaultJWSSignerFactory.createJWSSigner(JWK key,
JWSAlgorithm alg) |
Modifier and Type | Field and Description |
---|---|
static Set<JWSAlgorithm> |
RSASSAProvider.SUPPORTED_ALGORITHMS
The supported JWS algorithms by the RSA-SSA provider class.
|
static Set<JWSAlgorithm> |
MACProvider.SUPPORTED_ALGORITHMS
The supported JWS algorithms by the MAC provider class.
|
static Set<JWSAlgorithm> |
ECDSAProvider.SUPPORTED_ALGORITHMS
The supported JWS algorithms by the EC-DSA provider class.
|
static Set<JWSAlgorithm> |
EdDSAProvider.SUPPORTED_ALGORITHMS
The supported JWS algorithms by the EdDSA provider class.
|
Modifier and Type | Method and Description |
---|---|
static JWSAlgorithm |
ECDSA.resolveAlgorithm(Curve curve)
Resolves the matching EC DSA algorithm for the specified elliptic
curve.
|
static JWSAlgorithm |
ECDSA.resolveAlgorithm(ECKey ecKey)
Resolves the matching EC DSA algorithm for the specified EC key
(public or private).
|
JWSAlgorithm |
ECDSAProvider.supportedECDSAAlgorithm()
Returns the supported ECDSA algorithm.
|
Modifier and Type | Method and Description |
---|---|
Set<JWSAlgorithm> |
BaseJWSProvider.supportedJWSAlgorithms() |
Modifier and Type | Method and Description |
---|---|
protected static String |
MACProvider.getJCAAlgorithmName(JWSAlgorithm alg)
Gets the matching Java Cryptography Architecture (JCA) algorithm
name for the specified HMAC-based JSON Web Algorithm (JWA).
|
static int |
ECDSA.getSignatureByteArrayLength(JWSAlgorithm alg)
Returns the expected signature byte array length (R + S parts) for
the specified ECDSA algorithm.
|
static Signature |
RSASSA.getSignerAndVerifier(JWSAlgorithm alg,
Provider provider)
Returns a signer and verifier for the specified RSASSA-based JSON
Web Algorithm (JWA).
|
static Signature |
ECDSA.getSignerAndVerifier(JWSAlgorithm alg,
Provider jcaProvider)
Creates a new JCA signer / verifier for ECDSA.
|
static String |
AlgorithmSupportMessage.unsupportedJWSAlgorithm(JWSAlgorithm unsupported,
Collection<JWSAlgorithm> supported)
Returns a message that the specified JWS algorithm is not supported.
|
Modifier and Type | Method and Description |
---|---|
static String |
AlgorithmSupportMessage.unsupportedJWSAlgorithm(JWSAlgorithm unsupported,
Collection<JWSAlgorithm> supported)
Returns a message that the specified JWS algorithm is not supported.
|
Constructor and Description |
---|
ECDSAProvider(JWSAlgorithm alg)
Creates a new Elliptic Curve Digital Signature Algorithm (ECDSA)
provider.
|
Constructor and Description |
---|
BaseJWSProvider(Set<JWSAlgorithm> algs)
Creates a new base JWS provider.
|
MACProvider(byte[] secret,
Set<JWSAlgorithm> supportedAlgs)
Creates a new Message Authentication (MAC) provider.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
JCASupport.isSupported(JWSAlgorithm alg)
Checks if the specified JWS algorithm is supported by the default
system JCA provider(s).
|
static boolean |
JCASupport.isSupported(JWSAlgorithm alg,
Provider provider)
Checks if a JWS algorithm is supported by the the specified JCA
provider.
|
Modifier and Type | Method and Description |
---|---|
static Set<Curve> |
Curve.forJWSAlgorithm(JWSAlgorithm alg)
Gets the cryptographic curve(s) for the specified JWS algorithm.
|
Modifier and Type | Method and Description |
---|---|
JWSAlgorithm |
JWSVerificationKeySelector.getExpectedJWSAlgorithm()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
JWSVerificationKeySelector.isAllowed(JWSAlgorithm jwsAlg)
Checks if a JWS algorithm is allowed for key selection.
|
Constructor and Description |
---|
JWSVerificationKeySelector(JWSAlgorithm jwsAlg,
JWKSource<C> jwkSource)
Creates a new JWS verification key selector.
|
SingleKeyJWSKeySelector(JWSAlgorithm expectedJWSAlg,
Key key)
Creates a new single-key JWS key selector.
|
Constructor and Description |
---|
JWSVerificationKeySelector(Set<JWSAlgorithm> jwsAlgs,
JWKSource<C> jwkSource)
Creates a new JWS verification key selector.
|
Modifier and Type | Method and Description |
---|---|
JWSSigner |
JWSSignerFactory.createJWSSigner(JWK key,
JWSAlgorithm alg)
Create a JWS signer based on the key and algorithm.
|
Copyright © 2021 Connect2id Ltd.. All rights reserved.