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

// MIT License

// Copyright (c) 2018-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.

/// HKDF (HMAC-based Extract-and-Expand Key Derivation Function) as specified in the [RFC 5869](https://tools.ietf.org/html/rfc5869).
pub mod hkdf;

/// PBKDF2(Password-Based Key Derivation Function 2) as specified in the [RFC 8018](https://tools.ietf.org/html/rfc8018).
pub mod pbkdf2;

#[cfg(any(feature = "safe_api", feature = "alloc"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "safe_api", feature = "alloc"))))]
/// Scrypt Password-Based Key Derivation Function as specified in the [RFC 7914](https://datatracker.ietf.org/doc/html/rfc7914.html).
pub mod scrypt;

#[cfg(any(feature = "safe_api", feature = "alloc"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "safe_api", feature = "alloc"))))]
/// Argon2 password hashing function as described in the [P-H-C specification](https://github.com/P-H-C/phc-winner-argon2/blob/master/argon2-specs.pdf).
pub mod argon2;

#[cfg(feature = "safe_api")]
/// Parse a decimal parameter value to a u32. Returns an error on overflow
/// and if the value has leading zeroes.
pub(crate) fn parse_decimal_value(value: &str) -> Result<u32, crate::errors::UnknownCryptoError> {
    // See: https://github.com/C2SP/C2SP/blob/main/phc-strings.md#decimal-encoding
    if value.len() > 1 && value.starts_with('0') {
        return Err(crate::errors::UnknownCryptoError);
    }
    if value.len() > 1 && value.contains('+') {
        return Err(crate::errors::UnknownCryptoError);
    }

    // The specification allows `-` sign where the following digit must be non-zero.
    // However, since this is only used for Argon2/Scrypt where negative values are
    // invalid cost parameters, this is not implemented.

    // .parse::<T>() detects overflows (in debug and release builds)
    // and rejects empty strings. If the value contains spaces, parsing
    // also fails.
    Ok(value.parse::<u32>()?)
}

#[test]
#[cfg(feature = "safe_api")]
fn test_parse_decimal_value() {
    assert!(parse_decimal_value("-").is_err());
    assert!(parse_decimal_value("-0").is_err());
    assert!(parse_decimal_value("-1").is_err()); // should be true if we ever need to support it
    assert!(parse_decimal_value("+").is_err());
    assert!(parse_decimal_value("+0").is_err());
    assert!(parse_decimal_value("+1").is_err());
}