riscv.rs

//! AES block cipher implementations for RISC-V using the Cryptography Extensions
//!
//! Supported targets: rv64 (scalar), rvv
//!
//! NOTE: rv32 (scalar) is not currently implemented, primarily due to the difficulty in obtaining a
//! suitable development environment (lack of distro support and lack of precompiled toolchains),
//! the effort required for maintaining a test environment as 32-bit becomes less supported, and the
//! overall scarcity of relevant hardware. If someone has a specific need for such an
//! implementation, please open an issue. Theoretically, the rvv implementation should work for
//! riscv32, for a hypothetical rv32 implementation satisfying the vector feature requirements.
//!
//! NOTE: These implementations are currently not enabled through auto-detection. In order to use
//! this implementation, you must enable the appropriate target-features.
//!
//! Additionally, for the vector implementation, since the `zvkned` target-feature is not yet
//! defined in Rust, you must pass `--cfg target_feature_zvkned` to the compiler (through
//! `RUSTFLAGS` or some other means). However, you still must enable the `v` target-feature.
//!
//! Examining the module structure for this implementation should give you an idea of how to specify
//! these features in your own code.
//!
//! NOTE: AES-128, AES-192, and AES-256 are supported for both the scalar and vector
//! implementations.
//!
//! However, key expansion is not vector-accelerated for the AES-192 case (because RISC-V does not
//! provide vector instructions for this case). Users concerned with vector performance are advised
//! to select AES-129 or AES-256 instead. Nevertheless, the AES-192 vector implementation will still
//! fall back to the scalar AES-192 key-schedule implementation, if the appropriate scalar
//! target-features are enabled.

#[cfg(all(
    target_arch = "riscv64",
    target_feature = "zknd",
    target_feature = "zkne"
))]
pub(crate) mod rv64;
#[cfg(all(
    any(target_arch = "riscv32", target_arch = "riscv64"),
    target_feature = "v",
    target_feature_zvkned
))]
pub(crate) mod rvv;

#[cfg(test)]
mod test {
    use hex_literal::hex;

    pub(crate) const AES128_KEY: [u8; 16] = hex!("2b7e151628aed2a6abf7158809cf4f3c");
    pub(crate) const AES128_EXP_KEYS: [[u8; 16]; 11] = [
        AES128_KEY,
        hex!("a0fafe1788542cb123a339392a6c7605"),
        hex!("f2c295f27a96b9435935807a7359f67f"),
        hex!("3d80477d4716fe3e1e237e446d7a883b"),
        hex!("ef44a541a8525b7fb671253bdb0bad00"),
        hex!("d4d1c6f87c839d87caf2b8bc11f915bc"),
        hex!("6d88a37a110b3efddbf98641ca0093fd"),
        hex!("4e54f70e5f5fc9f384a64fb24ea6dc4f"),
        hex!("ead27321b58dbad2312bf5607f8d292f"),
        hex!("ac7766f319fadc2128d12941575c006e"),
        hex!("d014f9a8c9ee2589e13f0cc8b6630ca6"),
    ];
    pub(crate) const AES128_EXP_INVKEYS: [[u8; 16]; 11] = [
        AES128_KEY,
        hex!("2b3708a7f262d405bc3ebdbf4b617d62"),
        hex!("cc7505eb3e17d1ee82296c51c9481133"),
        hex!("7c1f13f74208c219c021ae480969bf7b"),
        hex!("90884413d280860a12a128421bc89739"),
        hex!("6ea30afcbc238cf6ae82a4b4b54a338d"),
        hex!("6efcd876d2df54807c5df034c917c3b9"),
        hex!("12c07647c01f22c7bc42d2f37555114a"),
        hex!("df7d925a1f62b09da320626ed6757324"),
        hex!("0c7b5a631319eafeb0398890664cfbb4"),
        hex!("d014f9a8c9ee2589e13f0cc8b6630ca6"),
    ];

    pub(crate) const AES192_KEY: [u8; 24] =
        hex!("8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b");
    pub(crate) const AES192_EXP_KEYS: [[u8; 16]; 13] = [
        hex!("8e73b0f7da0e6452c810f32b809079e5"),
        hex!("62f8ead2522c6b7bfe0c91f72402f5a5"),
        hex!("ec12068e6c827f6b0e7a95b95c56fec2"),
        hex!("4db7b4bd69b5411885a74796e92538fd"),
        hex!("e75fad44bb095386485af05721efb14f"),
        hex!("a448f6d94d6dce24aa326360113b30e6"),
        hex!("a25e7ed583b1cf9a27f939436a94f767"),
        hex!("c0a69407d19da4e1ec1786eb6fa64971"),
        hex!("485f703222cb8755e26d135233f0b7b3"),
        hex!("40beeb282f18a2596747d26b458c553e"),
        hex!("a7e1466c9411f1df821f750aad07d753"),
        hex!("ca4005388fcc5006282d166abc3ce7b5"),
        hex!("e98ba06f448c773c8ecc720401002202"),
    ];
    pub(crate) const AES192_EXP_INVKEYS: [[u8; 16]; 13] = [
        hex!("8e73b0f7da0e6452c810f32b809079e5"),
        hex!("9eb149c479d69c5dfeb4a27ceab6d7fd"),
        hex!("659763e78c817087123039436be6a51e"),
        hex!("41b34544ab0592b9ce92f15e421381d9"),
        hex!("5023b89a3bc51d84d04b19377b4e8b8e"),
        hex!("b5dc7ad0f7cffb09a7ec43939c295e17"),
        hex!("c5ddb7f8be933c760b4f46a6fc80bdaf"),
        hex!("5b6cfe3cc745a02bf8b9a572462a9904"),
        hex!("4d65dfa2b1e5620dea899c312dcc3c1a"),
        hex!("f3b42258b59ebb5cf8fb64fe491e06f3"),
        hex!("a3979ac28e5ba6d8e12cc9e654b272ba"),
        hex!("ac491644e55710b746c08a75c89b2cad"),
        hex!("e98ba06f448c773c8ecc720401002202"),
    ];

    pub(crate) const AES256_KEY: [u8; 32] =
        hex!("603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4");
    pub(crate) const AES256_EXP_KEYS: [[u8; 16]; 15] = [
        hex!("603deb1015ca71be2b73aef0857d7781"),
        hex!("1f352c073b6108d72d9810a30914dff4"),
        hex!("9ba354118e6925afa51a8b5f2067fcde"),
        hex!("a8b09c1a93d194cdbe49846eb75d5b9a"),
        hex!("d59aecb85bf3c917fee94248de8ebe96"),
        hex!("b5a9328a2678a647983122292f6c79b3"),
        hex!("812c81addadf48ba24360af2fab8b464"),
        hex!("98c5bfc9bebd198e268c3ba709e04214"),
        hex!("68007bacb2df331696e939e46c518d80"),
        hex!("c814e20476a9fb8a5025c02d59c58239"),
        hex!("de1369676ccc5a71fa2563959674ee15"),
        hex!("5886ca5d2e2f31d77e0af1fa27cf73c3"),
        hex!("749c47ab18501ddae2757e4f7401905a"),
        hex!("cafaaae3e4d59b349adf6acebd10190d"),
        hex!("fe4890d1e6188d0b046df344706c631e"),
    ];
    pub(crate) const AES256_EXP_INVKEYS: [[u8; 16]; 15] = [
        hex!("603deb1015ca71be2b73aef0857d7781"),
        hex!("8ec6bff6829ca03b9e49af7edba96125"),
        hex!("42107758e9ec98f066329ea193f8858b"),
        hex!("4a7459f9c8e8f9c256a156bc8d083799"),
        hex!("6c3d632985d1fbd9e3e36578701be0f3"),
        hex!("54fb808b9c137949cab22ff547ba186c"),
        hex!("25ba3c22a06bc7fb4388a28333934270"),
        hex!("d669a7334a7ade7a80c8f18fc772e9e3"),
        hex!("c440b289642b757227a3d7f114309581"),
        hex!("32526c367828b24cf8e043c33f92aa20"),
        hex!("34ad1e4450866b367725bcc763152946"),
        hex!("b668b621ce40046d36a047ae0932ed8e"),
        hex!("57c96cf6074f07c0706abb07137f9241"),
        hex!("ada23f4963e23b2455427c8a5c709104"),
        hex!("fe4890d1e6188d0b046df344706c631e"),
    ];
}