aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2021-07-08 11:14:14 -0400
committerJack O'Connor <[email protected]>2021-07-25 12:42:09 -0400
commit5aef6849bbee4e614d4c05db4a79d791baa3067e (patch)
tree10b3ae49bff8d267ba7544208391f5fa0e540ccd
parent037de38bfec4e813ab6189a50cb7c4cbae47268a (diff)
update README examples
-rw-r--r--README.md19
-rw-r--r--src/lib.rs2
2 files changed, 9 insertions, 12 deletions
diff --git a/README.md b/README.md
index dc3e050..303a549 100644
--- a/README.md
+++ b/README.md
@@ -133,7 +133,7 @@ output_reader.fill(&mut output);
assert_eq!(&output[..32], hash1.as_bytes());
// Print a hash as hex.
-println!("{}", hash1.to_hex());
+println!("{}", hash1);
```
Besides `hash`, BLAKE3 provides two other modes, `keyed_hash` and
@@ -151,21 +151,18 @@ let mac2 = hasher.finalize();
assert_eq!(mac1, mac2);
```
-The `derive_key` mode takes a context string of any length and key material of
-any length (not a password), and it outputs a derived key of any length. The
-context string should be hardcoded, globally unique, and application-specific.
-A good default format for the context string is `"[application] [commit
-timestamp] [purpose]"`:
+The `derive_key` mode takes a context string and some key material (not a
+password). The context string should be hardcoded, globally unique, and
+application-specific. A good default format for the context string is
+`"[application] [commit timestamp] [purpose]"`:
```rust
// Derive a couple of subkeys for different purposes.
const EMAIL_CONTEXT: &str = "BLAKE3 example 2020-01-07 17:10:44 email key";
const API_CONTEXT: &str = "BLAKE3 example 2020-01-07 17:11:21 API key";
-let input_key_material = b"usually at least 32 random bytes, not a password!";
-let mut email_key = [0; 32];
-blake3::derive_key(EMAIL_CONTEXT, input_key_material, &mut email_key);
-let mut api_key = [0; 32];
-blake3::derive_key(API_CONTEXT, input_key_material, &mut api_key);
+let input_key_material = b"usually at least 32 random bytes, not a password";
+let email_key = blake3::derive_key(EMAIL_CONTEXT, input_key_material);
+let api_key = blake3::derive_key(API_CONTEXT, input_key_material);
assert!(email_key != api_key);
```
diff --git a/src/lib.rs b/src/lib.rs
index 0b40c3b..c3b1894 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -25,7 +25,7 @@
//! # }
//!
//! // Print a hash as hex.
-//! println!("{}", hash1.to_hex());
+//! println!("{}", hash1);
//! # Ok(())
//! # }
//! ```