Struct josekit::jwk::Jwk

pub struct Jwk { /* fields omitted */ }

Represents JWK object.

Implementations

impl Jwk

pub fn new(key_type: &str) -> Self

pub fn from_map(map: impl Into<Map<String, Value>>) -> Result<Self, JoseError>

pub fn from_reader(input: &mut dyn Read) -> Result<Self, JoseError>

pub fn from_bytes(input: impl AsRef<[u8]>) -> Result<Self, JoseError>

pub fn generate_oct_key(key_len: u8) -> Result<Self, JoseError>

Generate a new oct type JWK.

Arguments

• key_len - A key byte length

pub fn generate_rsa_key(bits: u32) -> Result<Self, JoseError>

Generate a new RSA type JWK.

Arguments

• bits - A key bits size

pub fn generate_ec_key(curve: EcCurve) -> Result<Self, JoseError>

Generate a new EC type JWK.

Arguments

• curve - A EC curve algorithm

pub fn generate_ed_key(curve: EdCurve) -> Result<Self, JoseError>

Generate a new Ed type JWK.

Arguments

• curve - A Ed curve algorithm

pub fn generate_ecx_key(curve: EcxCurve) -> Result<Self, JoseError>

Generate a new Ecx type JWK.

Arguments

• curve - A Ecx curve algorithm

pub fn to_public_key(&self) -> Result<Self, JoseError>

Generate private key from private key.

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

Set a value for a key type parameter (kty).

Arguments

• value - A key type

pub fn key_type(&self) -> &str

Return a value for a key type parameter (kty).

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

Set a value for a key use parameter (use).

Arguments

• value - A key use

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

Return a value for a key use parameter (use).

pub fn set_key_operations(&mut self, values: Vec<impl Into<String>>)

Set values for a key operations parameter (key_ops).

Arguments

• values - key operations

pub fn key_operations(&self) -> Option<Vec<&str>>

Return values for a key operations parameter (key_ops).

pub fn is_for_key_operation(&self, key_operation: &str) -> bool

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

Set a value for a algorithm parameter (alg).

Arguments

• value - A algorithm

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

Return a value for a algorithm parameter (alg).

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

Set a value for a key ID parameter (kid).

Arguments

• value - A key ID

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

Return a value for a key ID parameter (kid).

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

Set a value for a x509 url parameter (x5u).

Arguments

• value - A x509 url

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

Return a value for a x509 url parameter (x5u).

pub fn set_x509_certificate_sha1_thumbprint(&mut self, value: impl AsRef<[u8]>)

Set a value for a x509 certificate SHA-1 thumbprint parameter (x5t).

Arguments

• value - A x509 certificate SHA-1 thumbprint

pub fn x509_certificate_sha1_thumbprint(&self) -> Option<Vec<u8>>

Return a value for a x509 certificate SHA-1 thumbprint parameter (x5t).

pub fn set_x509_certificate_sha256_thumbprint(
    &mut self,
    value: impl AsRef<[u8]>
)

Set a value for a x509 certificate SHA-256 thumbprint parameter (x5t#S256).

Arguments

• value - A x509 certificate SHA-256 thumbprint

pub fn x509_certificate_sha256_thumbprint(&self) -> Option<Vec<u8>>

Return a value for a x509 certificate SHA-256 thumbprint parameter (x5t#S256).

pub fn set_x509_certificate_chain(&mut self, values: &Vec<impl AsRef<[u8]>>)

Set values for a X.509 certificate chain parameter (x5c).

Arguments

• values - X.509 certificate chain

pub fn x509_certificate_chain(&self) -> Option<Vec<Vec<u8>>>

Return values for a X.509 certificate chain parameter (x5c).

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

Set a value for a curve parameter (crv).

Arguments

• value - A curve

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

Return a value for a curve parameter (crv).

pub fn set_key_value(&mut self, value: impl AsRef<[u8]>)

Set a value for a key value parameter (k) of a oct type.

Arguments

• value - A curve

pub fn key_value(&self) -> Option<Vec<u8>>

Return a value for a key value parameter (k) of a oct type.

pub fn set_parameter(
    &mut self,
    key: &str,
    value: Option<Value>
) -> Result<(), JoseError>

Set a value for a parameter of a specified key.

Arguments

• key - A key name of a parameter
• value - A typed value of a parameter

pub fn parameter(&self, key: &str) -> Option<&Value>

Return a value for a parameter of a specified key.

Arguments

• key - A key name of a parameter

Trait Implementations

impl AsRef<Map<String, Value>> for Jwk

fn as_ref(&self) -> &Map<String, Value>

Performs the conversion.

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

Formats the value using the given formatter.

impl Display for Jwk

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

Formats the value using the given formatter.

impl Into<Map<String, Value>> for Jwk

fn into(self) -> Map<String, Value>

Performs the conversion.

impl PartialEq<Jwk> 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: &Jwk) -> bool

This method tests for !=.

impl Eq for Jwk

impl StructuralEq for Jwk

impl StructuralPartialEq for Jwk