botan 0.14.0

Rust wrapper for Botan cryptography library
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
135
136
137
138
139
140
141
142
143
144
145

use crate::utils::*;
use botan_sys::*;

/// Password based key derivation function
///
/// # Examples
/// ```
/// let mut rng = botan::RandomNumberGenerator::new().unwrap();
/// let salt = rng.read(10).unwrap();
/// let key = botan::derive_key_from_password("Scrypt", 32, "passphrase", &salt, 8192, 8, 1).unwrap();
/// assert_eq!(key.len(), 32);
/// ```
pub fn derive_key_from_password<A: crate::PasswordHashAlgorithmIdentifier>(
    algo: A,
    out_len: usize,
    passphrase: &str,
    salt: &[u8],
    param1: usize,
    param2: usize,
    param3: usize,
) -> Result<Vec<u8>> {
    let algo = algo.botan_name();
    let algo = make_cstr(&algo)?;
    let passphrase = make_cstr(passphrase)?;

    let mut output = vec![0u8; out_len];

    botan_call!(
        botan_pwdhash,
        algo.as_ptr(),
        param1,
        param2,
        param3,
        output.as_mut_ptr(),
        output.len(),
        passphrase.as_ptr(),
        0,
        salt.as_ptr(),
        salt.len()
    )?;

    Ok(output)
}

/// Password based key derivation function, timed variant
///
/// # Examples
/// ```
/// let mut rng = botan::RandomNumberGenerator::new().unwrap();
/// let salt = rng.read(10).unwrap();
/// let msec = 30;
/// let (key,r,p,n) = botan::derive_key_from_password_timed("Scrypt", 32, "passphrase", &salt, msec).unwrap();
/// assert_eq!(key.len(), 32);
/// let key2 = botan::derive_key_from_password("Scrypt", 32, "passphrase", &salt, n, r, p).unwrap();
/// assert_eq!(key, key2);
/// ```
pub fn derive_key_from_password_timed<A: crate::PasswordHashAlgorithmIdentifier>(
    algo: A,
    out_len: usize,
    passphrase: &str,
    salt: &[u8],
    msec: u32,
) -> Result<(Vec<u8>, usize, usize, usize)> {
    let algo = algo.botan_name();
    let algo = make_cstr(&algo)?;
    let passphrase = make_cstr(passphrase)?;

    let mut output = vec![0u8; out_len];
    let mut param1 = 0;
    let mut param2 = 0;
    let mut param3 = 0;

    botan_call!(
        botan_pwdhash_timed,
        algo.as_ptr(),
        msec,
        &mut param1,
        &mut param2,
        &mut param3,
        output.as_mut_ptr(),
        output.len(),
        passphrase.as_ptr(),
        0,
        salt.as_ptr(),
        salt.len()
    )?;

    Ok((output, param1, param2, param3))
}

/// Password based key derivation function
///
/// Note currently only PBKDF2 is supported by this interface.
/// For PBKDF2, iterations >= 100000 is recommended.
///
/// # Examples
/// ```
/// let mut rng = botan::RandomNumberGenerator::new().unwrap();
/// let salt = rng.read(10).unwrap();
/// let key = botan::pbkdf("PBKDF2(SHA-256)", 32, "passphrase", &salt, 10000).unwrap();
/// assert_eq!(key.len(), 32);
/// ```
pub fn pbkdf<A: crate::PasswordHashAlgorithmIdentifier>(
    algo: A,
    out_len: usize,
    passphrase: &str,
    salt: &[u8],
    iterations: usize,
) -> Result<Vec<u8>> {
    derive_key_from_password(algo, out_len, passphrase, salt, iterations, 0, 0)
}

/// Scrypt key derivation
///
/// The n, r, p parameters control how much time and memory is used.
/// As of 2018, n = 32768, r = 8, p = 1 seems sufficient.
///
/// # Examples
/// ```
/// let mut rng = botan::RandomNumberGenerator::new().unwrap();
/// let salt = rng.read(10).unwrap();
/// let n = 32768;
/// let r = 8;
/// let p = 1;
/// let key = botan::scrypt(32, "passphrase", &salt, n, r, p).unwrap();
/// assert_eq!(key.len(), 32);
/// ```
pub fn scrypt(
    out_len: usize,
    passphrase: &str,
    salt: &[u8],
    n: usize,
    r: usize,
    p: usize,
) -> Result<Vec<u8>> {
    derive_key_from_password(
        crate::PasswordHashAlgorithm::Scrypt,
        out_len,
        passphrase,
        salt,
        n,
        r,
        p,
    )
}