Skip to content

Commit 322ade5

Browse files
docs: use derive_key_argon2 in examples, derive_key no longer exists (#375)
1 parent 4859c6d commit 322ade5

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

README_RUST.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -212,17 +212,15 @@ assert_eq!(32, key.len());
212212

213213
### Key Derivation
214214

215-
This is a method used to generate a key from a password or another key. Useful for password-dependant cryptography. Salt should be a random 16 bytes array if possible and iterations should be 10000 or configurable by the user.
215+
Key derivation can be used to generate a key of a specific length from an input of arbitrary length such as a password.
216216

217217
```rust
218-
use devolutions_crypto::utils::{generate_key, derive_key};
219-
let key = b"this is a secret password";
220-
let salt = generate_key(16);
221-
let iterations = 10000;
222-
let length = 32;
223-
224-
let new_key = derive_key(key, &salt, iterations, length);
218+
use devolutions_crypto::utils::derive_key_argon2;
219+
use devolutions_crypto::Argon2Parameters;
225220

221+
let key = b"this is a secret password";
222+
let parameters = Argon2Parameters::default();
223+
let new_key = derive_key_argon2(key, &parameters).expect("default parameters should not fail");
226224
assert_eq!(32, new_key.len());
227225
```
228226

0 commit comments

Comments
 (0)