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