/blake3.cr

Blake3 for Crystal

Primary LanguageAssemblyMIT LicenseMIT

BLAKE3

Crystal CI GitHub release GitHub commits since latest release (by date) for a branch Docs

Blake3 using the official BLAKE3 c implementation.

Features

  • Fast. ~2x faster than Sodium::Digest::Blake2b.
  • Uses Crystal's Digest API.
  • Keyed digests.
  • Key derivation.
  • Configurable final size.
  • Streaming final output.
  • Tested against official test vectors.
  • Builds a blake3 c static library.

Speed

examples/blake3_hash.cr is approximately the same speed as b3sum with 1 thread or mmap disabled.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  blake3:
    github: didactic-drunk/blake3.cr

  2. Run shards install

Usage

require "blake3"
digest = Digest::Blake3.new
digest.update data
p digest.final.hexstring
output_size = 1024
digest = Digest::Blake3.new(output_size)
digest.update data
p digest.final.hexstring => ...a.very.long.string...
digest = Digest::Blake3.new(key: "super secret exactly 32 byte key")
digest.update data
p digest.final.hexstring

For further API documentation see Crystal's Digest API

Contributing

  1. Fork it (https://github.com/didactic-drunk/blake3/fork)
  2. Install a formatting check git hook (ln -sf ../../scripts/git/pre-commit .git/hooks)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Contributors