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