Struct identity_iota::verification::jose::jwk::Jwk

pub struct Jwk { /* private fields */ }

JSON Web Key.

More Info

Implementations

impl Jwk

pub const fn new(kty: JwkType) -> Jwk

Creates a new Jwk with the given kty parameter.

pub fn from_params(params: impl Into<JwkParams>) -> Jwk

Creates a new Jwk from the given params.

pub fn kty(&self) -> JwkType

Returns the value for the key type parameter (kty).

pub fn set_kty(&mut self, value: impl Into<JwkType>)

Sets a value for the key type parameter (kty).

Removes any previously set params.

pub fn use_(&self) -> Option<JwkUse>

Returns the value for the use property (use).

pub fn set_use(&mut self, value: impl Into<JwkUse>)

Sets a value for the key use parameter (use).

pub fn key_ops(&self) -> Option<&[JwkOperation]>

Returns the value for the key operations parameter (key_ops).

pub fn set_key_ops( &mut self, value: impl IntoIterator<Item = impl Into<JwkOperation>> )

Sets values for the key operations parameter (key_ops).

pub fn alg(&self) -> Option<&str>

Returns the value for the algorithm property (alg).

pub fn set_alg(&mut self, value: impl Into<String>)

Sets a value for the algorithm property (alg).

pub fn kid(&self) -> Option<&str>

Returns the value of the key ID property (kid).

pub fn set_kid(&mut self, value: impl Into<String>)

Sets a value for the key ID property (kid).

pub fn x5u(&self) -> Option<&Url>

Returns the value of the X.509 URL property (x5u).

pub fn set_x5u(&mut self, value: impl Into<Url>)

Sets a value for the X.509 URL property (x5u).

pub fn x5c(&self) -> Option<&[String]>

Returns the value of the X.509 certificate chain property (x5c).

pub fn set_x5c(&mut self, value: impl IntoIterator<Item = impl Into<String>>)

Sets values for the X.509 certificate chain property (x5c).

pub fn x5t(&self) -> Option<&str>

Returns the value of the X.509 certificate SHA-1 thumbprint property (x5t).

pub fn set_x5t(&mut self, value: impl Into<String>)

Sets a value for the X.509 certificate SHA-1 thumbprint property (x5t).

pub fn x5t_s256(&self) -> Option<&str>

Returns the value of the X.509 certificate SHA-256 thumbprint property (x5t#S256).

pub fn set_x5t_s256(&mut self, value: impl Into<String>)

Sets a value for the X.509 certificate SHA-256 thumbprint property (x5t#S256).

pub fn params(&self) -> &JwkParams

Returns a reference to the custom JWK properties.

pub fn params_mut(&mut self) -> &mut JwkParams

Returns a mutable reference to the custom JWK properties.

pub fn set_params(&mut self, params: impl Into<JwkParams>) -> Result<(), Error>

Sets the value of the custom JWK properties.

The passed params must be appropriate for the key type (kty), an error is returned otherwise.

If you want to set params unchecked, use set_params_unchecked.

pub fn set_params_unchecked(&mut self, value: impl Into<JwkParams>)

Sets the value of the custom JWK properties.

Does not check whether the passed params are appropriate for the set key type (kty).

pub fn try_ec_params(&self) -> Result<&JwkParamsEc, Error>

Returns the JwkParamsEc in this JWK if it is of type Ec.

pub fn try_ec_params_mut(&mut self) -> Result<&mut JwkParamsEc, Error>

Returns a mutable reference to the JwkParamsEc in this JWK if it is of type Ec.

pub fn try_rsa_params(&self) -> Result<&JwkParamsRsa, Error>

Returns the JwkParamsRsa in this JWK if it is of type Rsa.

pub fn try_rsa_params_mut(&mut self) -> Result<&mut JwkParamsRsa, Error>

Returns a mutable reference to the JwkParamsRsa in this JWK if it is of type Rsa.

pub fn try_oct_params(&self) -> Result<&JwkParamsOct, Error>

Returns the JwkParamsOct in this JWK if it is of type Oct.

pub fn try_oct_params_mut(&mut self) -> Result<&mut JwkParamsOct, Error>

Returns a mutable reference to the JwkParamsOct in this JWK if it is of type Oct.

pub fn try_okp_params(&self) -> Result<&JwkParamsOkp, Error>

Returns the JwkParamsOkp in this JWK if it is of type Okp.

pub fn try_okp_params_mut(&mut self) -> Result<&mut JwkParamsOkp, Error>

Returns a mutable reference to the JwkParamsOkp in this JWK if it is of type Okp.

pub fn thumbprint_sha256_b64(&self) -> String

Creates a Thumbprint of the JSON Web Key according to RFC7638.

SHA2-256 is used as the hash function H.

The thumbprint is returned as a base64url-encoded string.

pub fn thumbprint_sha256(&self) -> [u8; 32]

Creates a Thumbprint of the JSON Web Key according to RFC7638.

SHA2-256 is used as the hash function H.

The thumbprint is returned as an unencoded array of bytes.

pub fn thumbprint_hash_input(&self) -> String

Creates the JSON string of the JSON Web Key according to RFC7638, which is used as the input for the JWK thumbprint hashing procedure. This can be used as input for a custom hash function.

pub fn check_alg(&self, expected: &str) -> Result<(), Error>

Checks if the alg claim of the JWK is equal to expected.

pub fn try_ec_curve(&self) -> Result<EcCurve, Error>

Returns the EcCurve of this JWK if it is of type Ec.

pub fn try_ed_curve(&self) -> Result<EdCurve, Error>

Returns the EdCurve of this JWK if it is of type Okp.

pub fn try_ecx_curve(&self) -> Result<EcxCurve, Error>

Returns the EcxCurve of this JWK if it is of type Okp.

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 to_public(&self) -> Option<Jwk>

Returns a clone of the Jwk with all private key components unset.

The None variant is returned when kty = oct as this key type is not considered public by this library.

Trait Implementations

impl Clone for Jwk

fn clone(&self) -> Jwk

Returns a copy 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D ) -> Result<Jwk, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Jwk

fn drop(&mut self)

Executes the destructor for this type.

impl FromIterator<Jwk> for JwkSet

fn from_iter<I>(iter: I) -> JwkSet

where I: IntoIterator<Item = Jwk>,

Creates a value from an iterator.

impl PartialEq for Jwk

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Jwk> for Jwk

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Jwk> for &Jwk

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Jwk, <&Jwk as TryInto<Jwk>>::Error>

Performs the conversion.

impl Zeroize for Jwk

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for Jwk

impl StructuralPartialEq for Jwk