compact_jwt 0.5.6

Minimal implementation of JWT for OIDC and other applications
Documentation
use crate::compact::{JweAlg, JweCompact, JweProtectedHeader};
use crate::jwe::Jwe;
use crate::traits::*;
use crate::{JwtError, KID_LEN};
use crypto_glue::{
    aes128::{self, Aes128Key},
    aes128kw::{Aes128Kw, Aes128KwWrapped},
    hmac_s256::{HmacSha256, HmacSha256Key},
    traits::Mac,
};

/// A JWE outer encipher and decipher for RFC3394 AES 128 Key Wrapping.
#[derive(Clone)]
pub struct JweA128KWEncipher {
    kid: String,
    wrap_key: Aes128Key,
    sign_option_embed_kid: bool,
}

impl From<Aes128Key> for JweA128KWEncipher {
    fn from(wrap_key: Aes128Key) -> Self {
        let kid = kid(&wrap_key);
        JweA128KWEncipher {
            wrap_key,
            kid,
            sign_option_embed_kid: false,
        }
    }
}

impl AsRef<Aes128Key> for JweA128KWEncipher {
    fn as_ref(&self) -> &Aes128Key {
        &self.wrap_key
    }
}

impl JweEncipherOuterA128 for JweA128KWEncipher {
    fn set_header_alg(&self, hdr: &mut JweProtectedHeader) -> Result<(), JwtError> {
        hdr.alg = JweAlg::A128KW;
        if self.sign_option_embed_kid {
            hdr.kid = Some(self.kid.clone());
        }
        Ok(())
    }

    fn wrap_key(&self, key_to_wrap: Aes128Key) -> Result<Vec<u8>, JwtError> {
        let key_wrap = Aes128Kw::new(&self.wrap_key);
        let mut wrapped_key = Aes128KwWrapped::default();

        key_wrap
            .wrap(&key_to_wrap, &mut wrapped_key)
            .map_err(|err| {
                error!(?err);
                JwtError::CryptoError
            })?;

        Ok(wrapped_key.to_vec())
    }
}

impl JweA128KWEncipher {
    /// Generate an ephemeral outer key.
    pub fn generate_ephemeral() -> Result<Self, JwtError> {
        let wrap_key = aes128::new_key();
        let kid = kid(&wrap_key);
        Ok(JweA128KWEncipher {
            wrap_key,
            kid,
            sign_option_embed_kid: false,
        })
    }

    /// Set the key identifier for this wrapping key.
    pub fn set_kid(&mut self, kid: &str) {
        self.sign_option_embed_kid = true;
        self.kid = kid.to_string();
    }

    /// Enable or disable the embeddidng of a key id during encryption
    pub fn set_sign_option_embed_kid(&mut self, value: bool) {
        self.sign_option_embed_kid = value
    }

    /// Generate and return a key identifier for this wrapping key
    pub fn get_kid(&self) -> &str {
        self.kid.as_str()
    }

    /// Given a JWE, encipher its content to a compact form.
    pub fn encipher<E: JweEncipherInnerA128>(&self, jwe: &Jwe) -> Result<JweCompact, JwtError> {
        let encipher = E::new_ephemeral()?;
        encipher.encipher_inner(self, jwe)
    }

    /// Given a JWE in compact form, decipher and authenticate its content.
    pub fn decipher(&self, jwec: &JweCompact) -> Result<Jwe, JwtError> {
        let wrapped_key = Aes128KwWrapped::from_exact_iter(jwec.content_enc_key.iter().copied())
            .ok_or_else(|| {
                debug!("Invalid content encryption key length");
                JwtError::CryptoError
            })?;

        let key_wrap = Aes128Kw::new(&self.wrap_key);
        let mut key_unwrapped = aes128::Aes128Key::default();

        key_wrap
            .unwrap(&wrapped_key, &mut key_unwrapped)
            .map_err(|err| {
                error!(?err);
                JwtError::CryptoError
            })?;

        let payload = jwec.header.enc.decipher_inner_a128(key_unwrapped, jwec)?;

        Ok(Jwe {
            header: jwec.header.clone(),
            payload,
        })
    }
}

/// Generate a key identifier for an AES 128 wrapping key
fn kid(wrap_key: &Aes128Key) -> String {
    let mut skey = HmacSha256Key::default();
    let skey_slice = skey.as_mut_slice();
    let wrap_key_slice = wrap_key.as_slice();
    let skey_slice_mut = &mut skey_slice[..wrap_key_slice.len()];
    skey_slice_mut.copy_from_slice(wrap_key_slice);
    // Key is setup
    let mut hmac = HmacSha256::new(&skey);
    hmac.update(b"key identifier");
    let hashout = hmac.finalize();
    let mut kid = hex::encode(hashout.into_bytes());
    kid.truncate(KID_LEN);
    kid
}