identity_verification::jose::jwk

Struct Jwk

pub struct Jwk { /* private fields */ }
Expand description

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: impl AsRef<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. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Jwk

§

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

Formats the value using the given formatter. Read more
§

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. Read more
§

impl Drop for Jwk

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl FromIterator<Jwk> for JwkSet

§

fn from_iter<I>(iter: I) -> JwkSet
where I: IntoIterator<Item = Jwk>,

Creates a value from an iterator. Read more
§

impl PartialEq for Jwk

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Serialize this value into the given Serde serializer. Read more
§

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

Auto Trait Implementations§

§

impl Freeze for Jwk

§

impl RefUnwindSafe for Jwk

§

impl Send for Jwk

§

impl Sync for Jwk

§

impl Unpin for Jwk

§

impl UnwindSafe for Jwk

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

impl<T> FmtJson for T
where T: ToJson,

§

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

Format this as a JSON string or pretty-JSON string based on whether the # format flag was used.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromJson for T
where T: for<'de> Deserialize<'de>,

§

fn from_json(json: &(impl AsRef<str> + ?Sized)) -> Result<Self, Error>

Deserialize Self from a string of JSON text.
§

fn from_json_slice(json: &(impl AsRef<[u8]> + ?Sized)) -> Result<Self, Error>

Deserialize Self from bytes of JSON text.
§

fn from_json_value(json: Value) -> Result<Self, Error>

Deserialize Self from a serde_json::Value.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> ToJson for T
where T: Serialize,

§

fn to_json(&self) -> Result<String, Error>

Serialize self as a string of JSON.
§

fn to_json_vec(&self) -> Result<Vec<u8>, Error>

Serialize self as a JSON byte vector.
§

fn to_json_value(&self) -> Result<Value, Error>

Serialize self as a serde_json::Value.
§

fn to_json_pretty(&self) -> Result<String, Error>

Serialize self as a pretty-printed string of JSON.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T