Top Fields Constructors Methods
org.keycloak.crypto

public Class KeyWrapper

extends Object
Class Inheritance
Imports
java.util.HashMap, .List, .ArrayList, .Map, javax.crypto.SecretKey, java.security.Key, java.security.cert.X509Certificate

Field Summary

Modifier and TypeField and Description
private String
algorithm

private X509Certificate
certificate

private List<X509Certificate>
certificateChain

private String
curve

private static final Map<String, String>
DEFAULT_ALGORITHM_BY_TYPE

A repository for the default algorithms by key type.

private boolean
isDefaultClientCertificate

private String
kid

private Key
privateKey

private String
providerId

private long
providerPriority

private Key
publicKey

private SecretKey
secretKey

private KeyStatus
status

private String
type

private KeyUse
use

Constructor Summary

AccessConstructor and Description
public
KeyWrapper()

Method Summary

Modifier and TypeMethod and Description
public KeyWrapper
cloneKey()

public String

Returns:

the algorithm value
getAlgorithm()

Returns the value of the optional alg claim.

public String

Returns:

the algorithm set or a default based on the key type.
getAlgorithmOrDefault()

Returns the value of the optional alg claim.

public X509Certificate
getCertificate()

public List<X509Certificate>
getCertificateChain()

public String
getCurve()

public String
getKid()

public Key
getPrivateKey()

public String
getProviderId()

public long
getProviderPriority()

public Key
getPublicKey()

public SecretKey
getSecretKey()

public KeyStatus
getStatus()

public String
getType()

public KeyUse
getUse()

public boolean
isDefaultClientCertificate()

public void
setAlgorithm(String algorithm)

public void
setCertificate(X509Certificate certificate)

public void
setCertificateChain(List<X509Certificate> certificateChain)

public void
setCurve(String curve)

public void
setIsDefaultClientCertificate(boolean isDefaultClientCertificate)

public void
setKid(String kid)

public void
setPrivateKey(Key privateKey)

public void
setProviderId(String providerId)

public void
setProviderPriority(long providerPriority)

public void
setPublicKey(Key publicKey)

public void
setSecretKey(SecretKey secretKey)

public void
setStatus(KeyStatus status)

public void
setType(String type)

public void
setUse(KeyUse use)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmback to summary
private String algorithm
certificateback to summary
private X509Certificate certificate
certificateChainback to summary
private List<X509Certificate> certificateChain
curveback to summary
private String curve
DEFAULT_ALGORITHM_BY_TYPEback to summary
private static final Map<String, String> DEFAULT_ALGORITHM_BY_TYPE

A repository for the default algorithms by key type.

isDefaultClientCertificateback to summary
private boolean isDefaultClientCertificate
kidback to summary
private String kid
privateKeyback to summary
private Key privateKey
providerIdback to summary
private String providerId
providerPriorityback to summary
private long providerPriority
publicKeyback to summary
private Key publicKey
secretKeyback to summary
private SecretKey secretKey
statusback to summary
private KeyStatus status
typeback to summary
private String type
useback to summary
private KeyUse use

Constructor Detail

KeyWrapperback to summary
public KeyWrapper()

Method Detail

cloneKeyback to summary
public KeyWrapper cloneKey()
getAlgorithmback to summary
public String getAlgorithm()

Returns the value of the optional alg claim.

Returns:String

the algorithm value

getAlgorithmOrDefaultback to summary
public String getAlgorithmOrDefault()

Returns the value of the optional alg claim. If not defined, a default is returned depending on the key type as per kty claim.

For keys of type KeyType#RSA, the default algorithm is Algorithm#RS256 as this is the default algorithm recommended by OIDC specs.

Returns:String

the algorithm set or a default based on the key type.

getCertificateback to summary
public X509Certificate getCertificate()
getCertificateChainback to summary
public List<X509Certificate> getCertificateChain()
getCurveback to summary
public String getCurve()
getKidback to summary
public String getKid()
getPrivateKeyback to summary
public Key getPrivateKey()
getProviderIdback to summary
public String getProviderId()
getProviderPriorityback to summary
public long getProviderPriority()
getPublicKeyback to summary
public Key getPublicKey()
getSecretKeyback to summary
public SecretKey getSecretKey()
getStatusback to summary
public KeyStatus getStatus()
getTypeback to summary
public String getType()
getUseback to summary
public KeyUse getUse()
isDefaultClientCertificateback to summary
public boolean isDefaultClientCertificate()
setAlgorithmback to summary
public void setAlgorithm(String algorithm)
setCertificateback to summary
public void setCertificate(X509Certificate certificate)
setCertificateChainback to summary
public void setCertificateChain(List<X509Certificate> certificateChain)
setCurveback to summary
public void setCurve(String curve)
setIsDefaultClientCertificateback to summary
public void setIsDefaultClientCertificate(boolean isDefaultClientCertificate)
setKidback to summary
public void setKid(String kid)
setPrivateKeyback to summary
public void setPrivateKey(Key privateKey)
setProviderIdback to summary
public void setProviderId(String providerId)
setProviderPriorityback to summary
public void setProviderPriority(long providerPriority)
setPublicKeyback to summary
public void setPublicKey(Key publicKey)
setSecretKeyback to summary
public void setSecretKey(SecretKey secretKey)
setStatusback to summary
public void setStatus(KeyStatus status)
setTypeback to summary
public void setType(String type)
setUseback to summary
public void setUse(KeyUse use)