com.nimbusds.jose.crypto

Class RSASSASigner

java.lang.Object

com.nimbusds.jose.crypto.RSASSASigner

All Implemented Interfaces:

AlgorithmProvider, JWSAlgorithmProvider, JWSSigner

@ThreadSafe
public class RSASSASigner
extends java.lang.Object
implements JWSSigner

RSA Signature-Scheme-with-Appendix (RSASSA) signer of JWS objects. This class is thread-safe.

Supports the following JSON Web Algorithms (JWAs):

• JWSAlgorithm.RS256
• JWSAlgorithm.RS384
• JWSAlgorithm.RS512
• JWSAlgorithm.PS256
• JWSAlgorithm.PS384
• JWSAlgorithm.PS512

Version:

$version$ (2013-05-04)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
protected java.security.Provider	provider The underlying cryptographic provider, null if not specified (implies default one).
static java.util.Set<JWSAlgorithm>	SUPPORTED_ALGORITHMS The supported JWS algorithms.

Constructor Summary

Constructors

Constructor and Description
RSASSASigner(java.security.interfaces.RSAPrivateKey privateKey) Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) signer.

Method Summary

Methods

Modifier and Type	Method and Description
java.security.interfaces.RSAPrivateKey	getPrivateKey() Gets the private RSA key.
protected static java.security.Signature	getRSASignerAndVerifier(JWSAlgorithm alg, java.security.Provider provider) Gets a signer and verifier for the specified RSASSA-based JSON Web Algorithm (JWA).
void	setProvider(java.security.Provider provider) Sets a specific JCA provider, to be used for all operations.
Base64URL	sign(JWSHeader header, byte[] signingInput) Signs the specified input of a JWS object.
java.util.Set<JWSAlgorithm>	supportedAlgorithms() Returns the names of the supported JWS algorithms.

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.JWSAlgorithmProvider

supportedAlgorithms

Methods inherited from interface com.nimbusds.jose.AlgorithmProvider

setProvider

Field Detail

SUPPORTED_ALGORITHMS

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

The supported JWS algorithms.

provider

protected java.security.Provider provider

The underlying cryptographic provider, null if not specified (implies default one).

Constructor Detail

RSASSASigner

public RSASSASigner(java.security.interfaces.RSAPrivateKey privateKey)

Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) signer.

Parameters:

privateKey - The private RSA key. Must not be null.

Method Detail

getPrivateKey

public java.security.interfaces.RSAPrivateKey getPrivateKey()

Gets the private RSA key.

Returns:

The private RSA key.

sign

public Base64URL sign(JWSHeader header,
             byte[] signingInput)
               throws JOSEException

Description copied from interface: JWSSigner

Signs the specified input of a JWS object.

Specified by:

sign in interface JWSSigner

Parameters:

header - The JSON Web Signature (JWS) header. Must specify a supported JWS algorithm and must not be null.

signingInput - The input to sign. Must not be null.

Returns:

The resulting signature part (third part) of the JWS object.

Throws:

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

getRSASignerAndVerifier

protected static java.security.Signature getRSASignerAndVerifier(JWSAlgorithm alg,
                                              java.security.Provider provider)
                                                          throws JOSEException

Gets a signer and verifier for the specified RSASSA-based JSON Web Algorithm (JWA).

Parameters:

alg - The JSON Web Algorithm (JWA). Must be supported and not null.

Returns:

A signer and verifier instance.

Throws:

JOSEException - If the algorithm is not supported.

supportedAlgorithms

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

Description copied from interface: JWSAlgorithmProvider

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

Specified by:

supportedAlgorithms in interface JWSAlgorithmProvider

Returns:

The supported JWS algorithms, empty set if none.

setProvider

public void setProvider(java.security.Provider provider)

Description copied from interface: AlgorithmProvider

Sets a specific JCA provider, to be used for all operations.

Specified by:

setProvider in interface AlgorithmProvider

Parameters:

provider - The JCA provider, or null to use the default one.