wolfcrypt 0.1.2

RustCrypto trait implementations backed by wolfCrypt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! AES Key Wrap (RFC 3394) backed by wolfCrypt.
//!
//! Provides [`aes_wrap_key`] and [`aes_unwrap_key`] which implement the
//! AES Key Wrap algorithm per RFC 3394 using wolfCrypt's native
//! `wc_AesKeyWrap` / `wc_AesKeyUnWrap` functions.
//!
//! The Key Encryption Key (KEK) must be 16, 24, or 32 bytes (AES-128/192/256).
//! The plaintext (key data) must be a multiple of 8 bytes and at least 16 bytes.
//! The ciphertext is always 8 bytes longer than the plaintext.
//!
//! # Example
//!
//! ```ignore
//! use wolfcrypt::keywrap::{aes_wrap_key, aes_unwrap_key};
//!
//! let kek = [0u8; 16];
//! let key_data = [0x42u8; 16];
//! let wrapped = aes_wrap_key(&kek, &key_data).unwrap();
//! let unwrapped = aes_unwrap_key(&kek, &wrapped).unwrap();
//! assert_eq!(&key_data[..], &unwrapped[..]);
//! ```

use core::ptr;

use alloc::vec;
use alloc::vec::Vec;

use crate::error::WolfCryptError;
use wolfcrypt_rs::{wc_AesKeyWrap, wc_AesKeyUnWrap};

/// Wrap `plaintext` key data under `kek` per RFC 3394.
///
/// - `kek` must be 16, 24, or 32 bytes.
/// - `plaintext` must be a multiple of 8 bytes and at least 16 bytes.
/// - Returns ciphertext of `plaintext.len() + 8` bytes on success.
pub fn aes_wrap_key(kek: &[u8], plaintext: &[u8]) -> Result<Vec<u8>, WolfCryptError> {
    if plaintext.len() < 16 || plaintext.len() % 8 != 0 {
        return Err(WolfCryptError::INVALID_INPUT);
    }
    match kek.len() {
        16 | 24 | 32 => {}
        _ => return Err(WolfCryptError::INVALID_INPUT),
    }

    let mut out = vec![0u8; plaintext.len() + 8];
    let rc = unsafe {
        wc_AesKeyWrap(
            kek.as_ptr(),
            kek.len() as u32,
            plaintext.as_ptr(),
            plaintext.len() as u32,
            out.as_mut_ptr(),
            out.len() as u32,
            ptr::null(), // default IV (A6A6A6A6 A6A6A6A6)
        )
    };
    if rc <= 0 {
        return Err(WolfCryptError::Ffi { code: rc, func: "wc_AesKeyWrap" });
    }
    let out_len = rc as usize;
    if out_len > out.len() {
        return Err(WolfCryptError::Ffi { code: -1, func: "wc_AesKeyWrap (output length)" });
    }
    out.truncate(out_len);
    Ok(out)
}

/// Unwrap `ciphertext` under `kek` per RFC 3394.
///
/// - `kek` must be 16, 24, or 32 bytes.
/// - `ciphertext` must be a multiple of 8 bytes and at least 24 bytes.
/// - Returns the original key data (`ciphertext.len() - 8` bytes) on success.
pub fn aes_unwrap_key(kek: &[u8], ciphertext: &[u8]) -> Result<Vec<u8>, WolfCryptError> {
    if ciphertext.len() < 24 || ciphertext.len() % 8 != 0 {
        return Err(WolfCryptError::INVALID_INPUT);
    }
    match kek.len() {
        16 | 24 | 32 => {}
        _ => return Err(WolfCryptError::INVALID_INPUT),
    }

    let mut out = vec![0u8; ciphertext.len()];
    let rc = unsafe {
        wc_AesKeyUnWrap(
            kek.as_ptr(),
            kek.len() as u32,
            ciphertext.as_ptr(),
            ciphertext.len() as u32,
            out.as_mut_ptr(),
            out.len() as u32,
            ptr::null(), // default IV (A6A6A6A6 A6A6A6A6)
        )
    };
    if rc <= 0 {
        return Err(WolfCryptError::Ffi { code: rc, func: "wc_AesKeyUnWrap" });
    }
    let out_len = rc as usize;
    if out_len > out.len() {
        return Err(WolfCryptError::Ffi { code: -1, func: "wc_AesKeyUnWrap (output length)" });
    }
    out.truncate(out_len);
    Ok(out)
}