Hackage :: [Package]

raaz: Fast and type safe cryptography.

[ codec, library, program, raaz ] [ Propose Tags ] [ Report a vulnerability ]

Raaz is a cryptographic library which provides the state of the art cryptographic primitives via a high-level, type safe interface. The default interface provided to the user is through the top level module Raaz. Rather than bothering the user with low-level details like the selection of primitives or entropy sources, this top level module only talks about the desired cryptographic operation (whether it is message digest or message encryption etc). A standalone application that needs cryptography should stick to using this top level interface.

Sometimes the selection of primitives is not in our hands --- we may need to interface with other programs written in other languages or using other libraries. For such situation, raaz exposes a primitive specific interface. As an example raaz exposes the Raaz.Digest.Sha256 module that gives the same interface as that of Raaz.Digest but uses sha256 as the underlying cryptographic hash.

[Skip to Readme]

library raaz

Modules

[Index] [Quick Jump]

  • Raaz
    • Raaz.Auth
      • Raaz.Auth.Blake2b
      • Raaz.Auth.Blake2s
    • Raaz.AuthEncrypt
      • Raaz.AuthEncrypt.Unsafe
        • Raaz.AuthEncrypt.Unsafe.ChaCha20Poly1305
        • Raaz.AuthEncrypt.Unsafe.XChaCha20Poly1305
    • Raaz.Core
    • Raaz.Digest
      • Raaz.Digest.Blake2b
      • Raaz.Digest.Blake2s
      • Raaz.Digest.Sha256
      • Raaz.Digest.Sha512
    • Raaz.Random
      • Raaz.Random.Internal

library raaz:bench-csprg

Modules

[Index] [Quick Jump]

  • Benchmark
    • Benchmark.CSPRG

library raaz:bench-prim

Modules

[Index] [Quick Jump]

  • Benchmark
    • Benchmark.Primitive

library raaz:bench-types

Modules

[Index] [Quick Jump]

  • Benchmark
    • Benchmark.Types

library raaz:test-auth-implementation

Modules

[Index] [Quick Jump]

  • Auth
    • Mac
      • Auth.Mac.Blake2b
      • Auth.Mac.Blake2s
    • Auth.Poly1305

library raaz:test-auth

Signatures

Modules

[Index] [Quick Jump]

  • Tests
    • Tests.Auth

library raaz:test-digest

Signatures

Modules

[Index] [Quick Jump]

  • Tests
    • Tests.Digest

library raaz:test-cipher

Modules

[Index] [Quick Jump]

  • Tests
    • Tests.Cipher

library raaz:test-core

Modules

[Index] [Quick Jump]

library raaz:implementation

Modules

[Index] [Quick Jump]

library raaz:aead-api

Signatures

  • Auth
    • Auth.Implementation
  • Cipher
    • Cipher.Implementation

Modules

[Index] [Quick Jump]

  • Interface

library raaz:encrypt-api

Signatures

Modules

[Index] [Quick Jump]

  • Interface

library raaz:random-api

Signatures

Modules

[Index] [Quick Jump]

  • Internal
  • PRGenerator

library raaz:auth-api

Signatures

Modules

[Index] [Quick Jump]

  • Interface

library raaz:digest-api

Signatures

Modules

[Index] [Quick Jump]

  • Interface

library raaz:xchacha-indef

Signatures

Modules

[Index] [Quick Jump]

library raaz:mac-indef

Signatures

Modules

[Index] [Quick Jump]

  • Mac
    • Mac.Implementation

library raaz:utils

Modules

[Index] [Quick Jump]

  • Utils

library raaz:buffer

Signatures

Modules

[Index] [Quick Jump]

  • Buffer
  • Context

library raaz:indef

Signatures

library raaz:libverse

Modules

[Index] [Quick Jump]

library raaz:core

Modules

[Index] [Quick Jump]

Flags

Manual Flags

NameDescriptionDefault
linux-getrandom

Use the getrandom for system entropy instead of devurandom. Enabled by default but disable this when building for kernel < 3.17.

Enabled
native

Compile for native architecture. Often this enables a lot of platform specific optimisation which lead to better performance. Do not enable this when packaging though. Also tested only with gcc

Disabled
wipe-memset

Use plain memset for wiping memory. The problem with its use is that agressive compilers often optimise it out. Raaz uses platform specific functions designed specifically to avoid this and hence enabling this flag is STRONGLY DISCOURAGED. Use it only if your platform does not support such a call.

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.0.1, 0.0.2, 0.1.0, 0.1.1, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.3.5, 0.3.6, 0.3.7, 0.3.8, 0.3.9, 0.3.10 (info)
Change log CHANGELOG.md
Dependencies base (>=4.11 && <4.21), bytestring (>=0.10 && <0.13), criterion-measurement (>=0.1 && <0.3), deepseq (>=1.4 && <1.6), hspec (>=2.10.6 && <2.12), HUnit (>=1.2 && <1.7), optparse-applicative (>=0.13.0.0 && <0.19), pretty (>=1.1.3 && <1.2), QuickCheck (>=2.4 && <2.16), raaz, vector (>=0.12 && <0.14) [details]
License (Apache-2.0 OR BSD-3-Clause)[multiple license files]
Copyright (c) 2012 Piyush P Kurur
Author Piyush P Kurur
Maintainer ppk@cse.iitk.ac.in
Category Codec, Raaz
Home page https://github.com/raaz-crypto/raaz
Bug tracker https://github.com/raaz-crypto/raaz/issues
Source repo head: git clone https://github.com/raaz-crypto/raaz
Uploaded by PiyushKurur at 2024-06-14T07:12:25Z
Distributions Debian:0.2.1, NixOS:0.3.10
Executables raaz
Downloads 5782 total (21 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for raaz-0.3.10

[back to package description]

Raaz: A secure cryptographic library

Apache-2.0 OR BSD-3-Clause Hackage Hackage Dependencies

Raaz is a cryptographic library in Haskell that provide a high level and safe access to a lot of cryptographic operations. The library can be used for standalone cryptographic applications as well as for implementing other network protocols. Some of the features that are unique to raaz are the following

  1. Pervasive use of types for better safety.
  2. Default choice of primitives and implementations are safe.
  3. Mechanism to have multiple implementations for any given cryptographic primitives. An advanced user who has an in-depth knowledge of the platform should be able to plugin the desired implementation.
  4. Strong emphasis on API design with through documentation.

Building

The recommended way to install raaz is through cabal-install version 3.0 or above. We also need a version of GHC that supports backpack (for details on which version of GHC is supported, refer to our CI-builds).

cabal build
cabal test
cabal install

Online documentation

About the name

The word Raaz (राज़) stands for secret in Hindi.

Copyright 2012 Piyush P Kurur

The library is licensed under

You may not use this software except in compliance with one of the above Licenses (at your option).

SPDX-License-Identifier: (Apache-2.0 OR BSD-3-Clause)

Unless required by applicable law or agreed to in writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. For the exact terms and conditions see the accompanying LICENSE file.