io.jsonwebtoken.security

Interface PrivateJwk<K extends PrivateKey,L extends PublicKey,M extends PublicJwk<L>>

Type Parameters:

K - The type of PrivateKey represented by this JWK

L - The type of PublicKey represented by the JWK's corresponding public JWK.

M - The type of PublicJwk reflected by the JWK's public properties.

All Superinterfaces:

AsymmetricJwk<K>, Identifiable, Jwk<K>, Map<String,Object>, X509Accessor

All Known Subinterfaces:

EcPrivateJwk, OctetPrivateJwk<K,L>, RsaPrivateJwk

public interface PrivateJwk<K extends PrivateKey,L extends PublicKey,M extends PublicJwk<L>>
extends AsymmetricJwk<K>

JWK representation of a PrivateKey.

JWK Private Key vs Java PrivateKey differences

Unlike the Java cryptography APIs, the JWK specification requires all public key and private key properties to be contained within every private JWK. As such, a PrivateJwk indeed represents private key values as its name implies, but it is probably more similar to the Java JCA concept of a KeyPair since it contains everything for both keys.

Consequently a PrivateJwk is capable of providing two additional convenience methods:

• toPublicJwk() - a method to obtain a PublicJwk instance that contains only the JWK public key properties, and
• toKeyPair() - a method to obtain both Java PublicKey and PrivateKeys in aggregate as a KeyPair instance if desired.

Since:

0.12.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
KeyPair<L,K>	toKeyPair() Returns the key's corresponding Java PrivateKey and PublicKey in aggregate as a type-safe KeyPair instance.
M	toPublicJwk() Returns the private JWK's corresponding PublicJwk, containing only the key's public properties.

Methods inherited from interface io.jsonwebtoken.security.AsymmetricJwk

getPublicKeyUse

Methods inherited from interface io.jsonwebtoken.security.Jwk

getAlgorithm, getOperations, getType, thumbprint, thumbprint, toKey

Methods inherited from interface io.jsonwebtoken.Identifiable

getId

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface io.jsonwebtoken.security.X509Accessor

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url

Method Detail

toPublicJwk

M toPublicJwk()

Returns the private JWK's corresponding PublicJwk, containing only the key's public properties.

Returns:

the private JWK's corresponding PublicJwk, containing only the key's public properties.

toKeyPair

KeyPair<L,K> toKeyPair()

Returns the key's corresponding Java PrivateKey and PublicKey in aggregate as a type-safe KeyPair instance.

Returns:

the key's corresponding Java PrivateKey and PublicKey in aggregate as a type-safe KeyPair instance.