com.nimbusds.jose.jwk

Class ECKey.Builder

java.lang.Object

com.nimbusds.jose.jwk.ECKey.Builder

Enclosing class:

ECKey

public static class ECKey.Builder
extends Object

Builder for constructing Elliptic Curve JWKs.

Example use:

 ECKey key = new ECKey.Builder(Curve.P521, x, y).
             d(d).
             algorithm(JWSAlgorithm.ES512).
             keyID("789").
             build();
 

Constructor Summary

Constructors

Constructor and Description
ECKey.Builder(ECKey.Curve crv, Base64URL x, Base64URL y) Creates a new Elliptic Curve JWK builder.
ECKey.Builder(ECKey.Curve crv, ECPublicKey pub) Creates a new Elliptic Curve JWK builder.

Method Summary

Methods

Modifier and Type	Method and Description
ECKey.Builder	algorithm(Algorithm alg) Sets the intended JOSE algorithm (alg) for the JWK.
ECKey	build() Builds a new octet sequence JWK.
ECKey.Builder	d(Base64URL d) Sets the private 'd' coordinate for the elliptic curve point.
ECKey.Builder	keyID(String kid) Sets the ID (kid) of the JWK.
ECKey.Builder	keyUse(Use use) Sets the use (use) of the JWK.
ECKey.Builder	privateKey(ECPrivateKey priv) Sets the private Elliptic Curve key.
ECKey.Builder	x509CertChain(List<Base64> x5c) Sets the X.509 certificate chain (x5c) of the JWK.
ECKey.Builder	x509CertThumbprint(Base64URL x5t) Sets the X.509 certificate thumbprint (x5t) of the JWK.
ECKey.Builder	x509CertURL(URL x5u) Sets the X.509 certificate URL (x5u) of the JWK.

Methods inherited from class java.lang.Object

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

Constructor Detail

ECKey.Builder

public ECKey.Builder(ECKey.Curve crv,
             Base64URL x,
             Base64URL y)

Creates a new Elliptic Curve JWK builder.

Parameters:

crv - The cryptographic curve. Must not be null.

x - The public 'x' coordinate for the elliptic curve point. It is represented as the Base64URL encoding of the coordinate's big endian representation. Must not be null.

y - The public 'y' coordinate for the elliptic curve point. It is represented as the Base64URL encoding of the coordinate's big endian representation. Must not be null.

ECKey.Builder

public ECKey.Builder(ECKey.Curve crv,
             ECPublicKey pub)

Creates a new Elliptic Curve JWK builder.

Parameters:

crv - The cryptographic curve. Must not be null.

pub - The public EC key to represent. Must not be null.

Method Detail

d

public ECKey.Builder d(Base64URL d)

Sets the private 'd' coordinate for the elliptic curve point. The alternative method is privateKey(java.security.interfaces.ECPrivateKey).

Parameters:

d - The 'd' coordinate. It is represented as the Base64URL encoding of the coordinate's big endian representation. null if not specified (for a public key).

Returns:

This builder.

privateKey

public ECKey.Builder privateKey(ECPrivateKey priv)

Sets the private Elliptic Curve key. The alternative method is d.

Parameters:

priv - The private EC key, used to obtain the private 'd' coordinate for the elliptic curve point. null if not specified (for a public key).

Returns:

This builder.

keyUse

public ECKey.Builder keyUse(Use use)

Sets the use (use) of the JWK.

Parameters:

use - The key use, null if not specified or if the key is intended for signing as well as encryption.

Returns:

This builder.

algorithm

public ECKey.Builder algorithm(Algorithm alg)

Sets the intended JOSE algorithm (alg) for the JWK.

Parameters:

alg - The intended JOSE algorithm, null if not specified.

Returns:

This builder.

keyID

public ECKey.Builder keyID(String kid)

Sets the ID (kid) of the JWK. The key ID can be used to match a specific key. This can be used, for instance, to choose a key within a JWKSet during key rollover. The key ID may also correspond to a JWS/JWE kid header parameter value.

Parameters:

kid - The key ID, null if not specified.

Returns:

This builder.

x509CertURL

public ECKey.Builder x509CertURL(URL x5u)

Sets the X.509 certificate URL (x5u) of the JWK.

Parameters:

x5u - The X.509 certificate URL, null if not specified.

Returns:

This builder.

x509CertThumbprint

public ECKey.Builder x509CertThumbprint(Base64URL x5t)

Sets the X.509 certificate thumbprint (x5t) of the JWK.

Parameters:

x5t - The X.509 certificate thumbprint, null if not specified.

Returns:

This builder.

x509CertChain

public ECKey.Builder x509CertChain(List<Base64> x5c)

Sets the X.509 certificate chain (x5c) of the JWK.

Parameters:

x5c - The X.509 certificate chain as a unmodifiable list, null if not specified.

Returns:

This builder.

build

public ECKey build()

Builds a new octet sequence JWK.

Returns:

The octet sequence JWK.