Struct Jwk

pub struct Jwk {
    pub kid: Option<String>,
    pub pk_use: Option<PKUse>,
    pub key_ops: Option<Vec<KeyOps>>,
    pub alg: Option<Algorithm>,
    pub x5u: Option<String>,
    pub x5c: Option<Vec<String>>,
    pub x5t: Option<String>,
    pub key_params: JwkAlgorithmParameters,
}

JWK parameters defined at https://datatracker.ietf.org/doc/html/rfc7517#section-4

Fields

kid: Option<String>

ID of the key

pk_use: Option<PKUse>

The intended use of the public key

key_ops: Option<Vec<KeyOps>>

The “key_ops” (key operations) parameter identifies the operation(s) for which the key is intended to be used The “use” and “key_ops” JWK members SHOULD NOT be used together; however, if both are used, the information they convey MUST be consistent. Applications should specify which of these members they use, if either is to be used by the application.

alg: Option<Algorithm>

The algorithm intended to be used

x5u: Option<String>

X.509 Public key cerfificate URL.

x5c: Option<Vec<String>>

X.509 public key certificate chain.

x5t: Option<String>

X.509 Certificate thumbprint.

key_params: JwkAlgorithmParameters

Implementations

impl Jwk

pub fn generate(key_type: KeyPairSubtype) -> Result<Self, CustomError>

Examples found in repository

examples/jpt.rs (line 46)

fn main() {
    let custom_claims = serde_json::json!({
        "degree": {
            "type": "BachelorDegree",
            "name": "Bachelor of Science and Arts",
            "ciao": [
                {"u1": "value1"},
                {"u2": "value2"}
                ]
            },
        "name": "John Doe"
    });

    let mut jpt_claims = JptClaims::new();
    jpt_claims.set_iss("https://issuer.example".to_owned());
    jpt_claims.set_claim(Some("vc"), custom_claims, true);

    let issued_header = IssuerProtectedHeader::new(ProofAlgorithm::BBS);

    let bbs_jwk = Jwk::generate(KeyPairSubtype::BLS12381G2Sha256).unwrap();
    println!(
        "\nBBS Jwk:\n {:#}",
        serde_json::to_string_pretty(&bbs_jwk).unwrap()
    );

    let issued_jwp = JwpIssuedBuilder::new(issued_header, jpt_claims)
        .build(&bbs_jwk)
        .unwrap();

    let compact_issued_jwp = issued_jwp.encode(SerializationType::COMPACT).unwrap();
    println!("\nCompact Issued JWP: {}", compact_issued_jwp);

    let decoded_issued_jwp =
        JwpIssuedDecoder::decode(&compact_issued_jwp, SerializationType::COMPACT)
            .unwrap()
            .verify(&bbs_jwk.to_public().unwrap())
            .unwrap();

    assert_eq!(issued_jwp, decoded_issued_jwp);

    let mut presentation_header = PresentationProtectedHeader::new(
        decoded_issued_jwp
            .get_issuer_protected_header()
            .alg()
            .into(),
    );
    presentation_header.set_aud(Some("https://recipient.example.com".to_owned()));
    presentation_header.set_nonce(Some("wrmBRkKtXjQ".to_owned()));

    let presented_jwp = JwpPresentedBuilder::new(&decoded_issued_jwp)
        .set_presentation_protected_header(presentation_header)
        .set_undisclosed("vc.degree.name")
        .unwrap()
        .set_undisclosed("vc.degree.ciao[0].u1")
        .unwrap()
        .set_undisclosed("vc.name")
        .unwrap()
        .build(&bbs_jwk.to_public().unwrap())
        .unwrap();

    let compact_presented_jwp = presented_jwp.encode(SerializationType::COMPACT).unwrap();

    println!("\nCompact Presented JWP: {}", compact_presented_jwp);

    let _decoded_presented_jwp =
        JwpPresentedDecoder::decode(&compact_presented_jwp, SerializationType::COMPACT)
            .unwrap()
            .verify(&bbs_jwk.to_public().unwrap())
            .unwrap();
}

pub fn set_kid(&mut self, kid: &str)

pub fn set_pk_use(&mut self, pk_use: PKUse)

pub fn set_key_ops(&mut self, key_ops: Vec<KeyOps>)

pub fn set_alg(&mut self, alg: Algorithm)

pub fn set_x5u(&mut self, x5u: &str)

pub fn set_x5c(&mut self, x5c: Vec<&str>)

pub fn set_x5t(&mut self, x5t: &str)

pub fn is_public(&self) -> bool

Returns true if all private key components of the key are unset, false otherwise.

pub fn is_private(&self) -> bool

Returns true if all private key components of the key are set, false otherwise.

pub fn from_key_params(key_params: JwkAlgorithmParameters) -> Self

pub fn to_public(&self) -> Option<Jwk>

Examples found in repository

examples/jpt.rs (line 62)

fn main() {
    let custom_claims = serde_json::json!({
        "degree": {
            "type": "BachelorDegree",
            "name": "Bachelor of Science and Arts",
            "ciao": [
                {"u1": "value1"},
                {"u2": "value2"}
                ]
            },
        "name": "John Doe"
    });

    let mut jpt_claims = JptClaims::new();
    jpt_claims.set_iss("https://issuer.example".to_owned());
    jpt_claims.set_claim(Some("vc"), custom_claims, true);

    let issued_header = IssuerProtectedHeader::new(ProofAlgorithm::BBS);

    let bbs_jwk = Jwk::generate(KeyPairSubtype::BLS12381G2Sha256).unwrap();
    println!(
        "\nBBS Jwk:\n {:#}",
        serde_json::to_string_pretty(&bbs_jwk).unwrap()
    );

    let issued_jwp = JwpIssuedBuilder::new(issued_header, jpt_claims)
        .build(&bbs_jwk)
        .unwrap();

    let compact_issued_jwp = issued_jwp.encode(SerializationType::COMPACT).unwrap();
    println!("\nCompact Issued JWP: {}", compact_issued_jwp);

    let decoded_issued_jwp =
        JwpIssuedDecoder::decode(&compact_issued_jwp, SerializationType::COMPACT)
            .unwrap()
            .verify(&bbs_jwk.to_public().unwrap())
            .unwrap();

    assert_eq!(issued_jwp, decoded_issued_jwp);

    let mut presentation_header = PresentationProtectedHeader::new(
        decoded_issued_jwp
            .get_issuer_protected_header()
            .alg()
            .into(),
    );
    presentation_header.set_aud(Some("https://recipient.example.com".to_owned()));
    presentation_header.set_nonce(Some("wrmBRkKtXjQ".to_owned()));

    let presented_jwp = JwpPresentedBuilder::new(&decoded_issued_jwp)
        .set_presentation_protected_header(presentation_header)
        .set_undisclosed("vc.degree.name")
        .unwrap()
        .set_undisclosed("vc.degree.ciao[0].u1")
        .unwrap()
        .set_undisclosed("vc.name")
        .unwrap()
        .build(&bbs_jwk.to_public().unwrap())
        .unwrap();

    let compact_presented_jwp = presented_jwp.encode(SerializationType::COMPACT).unwrap();

    println!("\nCompact Presented JWP: {}", compact_presented_jwp);

    let _decoded_presented_jwp =
        JwpPresentedDecoder::decode(&compact_presented_jwp, SerializationType::COMPACT)
            .unwrap()
            .verify(&bbs_jwk.to_public().unwrap())
            .unwrap();
}

Trait Implementations

impl Clone for Jwk

fn clone(&self) -> Jwk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Jwk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Jwk

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Jwk

fn eq(&self, other: &Jwk) -> 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 Jwk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Jwk

impl StructuralPartialEq for Jwk