Package com.auth0.jwt.algorithms

Class RSAAlgorithm

java.lang.Object

com.auth0.jwt.algorithms.Algorithm

com.auth0.jwt.algorithms.RSAAlgorithm

class RSAAlgorithm
extends Algorithm

Field Summary

Fields

Modifier and Type	Field	Description
private final CryptoHelper	crypto
private final RSAKeyProvider	keyProvider

Constructor Summary

Constructors

Constructor	Description
RSAAlgorithm(CryptoHelper crypto, String id, String algorithm, RSAKeyProvider keyProvider)
RSAAlgorithm(String id, String algorithm, RSAKeyProvider keyProvider)

Method Summary

Modifier and Type	Method	Description
String	getSigningKeyId()	Getter for the Id of the Private Key used to sign the tokens.
(package private) static RSAKeyProvider	providerForKeys(RSAPublicKey publicKey, RSAPrivateKey privateKey)
byte[]	sign(byte[] contentBytes)	Sign the given content using this Algorithm instance.
byte[]	sign(byte[] headerBytes, byte[] payloadBytes)	Deprecated.
void	verify(DecodedJWT jwt)	Verify the given token using this Algorithm instance.

Methods inherited from class com.auth0.jwt.algorithms.Algorithm

ECDSA256, ECDSA256, ECDSA256, ECDSA384, ECDSA384, ECDSA384, ECDSA512, ECDSA512, ECDSA512, getDescription, getName, HMAC256, HMAC256, HMAC384, HMAC384, HMAC512, HMAC512, none, RSA256, RSA256, RSA256, RSA384, RSA384, RSA384, RSA512, RSA512, RSA512, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

keyProvider

private final RSAKeyProvider keyProvider

crypto

private final CryptoHelper crypto

Constructor Details

RSAAlgorithm

RSAAlgorithm(CryptoHelper crypto,
 String id,
 String algorithm,
 RSAKeyProvider keyProvider)
      throws IllegalArgumentException

Throws:

IllegalArgumentException

RSAAlgorithm

RSAAlgorithm(String id,
 String algorithm,
 RSAKeyProvider keyProvider)
      throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

verify

public void verify(DecodedJWT jwt)
            throws SignatureVerificationException

Description copied from class: Algorithm

Verify the given token using this Algorithm instance.

Specified by:

verify in class Algorithm

Parameters:

jwt - the already decoded JWT that it's going to be verified.

Throws:

SignatureVerificationException - if the Token's Signature is invalid, meaning that it doesn't match the signatureBytes, or if the Key is invalid.

sign

@Deprecated
public byte[] sign(byte[] headerBytes,
 byte[] payloadBytes)
            throws SignatureGenerationException

Deprecated.

Description copied from class: Algorithm

Sign the given content using this Algorithm instance.

Overrides:

sign in class Algorithm

Parameters:

headerBytes - an array of bytes representing the base64 encoded header content to be verified against the signature.

payloadBytes - an array of bytes representing the base64 encoded payload content to be verified against the signature.

Returns:

the signature in a base64 encoded array of bytes

Throws:

SignatureGenerationException - if the Key is invalid.

sign

public byte[] sign(byte[] contentBytes)
            throws SignatureGenerationException

Description copied from class: Algorithm

Sign the given content using this Algorithm instance.

Specified by:

sign in class Algorithm

Parameters:

contentBytes - an array of bytes representing the base64 encoded content to be verified against the signature.

Returns:

the signature in a base64 encoded array of bytes

Throws:

SignatureGenerationException - if the Key is invalid.

getSigningKeyId

public String getSigningKeyId()

Description copied from class: Algorithm

Getter for the Id of the Private Key used to sign the tokens. This is usually specified as the `kid` claim in the Header.

Overrides:

getSigningKeyId in class Algorithm

Returns:

the Key Id that identifies the Signing Key or null if it's not specified.

providerForKeys

static RSAKeyProvider providerForKeys(RSAPublicKey publicKey,
 RSAPrivateKey privateKey)