package salsa20

  1. Overview
  2. Docs

Description

A pure OCaml implementation of Salsa20 encryption function family.

Installation

opam install salsa20

Usage

utop[0]> #require "nocrypto";;
utop[1]> #require "nocrypto.unix";;
utop[2]> Nocrypto_entropy_unix.initialize ();;
- : unit = ()
utop[3]> let key = Nocrypto.Rng.generate 32;;
val key : Cstruct.t = {Cstruct.buffer = <abstr>; off = 0; len = 32}
utop[4]> let nonce = Cstruct.create 8;;
val nonce : Cstruct.t = {Cstruct.buffer = <abstr>; off = 0; len = 8}
utop[5]> #require "salsa20";;
utop[6]> let state = Salsa20.create key nonce;;
val state : Salsa20.t = <abstr>
utop[7]> Salsa20.encrypt (Cstruct.of_string "My secret text") state |> Cstruct.to_string;;
- : string = " 2\193\020`\142\182\234\188H[R\241V"
  • Key can either 32 (recommended) or 16 bytes
  • Salsa20 state may use a different hashing function, the recommended Salsa20_core.salsa20_20_core is used by default.

Published: 30 Oct 2017

README

README.md

Salsa20 family of encryption functions, in pure OCaml

A pure OCaml implementation of Salsa20 encryption function family.

Installation

opam install salsa20

Usage

utop[0]> #require "nocrypto";;
utop[1]> #require "nocrypto.unix";;
utop[2]> Nocrypto_entropy_unix.initialize ();;
- : unit = ()
utop[3]> let key = Nocrypto.Rng.generate 32;;
val key : Cstruct.t = {Cstruct.buffer = <abstr>; off = 0; len = 32}
utop[4]> let nonce = Cstruct.create 8;;
val nonce : Cstruct.t = {Cstruct.buffer = <abstr>; off = 0; len = 8}
utop[5]> #require "salsa20";;
utop[6]> let state = Salsa20.create key nonce;;
val state : Salsa20.t = <abstr>
utop[7]> Salsa20.encrypt (Cstruct.of_string "My secret text") state |> Cstruct.to_string;;
- : string = " 2\193\020`\142\182\234\188H[R\241V"
  • Key can either 32 (recommended) or 16 bytes

  • Salsa20 state may use a different hashing function, the recommended Salsa20_core.salsa20_20_core is used by default.

Dependencies (7)

  1. salsa20-core >= "0.1.0" & < "1.0.0"
  2. nocrypto >= "0.5.3"
  3. cstruct >= "1.7.0"
  4. topkg build
  5. ocamlbuild build
  6. ocamlfind build
  7. ocaml >= "4.02.0"

Dev Dependencies (1)

  1. alcotest with-test

Used by

None

Conflicts

None