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

A key to encode a JWT with. Can be a secret, a PEM-encoded key or a DER-encoded key. This key can be re-used so make sure you only initialize it once if you can for better performance.

Implementations§

source§

impl EncodingKey

source

pub fn from_secret(secret: &[u8]) -> Self

If you’re using a HMAC secret that is not base64, use that.

source

pub fn from_base64_secret(secret: &str) -> Result<Self>

If you have a base64 HMAC secret, use that.

source

pub fn from_rsa_pem(key: &[u8]) -> Result<Self>

If you are loading a RSA key from a .pem file. This errors if the key is not a valid RSA key. Only exists if the feature use_pem is enabled.

NOTE

According to the ring doc, the key should be at least 2047 bits.

source

pub fn from_ec_pem(key: &[u8]) -> Result<Self>

If you are loading a ECDSA key from a .pem file This errors if the key is not a valid private EC key Only exists if the feature use_pem is enabled.

NOTE

The key should be in PKCS#8 form.

You can generate a key with the following:

openssl ecparam -genkey -noout -name prime256v1 \
    | openssl pkcs8 -topk8 -nocrypt -out ec-private.pem
source

pub fn from_ed_pem(key: &[u8]) -> Result<Self>

If you are loading a EdDSA key from a .pem file This errors if the key is not a valid private Ed key Only exists if the feature use_pem is enabled.

source

pub fn from_rsa_der(der: &[u8]) -> Self

If you know what you’re doing and have the DER-encoded key, for RSA only

source

pub fn from_ec_der(der: &[u8]) -> Self

If you know what you’re doing and have the DER-encoded key, for ECDSA

source

pub fn from_ed_der(der: &[u8]) -> Self

If you know what you’re doing and have the DER-encoded key, for EdDSA

Trait Implementations§

source§

impl Clone for EncodingKey

source§

fn clone(&self) -> EncodingKey

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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.

source§

impl<T> ToOwned for Twhere T: Clone,

§

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
source§

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

§

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 Twhere U: TryFrom<T>,

§

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.