Class JwkRSA

java.lang.Object

io.helidon.security.jwt.jwk.Jwk

io.helidon.security.jwt.jwk.JwkRSA

public class JwkRSA
extends Jwk

RSA JSON web key.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JwkRSA.Builder	Builder for JwkRSA.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALG_RS256	RSASSA-PKCS1-v1_5 using SHA-256.
static final String	ALG_RS384	RSASSA-PKCS1-v1_5 using SHA-384.
static final String	ALG_RS512	RSASSA-PKCS1-v1_5 using SHA-512.
static final String	PARAM_EXP	JWK parameter for private key exponent.
static final String	PARAM_FIRST_CRT_COEFF	JWK parameter for private key First CRT Coefficient.
static final String	PARAM_FIRST_FACTOR_CRT_EXP	JWK parameter for private key First Factor CRT Exponent.
static final String	PARAM_FIRST_PRIME_FACTOR	JWK parameter for private key First Prime Factor.
static final String	PARAM_OTHER_PRIMES	JWK parameter for private key Other Primes Info.
static final String	PARAM_PUB_EXP	JWK parameter for public key exponent.
static final String	PARAM_PUB_MODULUS	JWK parameter for public key modulus.
static final String	PARAM_SECOND_FACTOR_CRT_EXP	JWK parameter for private key Second Factor CRT Exponent.
static final String	PARAM_SECOND_PRIME_FACTOR	JWK parameter for private key Second Prime Factor.
static final String	PARAM_X509_CHAIN	JWK parameter for X.509 certificate chain array.
static final String	PARAM_X509_CHAIN_URL	JWK parameter for X.509 certificate chain URL.
static final String	PARAM_X509_SHA_1	JWK parameter for SHA 1 Thumbprint of X.509 certificate.
static final String	PARAM_X509_SHA_256	JWK parameter for SHA 256 Thumbprint of X.509 certificate.
static final String	SECURITY_ALGORITHM	The main Java security algorithm used.

Fields inherited from class Jwk

ALG_NONE, KEY_TYPE_EC, KEY_TYPE_OCT, KEY_TYPE_RSA, NONE_JWK, OPERATION_DECRYPT, OPERATION_DERIVE_BITS, OPERATION_DERIVE_KEY, OPERATION_ENCRYPT, OPERATION_SIGN, OPERATION_UNWRAP_KEY, OPERATION_VERIFY, OPERATION_WRAP_KEY, PARAM_ALGORITHM, PARAM_KEY_ID, PARAM_KEY_TYPE, PARAM_OPERATIONS, PARAM_USE, USE_ENCRYPTION, USE_SIGNATURE

Modifier and Type	Field	Description
static final String	ALG_NONE	Algorithm defining there is no security (e.g.
static final String	KEY_TYPE_EC	Key type of elliptic curve keys.
static final String	KEY_TYPE_OCT	Key type of octet keys.
static final String	KEY_TYPE_RSA	Key type of RSA keys.
static final Jwk	NONE_JWK	A jwk with no fields filled and Jwk.ALG_NONE algorithm.
static final String	OPERATION_DECRYPT	Decrypt content and validate decryption, if applicable.
static final String	OPERATION_DERIVE_BITS	Derive bits not to be used as a key.
static final String	OPERATION_DERIVE_KEY	Derive key.
static final String	OPERATION_ENCRYPT	Encrypt content.
static final String	OPERATION_SIGN	Compute digital signature or MAC.
static final String	OPERATION_UNWRAP_KEY	Decrypt key and validate decryption, if applicable.
static final String	OPERATION_VERIFY	Verify digital signature or MAC.
static final String	OPERATION_WRAP_KEY	Encrypt key.
static final String	PARAM_ALGORITHM	JWK parameter for algorithm.
static final String	PARAM_KEY_ID	JWK parameter for key id.
static final String	PARAM_KEY_TYPE	JWK parameter for key type.
static final String	PARAM_OPERATIONS	JWK parameters for permitted operations.
static final String	PARAM_USE	JWK parameter for usage.
static final String	USE_ENCRYPTION	Key can be used for encryption only.
static final String	USE_SIGNATURE	Key can be used for signatures only.

Method Summary

Modifier and Type	Method	Description
static JwkRSA.Builder	builder()	Create a builder instance.
Optional<List<X509Certificate>>	certificateChain()	X.509 certificate chain.
static JwkRSA	create(JsonObject json)	Create an instance from Json object.
byte[]	doSign(byte[] bytesToSign)
boolean	doVerify(byte[] signedBytes, byte[] signatureToVerify)
Optional<PrivateKey>	privateKey()	Private key if available.
PublicKey	publicKey()	Public key.
Optional<byte[]>	sha1Thumbprint()	X.509 certificate SHA-1 thumbprint.
Optional<byte[]>	sha256Thumbprint()	X.509 certificate SHA-256 thumbprint.

Methods inherited from class Jwk

algorithm, keyId, keyType, operations, sign, toString, usage, verifySignature

Modifier and Type	Method	Description
String	algorithm()	The algorithm used when signing/encrypting this key.
String	keyId()	The key id (kid) of this JWK.
String	keyType()	The key type (kty) of this JWK.
Optional<List<String>>	operations()	Permitted operations of this JWK.
final byte[]	sign(byte[] bytesToSign)	Sign the bytes to sign using this JWK type and algorithm.
String	toString()
Optional<String>	usage()	Permitted usage of this JWK.
final boolean	verifySignature(byte[] signedBytes, byte[] signature)	Verify that the signature is indeed for the signed bytes based on this JWK type and algorithm.

Methods inherited from class Object

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

Field Details

SECURITY_ALGORITHM

public static final String SECURITY_ALGORITHM

The main Java security algorithm used.

See Also:

• Constant Field Values

ALG_RS256

public static final String ALG_RS256

RSASSA-PKCS1-v1_5 using SHA-256. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

ALG_RS384

public static final String ALG_RS384

RSASSA-PKCS1-v1_5 using SHA-384. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

ALG_RS512

public static final String ALG_RS512

RSASSA-PKCS1-v1_5 using SHA-512. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

PARAM_PUB_MODULUS

public static final String PARAM_PUB_MODULUS

JWK parameter for public key modulus. See RFC 7518, section 6.3.1.1.

See Also:

• Constant Field Values

PARAM_PUB_EXP

public static final String PARAM_PUB_EXP

JWK parameter for public key exponent. See RFC 7518, section 6.3.1.2.

See Also:

• Constant Field Values

PARAM_EXP

public static final String PARAM_EXP

JWK parameter for private key exponent. See RFC 7518, section 6.3.2.1.

See Also:

• Constant Field Values

PARAM_FIRST_PRIME_FACTOR

public static final String PARAM_FIRST_PRIME_FACTOR

JWK parameter for private key First Prime Factor. See RFC 7518, section 6.3.2.2.

See Also:

• Constant Field Values

PARAM_SECOND_PRIME_FACTOR

public static final String PARAM_SECOND_PRIME_FACTOR

JWK parameter for private key Second Prime Factor. See RFC 7518, section 6.3.2.3.

See Also:

• Constant Field Values

PARAM_FIRST_FACTOR_CRT_EXP

public static final String PARAM_FIRST_FACTOR_CRT_EXP

JWK parameter for private key First Factor CRT Exponent. See RFC 7518, section 6.3.2.4.

See Also:

• Constant Field Values

PARAM_SECOND_FACTOR_CRT_EXP

public static final String PARAM_SECOND_FACTOR_CRT_EXP

JWK parameter for private key Second Factor CRT Exponent. See RFC 7518, section 6.3.2.5.

See Also:

• Constant Field Values

PARAM_FIRST_CRT_COEFF

public static final String PARAM_FIRST_CRT_COEFF

JWK parameter for private key First CRT Coefficient. See RFC 7518, section 6.3.2.6.

See Also:

• Constant Field Values

PARAM_OTHER_PRIMES

public static final String PARAM_OTHER_PRIMES

JWK parameter for private key Other Primes Info. See RFC 7518, section 6.3.2.7.

See Also:

• Constant Field Values

PARAM_X509_CHAIN_URL

public static final String PARAM_X509_CHAIN_URL

JWK parameter for X.509 certificate chain URL. See RFC 7517, section 4.6.

See Also:

• Constant Field Values

PARAM_X509_CHAIN

public static final String PARAM_X509_CHAIN

JWK parameter for X.509 certificate chain array. See RFC 7517, section 4.7.

See Also:

• Constant Field Values

PARAM_X509_SHA_1

public static final String PARAM_X509_SHA_1

JWK parameter for SHA 1 Thumbprint of X.509 certificate. See RFC 7517, section 4.8.

See Also:

• Constant Field Values

PARAM_X509_SHA_256

public static final String PARAM_X509_SHA_256

JWK parameter for SHA 256 Thumbprint of X.509 certificate. See RFC 7517, section 4.9.

See Also:

• Constant Field Values

Method Details

builder

public static JwkRSA.Builder builder()

Create a builder instance.

Returns:

builder ready to create a new JwkRSA instance.

create

public static JwkRSA create(JsonObject json)

Create an instance from Json object.

Parameters:

json - with definition of this RSA web key

Returns:

new instance of this class constructed from json

See Also:

• for generic method that can load any supported JWK type.

privateKey

public Optional<PrivateKey> privateKey()

Private key if available.

Returns:

private key

publicKey

public PublicKey publicKey()

Public key.

Returns:

public key

certificateChain

public Optional<List<X509Certificate>> certificateChain()

X.509 certificate chain.

Returns:

certificate chain

sha1Thumbprint

public Optional<byte[]> sha1Thumbprint()

X.509 certificate SHA-1 thumbprint.

Returns:

SHA-1 thumbprint bytes

sha256Thumbprint

public Optional<byte[]> sha256Thumbprint()

X.509 certificate SHA-256 thumbprint.

Returns:

SHA-256 thumbprint bytes

doVerify

public boolean doVerify(byte[] signedBytes,
 byte[] signatureToVerify)

doSign

public byte[] doSign(byte[] bytesToSign)