io.jsonwebtoken.security

Interface KeyOperationBuilder

All Superinterfaces:

Builder<KeyOperation>

public interface KeyOperationBuilder
extends Builder<KeyOperation>

A KeyOperationBuilder produces KeyOperation instances that may be added to a JWK's key operations parameter. This is primarily only useful for creating custom (non-standard) KeyOperations for use with a custom KeyOperationPolicy, as all standard ones are available already via the Jwks.OP registry singleton.

Since:

0.12.0

See Also:

Jwks.OP.builder(), Jwks.OP.policy(), KeyOperationPolicied.operationPolicy(KeyOperationPolicy)

Method Summary

Methods

Modifier and Type	Method and Description
KeyOperationBuilder	description(String description) Sets the key operation description.
KeyOperationBuilder	id(String id) Sets the CaSe-SeNsItIvE id expected to be unique compared to all other KeyOperations.
KeyOperationBuilder	related(String id) Indicates that the KeyOperation with the given id is cryptographically related (and complementary) to this one, and may be specified together in a JWK's operations set.

Methods inherited from interface io.jsonwebtoken.lang.Builder

build

Method Detail

id

KeyOperationBuilder id(String id)

Sets the CaSe-SeNsItIvE id expected to be unique compared to all other KeyOperations.

Parameters:

id - the key operation id

Returns:

the builder for method chaining

description

KeyOperationBuilder description(String description)

Sets the key operation description.

Parameters:

description - the key operation description

Returns:

the builder for method chaining

related

KeyOperationBuilder related(String id)

Indicates that the KeyOperation with the given id is cryptographically related (and complementary) to this one, and may be specified together in a JWK's operations set.

More concretely, calling this method will ensure the following:

     KeyOperation built = Jwks.operation()/*...*/.related(otherId).build();
     KeyOperation other = getKeyOperation(otherId);
     assert built.isRelated(other);

A JwkBuilder's key operation policy is likely to reject any unrelated operations specified together due to the potential security vulnerabilities that could occur.

This method may be called multiple times to add/append a related id to the constructed KeyOperation's total set of related ids.

Parameters:

id - the id of a KeyOperation that will be considered cryptographically related to this one.

Returns:

the builder for method chaining.

See Also:

KeyOperationPolicied.operationPolicy(KeyOperationPolicy)