Struct ssi_claims::Jws

source ·

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

Expand description

Borrowed URL-safe JWS.

This is an unsized type borrowing the JWS and meant to be referenced as &Jws, just like &str. Use JwsBuf if you need to own the JWS.

Contrarily to JwsSlice or JwsStr, this type guarantees that the payload is URL-safe, even if it is unencoded.

Use JwsStr if you expect an UTF-8 encoded JWS but don’t know if it is URL-safe. Use JwsSlice if you don’t have any expectations about the encoding.

Implementations§

source §

impl Jws

source

pub fn new<T>(data: &T) -> Result<&Jws, InvalidJws<&T>>
where T: AsRef<[u8]> + ?Sized,

source

pub const fn from_str_const(input: &str) -> Result<&Jws, InvalidJws<&str>>

Parses the given input string as an URL-safe JWS.

Returns an error if it is not a valid URL-safe JWS.

source

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

source

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

source

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

Creates a new compact JWS without checking the data.

§Safety

The input data must represent a valid compact JWS where the payload is an UTF-8 string.

source

pub fn as_str(&self) -> &str

Methods from Deref<Target = JwsSlice>§

source

pub fn len(&self) -> usize

Returns the Base64 encoded header.

source

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

source

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

Returns the Base64 encoded payload.

source

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.

source

pub fn signature(&self) -> &str

Returns the Base64 encoded signature.

source

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

source

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

Decodes the entire JWS.

source

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.

source

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

source

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.