Struct EncodingKey

pub struct EncodingKey { /* private fields */ }

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

impl EncodingKey

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

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

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

If you have a base64 HMAC secret, use that.

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.

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

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

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

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

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

Trait Implementations

impl Clone for EncodingKey

fn clone(&self) -> EncodingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingKey

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

Formats the value using the given formatter.

impl PartialEq for EncodingKey

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