package.yaml

# SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io/>
#
# SPDX-License-Identifier: MPL-2.0

_common: !include "../hpack/package.yaml"

name: NaCl
<<: *version
synopsis: Easy-and-safe-to-use high-level Haskell bindings to NaCl
description: |
  This library uses <https://libsodium.org Sodium> under the hood,
  but only exposes the primitives that are part of the “classic” NaCl
  interface. We believe, it is better to be paranoid than sorry.

  __Note: this package is experimental and WIP.__

  Sodium is more portable, but some people prefer to stick to NaCl.
  We agree that it is better to be paranoid than sorry.
  That is why, even though this library uses
  Sodium under the hood, it only exposes the primitives that
  are part of the “classic” NaCl interface.

  Sodium provides useful algorithms, that are not part of NaCl,
  for example key derivation or random number generation.
  If you need them too (you probably do), you should use
  </package/crypto-sodium crypto-sodium> instead.

  = Public-key cryptography

    * Authenticated encryption: "NaCl.Box"
    * Scalar multiplication: "NaCl.Scalarmult"
    * Public-key signatures: "NaCl.Sign"

  = Secret-key cryptography

    * Authenticated encryption: "NaCl.Secretbox"
    * Unauthenticated streaming encryption: "NaCl.Stream"
    * Authentication: "NaCl.Auth"

  = Low-level functions

    * Hashing: "NaCl.Hash"
    * String comparison: "NaCl.Verify"

category: Cryptography

<<: *author

extra-doc-files:
  - CHANGELOG.md
  - README.md

<<: *defaults

library:
  source-dirs: lib

  dependencies: []

tests:
  test:
    <<: *test

    dependencies:
      - NaCl

      - hedgehog
      - HUnit
      - tasty
      - tasty-hedgehog
      - tasty-hunit

      - base16 >= 0.1.1 && < 0.4

    build-tools:
      - tasty-discover:tasty-discover