io.jsonwebtoken.security

Interface KeyOperationPolicied<T extends KeyOperationPolicied<T>>

Type Parameters:

T - the implementing instance for method chaining

All Known Subinterfaces:

AsymmetricJwkBuilder<K,J,T>, DynamicJwkBuilder<K,J>, EcPrivateJwkBuilder, EcPublicJwkBuilder, JwkBuilder<K,J,T>, JwkParserBuilder, JwkSetBuilder, JwkSetParserBuilder, OctetPrivateJwkBuilder<K,L>, OctetPublicJwkBuilder<A,B>, PrivateJwkBuilder<K,L,J,M,T>, PublicJwkBuilder<K,L,J,M,P,T>, RsaPrivateJwkBuilder, RsaPublicJwkBuilder, SecretJwkBuilder

public interface KeyOperationPolicied<T extends KeyOperationPolicied<T>>

A marker interface that indicates the implementing instance supports the ability to configure a KeyOperationPolicy used to validate JWK instances.

Method Summary

Methods

Modifier and Type	Method and Description
T	operationPolicy(KeyOperationPolicy policy) Sets the key operation policy that determines which KeyOperations may be assigned to a JWK.

Method Detail

operationPolicy

T operationPolicy(KeyOperationPolicy policy)
                                                  throws IllegalArgumentException

Sets the key operation policy that determines which KeyOperations may be assigned to a JWK. Unless overridden by this method, the default RFC-recommended policy is used where:

• All RFC-standard key operations are supported.
• Multiple unrelated operations may not be assigned to the JWK per the RFC 7517, Section 4.3 recommendation:

   Multiple unrelated key operations SHOULD NOT be specified for a key
   because of the potential vulnerabilities associated with using the
   same key with multiple algorithms.  Thus, the combinations "sign"
   with "verify", "encrypt" with "decrypt", and "wrapKey" with
   "unwrapKey" are permitted, but other combinations SHOULD NOT be used.

If you wish to enable a different policy, perhaps to support additional custom KeyOperation values, one can be created by using the Jwks.OP.policy() builder, or by implementing the KeyOperationPolicy interface directly.

Parameters:

policy - the policy that determines which KeyOperations may be assigned to a JWK.

Returns:

the builder for method chaining.

Throws:

IllegalArgumentException - if policy is null