SstJoseObject
Superclass for both JWS and JWE. Currently, only JWS is supported.
Class Methods
fromCompactString:
No comment
fromJsonObject:
No comment
Instance Methods
asJsonObject
Return a json object form for the receiver.
This is always a JSON object represented by a KeyedCollection subclass.
Answers:
<KeyedCollection>
asJsonString
Answer the compact json serialization.
Answers:
<String>
asJsonString:
Answer the json serialization.
Arguments:
prettyPrint - <Boolean> use pretty printing if true, compact form if false
Answers:
<String>
commonHeader
In case of a single recipient, this contains all header parameters.
In case of multiple recipients, this header is composed of the shared header parameters and the per-recipient header parameters that are common.
Answers:
<SstJoseHeader>
getPayloadUsing:
Returns an EsFuture that resolves to the payload if the content of this object can be decrypted and verified.
Otherwise the future fails with a SstJoseException.
See comment in the method #getPayloadUsing:allowedAlgorithms:
Arguments:
sstJwkStore - <SstJwkStore> which contains the necessary keys for verification/decryption.
Answers:
<EsFuture>
getPayloadUsing:allowedAlgorithms:
Returns an EsFuture that resolves to the payload if the content of this object can be decrypted and verified.
Otherwise the future fails with a SstJoseException.
This method will fail if none of the signatures or recipients use one of the algorithms listed in @allowedAlgorithms for signing the payload or wrapping the key.
When @allowedAlgorithms is nil, all algorithms are allowed except 'none'.
If none of the recipients uses an algorithm supported by this library implementation, the future fails with a SstJoseNoSupportedAlgorithmException.
See SstJwa class variable @AllAlgorithms for the list of supported algorithms in this implementation.
Arguments:
sstJwkStore - <SstJwkStore> which contains the necessary keys for verification/decryption.
allowedAlgorithms - <UndefinedObject | Collection of String> where each string is an algorithm name (as defined in RFC 7518, section-3.1) that is allowed to verify/decrypt the payload.
Answers:
<EsFuture>
sharedProtectedHeader
Header parameters that are integrity protected and shared by all recipients.
Currently unused. Not applicable for Jws.
Answers:
<SstJsonMapObject>
sharedUnprotectedHeader
Header parameters that are not integrity protected and are shared by all recipients.
Currently unused. Not applicable for Jws.
Answers:
<SstJsonMapObject>
unverifiedPayload
Returns the unverified payload (with the protected header parameters from the first signature).
Answers:
<SstJosePayload>
Last modified date: 01/09/2026