Package org.jose4j.jwk

Class PublicJsonWebKey

java.lang.Object

org.jose4j.jwk.JsonWebKey

org.jose4j.jwk.PublicJsonWebKey

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EllipticCurveJsonWebKey, OctetKeyPairJsonWebKey, RsaJsonWebKey

public abstract class PublicJsonWebKey
extends JsonWebKey

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicJsonWebKey.Factory

Nested classes/interfaces inherited from class org.jose4j.jwk.JsonWebKey

JsonWebKey.OutputControlLevel

Field Summary

Fields

Modifier and Type	Field	Description
private List<X509Certificate>	certificateChain
protected String	jcaProvider
protected PrivateKey	privateKey
protected boolean	writeOutPrivateKeyToJson
static final String	X509_CERTIFICATE_CHAIN_PARAMETER
static final String	X509_SHA256_THUMBPRINT_PARAMETER
static final String	X509_THUMBPRINT_PARAMETER
static final String	X509_URL_PARAMETER
private String	x5t
private String	x5tS256
private String	x5u

Fields inherited from class org.jose4j.jwk.JsonWebKey

ALGORITHM_PARAMETER, key, KEY_ID_PARAMETER, KEY_OPERATIONS, KEY_TYPE_PARAMETER, otherParameters, USE_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PublicJsonWebKey(PublicKey publicKey)
protected	PublicJsonWebKey(Map<String,Object> params)
protected	PublicJsonWebKey(Map<String,Object> params, String jcaProvider)

Method Summary

Modifier and Type	Method	Description
(package private) void	checkForBareKeyCertMismatch()
protected abstract void	fillPrivateTypeSpecificParams(Map<String,Object> params)
protected abstract void	fillPublicTypeSpecificParams(Map<String,Object> params)
protected void	fillTypeSpecificParams(Map<String,Object> params, JsonWebKey.OutputControlLevel outputLevel)
(package private) BigInteger	getBigIntFromBase64UrlEncodedParam(Map<String,Object> params, String parameterName, boolean required)
List<X509Certificate>	getCertificateChain()
X509Certificate	getLeafCertificate()
PrivateKey	getPrivateKey()
PublicKey	getPublicKey()
String	getX509CertificateSha1Thumbprint()
String	getX509CertificateSha1Thumbprint(boolean allowFallbackDeriveFromX5c)
String	getX509CertificateSha256Thumbprint()
String	getX509CertificateSha256Thumbprint(boolean allowFallbackDeriveFromX5c)
String	getX509Url()
(package private) void	putBigIntAsBase64UrlEncodedParam(Map<String,Object> params, String parameterName, BigInteger value)
(package private) void	putBigIntAsBase64UrlEncodedParam(Map<String,Object> params, String parameterName, BigInteger value, int minLength)
void	setCertificateChain(X509Certificate... certificates)
void	setCertificateChain(List<X509Certificate> certificateChain)
void	setPrivateKey(PrivateKey privateKey)
void	setWriteOutPrivateKeyToJson(boolean writeOutPrivateKeyToJson)	Deprecated. as of 0.3.2 use JsonWebKey.toJson(org.jose4j.jwk.JsonWebKey.OutputControlLevel)
void	setX509CertificateSha1Thumbprint(String x5t)
void	setX509CertificateSha256Thumbprint(String x5tS2)
void	setX509Url(String x5u)

Methods inherited from class org.jose4j.jwk.JsonWebKey

calculateBase64urlEncodedThumbprint, calculateThumbprint, calculateThumbprintUri, getAlgorithm, getKey, getKeyId, getKeyOps, getKeyType, getOtherParameterValue, getString, getString, getStringRequired, getUse, produceThumbprintHashInput, putIfNotNull, removeFromOtherParams, setAlgorithm, setKeyId, setKeyOps, setOtherParameter, setUse, toJson, toJson, toParams, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

X509_CERTIFICATE_CHAIN_PARAMETER

public static final String X509_CERTIFICATE_CHAIN_PARAMETER

See Also:

• Constant Field Values

X509_THUMBPRINT_PARAMETER

public static final String X509_THUMBPRINT_PARAMETER

See Also:

• Constant Field Values

X509_SHA256_THUMBPRINT_PARAMETER

public static final String X509_SHA256_THUMBPRINT_PARAMETER

See Also:

• Constant Field Values

X509_URL_PARAMETER

public static final String X509_URL_PARAMETER

See Also:

• Constant Field Values

writeOutPrivateKeyToJson

protected boolean writeOutPrivateKeyToJson

privateKey

protected PrivateKey privateKey

jcaProvider

protected String jcaProvider

certificateChain

private List<X509Certificate> certificateChain

x5t

private String x5t

x5tS256

private String x5tS256

x5u

private String x5u

Constructor Details

PublicJsonWebKey

protected PublicJsonWebKey(PublicKey publicKey)

PublicJsonWebKey

protected PublicJsonWebKey(Map<String,Object> params)
                    throws JoseException

Throws:

JoseException

PublicJsonWebKey

protected PublicJsonWebKey(Map<String,Object> params,
 String jcaProvider)
                    throws JoseException

Throws:

JoseException

Method Details

fillPublicTypeSpecificParams

protected abstract void fillPublicTypeSpecificParams(Map<String,Object> params)

fillPrivateTypeSpecificParams

protected abstract void fillPrivateTypeSpecificParams(Map<String,Object> params)

fillTypeSpecificParams

protected void fillTypeSpecificParams(Map<String,Object> params,
 JsonWebKey.OutputControlLevel outputLevel)

Specified by:

fillTypeSpecificParams in class JsonWebKey

getPublicKey

public PublicKey getPublicKey()

Overrides:

getPublicKey in class JsonWebKey

Returns:

PublicKey

setWriteOutPrivateKeyToJson

public void setWriteOutPrivateKeyToJson(boolean writeOutPrivateKeyToJson)

Deprecated.

as of 0.3.2 use JsonWebKey.toJson(org.jose4j.jwk.JsonWebKey.OutputControlLevel)

Parameters:

writeOutPrivateKeyToJson - don't use this

getPrivateKey

public PrivateKey getPrivateKey()

setPrivateKey

public void setPrivateKey(PrivateKey privateKey)

getCertificateChain

public List<X509Certificate> getCertificateChain()

getLeafCertificate

public X509Certificate getLeafCertificate()

getX509CertificateSha1Thumbprint

public String getX509CertificateSha1Thumbprint()

getX509CertificateSha1Thumbprint

public String getX509CertificateSha1Thumbprint(boolean allowFallbackDeriveFromX5c)

getX509CertificateSha256Thumbprint

public String getX509CertificateSha256Thumbprint()

getX509CertificateSha256Thumbprint

public String getX509CertificateSha256Thumbprint(boolean allowFallbackDeriveFromX5c)

getX509Url

public String getX509Url()

setCertificateChain

public void setCertificateChain(List<X509Certificate> certificateChain)

setX509CertificateSha1Thumbprint

public void setX509CertificateSha1Thumbprint(String x5t)

setX509CertificateSha256Thumbprint

public void setX509CertificateSha256Thumbprint(String x5tS2)

setX509Url

public void setX509Url(String x5u)

checkForBareKeyCertMismatch

void checkForBareKeyCertMismatch()

setCertificateChain

public void setCertificateChain(X509Certificate... certificates)

getBigIntFromBase64UrlEncodedParam

BigInteger getBigIntFromBase64UrlEncodedParam(Map<String,Object> params,
 String parameterName,
 boolean required)
                                       throws JoseException

Throws:

JoseException

putBigIntAsBase64UrlEncodedParam

void putBigIntAsBase64UrlEncodedParam(Map<String,Object> params,
 String parameterName,
 BigInteger value)

putBigIntAsBase64UrlEncodedParam

void putBigIntAsBase64UrlEncodedParam(Map<String,Object> params,
 String parameterName,
 BigInteger value,
 int minLength)