io.jsonwebtoken.security

Interface AsymmetricJwkBuilder<K extends Key,J extends AsymmetricJwk<K>,T extends AsymmetricJwkBuilder<K,J,T>>

Type Parameters:

K - the type of Java key provided by the JWK.

J - the type of asymmetric JWK created

T - the type of the builder, for subtype method chaining

All Superinterfaces:

Builder<J>, JwkBuilder<K,J,T>, KeyOperationPolicied<T>, MapMutator<String,Object,T>, SecurityBuilder<J,T>, X509Builder<T>, X509Mutator<T>

All Known Subinterfaces:

EcPrivateJwkBuilder, EcPublicJwkBuilder, OctetPrivateJwkBuilder<K,L>, OctetPublicJwkBuilder<A,B>, PrivateJwkBuilder<K,L,J,M,T>, PublicJwkBuilder<K,L,J,M,P,T>, RsaPrivateJwkBuilder, RsaPublicJwkBuilder

public interface AsymmetricJwkBuilder<K extends Key,J extends AsymmetricJwk<K>,T extends AsymmetricJwkBuilder<K,J,T>>
extends JwkBuilder<K,J,T>, X509Builder<T>

A JwkBuilder that builds asymmetric (public or private) JWKs.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	publicKeyUse(String use) Sets the JWK use (Public Key Use) parameter value.

Methods inherited from interface io.jsonwebtoken.security.JwkBuilder

algorithm, id, idFromThumbprint, idFromThumbprint, operations

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Methods inherited from interface io.jsonwebtoken.security.SecurityBuilder

provider, random

Methods inherited from interface io.jsonwebtoken.lang.Builder

build

Methods inherited from interface io.jsonwebtoken.security.KeyOperationPolicied

operationPolicy

Methods inherited from interface io.jsonwebtoken.security.X509Builder

x509Sha1Thumbprint, x509Sha256Thumbprint

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Method Detail

publicKeyUse

T publicKeyUse(String use)
                                                   throws IllegalArgumentException

Sets the JWK use (Public Key Use) parameter value. use values are CaSe-SeNsItIvE. A null value will remove the property from the JWK.

The JWK specification defines the following use values:

JWK Key Use Values

Value	Key Use
sig	signature
enc	encryption

Other values MAY be used. For best interoperability with other applications however, it is recommended to use only the values above.

When a key is used to wrap another key and a public key use designation for the first key is desired, the enc (encryption) key use value is used, since key wrapping is a kind of encryption. The enc value is also to be used for public keys used for key agreement operations.

Public Key Use vs Key Operations

Per JWK RFC 7517, Section 4.3, last paragraph, the use (Public Key Use) and key_ops (Key Operations) members SHOULD NOT be used together; however, if both are used, the information they convey MUST be consistent. Applications should specify which of these members they use, if either is to be used by the application.

Parameters:

use - the JWK use value.

Returns:

the builder for method chaining.

Throws:

IllegalArgumentException - if the use value is null or empty.