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. Only exists if the feature use_pem is enabled.

NOTE

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

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

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.

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

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

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.