1f2879c86473ff5aff0c0b9ffc1cf65f45bd0837
[gnupg.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     * The data format may change in the next version!
10
11     * Some features are not yet implemented
12
13
14     I provide this version as a reality check to start discussion.
15     Please subscribe to g10@net.lut.ac.uk by sending a mail with
16     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
17
18
19     See the file COPYING for copyright and warranty information.
20
21
22     Due to the fact that G10 does not use use any patented algorithm,
23     it cannot be compatible to old PGP versions, because those use
24     IDEA (which is worldwide patented) and RSA (which is patented in
25     the United States until Sep 20, 2000).  I'm sorry about this, but
26     this is the world we have created (e.g. by using proprietary software).
27
28
29     Because the OpenPGP standard is still a draft, G10 is not yet
30     compatible to it (or PGP 5) - but it will.  The data structures
31     used are compatible with PGP 2.x, so it can parse an list such files
32     and PGP should be able to parse data created by G10 and complain
33     about unsupported algorithms.
34
35     The default algorithms used by G10 are ElGamal for public-key
36     encryption and signing; Blowfish with a 160 bit key for protecting
37     the secret-key components, conventional and session encryption;
38     RIPE MD-160 to create message digest.  DSA, SHA-1 and CAST are
39     also implemented, but not used on default.  I decided not
40     to use DSA as default signing algorithm, because it allows only for
41     1024 bit keys and this may be not enough in a couple of years.
42
43
44
45     Installation
46     ------------
47
48     1)  "./configure"
49
50        to enable the integrated malloc debugging stuff, use:
51
52         "./configure --enable-m-debug"
53
54     2) "make"
55
56     3) "make install"
57
58     4) You end up with a binary "g10" in /usr/local/bin
59
60     5) create a directory ".g10" under your hoem directory ("mkdir ~/.g10")
61
62
63
64     Key Generation
65     --------------
66
67         g10 --gen-key
68
69     This asks some questions and then starts key generation. To create
70     good random numbers for prime number generation, it uses a /dev/random
71     which will emit only bytes if the kernel can gather enough entropy.
72     If you see no progress, you should start some other activities such
73     as mouse moves, "find /" or using the keyboard (on another window).
74     Because we have no hardware device to generate random we have to use
75     this method.
76
77     Key generation shows progress by printing different characters to
78     stderr:
79              "."  Miller-Rabin test failed.
80              "+"  Miller-Rabin test succeeded.
81              "!"  Reloading the pool with fresh prime numbers
82              "^"  Checking a new value for the generator
83              "~"  Issued during generator checks
84              "<"  Size of one factor decreased
85              ">"  Size of one factor increased
86
87     The prime number for ElGamal is generated this way:
88
89     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
90     2) Select the length of the other prime factors to be at least the size
91        of q and calculate the number of prime factors needed
92     3) Make a pool of prime number, each of the length determined in step 2
93     4) Get a new permutation out of the pool or continue with step 3
94        if we have tested all permutations.
95     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
96     6) Check that this prime has the correct length (this may change q if
97        it seems not to be possible to make a prime of the desired length)
98     7) Check whether this is a prime using trial divisions and the
99        Miller-Rabin test.
100     8) Continue with step 4 if we did not find a prime in step 7.
101     9) Find a generator for that prime.
102
103
104     You can sign a key with this command:
105
106         g10 --sign-key Donald
107
108     This let you sign the key of "Donald" with your default userid.
109
110         g10 --sign-key -u Karl -u Joe Donald
111
112     This let you sign the key of of "Donald" with the userids of "Karl"
113     and "Joe".
114     All existing signatures are checked, if some are invalid, a menu is
115     offered to delete some of them, and the you are asked for every user
116     wether you want to sign this key.
117
118     You may remove a signature at any time using the option "--edit-sig",
119     which asks for the sigs to remove.
120
121
122     Sign
123     ----
124
125         g10 -s file
126
127     This creates a file file.g10 which is compressed and has a signature
128     attached.
129
130         g10 -sa file
131
132     Same as above, but file.g10 is ascii armored.
133
134         g10 -s -o out file
135
136     Creates a signature of file, but writes the output to the file "out".
137
138
139     Encrypt
140     -------
141
142         g10 -e -r heine file
143
144     This encrypts files with the public key of "heine" and writes it
145     to "file.g10"
146
147         echo "hallo" | g10 -ea -r heine | mail heine
148
149     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
150
151
152     Sign and Encrypt
153     ----------------
154
155         g10 -se -r heine file
156
157     This encrypts files with the public key of "heine" and writes it
158     to "file.g10" after signing it with the default user id.
159
160
161         g10 -se -r heine -u Suttner file
162
163     Ditto, but sign the file with the user id "Suttner"
164
165
166     Batch mode
167     ----------
168     If you use the option "--batch", G10 runs in non-interactive mode and
169     never prompts for input data.  This even does not allow to enter
170     passphrase; until we have a better solution (something like ssh-agent),
171     you can use the option "--passhrase-fd n", which works like PGPs
172     PGPPASSFD.
173
174     Batch mode also causes G10 to terminate as soon as a BAD signature is
175     detected.
176
177
178     Exit status
179     -----------
180     G10 returns with an exit status of 1 if in batch mode and a bad signature
181     has been detected or 2 or higher for all other errors.  You should parse
182     stderr to get detailed informations about the errors.
183
184
185     Esoteric commands
186     -----------------
187
188         g10 --list-packets datafile
189
190     Use this to list the contents of a data file. If the file is encrypted
191     you are asked for the passphrase, so that G10 is able to look at the
192     inner structure of a encrypted packet.
193
194         --quick-random
195
196     Do not use the stroing random generator but a faster one.  This can be
197     used to generate keys for tests; those are marked as insecure.
198
199         --list-trustdb
200
201     List the contents of the trustdb in a human readable format
202
203         --list-trustdb  <usernames>
204
205     List the tree of certificates for the given usernames
206
207         --list-trust-path  depth  username
208
209     List the possible trust paths for the given username, up to the specified
210     depth.  If depth is negative, duplicate introducers are not listed,
211     because those would increase the trust probabilty only minimal.
212     (you must use the special option "--" to stop option parsing when
213      using a negative number)
214
215         --print-mds  filenames
216
217     List all available message digest values for the fiven filenames
218
219         --gen-prime n
220
221     Generate and print a simple prime number of size n
222
223         --gen-prime n q
224
225     Generate a prime number suitable for ElGamal signatures of size n with
226     a q as largest primefactor of n-1.
227
228         --gen-prime n q 1
229
230     Ditto, but calculate a generator too.
231
232
233     For more options/commands see the file g10/OPTIONS.
234
235
236     Debug Flags
237     -----------
238     Use the option "--debug n" to output debug informations. This option
239     can be used multiple times, all values are ORed; n maybe prefixed with
240     0x to use hex-values.
241
242          value  used for
243          -----  ----------------------------------------------
244           1     packet reading/writing
245           2     MPI details
246           4     ciphers and primes (may reveal sensitive data)
247           8     iobuf filter functions
248           16    iobuf stuff
249           32    memory allocation stuff
250           64    caching
251           128   show memory statistics at exit
252           256   trust verification stuff
253
254
255     Other Notes
256     -----------
257     This is work in progress, so you may find duplicated code fragments,
258     ugly data structures, weird usage of filenames and other thinks.
259     I will run "indent" over the source when making a real distribution,
260     but for now I stick to my own formatting rules.
261
262     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
263     The primary WWW page is "http://www.d.shuttle.de/isil/g10.html"
264
265     Please direct bug reports to <g10-bugs@isil.d.shuttle.de> or better
266     post them to the mailing list <g10@net.lut.ac.uk>.
267
268