orion 0.18.1

Usable, easy and safe pure-Rust crypto
Documentation 
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

// MIT License

// Copyright (c) 2025-2026 The orion Developers

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use crate::generics::GenerateSecret;
use crate::generics::{ByteArrayData, Secret, TypeSpec, sealed::Sealed};
#[cfg(feature = "safe_api")]
use crate::{errors::UnknownCryptoError, generics::sealed::Data};

/// Internal implementation logic for ML-KEM.
pub mod internal;

/// ML-KEM-512 as specified in [FIPS-203](https://doi.org/10.6028/NIST.FIPS.203).
pub mod mlkem512;

/// ML-KEM-768 as specified in [FIPS-203](https://doi.org/10.6028/NIST.FIPS.203).
pub mod mlkem768;

/// ML-KEM-1024 as specified in [FIPS-203](https://doi.org/10.6028/NIST.FIPS.203).
pub mod mlkem1024;

/// Size of private [`Seed`].
pub const SEED_SIZE: usize = 64;

/// Size of explicit randomness ("`m`") used during encapsulation [`ExplicitRandom`].
pub const RAND_SIZE: usize = 32;

#[derive(Debug)]
/// ML-KEM seed implementation. See [`Seed`] type for convenience.
pub struct MlKemSeed {}
impl Sealed for MlKemSeed {}

impl TypeSpec for MlKemSeed {
    const NAME: &'static str = stringify!(Seed);
    type TypeData = ByteArrayData<SEED_SIZE>;
}

impl From<[u8; SEED_SIZE]> for Secret<MlKemSeed> {
    fn from(value: [u8; SEED_SIZE]) -> Self {
        Self::from_data(<MlKemSeed as TypeSpec>::TypeData::from(value))
    }
}

impl GenerateSecret for MlKemSeed {
    #[cfg(feature = "safe_api")]
    #[cfg_attr(docsrs, doc(cfg(feature = "safe_api")))]
    fn generate() -> Result<Secret<MlKemSeed>, UnknownCryptoError> {
        let mut data = Self::TypeData::new(SEED_SIZE)?;
        crate::util::secure_rand_bytes(&mut data.bytes)?;
        Ok(Secret::from_data(data))
    }
}

/// ML-KEM seed.
///
/// Represent the `d||z` seed used by ML-KEM to produce
/// a decapsulation key and its corresponding encapsulation key.
///
/// **SECURITY**: It is crucial for the security of ML-KEM that these be generated
/// using a CSPRNG.
pub type Seed = Secret<MlKemSeed>;

#[derive(Debug)]
/// ML-KEM `m` explicit randomness implementation. See [`ExplicitRandom`] type for convenience.
pub struct MlKemExplicitRandom {}
impl Sealed for MlKemExplicitRandom {}

impl TypeSpec for MlKemExplicitRandom {
    const NAME: &'static str = stringify!(ExplicitRandom);
    type TypeData = ByteArrayData<RAND_SIZE>;
}

impl From<[u8; RAND_SIZE]> for Secret<MlKemExplicitRandom> {
    fn from(value: [u8; RAND_SIZE]) -> Self {
        Self::from_data(<MlKemExplicitRandom as TypeSpec>::TypeData::from(value))
    }
}

impl GenerateSecret for MlKemExplicitRandom {
    #[cfg(feature = "safe_api")]
    #[cfg_attr(docsrs, doc(cfg(feature = "safe_api")))]
    fn generate() -> Result<Secret<MlKemExplicitRandom>, UnknownCryptoError> {
        let mut data = Self::TypeData::new(RAND_SIZE)?;
        crate::util::secure_rand_bytes(&mut data.bytes)?;
        Ok(Secret::from_data(data))
    }
}

/// ML-KEM explicit randomness ("`m`") used during encapsulation.
///
/// This type exists for the purpose of deterministic operations.
///
/// **SECURITY**: It is crucial for the security of ML-KEM that these be generated
/// using a CSPRNG.
pub type ExplicitRandom = Secret<MlKemExplicitRandom>;

#[test]
fn test_mlkem_seed() {
    use crate::test_framework::newtypes::secret::SecretNewtype;
    SecretNewtype::test_with_generate::<SEED_SIZE, SEED_SIZE, SEED_SIZE, MlKemSeed>();

    // Test of From<[u8; N]>
    assert_ne!(Seed::from([0u8; SEED_SIZE]), Seed::from([1u8; SEED_SIZE]));
}

#[test]
fn test_mlkem_explicitrandom() {
    use crate::test_framework::newtypes::secret::SecretNewtype;
    SecretNewtype::test_with_generate::<RAND_SIZE, RAND_SIZE, RAND_SIZE, MlKemExplicitRandom>();

    // Test of From<[u8; N]>
    assert_ne!(
        ExplicitRandom::from([0u8; RAND_SIZE]),
        ExplicitRandom::from([1u8; RAND_SIZE])
    );
}