https://github.com/haskell-cryptography/cryptography-blake3-bindings

Vendored low-level bindings to BLAKE3 C implementation
https://github.com/haskell-cryptography/cryptography-blake3-bindings

blake3 cryptography haskell

Last synced: about 1 month ago
JSON representation

Vendored low-level bindings to BLAKE3 C implementation

• Host: GitHub
• URL: https://github.com/haskell-cryptography/cryptography-blake3-bindings
• Owner: haskell-cryptography
• License: bsd-3-clause
• Created: 2022-01-22T02:42:11.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-27T00:20:22.000Z (almost 3 years ago)
• Last Synced: 2024-03-25T21:15:07.425Z (9 months ago)
• Topics: blake3, cryptography, haskell
• Language: Assembly
• Size: 78.1 KB
• Stars: 7
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# `cryptography-blake3-bindings` [![CI](https://github.com/haskell-cryptography/cryptography-blake3-bindings/actions/workflows/ci.yml/badge.svg)](https://github.com/haskell-cryptography/cryptography-blake3-bindings/actions/workflows/ci.yml) [![made with Haskell](https://img.shields.io/badge/Made%20in-Haskell-%235e5086?logo=haskell&style=flat-square)](https://haskell.org)

## What is this?

A set of low-level bindings (and helpers) wrapping the [C implementation of

BLAKE3](https://github.com/BLAKE3-team/BLAKE3/tree/master/c), version 1.6.0.

## What're the goals of this project?

### Ease of use

No user of this library should ever have to think about C, linking to system

libraries, enabling SIMD through weird flags, or any similar issues. Just add

this as a dependency and go.

### Minimality

No weird lawless type class hierarchy. No dependencies outside of `base`. These

are truly minimal bindings, for those who want the ability to operate as close

to the original code as posssible.

### Stability and clarity

Just by reading the documentation of this library, you should know everything

you need to use it. No reading the C 'documentation' should ever be required.

Furthermore, you shouldn't need to doubt that this behaves - our CI should prove

it to you. No surprises on upgrades either - _impeccable_

[PVP](https://pvp.haskell.org) compliance only here.

## How do I use this?

```haskell

{-# LANGUAGE ScopedTypeVariables #-}

module Sample where

import Foreign.Marshal.Alloc (mallocBytes, free)

import Foreign.C.Types (CSize, CUChar)

import Foreign.Ptr (Ptr)

import Cryptography.BLAKE3.Bindings (

  blake3HasherSize,

  blake3OutLen,

  blake3HasherUpdate,

  blake3HasherFinalize

  )

hashMeSomeData :: IO (Ptr Word8)

hashMeSomeData = do

  -- allocate an initialize a hasher

  hasherPtr <- mallocBytes . fromIntegral $ blake3HasherSize

  blake3HasherInit hasherPtr

  -- get some data to hash (we assume this is done in some user-specific way)

  (dataLen :: CSize, dataPtr :: Ptr CUChar) <- mkSomeDataWithLength

  -- feed the data into the hasher

  blake3HasherUpdate hasherPtr dataPtr dataLen

  -- make a place to fit the hash into

  outPtr <- mallocBytes . fromIntegral $ blake3OutLen

  -- output the hash

  blake3HasherFinalize hasherPtr outPtr blake3OutLen

  -- deallocate the hasher, since we don't need it anymore

  free hasherPtr

  -- use the hash output however we please

```

## What does this run on?

Our CI currently checks Windows, Linux (on Ubuntu) and macOS. Additionally, we

also verify that the embedded BLAKE3 compiles correctly on SIMD and non-SIMD

platforms: we currently test x86-64 (Github Actions default), aarch64 and armv7.

## What can I do with this?

The bindings themselves are licensed under `BSD-3-Clause`, while the C code for

BLAKE3 is under `Apache-2.0`. See the `LICENSE` and `LICENSE.BLAKE3` files for

more information.