Struct CompactJws 

pub struct CompactJws { /* private fields */ }

A decoded compact JWS: BASE64URL(header) || '.' || BASE64URL(payload) || '.' || BASE64URL(signature).

Decoding parses the header and the parts and nothing more: CompactJws::verify (or any JwsVerifier) checks the signature once the caller has resolved the key, which usually means dereferencing kid through a DID resolver.

Examples

use identity_kit::jose::{CompactJws, JwsAlgorithm};

// RFC 8037 Appendix A.4.
let token = "eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc.\
             hgyY0il_MGCjP0JzlnLWG1PPOt7-09PGcvMg3AIbQR6dWbhijcNR4ki4iylGjg5BhVsPt9g7sVvpAr_MuM0KAg";
let jws = CompactJws::decode(token)?;
assert_eq!(jws.alg(), JwsAlgorithm::EdDSA);
assert_eq!(jws.kid(), None);
assert_eq!(jws.payload(), b"Example of Ed25519 signing");
assert_eq!(
    jws.signing_input(),
    b"eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc"
);
assert_eq!(jws.signature().len(), 64);

Implementations

impl CompactJws

pub fn decode(token: &str) -> Result<Self, JwsError>

Parses a compact JWS without verifying it.

Errors

A JwsError when the input is not three base64url parts, the header is not a JSON object with a supported alg, or the header has crit or b64: false.

pub fn header(&self) -> &JwsHeader

The protected header.

pub fn alg(&self) -> JwsAlgorithm

The header alg.

pub fn kid(&self) -> Option<&str>

The header kid, if any.

pub fn signing_input(&self) -> &[u8]

The JWS signing input: BASE64URL(header) || '.' || BASE64URL(payload) as ASCII.

pub fn payload(&self) -> &[u8]

The decoded payload.

pub fn signature(&self) -> &[u8]

The decoded signature.

pub fn claims<T: DeserializeOwned>(&self) -> Result<T, JwsError>

The payload read as JSON into T, a JwtClaims set say, unverified: nothing about the signature or the claims is checked.

Errors

JwsError::InvalidPayload when the payload is not JSON of the shape T expects.

Examples

use identity_kit::jose::{CompactJws, JwtClaims};

// RFC 7515 Appendix A.3: the RFC 7519 §3.1 claims set, signed with ES256.
let jws = CompactJws::decode(
    "eyJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGF\
     tcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4GawxaepmXFCgfTjDx\
     w5djxLa8ISlSApmWQxfKTUJqPP3-Kg6NU1Q",
)?;
let claims: JwtClaims = jws.claims()?;
assert_eq!(claims.iss.as_deref(), Some("joe"));
assert_eq!(claims.exp, Some(1300819380));
assert_eq!(claims.additional["http://example.com/is_root"], true);

pub fn as_str(&self) -> &str

The compact serialization as it was decoded.

pub fn verify<V: JwsVerifier + ?Sized>( &self, verifier: &V, key: &Jwk, ) -> Result<(), VerificationError>

Verifies the signature with verifier under key and the header alg.

Errors

Whatever the verifier reports; see JwsVerifier::verify.

Trait Implementations

impl AsRef<str> for CompactJws

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CompactJws

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompactJws

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CompactJws

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.