aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorRob Napier <rob@neverwood.org>2020-09-13 09:59:36 -0400
committerRob Napier <rob@neverwood.org>2020-09-13 09:59:36 -0400
commit0f85b85acb0bd322ff7408c25dc09a84ff6621dc (patch)
tree5941d076597cc33a9d31d1d8153ff82f0f81145e /lib
parent17156e1775f60893b4c5040d7a0073659ea9157d (diff)
downloadzig-0f85b85acb0bd322ff7408c25dc09a84ff6621dc.tar.gz
zig-0f85b85acb0bd322ff7408c25dc09a84ff6621dc.zip
Improve doc text
Diffstat (limited to 'lib')
-rw-r--r--lib/std/crypto/pbkdf2.zig13
1 files changed, 6 insertions, 7 deletions
diff --git a/lib/std/crypto/pbkdf2.zig b/lib/std/crypto/pbkdf2.zig
index 6cf1e8a75e..2f9b720220 100644
--- a/lib/std/crypto/pbkdf2.zig
+++ b/lib/std/crypto/pbkdf2.zig
@@ -10,11 +10,11 @@ const debug = std.debug;
const assert = debug.assert;
const mem = std.mem;
-//! PBKDF2 (Password-Based Key Derivation Function 2) is a specific Key Derivation Function,
-//! intended to turn a weak, human generated password into a strong key, suitable for cryptographic
-//! uses. It does this by salting and stretching the password. Salting injects non-secret random
-//! data, so that identical passwords will be converted into unique keys. Stretching applies a
-//! deliberately slow hashing function to frustrate brute-force guessing.
+//! PBKDF2 (Password-Based Key Derivation Function 2) is intended to turn a weak, human generated
+//! password into a strong key, suitable for cryptographic uses. It does this by salting and
+//! stretching the password. Salting injects non-secret random data, so that identical passwords
+//! will be converted into unique keys. Stretching applies a deliberately slow hashing function to
+//! frustrate brute-force guessing.
//!
//! PBKDF2 is defined in RFC 2898, and is a recommendation of NIST SP 800-132.
@@ -46,8 +46,7 @@ const mem = std.mem;
// Based on Apple's CommonKeyDerivation, based originally on code by Damien Bergamini.
-/// Given a password, salt, iteration count (rounds), and a pseudo-random function, generates a
-/// derived key in the provided buffer slice.
+/// Apply PBKDF2 to generate a key from a password.
///
/// derivedKey: Slice of appropriate size for generated key. Generally 16 or 32 bytes in length.
/// May be uninitialized. All bytes will be written.