Package | Description |
---|---|
com.nimbusds.jose |
Javascript Object Signing and Encryption (JOSE) classes.
|
com.nimbusds.jose.crypto |
Implementations of all standard Javascript Object Signing and Encryption
(JOSE) algorithms.
|
com.nimbusds.jose.jwk |
JSON Web Key (JWK) classes.
|
com.nimbusds.jose.util |
Utility interfaces and classes.
|
com.nimbusds.jwt |
JSON Web Token (JWT) classes.
|
Modifier and Type | Method and Description |
---|---|
Base64URL |
JWEHeader.getAgreementPartyUInfo()
Gets the agreement PartyUInfo (
apu ) parameter. |
Base64URL |
JWEHeader.getAgreementPartyVInfo()
Gets the agreement PartyVInfo (
apv ) parameter. |
Base64URL |
JWECryptoParts.getAuthenticationTag()
Gets the authentication tag.
|
Base64URL |
JWEObject.getAuthTag()
Returns the authentication tag of this JWE object.
|
Base64URL |
JWEHeader.getAuthTag()
Gets the authentication tag (
tag ) parameter. |
Base64URL |
JWECryptoParts.getCipherText()
Gets the cipher text.
|
Base64URL |
JWEObject.getCipherText()
Returns the cipher text of this JWE object.
|
Base64URL |
JWECryptoParts.getEncryptedKey()
Gets the encrypted key.
|
Base64URL |
JWEObject.getEncryptedKey()
Returns the encrypted key of this JWE object.
|
Base64URL |
JWECryptoParts.getInitializationVector()
Gets the initialisation vector (IV).
|
Base64URL |
JWEObject.getIV()
Returns the initialisation vector (IV) of this JWE object.
|
Base64URL |
JWEHeader.getIV()
Gets the initialisation vector (
iv ) parameter. |
Base64URL |
Header.getParsedBase64URL()
Gets the original Base64URL used to create this header.
|
Base64URL[] |
JOSEObject.getParsedParts()
Returns the original parsed Base64URL parts used to create this JOSE
object.
|
Base64URL |
JWEHeader.getPBES2Salt()
Gets the PBES2 salt (
p2s ) parameter. |
Base64URL |
JWSObject.getSignature()
Returns the signature of this JWS object.
|
Base64URL |
JWSSigner.sign(JWSHeader header,
byte[] signingInput)
Signs the specified
input of a
JWS object . |
static Base64URL[] |
JOSEObject.split(String s)
Splits a compact serialised JOSE object into its Base64URL-encoded
parts.
|
Base64URL |
Payload.toBase64URL()
Returns a Base64URL representation of this payload.
|
Base64URL |
Header.toBase64URL()
Returns a Base64URL representation of the header.
|
Modifier and Type | Method and Description |
---|---|
JWEHeader.Builder |
JWEHeader.Builder.agreementPartyUInfo(Base64URL apu)
Sets the agreement PartyUInfo (
apu ) parameter. |
JWEHeader.Builder |
JWEHeader.Builder.agreementPartyVInfo(Base64URL apv)
Sets the agreement PartyVInfo (
apv ) parameter. |
JWEHeader.Builder |
JWEHeader.Builder.authTag(Base64URL tag)
Sets the authentication tag (
tag ) parameter. |
byte[] |
JWEDecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag)
Decrypts the specified cipher text of a
JWE Object . |
JWEHeader.Builder |
JWEHeader.Builder.iv(Base64URL iv)
Sets the initialisation vector (
iv ) parameter. |
static PlainHeader |
PlainHeader.parse(Base64URL base64URL)
Parses an unsecured header from the specified Base64URL.
|
static JWSHeader |
JWSHeader.parse(Base64URL base64URL)
Parses a JWS header from the specified Base64URL.
|
static Header |
Header.parse(Base64URL base64URL)
|
static JWEHeader |
JWEHeader.parse(Base64URL base64URL)
Parses a JWE header from the specified Base64URL.
|
static PlainHeader |
PlainHeader.parse(net.minidev.json.JSONObject jsonObject,
Base64URL parsedBase64URL)
Parses an unsecured header from the specified JSON object.
|
static JWSHeader |
JWSHeader.parse(net.minidev.json.JSONObject jsonObject,
Base64URL parsedBase64URL)
Parses a JWS header from the specified JSON object.
|
static Header |
Header.parse(net.minidev.json.JSONObject jsonObject,
Base64URL parsedBase64URL)
|
static JWEHeader |
JWEHeader.parse(net.minidev.json.JSONObject jsonObject,
Base64URL parsedBase64URL)
Parses a JWE header from the specified JSON object.
|
static PlainHeader |
PlainHeader.parse(String jsonString,
Base64URL parsedBase64URL)
Parses an unsecured header from the specified JSON string.
|
static JWSHeader |
JWSHeader.parse(String jsonString,
Base64URL parsedBase64URL)
Parses a JWS header from the specified JSON object string.
|
static Header |
Header.parse(String jsonString,
Base64URL parsedBase64URL)
|
static JWEHeader |
JWEHeader.parse(String jsonString,
Base64URL parsedBase64URL)
Parses a JWE header from the specified JSON object string.
|
PlainHeader.Builder |
PlainHeader.Builder.parsedBase64URL(Base64URL base64URL)
Sets the parsed Base64URL.
|
JWSHeader.Builder |
JWSHeader.Builder.parsedBase64URL(Base64URL base64URL)
Sets the parsed Base64URL.
|
JWEHeader.Builder |
JWEHeader.Builder.parsedBase64URL(Base64URL base64URL)
Sets the parsed Base64URL.
|
JWEHeader.Builder |
JWEHeader.Builder.pbes2Salt(Base64URL p2s)
Sets the PBES2 salt (
p2s ) parameter. |
protected void |
JOSEObject.setParsedParts(Base64URL... parts)
Sets the original parsed Base64URL parts used to create this JOSE
object.
|
boolean |
JWSVerifier.verify(JWSHeader header,
byte[] signingInput,
Base64URL signature)
Verifies the specified
signature of a
JWS object . |
JWSHeader.Builder |
JWSHeader.Builder.x509CertSHA256Thumbprint(Base64URL x5t256)
Sets the X.509 certificate SHA-256 thumbprint
(
x5t#S256 ) parameter. |
JWEHeader.Builder |
JWEHeader.Builder.x509CertSHA256Thumbprint(Base64URL x5t256)
Sets the X.509 certificate SHA-256 thumbprint
(
x5t#s256 ) parameter. |
JWSHeader.Builder |
JWSHeader.Builder.x509CertThumbprint(Base64URL x5t)
Sets the X.509 certificate SHA-1 thumbprint (
x5t )
parameter. |
JWEHeader.Builder |
JWEHeader.Builder.x509CertThumbprint(Base64URL x5t)
Sets the X.509 certificate SHA-1 thumbprint (
x5t )
parameter. |
Constructor and Description |
---|
Header(Algorithm alg,
JOSEObjectType typ,
String cty,
Set<String> crit,
Map<String,Object> customParams,
Base64URL parsedBase64URL)
Creates a new abstract header.
|
JWECryptoParts(Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authenticationTag)
Creates a new cryptographic JWE parts instance.
|
JWECryptoParts(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authenticationTag)
Creates a new cryptographic JWE parts instance.
|
JWEHeader(Algorithm alg,
EncryptionMethod enc,
JOSEObjectType typ,
String cty,
Set<String> crit,
URI jku,
JWK jwk,
URI x5u,
Base64URL x5t,
Base64URL x5t256,
List<Base64> x5c,
String kid,
ECKey epk,
CompressionAlgorithm zip,
Base64URL apu,
Base64URL apv,
Base64URL p2s,
int p2c,
Base64URL iv,
Base64URL tag,
Map<String,Object> customParams,
Base64URL parsedBase64URL)
Creates a new JSON Web Encryption (JWE) header.
|
JWEObject(Base64URL firstPart,
Base64URL secondPart,
Base64URL thirdPart,
Base64URL fourthPart,
Base64URL fifthPart)
Creates a new encrypted JSON Web Encryption (JWE) object with the
specified serialised parts.
|
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)
Creates a new JSON Web Signature (JWS) header.
|
JWSObject(Base64URL firstPart,
Base64URL secondPart,
Base64URL thirdPart)
Creates a new signed JSON Web Signature (JWS) object with the
specified serialised parts.
|
Payload(Base64URL base64URL)
Creates a new payload from the specified Base64URL-encoded object.
|
PlainHeader(JOSEObjectType typ,
String cty,
Set<String> crit,
Map<String,Object> customParams,
Base64URL parsedBase64URL)
Creates a new unsecured (plain) header with algorithm
none . |
PlainObject(Base64URL firstPart,
Base64URL secondPart)
Creates a new unsecured JOSE object with the specified
Base64URL-encoded parts.
|
Modifier and Type | Method and Description |
---|---|
Base64URL |
MACSigner.sign(JWSHeader header,
byte[] signingInput) |
Base64URL |
RSASSASigner.sign(JWSHeader header,
byte[] signingInput) |
Base64URL |
ECDSASigner.sign(JWSHeader header,
byte[] signingInput) |
Modifier and Type | Method and Description |
---|---|
byte[] |
PasswordBasedDecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag) |
byte[] |
AESDecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag) |
byte[] |
ECDHDecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag) |
byte[] |
RSADecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag) |
byte[] |
DirectDecrypter.decrypt(JWEHeader header,
Base64URL encryptedKey,
Base64URL iv,
Base64URL cipherText,
Base64URL authTag) |
boolean |
MACVerifier.verify(JWSHeader header,
byte[] signedContent,
Base64URL signature) |
boolean |
ECDSAVerifier.verify(JWSHeader header,
byte[] signedContent,
Base64URL signature) |
boolean |
RSASSAVerifier.verify(JWSHeader header,
byte[] signedContent,
Base64URL signature) |
Modifier and Type | Method and Description |
---|---|
static Base64URL |
ThumbprintUtils.compute(JWK jwk)
Computes the SHA-256 thumbprint for the specified JWK.
|
static Base64URL |
ThumbprintUtils.compute(String hashAlg,
JWK jwk)
Computes the thumbprint for the specified JWK.
|
static Base64URL |
ThumbprintUtils.compute(String hashAlg,
LinkedHashMap<String,?> params)
Computes the thumbprint for the specified required JWK parameters.
|
Base64URL |
JWK.computeThumbprint()
Computes the SHA-256 thumbprint of this JWK.
|
Base64URL |
JWK.computeThumbprint(String hashAlg)
Computes the thumbprint of this JWK using the specified hash
algorithm.
|
static Base64URL |
ECKey.encodeCoordinate(int fieldSize,
BigInteger coordinate)
Returns the Base64URL encoding of the specified elliptic curve 'x',
'y' or 'd' coordinate, with leading zero padding up to the specified
field size in bits.
|
Base64URL |
ECKey.getD()
Gets the private 'd' coordinate for the elliptic curve point.
|
Base64URL |
RSAKey.OtherPrimesInfo.getFactorCRTCoefficient()
The factor Chinese Remainder Theorem (CRT) coefficient
(
t ). |
Base64URL |
RSAKey.OtherPrimesInfo.getFactorCRTExponent()
Gets factor Chinese Remainder Theorem (CRT) exponent
(
d ). |
Base64URL |
RSAKey.getFirstCRTCoefficient()
Gets the first Chinese Remainder Theorem (CRT) coefficient
(
qi )} of the private RSA key. |
Base64URL |
RSAKey.getFirstFactorCRTExponent()
Gets the first factor Chinese Remainder Theorem (CRT) exponent
(
dp ) of the private RSA key. |
Base64URL |
RSAKey.getFirstPrimeFactor()
Gets the first prime factor (
p ) of the private RSA key. |
Base64URL |
OctetSequenceKey.getKeyValue()
Returns the value of this octet sequence key.
|
Base64URL |
RSAKey.getModulus()
Gets the modulus value (
n ) of the RSA key. |
Base64URL |
RSAKey.OtherPrimesInfo.getPrimeFactor()
Gets the prime factor (
r ). |
Base64URL |
RSAKey.getPrivateExponent()
Gets the private exponent (
d ) of the RSA key. |
Base64URL |
RSAKey.getPublicExponent()
Gets the public exponent (
e ) of the RSA key. |
Base64URL |
RSAKey.getSecondFactorCRTExponent()
Gets the second factor Chinese Remainder Theorem (CRT) exponent
(
dq ) of the private RSA key. |
Base64URL |
RSAKey.getSecondPrimeFactor()
Gets the second prime factor (
q ) of the private RSA key. |
Base64URL |
ECKey.getX()
Gets the public 'x' coordinate for the elliptic curve point.
|
Base64URL |
JWK.getX509CertThumbprint()
Gets the X.509 certificate thumbprint (
x5t ) of this JWK. |
Base64URL |
ECKey.getY()
Gets the public 'y' coordinate for the elliptic curve point.
|
Modifier and Type | Method and Description |
---|---|
ECKey.Builder |
ECKey.Builder.d(Base64URL d)
Sets the private 'd' coordinate for the elliptic curve
point.
|
RSAKey.Builder |
RSAKey.Builder.firstCRTCoefficient(Base64URL qi)
Sets the first Chinese Remainder Theorem (CRT) coefficient
(
qi )} of the private RSA key. |
RSAKey.Builder |
RSAKey.Builder.firstFactorCRTExponent(Base64URL dp)
Sets the first factor Chinese Remainder Theorem (CRT)
exponent (
dp ) of the private RSA key. |
RSAKey.Builder |
RSAKey.Builder.firstPrimeFactor(Base64URL p)
Sets the first prime factor (
p ) of the private RSA
key. |
RSAKey.Builder |
RSAKey.Builder.privateExponent(Base64URL d)
Sets the private exponent (
d ) of the RSA key. |
RSAKey.Builder |
RSAKey.Builder.secondFactorCRTExponent(Base64URL dq)
Sets the second factor Chinese Remainder Theorem (CRT)
exponent (
dq ) of the private RSA key. |
RSAKey.Builder |
RSAKey.Builder.secondPrimeFactor(Base64URL q)
Sets the second prime factor (
q ) of the private RSA
key. |
RSAKey.Builder |
RSAKey.Builder.x509CertThumbprint(Base64URL x5t)
Sets the X.509 certificate thumbprint (
x5t ) of the
JWK. |
OctetSequenceKey.Builder |
OctetSequenceKey.Builder.x509CertThumbprint(Base64URL x5t)
Sets the X.509 certificate thumbprint (
x5t ) of the
JWK. |
ECKey.Builder |
ECKey.Builder.x509CertThumbprint(Base64URL x5t)
Sets the X.509 certificate thumbprint (
x5t ) of the
JWK. |
Constructor and Description |
---|
Builder(Base64URL k)
Creates a new octet sequence JWK builder.
|
Builder(Base64URL n,
Base64URL e)
Creates a new RSA JWK builder.
|
Builder(ECKey.Curve crv,
Base64URL x,
Base64URL y)
Creates a new Elliptic Curve JWK builder.
|
ECKey(ECKey.Curve crv,
Base64URL x,
Base64URL y,
Base64URL d,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private Elliptic Curve JSON Web Key (JWK)
with the specified parameters.
|
ECKey(ECKey.Curve crv,
Base64URL x,
Base64URL y,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public Elliptic Curve JSON Web Key (JWK) with the
specified parameters.
|
ECKey(ECKey.Curve crv,
ECPublicKey pub,
ECPrivateKey priv,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private Elliptic Curve JSON Web Key (JWK)
with the specified parameters.
|
ECKey(ECKey.Curve crv,
ECPublicKey pub,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public Elliptic Curve JSON Web Key (JWK) with the
specified parameters.
|
JWK(KeyType kty,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new JSON Web Key (JWK).
|
OctetSequenceKey(Base64URL k,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new octet sequence JSON Web Key (JWK) with the specified
parameters.
|
OtherPrimesInfo(Base64URL r,
Base64URL d,
Base64URL t)
Creates a new JWK Other Primes Info with the specified
parameters.
|
RSAKey(Base64URL n,
Base64URL e,
Base64URL d,
Base64URL p,
Base64URL q,
Base64URL dp,
Base64URL dq,
Base64URL qi,
List<RSAKey.OtherPrimesInfo> oth,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
RSAKey(Base64URL n,
Base64URL e,
Base64URL p,
Base64URL q,
Base64URL dp,
Base64URL dq,
Base64URL qi,
List<RSAKey.OtherPrimesInfo> oth,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
RSAKey(Base64URL n,
Base64URL e,
Base64URL d,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
RSAKey(Base64URL n,
Base64URL e,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public RSA JSON Web Key (JWK) with the specified
parameters.
|
RSAKey(RSAPublicKey pub,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public RSA JSON Web Key (JWK) with the specified
parameters.
|
RSAKey(RSAPublicKey pub,
RSAMultiPrimePrivateCrtKey priv,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
RSAKey(RSAPublicKey pub,
RSAPrivateCrtKey priv,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
RSAKey(RSAPublicKey pub,
RSAPrivateKey priv,
KeyUse use,
Set<KeyOperation> ops,
Algorithm alg,
String kid,
URI x5u,
Base64URL x5t,
List<Base64> x5c)
Creates a new public / private RSA JSON Web Key (JWK) with the
specified parameters.
|
Modifier and Type | Method and Description |
---|---|
static Base64URL |
Base64URL.encode(BigInteger bigInt)
Base64URL-encodes the specified big integer, without the sign bit.
|
static Base64URL |
Base64URL.encode(byte[] bytes)
Base64URL-encodes the specified byte array.
|
static Base64URL |
Base64URL.encode(String text)
Base64URL-encodes the specified string.
|
Modifier and Type | Method and Description |
---|---|
Base64URL[] |
JWT.getParsedParts()
Gets the original parsed Base64URL parts used to create the JSON Web
Token (JWT).
|
Constructor and Description |
---|
EncryptedJWT(Base64URL firstPart,
Base64URL secondPart,
Base64URL thirdPart,
Base64URL fourthPart,
Base64URL fifthPart)
Creates a new encrypted JSON Web Token (JWT) with the specified
serialised parts.
|
PlainJWT(Base64URL firstPart,
Base64URL secondPart)
Creates a new unsecured (plain) JSON Web Token (JWT) with the
specified Base64URL-encoded parts.
|
SignedJWT(Base64URL firstPart,
Base64URL secondPart,
Base64URL thirdPart)
Creates a new signed JSON Web Token (JWT) with the specified
serialised parts.
|
Copyright © 2016 Connect2id Ltd.. All rights reserved.