io.jsonwebtoken.security

Class Jwks.OP

java.lang.Object

io.jsonwebtoken.security.Jwks.OP

Enclosing class:

Jwks

public static final class Jwks.OP
extends Object

Constants for all standard JWK key_ops (Key Operations) parameter values defined in the JSON Web Key Operations Registry. Each standard key operation is available as a (public static final) constant for direct type-safe reference in application code. For example:

 Jwks.builder()
     .operations(Jwks.OP.SIGN)
     // ... etc ...
     .build();

They are also available together as a Registry instance via the get() method.

Since:

0.12.0

See Also:

get()

Field Summary

Fields

Modifier and Type	Field and Description
static KeyOperation	DECRYPT decrypt operation indicating a key is intended to be used to decrypt content.
static KeyOperation	DERIVE_BITS deriveBits operation indicating a key is intended to be used to derive bits that are not to be used as key.
static KeyOperation	DERIVE_KEY deriveKey operation indicating a key is intended to be used to derive another key.
static KeyOperation	ENCRYPT encrypt operation indicating a key is intended to be used to encrypt content.
static KeyOperation	SIGN sign operation indicating a key is intended to be used to compute digital signatures or MACs.
static KeyOperation	UNWRAP_KEY unwrapKey operation indicating a key is intended to be used to decrypt another key and validate decryption, if applicable.
static KeyOperation	VERIFY verify operation indicating a key is intended to be used to verify digital signatures or MACs.
static KeyOperation	WRAP_KEY wrapKey operation indicating a key is intended to be used to encrypt another key.

Method Summary

Methods

Modifier and Type	Method and Description
static KeyOperationBuilder	builder() Creates a new KeyOperationBuilder for creating custom KeyOperation instances.
static Registry<String,KeyOperation>	get() Returns a registry of all standard Key Operations in the JSON Web Key Operations Registry defined by RFC 7517, Section 8.3.
static KeyOperationPolicyBuilder	policy() Creates a new KeyOperationPolicyBuilder for creating custom KeyOperationPolicy instances.

Methods inherited from class java.lang.Object

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

Field Detail

SIGN

public static final KeyOperation SIGN

sign operation indicating a key is intended to be used to compute digital signatures or MACs. It's related operation is VERIFY.

See Also:

VERIFY, Key Operation Registry Contents

VERIFY

public static final KeyOperation VERIFY

verify operation indicating a key is intended to be used to verify digital signatures or MACs. It's related operation is SIGN.

See Also:

SIGN, Key Operation Registry Contents

ENCRYPT

public static final KeyOperation ENCRYPT

encrypt operation indicating a key is intended to be used to encrypt content. It's related operation is DECRYPT.

See Also:

DECRYPT, Key Operation Registry Contents

DECRYPT

public static final KeyOperation DECRYPT

decrypt operation indicating a key is intended to be used to decrypt content. It's related operation is ENCRYPT.

See Also:

ENCRYPT, Key Operation Registry Contents

WRAP_KEY

public static final KeyOperation WRAP_KEY

wrapKey operation indicating a key is intended to be used to encrypt another key. It's related operation is UNWRAP_KEY.

See Also:

UNWRAP_KEY, Key Operation Registry Contents

UNWRAP_KEY

public static final KeyOperation UNWRAP_KEY

unwrapKey operation indicating a key is intended to be used to decrypt another key and validate decryption, if applicable. It's related operation is WRAP_KEY.

See Also:

WRAP_KEY, Key Operation Registry Contents

DERIVE_KEY

public static final KeyOperation DERIVE_KEY

deriveKey operation indicating a key is intended to be used to derive another key. It does not have a related operation.

See Also:

Key Operation Registry Contents

DERIVE_BITS

public static final KeyOperation DERIVE_BITS

deriveBits operation indicating a key is intended to be used to derive bits that are not to be used as key. It does not have a related operation.

See Also:

Key Operation Registry Contents

Method Detail

builder

public static KeyOperationBuilder builder()

Creates a new KeyOperationBuilder for creating custom KeyOperation instances.

Returns:

a new KeyOperationBuilder for creating custom KeyOperation instances.

policy

public static KeyOperationPolicyBuilder policy()

Creates a new KeyOperationPolicyBuilder for creating custom KeyOperationPolicy instances.

Returns:

a new KeyOperationPolicyBuilder for creating custom KeyOperationPolicy instances.

get

public static Registry<String,KeyOperation> get()

Returns a registry of all standard Key Operations in the JSON Web Key Operations Registry defined by RFC 7517, Section 8.3.

Returns:

a registry of all standard Key Operations in the JSON Web Key Operations Registry.