use super::{Blake3Algorithm, DeriveKeyXof, ExtendableOutputFunction, KeyedXof};
use crate::error::{validate, Error, Result};
use crate::xof::XofAlgorithm;
use dcrypt_common::security::SecretBuffer;
use dcrypt_internal::zeroing::{
boxed_bytes_zeroed, Zeroize, ZeroizeOnDrop, Zeroizing, ZeroizingBytes,
};
#[cfg(not(feature = "std"))]
use alloc::{boxed::Box, vec};
const OUT_LEN: usize = 32; const KEY_LEN: usize = 32; const BLOCK_LEN: usize = 64; const CHUNK_LEN: usize = 1024;
type ProtectedChainingValue = Zeroizing<[u32; 8]>;
type ProtectedBlockWords = Zeroizing<[u32; 16]>;
const CHUNK_START: u32 = 1 << 0; const CHUNK_END: u32 = 1 << 1; const PARENT: u32 = 1 << 2; const ROOT: u32 = 1 << 3; const KEYED_HASH: u32 = 1 << 4; const DERIVE_KEY_CONTEXT: u32 = 1 << 5; const DERIVE_KEY_MATERIAL: u32 = 1 << 6;
const IV: [u32; 8] = [
0x6A09E667, 0xBB67AE85, 0x3C6EF372, 0xA54FF53A, 0x510E527F, 0x9B05688C, 0x1F83D9AB, 0x5BE0CD19,
];
const MSG_PERMUTATION: [usize; 16] = [2, 6, 3, 10, 7, 0, 4, 13, 1, 11, 12, 5, 9, 14, 15, 8];
fn words_from_little_endian_bytes(bytes: &[u8], words: &mut [u32]) {
debug_assert_eq!(bytes.len(), 4 * words.len());
for i in 0..words.len() {
let offset = i * 4;
words[i] = u32::from(bytes[offset])
| (u32::from(bytes[offset + 1]) << 8)
| (u32::from(bytes[offset + 2]) << 16)
| (u32::from(bytes[offset + 3]) << 24);
}
}
fn words_to_little_endian_bytes(words: &[u32], bytes: &mut [u8]) {
debug_assert_eq!(bytes.len(), 4 * words.len());
for i in 0..words.len() {
for byte in 0..4 {
bytes[i * 4 + byte] = (words[i] >> (byte * 8)) as u8;
}
}
}
#[inline(always)]
fn g(state: &mut [u32; 16], a: usize, b: usize, c: usize, d: usize, mx: u32, my: u32) {
state[a] = state[a].wrapping_add(state[b]).wrapping_add(mx);
state[d] = (state[d] ^ state[a]).rotate_right(16);
state[c] = state[c].wrapping_add(state[d]);
state[b] = (state[b] ^ state[c]).rotate_right(12);
state[a] = state[a].wrapping_add(state[b]).wrapping_add(my);
state[d] = (state[d] ^ state[a]).rotate_right(8);
state[c] = state[c].wrapping_add(state[d]);
state[b] = (state[b] ^ state[c]).rotate_right(7);
}
fn round(state: &mut [u32; 16], m: &[u32; 16]) {
g(state, 0, 4, 8, 12, m[0], m[1]);
g(state, 1, 5, 9, 13, m[2], m[3]);
g(state, 2, 6, 10, 14, m[4], m[5]);
g(state, 3, 7, 11, 15, m[6], m[7]);
g(state, 0, 5, 10, 15, m[8], m[9]);
g(state, 1, 6, 11, 12, m[10], m[11]);
g(state, 2, 7, 8, 13, m[12], m[13]);
g(state, 3, 4, 9, 14, m[14], m[15]);
}
fn permute(m: &mut [u32; 16]) {
let mut permuted = Zeroizing::new([0u32; 16]);
for i in 0..16 {
permuted[i] = m[MSG_PERMUTATION[i]];
}
m.copy_from_slice(&*permuted);
}
fn compress(
chaining_value: &[u32; 8],
block_words: &[u32; 16],
counter: u64,
block_len: u32,
flags: u32,
) -> ProtectedBlockWords {
let counter_low = counter as u32;
let counter_high = (counter >> 32) as u32;
let mut state = Zeroizing::new([
chaining_value[0],
chaining_value[1],
chaining_value[2],
chaining_value[3],
chaining_value[4],
chaining_value[5],
chaining_value[6],
chaining_value[7],
IV[0],
IV[1],
IV[2],
IV[3],
counter_low,
counter_high,
block_len,
flags,
]);
let mut block = Zeroizing::new(*block_words);
for r in 0..7 {
round(&mut state, &block);
if r < 6 {
permute(&mut block);
}
}
let mut output = Zeroizing::new([0u32; 16]);
for i in 0..8 {
output[i] = state[i] ^ state[i + 8];
}
for i in 0..8 {
output[i + 8] = state[i + 8] ^ chaining_value[i];
}
output
}
fn first_8_words(compression_output: &[u32; 16]) -> ProtectedChainingValue {
let mut result = Zeroizing::new([0u32; 8]);
result.copy_from_slice(&compression_output[0..8]);
result
}
#[derive(Clone)]
struct Output {
input_chaining_value: [u32; 8],
block_words: [u32; 16],
counter: u64,
block_len: u32,
flags: u32,
}
impl Zeroize for Output {
fn zeroize(&mut self) {
self.input_chaining_value.zeroize();
self.block_words.zeroize();
self.counter.zeroize();
self.block_len.zeroize();
self.flags.zeroize();
}
}
impl Drop for Output {
fn drop(&mut self) {
self.zeroize();
}
}
impl ZeroizeOnDrop for Output {}
impl Output {
fn chaining_value(&self) -> ProtectedChainingValue {
let compression_output = compress(
&self.input_chaining_value,
&self.block_words,
self.counter,
self.block_len,
self.flags,
);
first_8_words(&compression_output)
}
fn root_output_bytes(&self, out_slice: &mut [u8]) {
for (output_block_counter, out_block) in out_slice.chunks_mut(2 * OUT_LEN).enumerate() {
let words = compress(
&self.input_chaining_value,
&self.block_words,
output_block_counter as u64,
self.block_len,
self.flags | ROOT,
);
for (i, word) in words.iter().enumerate() {
let start = i * 4;
if start >= out_block.len() {
break;
}
let end = core::cmp::min((i + 1) * 4, out_block.len());
for (offset, byte) in out_block[start..end].iter_mut().enumerate() {
*byte = (word >> (offset * 8)) as u8;
}
}
}
}
}
#[derive(Clone)]
struct ChunkState {
chaining_value: [u32; 8],
chunk_counter: u64,
block: [u8; BLOCK_LEN],
block_len: u8,
blocks_compressed: u8,
flags: u32,
}
impl Zeroize for ChunkState {
fn zeroize(&mut self) {
self.chaining_value.zeroize();
self.chunk_counter.zeroize();
self.block.zeroize();
self.block_len.zeroize();
self.blocks_compressed.zeroize();
self.flags.zeroize();
}
}
impl Drop for ChunkState {
fn drop(&mut self) {
self.zeroize();
}
}
impl ZeroizeOnDrop for ChunkState {}
impl ChunkState {
fn new(key_words: &[u32; 8], chunk_counter: u64, flags: u32) -> Self {
let mut state = Self {
chaining_value: [0; 8],
chunk_counter,
block: [0; BLOCK_LEN],
block_len: 0,
blocks_compressed: 0,
flags,
};
state.chaining_value.copy_from_slice(key_words);
state
}
fn len(&self) -> usize {
(self.blocks_compressed as usize) * BLOCK_LEN + (self.block_len as usize)
}
fn start_flag(&self) -> u32 {
if self.blocks_compressed == 0 {
CHUNK_START
} else {
0
}
}
fn update_internal(&mut self, mut input: &[u8]) -> Result<()> {
if self.len() + input.len() > CHUNK_LEN {
let want = CHUNK_LEN - self.len();
self.update_internal(&input[..want])?;
return Ok(());
}
while !input.is_empty() {
if self.block_len as usize == BLOCK_LEN {
let mut block_words = Zeroizing::new([0u32; 16]);
words_from_little_endian_bytes(&self.block, &mut block_words[..]);
let compression_output = compress(
&self.chaining_value,
&block_words,
self.chunk_counter,
BLOCK_LEN as u32,
self.flags | self.start_flag(),
);
let chaining_value = first_8_words(&compression_output);
self.chaining_value.copy_from_slice(&*chaining_value);
self.blocks_compressed += 1;
self.block.zeroize();
self.block_len = 0;
}
let want = BLOCK_LEN - self.block_len as usize;
let take = core::cmp::min(want, input.len());
self.block[self.block_len as usize..self.block_len as usize + take]
.copy_from_slice(&input[..take]);
self.block_len += take as u8;
input = &input[take..];
}
Ok(())
}
#[cfg(test)]
pub fn update(&mut self, input: &[u8]) -> Result<()> {
self.update_internal(input)
}
fn output(&self) -> Output {
let mut block_words = Zeroizing::new([0u32; 16]);
words_from_little_endian_bytes(&self.block, &mut block_words[..]);
Output {
input_chaining_value: self.chaining_value,
block_words: *block_words,
counter: self.chunk_counter,
block_len: self.block_len as u32,
flags: self.flags | self.start_flag() | CHUNK_END,
}
}
}
fn parent_output(
left_child_cv: &[u32; 8],
right_child_cv: &[u32; 8],
key_words: &[u32; 8],
flags: u32,
) -> Output {
let mut block_words = Zeroizing::new([0u32; 16]);
block_words[..8].copy_from_slice(left_child_cv);
block_words[8..].copy_from_slice(right_child_cv);
let mut input_chaining_value = Zeroizing::new([0u32; 8]);
input_chaining_value.copy_from_slice(key_words);
Output {
input_chaining_value: *input_chaining_value,
block_words: *block_words,
counter: 0,
block_len: BLOCK_LEN as u32,
flags: PARENT | flags,
}
}
fn parent_cv(
left_child_cv: &[u32; 8],
right_child_cv: &[u32; 8],
key_words: &[u32; 8],
flags: u32,
) -> ProtectedChainingValue {
parent_output(left_child_cv, right_child_cv, key_words, flags).chaining_value()
}
#[derive(Clone)]
pub struct Blake3Xof {
chunk_state: ChunkState,
key_words: SecretBuffer<32>, cv_stack: Zeroizing<Box<[[u32; 8]]>>,
flags: u32,
}
impl Drop for Blake3Xof {
fn drop(&mut self) {
self.zeroize();
}
}
impl ZeroizeOnDrop for Blake3Xof {}
impl Zeroize for Blake3Xof {
fn zeroize(&mut self) {
self.chunk_state.zeroize();
self.key_words.zeroize();
self.cv_stack.zeroize();
self.flags = 0;
}
}
impl Blake3Xof {
fn get_key_words(&self) -> ProtectedChainingValue {
let mut words = Zeroizing::new([0u32; 8]);
let key_bytes = self.key_words.as_ref();
words_from_little_endian_bytes(key_bytes, &mut words[..]);
words
}
fn push_stack(&mut self, cv: ProtectedChainingValue) {
let current_len = self.cv_stack.len();
let mut replacement = Zeroizing::new(vec![[0u32; 8]; current_len + 1].into_boxed_slice());
replacement[..current_len].copy_from_slice(&self.cv_stack);
replacement[current_len].copy_from_slice(&*cv);
self.cv_stack = replacement;
}
fn pop_stack(&mut self) -> Result<ProtectedChainingValue> {
let current_len = self.cv_stack.len();
if current_len == 0 {
return Err(Error::Processing {
operation: "BLAKE3",
details: "Stack underflow",
});
}
let value = Zeroizing::new(self.cv_stack[current_len - 1]);
let mut replacement = Zeroizing::new(vec![[0u32; 8]; current_len - 1].into_boxed_slice());
replacement.copy_from_slice(&self.cv_stack[..current_len - 1]);
self.cv_stack = replacement;
Ok(value)
}
fn add_chunk_chaining_value(
&mut self,
mut new_cv: ProtectedChainingValue,
mut total_chunks: u64,
) -> Result<()> {
while total_chunks & 1 == 0 {
let left_cv = self.pop_stack()?;
let key_words = self.get_key_words();
new_cv = parent_cv(&left_cv, &new_cv, &key_words, self.flags);
total_chunks >>= 1;
}
self.push_stack(new_cv);
Ok(())
}
fn finalize(&mut self, out_slice: &mut [u8]) -> Result<()> {
let mut output = self.chunk_state.output();
let mut parent_nodes_remaining = self.cv_stack.len();
while parent_nodes_remaining > 0 {
parent_nodes_remaining -= 1;
let right_cv = output.chaining_value();
let key_words = self.get_key_words();
output = parent_output(
&self.cv_stack[parent_nodes_remaining],
&right_cv,
&key_words,
self.flags,
);
}
output.root_output_bytes(out_slice);
Ok(())
}
pub fn generate(data: &[u8], len: usize) -> Result<ZeroizingBytes> {
Blake3Algorithm::validate_output_length(len)?;
let mut xof = Self::new();
xof.update(data)?;
let mut result = Zeroizing::new(boxed_bytes_zeroed(len));
xof.squeeze(&mut result)?;
Ok(result)
}
}
impl ExtendableOutputFunction for Blake3Xof {
fn new() -> Self {
let mut key_bytes = Zeroizing::new([0u8; 32]);
words_to_little_endian_bytes(&IV, &mut key_bytes[..]);
Self {
chunk_state: ChunkState::new(&IV, 0, 0),
key_words: SecretBuffer::new(*key_bytes),
cv_stack: Zeroizing::new(Box::default()),
flags: 0,
}
}
fn update(&mut self, mut input: &[u8]) -> Result<()> {
while !input.is_empty() {
if self.chunk_state.len() == CHUNK_LEN {
let chunk_cv = self.chunk_state.output().chaining_value();
let total_chunks = self.chunk_state.chunk_counter + 1;
self.add_chunk_chaining_value(chunk_cv, total_chunks)?;
let key_words = self.get_key_words();
self.chunk_state = ChunkState::new(&key_words, total_chunks, self.flags);
}
let want = CHUNK_LEN - self.chunk_state.len();
let take = core::cmp::min(want, input.len());
self.chunk_state.update_internal(&input[..take])?;
input = &input[take..];
}
Ok(())
}
fn finalize(&mut self) -> Result<()> {
Ok(())
}
fn squeeze(&mut self, output: &mut [u8]) -> Result<()> {
Blake3Algorithm::validate_output_length(output.len())?;
self.finalize(output)
}
fn squeeze_into_vec(&mut self, len: usize) -> Result<ZeroizingBytes> {
Blake3Algorithm::validate_output_length(len)?;
let mut result = Zeroizing::new(boxed_bytes_zeroed(len));
self.squeeze(&mut result)?;
Ok(result)
}
fn reset(&mut self) -> Result<()> {
*self = Self::new();
Ok(())
}
fn security_level() -> usize {
Blake3Algorithm::SECURITY_LEVEL
}
}
impl KeyedXof for Blake3Xof {
fn with_key(key: &[u8]) -> Result<Self> {
validate::length("BLAKE3 key", key.len(), KEY_LEN)?;
let mut key_bytes = Zeroizing::new([0u8; KEY_LEN]);
key_bytes.copy_from_slice(key);
let key_buf = SecretBuffer::new(*key_bytes);
let mut key_words = Zeroizing::new([0u32; 8]);
words_from_little_endian_bytes(key, &mut key_words[..]);
let instance = Self {
chunk_state: ChunkState::new(&key_words, 0, KEYED_HASH),
key_words: key_buf,
cv_stack: Zeroizing::new(Box::default()),
flags: KEYED_HASH,
};
Ok(instance)
}
}
impl DeriveKeyXof for Blake3Xof {
fn for_derive_key(context: &[u8]) -> Result<Self> {
let mut context_hasher = Self::new();
context_hasher.update(context)?;
let mut context_key = Zeroizing::new([0u8; KEY_LEN]);
let mut output = context_hasher.chunk_state.output();
output.flags |= DERIVE_KEY_CONTEXT;
output.root_output_bytes(&mut *context_key);
let key_buf = SecretBuffer::new(*context_key);
let mut key_words = Zeroizing::new([0u32; 8]);
words_from_little_endian_bytes(context_key.as_ref(), &mut key_words[..]);
let instance = Self {
chunk_state: ChunkState::new(&key_words, 0, DERIVE_KEY_MATERIAL),
key_words: key_buf,
cv_stack: Zeroizing::new(Box::default()),
flags: DERIVE_KEY_MATERIAL,
};
Ok(instance)
}
}
#[cfg(test)]
mod tests;