Struct ssi_claims::JwsString

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

Owned UTF-8 encoded JWS.

This type is similar to the JwsBuf type. However contrarily to JwsBuf, there is no guarantee that the JWS is URL-safe.

Use JwsBuf if you expect URL-safe JWSs.

Implementations

impl JwsString

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

pub fn from_string(string: String) -> Result<JwsString, InvalidJws>

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

Safety

The input bytes must represent a valid compact JWS where the payload is UTF-8 encoded.

pub fn new_detached( header: Header, b64_signature: &[u8], ) -> Result<JwsString, InvalidJws<Vec<u8>>>

Creates a new detached JWS from a header and base64-encoded signature.

Detached means the payload will not appear in the JWS.

pub fn encode_detached(header: Header, signature: &[u8]) -> JwsString

Creates a new detached JWS from a header and unencoded signature.

Detached means the payload will not appear in the JWS.

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

Encodes the given signature in base64 and returns a compact JWS.

pub fn from_signing_bytes_and_signature( signing_bytes: Vec<u8>, signature: impl IntoIterator<Item = u8>, ) -> Result<JwsString, InvalidJws<Vec<u8>>>

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

Safety

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

pub fn as_compact_jws_str(&self) -> &JwsStr

pub fn into_signing_bytes(self) -> String

pub fn into_string(self) -> String

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

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

Methods from Deref<Target = JwsStr>

pub fn as_str(&self) -> &str

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 Clone for JwsString

fn clone(&self) -> JwsString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwsString

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

Formats the value using the given formatter.

impl Deref for JwsString

type Target = JwsStr

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for JwsString

fn deserialize<D>( deserializer: D, ) -> Result<JwsString, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JwsString

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

Formats the value using the given formatter.

impl FromStr for JwsString

type Err = InvalidJws

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<JwsString, <JwsString as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoDecodedJwt for JwsString

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<'a> PartialEq<&'a str> for JwsString

fn eq(&self, other: &&'a str) -> 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<'a> PartialEq<JwsString> for &'a str

fn eq(&self, other: &JwsString) -> 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 PartialEq<JwsString> for str

fn eq(&self, other: &JwsString) -> 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 PartialEq<String> for JwsString

fn eq(&self, other: &String) -> 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 PartialEq<str> for JwsString

fn eq(&self, other: &str) -> 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 Serialize for JwsString

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToDecodedJwt for JwsString

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 TryFrom<String> for JwsString

type Error = InvalidJws

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<JwsString, <JwsString as TryFrom<String>>::Error>

Performs the conversion.