started with trust stuff
[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
61
62
63     Resources
64     ---------
65     G10 needs a directory "~/.g10" to store the default keyrings
66     and other files.
67
68
69     Key Generation
70     --------------
71
72         g10 --gen-key
73
74     This asks some questions and then starts key generation. To create
75     good random numbers for prime number generation, it uses a /dev/random
76     which will emit only bytes if the kernel can gather enough entropy.
77     If you see no progress, you should start some other activities such
78     as mouse moves or a "find /".  Because we have no hardware device
79     to generate random we have to use this method.
80
81     Key generation shows progress by printing different characters to
82     stderr:
83              "."  Miller-Rabin test failed.
84              "+"  Miller-Rabin test succeeded.
85              "!"  Reloading the pool with fresh prime numbers
86              "^"  Checking a new value for the generator
87              "~"  Issued during generator checks
88              "<"  Size of one factor decreased
89              ">"  Size of one factor increased
90
91     The prime number for ElGamal is generated this way:
92
93     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
94     2) Select the length of the other prime factors to be at least the size
95        of q and calculate the number of prime factors needed
96     3) Make a pool of prime number, each of the length determined in step 2
97     4) Get a new permutation out of the pool or continue with step 3
98        if we have tested all permutations.
99     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
100     6) Check that this prime has the correct length (this may change q if
101        it seems not to be possible to make a prime of the desired length)
102     7) Check whether this is a prime using trial divisions and the
103        Miller-Rabin test.
104     8) Continue with step 4 if we did not find a prime in step 7.
105     9) Find a generator for that prime.
106
107
108     You can sign a key with this command:
109
110         g10 --sign-key Donald
111
112     To sign the key of of "Donald" with your default userid
113
114         g10 --sign-key -u Karl -u Joe Donald
115
116     To sign the key of of "Donald" with the userids of "Karl" and "Joe".
117     All existing signatures are checked, if some are invalid, a menu is
118     offered to delete some of them, and the you are asked for every user
119     wether you want to sign this key.
120
121     You may remove a signature at any time by usiing the option "--edit-sig",
122     which also asks for the sigs to remove.
123
124
125     Sign
126     ----
127
128         g10 -s file
129
130     This creates a file file.g10 which is compressed and has a signature
131     attached.
132
133         g10 -sa file
134
135     Same as above, but file.g10 is ascii armored.
136
137         g10 -s -o out file
138
139     Creates a signature of file, but writes the output to the file "out".
140
141
142     Encrypt
143     -------
144
145         g10 -e -r heine file
146
147     This encrypts files with the public key of "heine" and writes it
148     to "file.g10"
149
150         echo "hallo" | g10 -ea -r heine | mail heine
151
152     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
153
154
155     Sign and Encrypt
156     ----------------
157
158         g10 -se -r heine file
159
160     This encrypts files with the public key of "heine" and writes it
161     to "file.g10" after signing it with the default user id.
162
163
164         g10 -se -r heine -u Suttner file
165
166     Ditto, but sign the file with the user id "Suttner"
167
168
169
170     Examine a data or key file
171     --------------------------
172
173         g10 --list-packets datafile
174
175     Use this to list the contents of a data file. If the file is encrypted
176     you are asked for the passphrase, so that G10 is able to look at the
177     inner structure of a encrypted packet.
178
179
180     Batch mode
181     ----------
182     If you use the option "--batch", G10 runs in non-interactive mode and
183     never prompts for input data.  This even does not allow to enter
184     passphrase; until we have a better solution (something like ssh-agent),
185     you can use the option "--passhrase-fd n", which works like PGPs
186     PGPPASSFD.
187
188     Batch mode also causes PGP to terminate as soon as a BAD signature is
189     detected.
190
191
192     Exit status
193     -----------
194     G10 returns with an exit status of 1 if in batch mode and a bad signature
195     has been detected or 2 or higher for all other errors.  You should parse
196     stderr to get detailed informations about the errors.
197
198
199
200     Debug Flags
201     -----------
202     Use the option "--debug n" to output debug informations. This option
203     can be used multiple times, all values are ORed; n maybe prefixed with
204     0x to use hex-values.
205
206          value  used for
207          -----  ----------------------------------------------
208           1     packet reading/writing
209           2     MPI details
210           4     ciphers and primes (may reveal sensitive data)
211           8     iobuf filter functions
212           16    iobuf stuff
213           32    memory allocation stuff
214           64    caching
215           128   show memory statistics at exit
216
217
218
219     Other Notes
220     -----------
221     This is work in progress, so you may find duplicated code fragments,
222     ugly data structures, weird usage of filenames and other thinks.
223     I will run "indent" over the source when making a real distribution,
224     but for now I stick to my own formatting rules.
225
226     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
227     The primary WWW page is "http://www.d.shuttle.de/isil/g10.html"
228
229     Please direct bug reports to <g10-bugs@isil.d.shuttle.de> or better
230     post them to the mailing list <g10@net.lut.ac.uk>.
231
232