Debian Codegraph @

README

raw
1 Hi! :)
2 A short preamble: Gringotts is the name of the inviolable wizard bank in a
3 famous children book series, known in all the wizardry world for the truculent
4 fate that awaits all the wannabe robbers. I think it's a quite fitting name for
5 a program which purpose is to secure sensitive data, isn't it? :-)
6
7 libGringotts is a small, easy-to-use, thread-safe C library originally
8 developed for Gringotts; its purpose is to encapsulate data (generic: ASCII,
9 but also binary data) in an encrypted and compressed structure, to be written
10 in a file or used elseway. It makes use of strong encryption algorithms, to
11 ensure the data are as safe as possible, and allow the user to have the complete
12 control over all the algorithms used in the process.
13
14 For encryptions, libGringotts makes use of the MCrypt and MHash libs by
15 Nikos Mavroyanopoulos, two really powerful and easy to use C libraries.
16
17 Being Free Sofware, you're *encouraged* to take the code and do just
18 whatever you want with it... as long as you retain the original
19 copyright note, of course. Every contribution is more than welcome! Now
20 it's time to read INSTALL and the HTML manual!
21
22 Have a nice day, and thank you very much,
23
24 Mano :)
25
26 ------------------------------------------------------------------------
27
28
29 Features
30
31 This library aims to be as complete as possible, but with a stress on
32 lightness and simplicity. Currently it features:
33
34 * High stress on safety & security
35 * Any data sequence can be used as password and as data, in any
36 combination. You can use files as passwords, for example.
37 * Highly customizable & easy to use
38 * 8 encryption algorithms are available:
39 o The AES winner:
40 + RIJNDAEL-128
41 o AES finalists:
42 + SERPENT
43 + TWOFISH
44 o Other AES contestants:
45 + CAST 256
46 + SAFER+
47 + LOKI97
48 o Other strong algorithms:
49 + 3DES
50 + RIJNDAEL-256
51 * 2 160-bit hash algorithms, used to generate the key
52 o SHA1
53 o RIPEMD 160
54 * 2 compression types, with 4 compression levels each
55 o ZLib
56 o BZip2
57 * Encapsulated data can be left in memory, or written securely
58 to files, with a convenient and minimalistic API.
59 * Provides functions to write data to temporary files in a
60 totally secure way, with the same strong encryption of the
61 data files.
62 * pkg-config support
63 * it's easy to write a magic file for the GNU file utility
64
65 ------------------------------------------------------------------------
66 The authors
67
68 This library has been originally designed & written by Germano Rizzo
69 (aka Mano) (aka me :-) <[email protected]>
70
71 Nice patches and a major bugfix by James Antill <[email protected]>.
72
73 Good ideas from Marcin Gibula <[email protected]>.
74
75 File format 3 comes from a very interesting discussion with Bob Mathews
76 <[email protected]>.
77
78 ------------------------------------------------------------------------
79 Copyright notes
80
81 The "libGringotts" library itself is (c) (better, copyleft) 2002 by
82 Germano Rizzo <[email protected]>.
83
84 You can use, modify and redistribute them /as you wish/ (it's free
85 software! :), under the terms of the GNU General Public License
86 <http://www.gnu.org/copyleft/gpl.html>, v.2 or later.
87
88 My deepest thanks to the Free Software Foundation <http://www.fsf.org>
89 and the GNU project <http://www.gnu.org>for having created such a
90 wonderful concept!
91
92 Being quoted by Joanna K. Rowling's books, the very name Gringotts could
93 be (c), (r) or (tm) by her or someone in her behalf, altough I'm not aware
94 of it. In case I'm violating any law, just let me know.