Permalink
Browse files

Doc update, logo, Travis badge

  • Loading branch information...
jedisct1 committed Feb 6, 2017
1 parent 19657b2 commit 9d902424e7aa1daaf86808ca2a5a5c318437dac7
Showing with 39 additions and 22 deletions.
  1. +18 −14 LICENSE
  2. +21 −8 README.md
  3. BIN logo.png
32 LICENSE
@@ -1,14 +1,18 @@
Copyright (c) 2017, Frank Denis <j at pureftpd dot org>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
/*
* ISC License
*
* Copyright (c) 2017
* Frank Denis <j at pureftpd dot org>
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
@@ -1,11 +1,24 @@
libhydrogen
===========
[![Build Status](https://travis-ci.org/jedisct1/libhydrogen.svg?branch=master)](https://travis-ci.org/jedisct1/libhydrogen?branch=master)
The Hydrogen library is a small, easy-to-use, hard-to-misuse cryptographic
library for constrained environements.
![libhydrogen](https://raw.github.com/jedisct1/libhydrogen/master/logo.png)
==============
It provides a consistent high-level API for common operations, and the
whole code is licensed under the very liberal 2-clauses BSD license.
The Hydrogen library is a small, easy-to-use, hard-to-misuse cryptographic library for constrained environments.
This is a work in progress (mainly targeting Arduino boards for now) --
Do not use yet. It isn't supposed to work *at all*.
Features:
- Consistent high-level API, inspired by libsodium. Instead of low-level primitives, it exposes simple functions to solve common problems that cryptography can solve.
- Under the hood, it uses modern cryptographic primitives (BLAKE2X, SipHash, XChaCha20, X25519) and follows the current best practices.
- Small and easy to audit. Implemented as one tiny file for every set of operation, and adding a single `.c` file to your project is all it takes to use libhydrogen in your project.
- The whole code is released under a single, very liberal license (ISC).
- Zero dynamic memory allocations and low stack requirements. This makes it usable in constrained environments such as microcontrollers.
- Portable: written in standard C99. Supports Linux, *BSD, MacOS, Windows, and the Arduino IDE out of the box.
- Can generate cryptographically-secure random numbers, even on Arduino boards.
Non-goals:
- Having multiple primitives serving the same purpose, even to provide compatibility with other libraries.
- Networking (but a simple API to complete a NOISE-inspired key exchange may be added).
- Replacing libsodium. Libhydrogen focuses on being small.
Warning
-------
This is a work in progress -- Do not use yet.
BIN +17.8 KB logo.png
Binary file not shown.

0 comments on commit 9d90242

Please sign in to comment.