README 2.36 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
What is Nettle? A quote from the introduction in the Nettle Manual:

  Nettle is a cryptographic library that is designed to fit easily in more
  or less any context: In crypto toolkits for object-oriented languages
  (C++, Python, Pike, ...), in applications like LSH or GNUPG, or even in
  kernel space. In most contexts, you need more than the basic
  cryptographic algorithms, you also need some way to keep track of available
  algorithms, their properties and variants. You often have some algorithm
  selection process, often dictated by a protocol you want to implement.
  
  And as the requirements of applications differ in subtle and not so
  subtle ways, an API that fits one application well can be a pain to use
  in a different context. And that is why there are so many different
  cryptographic libraries around.
  
  Nettle tries to avoid this problem by doing one thing, the low-level
Niels Möller's avatar
Niels Möller committed
17
  crypto stuff, and providing a simple but general interface to it.
18 19 20 21
  In particular, Nettle doesn't do algorithm selection. It doesn't do
  memory allocation. It doesn't do any I/O.
  
  The idea is that one can build several application and context specific
Niels Möller's avatar
Niels Möller committed
22 23 24 25
  interfaces on top of Nettle, and share the code, test cases, benchmarks,
  documentation, etc. Examples are the Nettle module for the Pike
  language, and LSH, which both use an object-oriented abstraction on top
  of the library.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

Nettle is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation. See the file COPYING for details. Most, but not
all, of Nettle can also be used under the terms of the GNU Lesser
General Public License; please read the Copyright section of the
manual if you want to exercise this option.

Build nettle with the usual ./configure && make && make check && make
install. Read the manual. Mail me if you have any questions or
suggestions.

You can also build Nettle from cvs, using

  cvs -d :pserver:anonymous@cvs.lysator.liu.se:/cvsroot/lsh login
  [ empty password ]
  cvs -d :pserver:anonymous@cvs.lysator.liu.se:/cvsroot/lsh co nettle

If you get it from cvs, you need to build it with

  ./.bootstrap && ./configure && make && make check

You may want to subscribe to the nettle-bugs mailing list. See
<URL: http://lists.lysator.liu.se/mailman/listinfo/nettle-bugs>.


Happy hacking,
/Niels Möller <nisse@lysator.liu.se>