Class JwkOctet

java.lang.Object

io.helidon.security.jwt.jwk.Jwk

io.helidon.security.jwt.jwk.JwkOctet

public class JwkOctet
extends Jwk

Symmetric cipher JSON web key.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALG_HS256	HMAC using SHA-256.
static final String	ALG_HS384	HMAC using SHA-384.
static final String	ALG_HS512	HMAC using SHA-512.
static final String	PARAM_OCTET_KEY	Key value.

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 JwkOctet.Builder	builder()	Create a builder instance.
static JwkOctet	create(JsonObject json)	Create an instance from Json object.
byte[]	doSign(byte[] bytesToSign)
boolean	doVerify(byte[] signedBytes, byte[] signature)
byte[]	getKeyBytes()	Get the bytes of the secret key.

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

ALG_HS256

public static final String ALG_HS256

HMAC using SHA-256. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

ALG_HS384

public static final String ALG_HS384

HMAC using SHA-384. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

ALG_HS512

public static final String ALG_HS512

HMAC using SHA-512. See RFC 7518, section 7.1.2.

See Also:

• Constant Field Values

PARAM_OCTET_KEY

public static final String PARAM_OCTET_KEY

Key value. The "k" (key value) parameter contains the value of the symmetric (or other single-valued) key. It is represented as the base64url encoding of the octet sequence containing the key value. See RFC 7518, section 6.4.1.

See Also:

• Constant Field Values

Method Details

builder

public static JwkOctet.Builder builder()

Create a builder instance.

Returns:

builder ready to create a new JwkOctet instance.

create

public static JwkOctet create(JsonObject json)

Create an instance from Json object. Note that the "k" must be base64 encoded.

Parameters:

json - with definition of this octet web key

Returns:

new instance of this class constructed from json

See Also:

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

getKeyBytes

public byte[] getKeyBytes()

Get the bytes of the secret key.

Returns:

byte array of the secret key

doVerify

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

doSign

public byte[] doSign(byte[] bytesToSign)