com.nimbusds.jose.crypto

Class RSAEncrypter

java.lang.Object

com.nimbusds.jose.crypto.RSAEncrypter

All Implemented Interfaces:

JWEAlgorithmProvider, JWEEncrypter

public class RSAEncrypter
extends java.lang.Object
implements JWEEncrypter

RSA encrypter of JWE objects. This class is thread-safe.

Supports the following JWE algorithms:

• JWEAlgorithm.RSA1_5
• JWEAlgorithm.RSA_OAEP

Supports the following encryption methods:

• EncryptionMethod.A128CBC_HS256
• EncryptionMethod.A256CBC_HS512
• EncryptionMethod.A128GCM
• EncryptionMethod.A256GCM

Version:

$version$ (2013-03-26)

Author:

David Ortiz, Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<JWEAlgorithm>	SUPPORTED_ALGORITHMS The supported JWE algorithms.
static java.util.Set<EncryptionMethod>	SUPPORTED_ENCRYPTION_METHODS The supported encryption methods.

Constructor Summary

Constructors

Constructor and Description
RSAEncrypter(java.security.interfaces.RSAPublicKey publicKey) Creates a new RSA encrypter.

Method Summary

Methods

Modifier and Type	Method and Description
protected static int	cekBitLength(EncryptionMethod method) Gets the Content Encryption Key (CEK) length for the specified encryption method.
protected static int	cikBitLength(EncryptionMethod method) Gets the Content Integrity Key (CIK) length for the specified encryption method.
protected static int	cmkBitLength(EncryptionMethod method) Gets the Content Master Key (CMK) length for the specified encryption method.
JWECryptoParts	encrypt(ReadOnlyJWEHeader readOnlyJWEHeader, byte[] bytes) Encrypts the specified clear text of a JWE object.
java.security.interfaces.RSAPublicKey	getPublicKey() Gets the public RSA key.
java.util.Set<JWEAlgorithm>	supportedAlgorithms() Returns the names of the supported JWE algorithms.
java.util.Set<EncryptionMethod>	supportedEncryptionMethods() Returns the names of the supported encryption methods.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.jose.JWEAlgorithmProvider

supportedAlgorithms, supportedEncryptionMethods

Field Detail

SUPPORTED_ALGORITHMS

public static final java.util.Set<JWEAlgorithm> SUPPORTED_ALGORITHMS

The supported JWE algorithms.

SUPPORTED_ENCRYPTION_METHODS

public static final java.util.Set<EncryptionMethod> SUPPORTED_ENCRYPTION_METHODS

The supported encryption methods.

Constructor Detail

RSAEncrypter

public RSAEncrypter(java.security.interfaces.RSAPublicKey publicKey)
             throws JOSEException

Creates a new RSA encrypter.

Parameters:

publicKey - The public RSA key. Must not be null.

Throws:

JOSEException - If the underlying secure random generator couldn't be instantiated.

Method Detail

getPublicKey

public java.security.interfaces.RSAPublicKey getPublicKey()

Gets the public RSA key.

Returns:

The public RSA key.

encrypt

public JWECryptoParts encrypt(ReadOnlyJWEHeader readOnlyJWEHeader,
                     byte[] bytes)
                       throws JOSEException

Description copied from interface: JWEEncrypter

Encrypts the specified clear text of a JWE object.

Specified by:

encrypt in interface JWEEncrypter

Parameters:

readOnlyJWEHeader - The JSON Web Encryption (JWE) header. Must specify a supported JWE algorithm and must not be null.

bytes - The clear text to encrypt. Must not be null.

Returns:

The resulting JWE crypto parts.

Throws:

JOSEException - If the JWE algorithm is not supported or if encryption failed for some other reason.

cmkBitLength

protected static int cmkBitLength(EncryptionMethod method)
                           throws JOSEException

Gets the Content Master Key (CMK) length for the specified encryption method.

Parameters:

method - The encryption method. Must be supported by this RSA provider. Must not be null.

Returns:

The CMK length, in bits.

Throws:

JOSEException - If the encryption method is not supported.

cekBitLength

protected static int cekBitLength(EncryptionMethod method)
                           throws JOSEException

Gets the Content Encryption Key (CEK) length for the specified encryption method.

Parameters:

method - The encryption method. Must be supported by this RSA provider and must employ CEKs. Must not be null.

Returns:

The CEK length, in bits.

Throws:

JOSEException - If the encryption method is not supported or doesn't employ CEKs.

cikBitLength

protected static int cikBitLength(EncryptionMethod method)
                           throws JOSEException

Gets the Content Integrity Key (CIK) length for the specified encryption method.

Parameters:

method - The encryption method. Must be supported by this RSA provider and must employ CIKs. Must not be null.

Returns:

The CIK length, in bits.

Throws:

JOSEException - If the encryption method is not supported or doesn't employ CIKs.

supportedAlgorithms

public java.util.Set<JWEAlgorithm> supportedAlgorithms()

Description copied from interface: JWEAlgorithmProvider

Returns the names of the supported JWE algorithms. These correspond to the alg JWE header parameter.

Specified by:

supportedAlgorithms in interface JWEAlgorithmProvider

Returns:

The supported JWE algorithms, empty set if none.

supportedEncryptionMethods

public java.util.Set<EncryptionMethod> supportedEncryptionMethods()

Description copied from interface: JWEAlgorithmProvider

Returns the names of the supported encryption methods. These correspond to the enc JWE header parameter.

Specified by:

supportedEncryptionMethods in interface JWEAlgorithmProvider

Returns:

The supported encryption methods, empty set if none.