Package com.nimbusds.jose.jwk.gen

Class OctetKeyPairGenerator

java.lang.Object

com.nimbusds.jose.jwk.gen.JWKGenerator<OctetKeyPair>

com.nimbusds.jose.jwk.gen.OctetKeyPairGenerator

public class OctetKeyPairGenerator
extends JWKGenerator<OctetKeyPair>

Octet Key Pair (OKP) JSON Web Key (JWK) generator.

Supported curves:

• X25519
• Ed25519

Version:

2023-01-02

Author:

Tim McLean

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<Curve>	SUPPORTED_CURVES	The supported values for the "crv" property.

Fields inherited from class com.nimbusds.jose.jwk.gen.JWKGenerator

alg, exp, iat, keyStore, kid, nbf, ops, provider, secureRandom, use, x5tKid

Constructor Summary

Constructors

Constructor	Description
OctetKeyPairGenerator(Curve crv)	Creates a new OctetKeyPair JWK generator.

Method Summary

Modifier and Type	Method	Description
OctetKeyPair	generate()	Generates the JWK according to the set parameters.

Methods inherited from class com.nimbusds.jose.jwk.gen.JWKGenerator

algorithm, expirationTime, issueTime, keyID, keyIDFromThumbprint, keyOperations, keyStore, keyUse, notBeforeTime, provider, secureRandom

Methods inherited from class java.lang.Object

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

Field Details

SUPPORTED_CURVES

public static final Set<Curve> SUPPORTED_CURVES

The supported values for the "crv" property.

Constructor Details

OctetKeyPairGenerator

public OctetKeyPairGenerator(Curve crv)

Creates a new OctetKeyPair JWK generator.

Parameters:

crv - The curve. Must not be null.

Method Details

generate

public OctetKeyPair generate()
                      throws JOSEException

Description copied from class: JWKGenerator

Generates the JWK according to the set parameters.

Specified by:

generate in class JWKGenerator<OctetKeyPair>

Returns:

The generated JWK.

Throws:

JOSEException - If the key generation failed.