Class JWS
java.lang.Object
org.jose4j.jwx.JsonWebStructure
org.jose4j.jws.JsonWebSignature
eu.europa.esig.dss.jades.validation.JWS
- All Implemented Interfaces:
Serializable
Extension of a JSON web Signature according to RFC 7515
- See Also:
-
Field Summary
Fields inherited from class org.jose4j.jws.JsonWebSignature
COMPACT_SERIALIZATION_PARTS
Fields inherited from class org.jose4j.jwx.JsonWebStructure
base64url, doKeyValidation, headers, rawCompactSerialization
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Gets theJWSJsonSerializationObject
List
<?> Returns a protected header value with thekey
Map
<?, ?> Returns a protected header value with thekey
Returns a protected header value with thekey
byte[]
Returns SignatureValue bytesReturns payload string based on a 'b64' value in the protected header (The actual signed payload value)Gets unprotected header mapboolean
Checks if the signature's payload is 'b64' unencoded (see RFC 7797)void
setJwsJsonSerializationObject
(JWSJsonSerializationObject jwsJsonSerializationObject) Sets theJWSJsonSerializationObject
void
setKnownCriticalHeaders
(Collection<String> knownCriticalHeaders) Sets values of the 'crit' header that must be known and proceededvoid
setPayloadOctets
(byte[] payload) Sets payload binaries depending on the 'b64' header's valuevoid
setProtected
(String protectedBase64Url) Sets the protected headervoid
setSignature
(byte[] signature) void
setUnprotected
(Map<String, Object> unprotected) Sets the unprotected headerMethods inherited from class org.jose4j.jws.JsonWebSignature
getAlgorithm, getAlgorithmNoConstraintCheck, getCompactSerialization, getDetachedContentCompactSerialization, getEncodedPayload, getEncodedSignature, getKeyPersuasion, getKeyType, getPayload, getPayloadBytes, getPayloadCharEncoding, getSignature, getUnverifiedPayload, getUnverifiedPayloadBytes, isSupportedCriticalHeader, onNewKey, prepareSigningPrimitive, setCompactSerializationParts, setEncodedPayload, setPayload, setPayloadBytes, setPayloadCharEncoding, sign, verifySignature
Methods inherited from class org.jose4j.jwx.JsonWebStructure
checkNotEmptyPart, fromCompactSerialization, getAlgorithmConstraints, getAlgorithmHeaderValue, getCertificateChainHeaderValue, getContentTypeHeaderValue, getHeader, getHeader, getHeaders, getIntegrity, getJwkHeader, getKey, getKeyIdHeaderValue, getLeafCertificateHeaderValue, getObjectHeader, getProviderCtx, getX509CertSha1ThumbprintHeaderValue, getX509CertSha256ThumbprintHeaderValue, isDoKeyValidation, setAlgorithmConstraints, setAlgorithmHeaderValue, setCertificateChainHeaderValue, setCompactSerialization, setContentTypeHeaderValue, setCriticalHeaderNames, setDoKeyValidation, setEncodedHeader, setHeader, setHeader, setIntegrity, setJwkHeader, setKey, setKeyIdHeaderValue, setKnownCriticalHeaders, setProviderContext, setX509CertSha1ThumbprintHeaderValue, setX509CertSha1ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, toString
-
Constructor Details
-
JWS
public JWS()The default constructor creating an empty JsonWebSignature -
JWS
The constructor to instantiate a JWSCompactSerialization objects (RFC 7515)- Parameters:
parts
- an array of String with the header, optional payload and the signature
-
-
Method Details
-
getEncodedHeader
- Overrides:
getEncodedHeader
in classorg.jose4j.jwx.JsonWebStructure
-
setPayloadOctets
public void setPayloadOctets(byte[] payload) Sets payload binaries depending on the 'b64' header's value- Parameters:
payload
- a byte array representing a payload (unencoded or encoded)
-
getSignedPayload
Returns payload string based on a 'b64' value in the protected header (The actual signed payload value)- Returns:
String
payload to be signed
-
isRfc7797UnencodedPayload
public boolean isRfc7797UnencodedPayload()Checks if the signature's payload is 'b64' unencoded (see RFC 7797)- Overrides:
isRfc7797UnencodedPayload
in classorg.jose4j.jws.JsonWebSignature
- Returns:
- TRUE if 'b64' is present and set to false, FALSE otherwise
-
getSignatureValue
public byte[] getSignatureValue()Returns SignatureValue bytes- Returns:
- byte array representing a signature value
-
setSignature
public void setSignature(byte[] signature) - Overrides:
setSignature
in classorg.jose4j.jws.JsonWebSignature
-
setProtected
Sets the protected header- Parameters:
protectedBase64Url
-String
base64url encoded protected header- Throws:
org.jose4j.lang.JoseException
- if a format exception occurs
-
getUnprotected
Gets unprotected header map- Returns:
- unprotected header map
-
setUnprotected
Sets the unprotected header- Parameters:
unprotected
- the unprotected header map
-
getJwsJsonSerializationObject
Gets theJWSJsonSerializationObject
- Returns:
JWSJsonSerializationObject
-
setJwsJsonSerializationObject
Sets theJWSJsonSerializationObject
- Parameters:
jwsJsonSerializationObject
-JWSJsonSerializationObject
-
setKnownCriticalHeaders
Sets values of the 'crit' header that must be known and proceeded- Parameters:
knownCriticalHeaders
- a collection of supportedString
headers
-
checkCrit
protected void checkCrit() throws org.jose4j.lang.JoseException- Overrides:
checkCrit
in classorg.jose4j.jwx.JsonWebStructure
- Throws:
org.jose4j.lang.JoseException
-
getProtectedHeaderValueAsString
Returns a protected header value with thekey
-
getProtectedHeaderValueAsMap
Returns a protected header value with thekey
-
getProtectedHeaderValueAsList
Returns a protected header value with thekey
-