Struct ssi_claims::JwsVec

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

Owned JWS without any encoding guaranties.

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

Use JwsString if you expect UTF-8 encoded JWSs. Use JwsBuf if you expect URL-safe JWSs.

Implementations

impl JwsVec

pub fn new(bytes: Vec<u8>) -> Result<JwsVec, InvalidJws<Vec<u8>>>

pub unsafe fn new_unchecked(bytes: Vec<u8>) -> JwsVec

Safety

The input bytes must represent a valid compact JWS.

pub fn from_signing_bytes_and_signature( signing_bytes: Vec<u8>, signature: &[u8], ) -> Result<JwsVec, InvalidJws<Vec<u8>>>

pub fn new_detached(header: Header, signature: &[u8]) -> JwsVec

Creates a new detached JWS.

Detached means the payload will not appear in the JWS.

pub unsafe fn from_signing_bytes_and_signature_unchecked( signing_bytes: Vec<u8>, signature: Vec<u8>, ) -> JwsVec

Safety

The input signing_bytes and signature must form a valid compact JWS once concatenated with a ..

pub fn as_compact_jws(&self) -> &JwsSlice

pub fn into_signing_bytes(self) -> Vec<u8>

pub fn into_bytes(self) -> Vec<u8>

pub fn into_decoded(self) -> Result<DecodedJws<'static>, DecodeError>

Decodes the entire JWS while preserving the signing bytes so they can be verified.

pub fn into_url_safe(self) -> Result<JwsBuf, JwsVec>

pub fn into_jws_string(self) -> Result<JwsString, JwsVec>

Methods from Deref<Target = JwsSlice>

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 Deref for JwsVec

type Target = JwsSlice

The resulting type after dereferencing.

fn deref(&self) -> &<JwsVec as Deref>::Target

Dereferences the value.

impl IntoDecodedJwt for JwsVec

fn into_decoded_custom_jwt<C>( self, ) -> Result<DecodedJws<'static, JWTClaims<C>>, DecodeError>

where C: DeserializeOwned,

Decodes a JWT with custom claims.

fn into_decoded_jwt(self) -> Result<DecodedJws<'static, JWTClaims>, DecodeError>

impl ToDecodedJwt for JwsVec

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.