Struct Jwt 

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

Available on crate feature vc only.

A JSON Web Token (RFC 7519) in compact serialization, kept as the string it is.

Construction checks that the string is a well-formed compact JWS with a supported alg; nothing is verified. The type serializes as a plain string, which is how a presentation carries its credentials.

Examples

use identity_kit::vc::Jwt;

// RFC 8037 Appendix A.4.
let jwt: Jwt = "eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc.\
    hgyY0il_MGCjP0JzlnLWG1PPOt7-09PGcvMg3AIbQR6dWbhijcNR4ki4iylGjg5BhVsPt9g7sVvpAr_MuM0KAg"
    .parse()?;
assert_eq!(jwt.decode()?.payload(), b"Example of Ed25519 signing");
assert!("not.a.jwt".parse::<Jwt>().is_err());

Implementations

impl Jwt

pub fn new(token: impl Into<String>) -> Result<Self, JwsError>

Wraps token after checking it is a compact JWS this crate can decode.

Errors

The JwsError of CompactJws::decode.

pub async fn sign( header: &JwsHeader, claims: &JwtClaims, signer: &dyn Signer, ) -> Result<Self, JwsError>

Signs claims under header with signer.

The claims are serialized as compact JSON in their field order, additional last.

Errors

JwsError::InvalidPayload when additional holds a registered claim, which would put the member in the payload twice; otherwise as encode_compact.

Panics

Never: a claims set always serializes to JSON.

pub fn as_str(&self) -> &str

The compact serialization.

pub fn into_string(self) -> String

The compact serialization.

pub fn decode(&self) -> Result<CompactJws, JwsError>

The decoded parts, unverified.

Errors

Never, in practice: construction decoded the same string.

Trait Implementations

impl AsRef<str> for Jwt

fn as_ref(&self) -> &str

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

impl Clone for Jwt

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 Jwt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Jwt

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

Deserialize this value from the given Serde deserializer.

impl Display for Jwt

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

Formats the value using the given formatter.

impl Eq for Jwt

impl FromStr for Jwt

type Err = JwsError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Jwt

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Jwt

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Jwt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Jwt

impl TryFrom<String> for Jwt

type Error = JwsError

The type returned in the event of a conversion error.

fn try_from(token: String) -> Result<Self, Self::Error>

Performs the conversion.