io.jsonwebtoken.impl.crypto

Class RsaProvider

java.lang.Object

io.jsonwebtoken.impl.crypto.RsaProvider

Direct Known Subclasses:

RsaSignatureValidator, RsaSigner

public abstract class RsaProvider
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected SignatureAlgorithm	alg
static SecureRandom	DEFAULT_SECURE_RANDOM JJWT's default SecureRandom number generator.
protected Key	key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RsaProvider(SignatureAlgorithm alg, Key key)

Method Summary

Methods

Modifier and Type	Method and Description
protected Signature	createSignatureInstance()
protected void	doSetParameter(Signature sig, PSSParameterSpec spec)
static KeyPair	generateKeyPair() Generates a new RSA secure-random 4096 bit key pair.
static KeyPair	generateKeyPair(int keySizeInBits) Generates a new RSA secure-randomly key pair of the specified size using JJWT's default SecureRandom instance.
static KeyPair	generateKeyPair(int keySizeInBits, SecureRandom random) Generates a new RSA secure-random key pair of the specified size using the given SecureRandom number generator.
static KeyPair	generateKeyPair(SignatureAlgorithm alg) Generates a new RSA secure-randomly key pair suitable for the specified SignatureAlgorithm using JJWT's default SecureRandom instance.
protected static KeyPair	generateKeyPair(String jcaAlgorithmName, int keySizeInBits, SecureRandom random) Generates a new secure-random key pair of the specified size using the specified SecureRandom according to the specified jcaAlgorithmName.
protected Signature	getSignatureInstance()
protected boolean	isBouncyCastleAvailable()
protected void	setParameter(Signature sig, PSSParameterSpec spec)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SECURE_RANDOM

public static final SecureRandom DEFAULT_SECURE_RANDOM

JJWT's default SecureRandom number generator. This RNG is initialized using the JVM default as follows:

 static {
     DEFAULT_SECURE_RANDOM = new SecureRandom();
     DEFAULT_SECURE_RANDOM.nextBytes(new byte[64]);
 }
 

nextBytes is called to force the RNG to initialize itself if not already initialized. The byte array is not used and discarded immediately for garbage collection.

alg

protected final SignatureAlgorithm alg

key

protected final Key key

Constructor Detail

RsaProvider

protected RsaProvider(SignatureAlgorithm alg,
           Key key)

Method Detail

createSignatureInstance

protected Signature createSignatureInstance()

setParameter

protected void setParameter(Signature sig,
                PSSParameterSpec spec)

doSetParameter

protected void doSetParameter(Signature sig,
                  PSSParameterSpec spec)
                       throws InvalidAlgorithmParameterException

Throws:

InvalidAlgorithmParameterException

generateKeyPair

public static KeyPair generateKeyPair()

Generates a new RSA secure-random 4096 bit key pair. 4096 bits is JJWT's current recommended minimum key size for use in modern applications (during or after year 2015). This is a convenience method that immediately delegates to generateKeyPair(int).

Returns:

a new RSA secure-random 4096 bit key pair.

Since:

0.5

See Also:

generateKeyPair(int), generateKeyPair(int, SecureRandom), generateKeyPair(String, int, SecureRandom)

generateKeyPair

public static KeyPair generateKeyPair(int keySizeInBits)

Generates a new RSA secure-randomly key pair of the specified size using JJWT's default SecureRandom instance. This is a convenience method that immediately delegates to generateKeyPair(int, SecureRandom).

Parameters:

keySizeInBits - the key size in bits (NOT bytes).

Returns:

a new RSA secure-random key pair of the specified size.

Since:

0.5

See Also:

generateKeyPair(), generateKeyPair(int, SecureRandom), generateKeyPair(String, int, SecureRandom)

generateKeyPair

public static KeyPair generateKeyPair(SignatureAlgorithm alg)

Generates a new RSA secure-randomly key pair suitable for the specified SignatureAlgorithm using JJWT's default SecureRandom instance. This is a convenience method that immediately delegates to generateKeyPair(int) based on the relevant key size for the specified algorithm.

Parameters:

alg - the signature algorithm to inspect to determine a size in bits.

Returns:

a new RSA secure-random key pair of the specified size.

Since:

0.10.0

See Also:

generateKeyPair(), generateKeyPair(int, SecureRandom), generateKeyPair(String, int, SecureRandom)

generateKeyPair

public static KeyPair generateKeyPair(int keySizeInBits,
                      SecureRandom random)

Generates a new RSA secure-random key pair of the specified size using the given SecureRandom number generator. This is a convenience method that immediately delegates to generateKeyPair(String, int, SecureRandom) using RSA as the jcaAlgorithmName argument.

Parameters:

keySizeInBits - the key size in bits (NOT bytes)

random - the secure random number generator to use during key generation.

Returns:

a new RSA secure-random key pair of the specified size using the given SecureRandom number generator.

Since:

0.5

See Also:

generateKeyPair(), generateKeyPair(int), generateKeyPair(String, int, SecureRandom)

generateKeyPair

protected static KeyPair generateKeyPair(String jcaAlgorithmName,
                      int keySizeInBits,
                      SecureRandom random)

Generates a new secure-random key pair of the specified size using the specified SecureRandom according to the specified jcaAlgorithmName.

Parameters:

jcaAlgorithmName - the name of the JCA algorithm to use for key pair generation, for example, RSA.

keySizeInBits - the key size in bits (NOT bytes)

random - the SecureRandom generator to use during key generation.

Returns:

a new secure-randomly generated key pair of the specified size using the specified SecureRandom according to the specified jcaAlgorithmName.

Since:

0.5

See Also:

generateKeyPair(), generateKeyPair(int), generateKeyPair(int, SecureRandom)

getSignatureInstance

protected Signature getSignatureInstance()
                                  throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

isBouncyCastleAvailable

protected boolean isBouncyCastleAvailable()