very first release
[libgcrypt.git] / README
1
2              G10 - The GNU Encryption and Signing Tool
3             ------------------------------------------
4
5
6     THIS IS VERSION IS ONLY A TEST VERSION !  YOU SHOULD NOT
7     USE IT FOR OTHER PURPOSES THAN EVALUATING THE CURRENT CODE.
8
9     * Only some parts work.
10
11     * The data format may change in the next version!
12
13     * Some features are not yet implemented
14
15
16     I provide this version as a reality check to start discussion.
17     Please subscribe to g10@net.lut.ac.uk by sending a mail with
18     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
19
20
21     See the file COPYING for copyright and warranty information.
22
23
24     Due to the fact that G10 does not use use any patented algorithm,
25     it cannot be compatible to old PGP versions, because those use
26     IDEA (which is worldwide patented) and RSA (which is patented in
27     the United States until Sep 20, 2000).  I'm sorry about this, but
28     this is the world we have created (e.g. by using proprietary software).
29
30
31     Because the OpenPGP standard is still a draft, G10 is not yet
32     compatible to it (or PGP 5) - but it will.  The data structures
33     used are compatible with PGP 2.x, so it can parse an list such files
34     and PGP should be able to parse data created by G10 and complain
35     about unsupported algorithms.
36
37     The default algorithms used by G10 are ElGamal for public-key
38     encryption and signing; Blowfish with a 160 bit key for protecting
39     the secret-key components, conventional and session encryption;
40     RIPE MD-160 to create message digest.  DSA, SHA-1 and CAST are
41     also implemented, but not used on default.  I decided not
42     to use DSA as default signing algorithm, because it allows only for
43     1024 bit keys and this may be not enough in a couple of years.
44
45
46     Resources
47     ---------
48     G10 needs a directory "~/.g10" to store the default keyrings
49     and other files.
50
51
52     Key Generation
53     --------------
54     Create a key pair with this command:
55
56         g10 --gen-key
57
58     This asks some questions and then starts key generation. To create
59     good random numbers for prime number generation, it uses a /dev/random
60     which will emit only bytes if the kernel can gather enough entropy.
61     If you see no progress, you should start some other activities such
62     as a mouse moves or a "find /".  Because we have no hardware device
63     to generate random we have to use this method.
64
65     Key generation shows progress by printing different characters to
66     stderr:
67              "."  Miller-Rabin test failed.
68              "+"  Miller-Rabin test succeeded.
69              "!"  Reloading the pool with fresh prime numbers
70              "^"  Checking a new value for the generator
71              "~"  Issued during generator checks
72              "<"  Size of one factor decreased
73              ">"  Size of one factor increased
74
75     The prime number for ElGamal is generated this way:
76
77     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
78     2) Select the length of the other prime factors to be at least the size
79        of q and calculate the number of prime factors needed
80     3) Make a pool of prime number, each of the length determined in step 2
81     4) Get a new permutation out of the pool or continue with step 3
82        if we have tested all permutations.
83     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
84     6) Check that this prime has the correct length (this may change q if
85        it seems not to be possible to make a prime of the desired length)
86     7) Check whether this is a prime using trial divisions and the
87        Miller-Rabin test.
88     8) Continue with step 4 if we did not find a prime in step 7.
89     9) Find a generator for that prime.
90
91
92     Signatures
93     ----------
94     To create a signature, use this:
95
96         g10 -s file
97
98     This creates a file file.g10 which is compressed and has a signature
99     attached.
100
101         g10 -sa file
102
103     Same as above, but file.g10 is ascii armored.
104
105         g10 -s -o out file
106
107     Creates a signature of file, but writes the output to the file "out".
108
109     Encryption
110     ----------
111     To encrypt data use this:
112
113         g10 -e -r heine file
114
115     This encrypts files with the public key of "heine" and writes it
116     to "file.g10"
117
118         echo "hallo" | g10 -ea -r heine | mail heine
119
120     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
121
122
123     Debug Flags
124     -----------
125     Use the option "--debug n" to output debug informations. This option
126     can be used multiple times, all values are ORed; n maybe prefixed with
127     0x to use hex-values.
128
129          value  used for
130          -----  ----------------------------------------------
131           1     packet reading/writing
132           2     MPI details
133           4     ciphers and primes (may reveal sensitive data)
134           8     iobuf filter functions
135           16    iobuf stuff
136           32    memory allocation stuff
137           64    caching
138           128   show memory statistics at exit
139
140
141
142     Other Notes
143     -----------
144     This is work in progress, so you may find duplicated code fragments,
145     ugly data structures, weird usage of filenames and other thinks.
146     I will run "indent" over the source when making a real distribution,
147     but for now I stick to my own formatting rules.
148
149     Compression does not work always; this is the reason that "-z 0"
150     is the default.
151
152     This will be cleaned up of course.
153
154     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
155     The primary WWW page is "http://www.d.shuttle.de/isil/g10.html"
156
157     Please direct bug reports to <g10-bugs@isil.d.shuttle.de> or better
158     post them to the mailing list <g10@net.lut.ac.uk>.
159
160     Have fun
161
162         Werner
163