README 2.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
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.
  
11
  And as the requirements of applications differ in subtle and not so
12 13 14 15 16
  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

Niels Möller's avatar
Niels Möller committed
27 28 29
Nettle is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation. See the file COPYING.LIB for details.
30

Niels Möller's avatar
Niels Möller committed
31 32 33
If you have downloaded a Nettle release, build it with the usual
./configure && make && make check && make install (see the INSTALL
file for further instructions).
34

Niels Möller's avatar
Niels Möller committed
35 36 37 38 39 40
You can also get Nettle from git, see
http://www.lysator.liu.se/~nisse/nettle/ for current instructions. In
particular, you need to run the ./.bootstrap script after checkout and
before running ./configure.

Read the manual. Mail me if you have any questions or suggestions.
Niels Möller's avatar
Niels Möller committed
41

Niels Möller's avatar
Niels Möller committed
42 43 44 45
You may want to subscribe to the nettle-bugs mailing list. See
<URL: http://lists.lysator.liu.se/mailman/listinfo/nettle-bugs>.


46
Happy hacking,
Niels Möller's avatar
Niels Möller committed
47
/Niels Möller <nisse@lysator.liu.se>