Panic on size being smaller than default about rust-multihash HOT 5 CLOSED

Thanks @mriise for a fix and @hummingly for being patient and explaining things in even more depths. It's funny that I even opened an issue about it and didn't recall.

from rust-multihash.

quick note for transparency, this was a bit more broken than this issue mentions, since the digest returned by blake3 was only 32 bytes, anything bigger would've been filled with 0s

...fun

from rust-multihash.

I don't think it would panic, but I might miss something.

So let's say S is 16 and digest_bytes.len() is 32. Then digest_bytes.len().max(S) would be 32.

So Blake3Hasher.finalize() makes sure that the returned value has at least S bytes, but maybe more. Then later, when the hash is used (that mostly happens in the multihash-derive crate), the result goes through Multihash::wrap(), which will error (not panic) in case the has is too long:

from rust-multihash.

My code looks like that where DIGEST_SIZE is 32 right now.

pub struct ContentHasher(Blake3Hasher<DIGEST_SIZE>);

impl ContentHasher {
    pub fn new() -> ContentHasher {
        ContentHasher(Blake3Hasher::default())
    }

    pub fn write(&mut self, input: &[u8]) {
        self.0.update(input);
    }

    pub fn finish(&mut self) -> ContentHash {
        let hash = multihash::Code::Blake3_256.wrap(self.0.finalize()).unwrap();
        hash.resize::<DIGEST_SIZE>().unwrap()
    }

    pub fn reset(&mut self) {
        self.0.reset();
    }
}

However, if I were to set it to something smaller than the default digest size (32), it will panic. The reason is an out of bounds indexing error due the array digest in the Blake3Hasher struct as I explained in the previous comment.

So Blake3Hasher.finalize() makes sure that the returned value has at least S bytes, but maybe more. Then later, when the hash is used (that mostly happens in the multihash-derive crate), the result goes through Multihash::wrap(), which will error (not panic) in case the has is too long:

It is the other way around. The length will always be S or smaller because Blake3Hasher.finalize() returns a slice to the array digest in Blake3Hasher.

Do you consider it a user error to use an S smaller than the default size of the hash?

from rust-multihash.

Blake3Hasher was originally intended to be flexible like this, but some implementation details had kept me away at the time but has since been fixed. see #130
The Code table being generic over Blake Digest sizes is still something to be solved, either through more proc macro magic or new const generic things.

from rust-multihash.