-
-
Notifications
You must be signed in to change notification settings - Fork 782
add argon2id support for ossl 3.2+ #2290
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2d340cb
add argon2id support for ossl 3.2+
reaperhulk 6ed35b2
review feedback, support OPENSSL_NO_ARGON2
reaperhulk 05d9f2e
simplify, use CStr to hopefully handle i8/u8 nonsense
reaperhulk 04ffcf1
speeeeeeed
reaperhulk 826f2a0
use c_char
reaperhulk 5ff8594
rename to kdf, remove thread arg
reaperhulk 3e57d9a
oops + clippy
reaperhulk bef571b
EvpKdf and EvpKdfCtx are available in 3.0.0, but mark them ossl320
reaperhulk 9852168
Apply suggestions from code review
reaperhulk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,162 @@ | ||
#[cfg(ossl320)] | ||
struct EvpKdf(*mut ffi::EVP_KDF); | ||
|
||
#[cfg(ossl320)] | ||
impl Drop for EvpKdf { | ||
fn drop(&mut self) { | ||
unsafe { | ||
ffi::EVP_KDF_free(self.0); | ||
} | ||
} | ||
} | ||
|
||
#[cfg(ossl320)] | ||
struct EvpKdfCtx(*mut ffi::EVP_KDF_CTX); | ||
|
||
#[cfg(ossl320)] | ||
impl Drop for EvpKdfCtx { | ||
fn drop(&mut self) { | ||
unsafe { | ||
ffi::EVP_KDF_CTX_free(self.0); | ||
} | ||
} | ||
} | ||
|
||
cfg_if::cfg_if! { | ||
if #[cfg(all(ossl320, not(osslconf = "OPENSSL_NO_ARGON2")))] { | ||
use std::ffi::{c_char, c_void}; | ||
use std::mem::MaybeUninit; | ||
use std::ptr; | ||
use crate::{cvt, cvt_p}; | ||
use crate::error::ErrorStack; | ||
|
||
/// Derives a key using the argon2id algorithm. | ||
/// | ||
/// This function currently does not support multi-threaded operation, so | ||
/// lanes greater than 1 will be processed sequentially. | ||
/// | ||
/// Requires OpenSSL 3.2.0 or newer. | ||
#[allow(clippy::too_many_arguments)] | ||
pub fn argon2id( | ||
pass: &[u8], | ||
salt: &[u8], | ||
ad: Option<&[u8]>, | ||
secret: Option<&[u8]>, | ||
mut iter: u32, | ||
mut lanes: u32, | ||
mut memcost: u32, | ||
out: &mut [u8], | ||
) -> Result<(), ErrorStack> { | ||
unsafe { | ||
ffi::init(); | ||
let mut threads = 1; | ||
let mut params: [ffi::OSSL_PARAM; 10] = | ||
core::array::from_fn(|_| MaybeUninit::<ffi::OSSL_PARAM>::zeroed().assume_init()); | ||
let mut idx = 0; | ||
params[idx] = ffi::OSSL_PARAM_construct_octet_string( | ||
b"pass\0".as_ptr() as *const c_char, | ||
pass.as_ptr() as *mut c_void, | ||
pass.len(), | ||
); | ||
idx += 1; | ||
params[idx] = ffi::OSSL_PARAM_construct_octet_string( | ||
b"salt\0".as_ptr() as *const c_char, | ||
salt.as_ptr() as *mut c_void, | ||
salt.len(), | ||
); | ||
idx += 1; | ||
params[idx] = | ||
ffi::OSSL_PARAM_construct_uint(b"threads\0".as_ptr() as *const c_char, &mut threads); | ||
idx += 1; | ||
params[idx] = | ||
ffi::OSSL_PARAM_construct_uint(b"lanes\0".as_ptr() as *const c_char, &mut lanes); | ||
idx += 1; | ||
params[idx] = | ||
ffi::OSSL_PARAM_construct_uint(b"memcost\0".as_ptr() as *const c_char, &mut memcost); | ||
idx += 1; | ||
params[idx] = | ||
ffi::OSSL_PARAM_construct_uint(b"iter\0".as_ptr() as *const c_char, &mut iter); | ||
idx += 1; | ||
let mut size = out.len() as u32; | ||
params[idx] = | ||
ffi::OSSL_PARAM_construct_uint(b"size\0".as_ptr() as *const c_char, &mut size); | ||
idx += 1; | ||
if let Some(ad) = ad { | ||
params[idx] = ffi::OSSL_PARAM_construct_octet_string( | ||
b"ad\0".as_ptr() as *const c_char, | ||
ad.as_ptr() as *mut c_void, | ||
ad.len(), | ||
); | ||
idx += 1; | ||
} | ||
if let Some(secret) = secret { | ||
params[idx] = ffi::OSSL_PARAM_construct_octet_string( | ||
b"secret\0".as_ptr() as *const c_char, | ||
secret.as_ptr() as *mut c_void, | ||
secret.len(), | ||
); | ||
idx += 1; | ||
} | ||
params[idx] = ffi::OSSL_PARAM_construct_end(); | ||
|
||
let argon2_p = cvt_p(ffi::EVP_KDF_fetch( | ||
ptr::null_mut(), | ||
b"ARGON2ID\0".as_ptr() as *const c_char, | ||
ptr::null(), | ||
))?; | ||
let argon2 = EvpKdf(argon2_p); | ||
let ctx_p = cvt_p(ffi::EVP_KDF_CTX_new(argon2.0))?; | ||
let ctx = EvpKdfCtx(ctx_p); | ||
reaperhulk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
cvt(ffi::EVP_KDF_derive( | ||
ctx.0, | ||
out.as_mut_ptr(), | ||
out.len(), | ||
params.as_ptr(), | ||
)) | ||
.map(|_| ()) | ||
} | ||
} | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
#[test] | ||
#[cfg(all(ossl320, not(osslconf = "OPENSSL_NO_ARGON2")))] | ||
fn argon2id() { | ||
// RFC 9106 test vector for argon2id | ||
let pass = hex::decode("0101010101010101010101010101010101010101010101010101010101010101") | ||
.unwrap(); | ||
let salt = hex::decode("02020202020202020202020202020202").unwrap(); | ||
let secret = hex::decode("0303030303030303").unwrap(); | ||
let ad = hex::decode("040404040404040404040404").unwrap(); | ||
let expected = "0d640df58d78766c08c037a34a8b53c9d01ef0452d75b65eb52520e96b01e659"; | ||
|
||
let mut actual = [0u8; 32]; | ||
super::argon2id( | ||
&pass, | ||
&salt, | ||
Some(&ad), | ||
Some(&secret), | ||
3, | ||
4, | ||
32, | ||
&mut actual, | ||
) | ||
.unwrap(); | ||
assert_eq!(hex::encode(&actual[..]), expected); | ||
} | ||
|
||
#[test] | ||
#[cfg(all(ossl320, not(osslconf = "OPENSSL_NO_ARGON2")))] | ||
fn argon2id_no_ad_secret() { | ||
// Test vector from OpenSSL | ||
let pass = ""; | ||
reaperhulk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
let salt = hex::decode("02020202020202020202020202020202").unwrap(); | ||
let expected = "0a34f1abde67086c82e785eaf17c68382259a264f4e61b91cd2763cb75ac189a"; | ||
|
||
let mut actual = [0u8; 32]; | ||
super::argon2id(pass.as_bytes(), &salt, None, None, 3, 4, 32, &mut actual).unwrap(); | ||
reaperhulk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
assert_eq!(hex::encode(&actual[..]), expected); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.