Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.jwk.oct

Interface OCTJWK

All Superinterfaces:

JWK, SymmetricJWK

public interface OCTJWK
extends SymmetricJWK

Octet JSON Web Key.

An octet JWK is symmetric, the secret key id defined by the key value.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_TYPE	Octet sequence key type (used to represent symmetric keys) as defined by RFC7518 Section 6.1.

Fields inherited from interface io.inverno.mod.security.jose.jwk.JWK

DEFAULT_THUMBPRINT_DIGEST, KEY_OP_DECRYPT, KEY_OP_DERIVE_BITS, KEY_OP_DERIVE_KEY, KEY_OP_ENCRYPT, KEY_OP_SIGN, KEY_OP_UNWRAP_KEY, KEY_OP_VERIFY, KEY_OP_WRAP_KEY, USE_ENC, USE_SIG

Method Summary

Modifier and Type	Method	Description
String	getKeyValue()	Returns the key value encoded as Base64URL.
OCTJWK	minify()	Returns a minified representation of the key only containing required data.
OCTJWK	toPublicJWK()	Returns a public and safe to share representation of the key.
OCTJWK	trust()	Trusts the key explicitly.

Methods inherited from interface io.inverno.mod.security.jose.jwk.JWK

cipher, cipher, equals, getAlgorithm, getKeyId, getKeyOperations, getKeyType, getPublicKeyUse, hashCode, isTrusted, keyManager, keyManager, signer, signer, supportsAlgorithm, toJWKThumbprint, toJWKThumbprint

Methods inherited from interface io.inverno.mod.security.jose.jwk.SymmetricJWK

toSecretKey

Field Details

KEY_TYPE

static final String KEY_TYPE

Octet sequence key type (used to represent symmetric keys) as defined by RFC7518 Section 6.1.

See Also:

• Constant Field Values

Method Details

getKeyValue

String getKeyValue()

Returns the key value encoded as Base64URL.

Returns:

the Base64URL encoded key value with no padding.

toPublicJWK

OCTJWK toPublicJWK()

Description copied from interface: JWK

Returns a public and safe to share representation of the key.

Specified by:

toPublicJWK in interface JWK

Specified by:

toPublicJWK in interface SymmetricJWK

Returns:

a public representation of this JWK

minify

OCTJWK minify()

Description copied from interface: JWK

Returns a minified representation of the key only containing required data.

Note that the returned JWK may contain private data.

Specified by:

minify in interface JWK

Returns:

a minified representation of this JWK

trust

OCTJWK trust()

Description copied from interface: JWK

Trusts the key explicitly.

This should be used with care when the authenticity of an untrusted key has been established through external means.

Specified by:

trust in interface JWK

Specified by:

trust in interface SymmetricJWK

Returns:

this JWK