Struct ssi_claims::JwsSlice

pub struct JwsSlice(/* private fields */);

Borrowed JWS without any encoding guaranties.

This is an unsized type borrowing the JWS and meant to be referenced as &JwsSlice, just like &[u8]. Use JwsVec if you need to own the JWS.

This type is similar to the Jws type. However contrarily to Jws, there is no guarantee that the JWS is a valid UTF-8 string (and even less URL-safe).

Use JwsStr if you expect UTF-8 encoded JWSs. Use Jws if you expect URL-safe JWSs.

Implementations

impl JwsSlice

pub fn new<T>(data: &T) -> Result<&JwsSlice, InvalidJws<&T>>

where T: AsRef<[u8]> + ?Sized,

pub unsafe fn new_unchecked(data: &[u8]) -> &JwsSlice

Creates a new compact JWS without checking the data.

Safety

The input data must represent a valid compact JWS.

pub const fn validate(bytes: &[u8]) -> bool

pub const fn validate_range(bytes: &[u8], i: usize, end: usize) -> bool

pub fn check_signing_bytes(bytes: &[u8]) -> bool

pub fn len(&self) -> usize

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

Returns the Base64 encoded header.

pub fn decode_header(&self) -> Result<Header, InvalidHeader>

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

Returns the Base64 encoded payload.

pub fn decode_payload( &self, header: &Header, ) -> Result<Cow<'_, [u8]>, DecodeError>

Decode the payload bytes.

The header is necessary to know how the payload is encoded.

pub fn signature(&self) -> &str

Returns the Base64 encoded signature.

pub fn decode_signature(&self) -> Result<JwsSignature, DecodeError>

pub fn decode(&self) -> Result<DecodedJws<'_, Cow<'_, [u8]>>, DecodeError>

Decodes the entire JWS.

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

Returns the signing bytes.

It is the concatenation of the Base64 encoded headers, a period ‘.’ and the Base64 encoded payload.

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

pub async fn verify<V>( &self, params: V, ) -> Result<Result<(), Invalid>, ProofValidationError>

where V: ResolverProvider, <V as ResolverProvider>::Resolver: JWKResolver,

Verify the JWS signature.

This will only check the signature and not the validity of the decoded payload. For instance if the payload is a set of JWT claims, those claims will not be validated.

To perform a more precise verification, specify use a specialized T instead of the default Vec<u8>

The params argument provides all the verification parameters required to validate the claims and proof.

What verification parameters should I use?

Any type that providing a JWKResolver through the ResolverProvider trait will be fine. Notable implementors are:

• VerificationParameters: A good default providing many other common verification parameters that are not necessary here.
• JWK: allows you to put a JWK as params, which will resolve into itself. Can be useful if you don’t need key resolution because you know in advance what key was used to sign the JWS.

Passing the parameters by reference

If the validation traits are implemented for P, they will be implemented for &P as well. This means the parameters can be passed by move or by reference.

Trait Implementations

impl Debug for JwsSlice

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

Formats the value using the given formatter.

impl Hash for JwsSlice

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

impl Ord for JwsSlice

fn cmp(&self, other: &JwsSlice) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for JwsSlice

fn eq(&self, other: &JwsSlice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JwsSlice

fn partial_cmp(&self, other: &JwsSlice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToDecodedJwt for JwsSlice

fn to_decoded_custom_jwt<C>( &self, ) -> Result<DecodedJws<'_, JWTClaims<C>>, DecodeError>

where C: DeserializeOwned,

Decodes a JWT with custom claims.

fn to_decoded_jwt(&self) -> Result<DecodedJws<'_, JWTClaims>, DecodeError>

Decodes a JWT.

async fn verify_jwt<V>( &self, verifier: &V, ) -> Result<Result<(), Invalid>, ProofValidationError>

where V: ResolverProvider + DateTimeProvider, <V as ResolverProvider>::Resolver: JWKResolver,

Verify the JWS signature.

impl Eq for JwsSlice

impl StructuralPartialEq for JwsSlice