com.nimbusds.jose.crypto

Class ECDSASigner

java.lang.Object

com.nimbusds.jose.crypto.ECDSASigner

All Implemented Interfaces:

JCAAware<JCAContext>, JOSEProvider, JWSProvider, JWSSigner

@ThreadSafe
public class ECDSASigner
extends Object
implements JWSSigner

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

Supports the following algorithms:

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

Version:

2015-06-07

Author:

Axel Nennker, Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static Set<JWSAlgorithm>	SUPPORTED_ALGORITHMS The supported JWS algorithms by the EC-DSA provider class.

Constructor Summary

Constructors

Constructor and Description
ECDSASigner(ECKey ecJWK) Creates a new Elliptic Curve Digital Signature Algorithm (ECDSA) signer.
ECDSASigner(ECPrivateKey privateKey) Creates a new Elliptic Curve Digital Signature Algorithm (ECDSA) signer.

Method Summary

Methods

Modifier and Type	Method and Description
JCAContext	getJCAContext() Returns the Java Cryptography Architecture (JCA) context.
ECPrivateKey	getPrivateKey() Returns the private EC key.
Base64URL	sign(JWSHeader header, byte[] signingInput) Signs the specified input of a JWS object.
Set<JWSAlgorithm>	supportedJWSAlgorithms() Returns the names of the supported algorithms by the JWS provider instance.

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

supportedJWSAlgorithms

Field Detail

SUPPORTED_ALGORITHMS

public static final Set<JWSAlgorithm> SUPPORTED_ALGORITHMS

The supported JWS algorithms by the EC-DSA provider class.

Constructor Detail

ECDSASigner

public ECDSASigner(ECPrivateKey privateKey)
            throws JOSEException

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

Parameters:

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

Throws:

JOSEException - If the elliptic curve of key is not supported.

ECDSASigner

public ECDSASigner(ECKey ecJWK)
            throws JOSEException

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

Parameters:

ecJWK - The EC JSON Web Key (JWK). Must contain a private part. Must not be null.

Throws:

JOSEException - If the EC JWK doesn't contain a private part, its extraction failed, or the elliptic curve is not supported.

Method Detail

getPrivateKey

public ECPrivateKey getPrivateKey()

Returns the private EC key.

Returns:

The private EC 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, if a critical header parameter is not supported or marked for deferral to the application, or if signing failed for some other internal reason.

supportedJWSAlgorithms

public Set<JWSAlgorithm> supportedJWSAlgorithms()

Description copied from interface: JWSProvider

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

Specified by:

supportedJWSAlgorithms in interface JWSProvider

Returns:

The supported JWS algorithms, empty set if none.

getJCAContext

public JCAContext getJCAContext()

Description copied from interface: JCAAware

Returns the Java Cryptography Architecture (JCA) context. May be used to set a specific JCA security provider or secure random generator.

Specified by:

getJCAContext in interface JCAAware<JCAContext>

Returns:

The JCA context. Not null.