Expand description
JSON Web Signatures (JWS)
The encoding and decoding APIs are strongly informed by the requirements of the higher level functionality
offered by the IOTA Identity library. Hence these APIs may possibly not be immediately recognizable from a standard
JWT/JWS perspective. See identity_jose/examples/jws_encoding_decoding.rs
for a complete example of how to encode
and then decode a JWS.
Structs§
- Compact
JwsEncoder - A JWS encoder supporting the Compact JWS serialization format.
- Decoded
Jws - A cryptographically verified decoded token from a JWS.
- Decoder
- The
Decoder
is responsible for decoding a JWS into one or moreJwsValidationItems
. - Flattened
JwsEncoder - An encoder supporting the Flattened JWS JSON Serialiazion format.
- General
JwsEncoder - An encoder for the General JWS JSON Serialization format.
- JwsHeader
- JSON Web Signature JOSE Header.
- JwsValidation
Item - A partially decoded JWS containing claims, and the decoded verification data
for its corresponding signature (headers, signing input and signature). This data
can be cryptographically verified using a
JwsVerifier
. SeeSelf::verify
. - JwsValidation
Iter - An iterator over the
JwsValidationItems
corresponding to the signatures in a JWS encoded with the general JWS JSON serialization format. - JwsVerifier
Fn - Simple wrapper around a closure capable of verifying a JWS signature. This wrapper implements
JwsVerifier
. - Recipient
- The recipient of a JWS.
- Verification
Input - Input a
JwsVerifier
verifies.
Enums§
- CharSet
- The requirements towards the character set when encoding a JWS.
- Compact
JwsEncoding Options - Options determining whether the payload is detached and if not which additional requirements the payload must satisfy.
- JwsAlgorithm
- Supported algorithms for the JSON Web Signatures
alg
claim. - JwsFormat
- The serialization format used for the JWS.
- Signature
Verification Error Kind - The cause of a failed jws signature verification.
Traits§
- JwsVerifier
- Trait for cryptographically verifying a JWS signature.
Type Aliases§
- Recipient
Processing Encoder - A General JWS Encoder that is currently processing the latest
Recipient
. - Signature
Verification Error - Error type for a failed jws signature verification. See
JwsVerifier
.