com.nimbusds.jose.crypto

Class ECDSASigner

java.lang.Object

com.nimbusds.jose.crypto.ECDSASigner

All Implemented Interfaces:

AlgorithmProvider, JWSAlgorithmProvider, JWSSigner

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

Elliptic Curve Digital Signature Algorithm (ECDSA) signer of JWS objects. This class is thread-safe.

Supports the following JSON Web Algorithms (JWAs):

• JWSAlgorithm.ES256
• JWSAlgorithm.ES384
• JWSAlgorithm.ES512

Version:

$version$ (2014-07-08)

Author:

Axel Nennker, 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
ECDSASigner(java.math.BigInteger privateKey) Creates a new Elliptic Curve Digital Signature Algorithm (ECDSA) signer.

Method Summary

Methods

Modifier and Type	Method and Description
protected static com.nimbusds.jose.crypto.ECDSAParameters	getECDSAParameters(JWSAlgorithm alg) Gets the initial parameters for the specified ECDSA-based JSON Web Algorithm (JWA).
java.math.BigInteger	getPrivateKey() Gets the private key ('d' parameter).
protected static int	getSignatureByteArrayLength(JWSAlgorithm alg) Gets the expected signature byte array length (R + S parts) for the specified ECDSA algorithm.
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

ECDSASigner

public ECDSASigner(java.math.BigInteger privateKey)

Creates a new Elliptic Curve Digital Signature Algorithm (ECDSA) signer.

Parameters:

privateKey - The private key ('d' parameter). Must not be null.

Method Detail

getPrivateKey

public java.math.BigInteger getPrivateKey()

Gets the private key ('d' parameter).

Returns:

The private 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.

getSignatureByteArrayLength

protected static int getSignatureByteArrayLength(JWSAlgorithm alg)
                                          throws JOSEException

Gets the expected signature byte array length (R + S parts) for the specified ECDSA algorithm.

Parameters:

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

Returns:

The expected byte array length for the signature.

Throws:

JOSEException - If the algorithm is not supported.

getECDSAParameters

protected static com.nimbusds.jose.crypto.ECDSAParameters getECDSAParameters(JWSAlgorithm alg)
                                                                      throws JOSEException

Gets the initial parameters for the specified ECDSA-based JSON Web Algorithm (JWA).

Parameters:

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

Returns:

The initial ECDSA parameters.

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.