/[winpt]/trunk/Doc/winpt.texi
ViewVC logotype

Diff of /trunk/Doc/winpt.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 224 by twoaday, Sun Jun 4 10:13:20 2006 UTC revision 256 by twoaday, Sat Aug 5 10:31:06 2006 UTC
# Line 8  This file is free under the terms of the Line 8  This file is free under the terms of the
8    
9  Copyright (C) 2006 Timo Schulz  Copyright (C) 2006 Timo Schulz
10    
11  Version 0.0.0  Version 1.0.0
12    
13  @settitle WinPT - The Windows Privacy Tray; a free GPG front-end for Windows  @settitle WinPT - The Windows Privacy Tray; a free GPG front-end
14    
15  @section Requirements for WinPT  @section Requirements for WinPT
16    
17  First you need to have a working GnuPG 1.4 installtion on the machine you  First you need to have a working GnuPG 1.4 installtion on the machine you plan to install WinPT.
18  plan to install WinPT. If you don't have GPG in your machine, please  If you do not have GPG in your machine, please visit http://www.gnupg.org and download the latest
19  visit http://www.gnupg.org and download the latest GPG version there.  GPG version there. It comes with a graphical installer so there is no need to do the
20  It comes with a graphical installer so there is no need to do this  installation manually.
21  step manually.  
22    You need at least Windows 98/2K/XP, but Windows XP or better is recommend. The program also works
23  You need at least Windows 98/2K/XP, but Windows XP or better is  on NT/95/ME but there is no support for these OS versions any longer. Mainly because the OS
24  recommend. The program also works on NT/95/ME but there is no support  vendor also dropped support and no bug fixes will be provided any longer.
25  for these OS versions any longer.  And it is very likely that the program does not work optimal on such platforms.
26    
27  @section A short Introduction  @section A short Introduction
28  WinPT is a graphical GnuPG front-end which resides in the task bar.  
29  It is divided into several, so-called, managers. There is a manager  WinPT is a graphical GnuPG front-end which resides in the task bar. It is divided into several,
30  for the keyring, for files and for smart cards. The aim of the program  so-called, managers. There is a manager for the key(ring), for files and for smart cards.
31  is to secure email communication and to perform file encryption.  The aim of the program is to secure email communication and to perform file encryption and
32    to allow an easy and user friendly way for key management.
33    
34  @subsection What is GnuPG  @subsection What is GnuPG
35  GnuPG is a tool for secure communication and data storage.  GnuPG is a tool for secure communication and data storage. It can be used to encrypt data and
36  It can be used to encrypt data and to create digital signatures.  to create digital signatures. It includes an advanced key management facility and is compliant
 It includes an advanced key management facility and is compliant  
37  with the proposed Internet standard as described in RFC2440.  with the proposed Internet standard as described in RFC2440.
38    
39  @subsection The Web of Trust  @subsection The Web of Trust
40  For a detailled description of these and other GnuPG topics, I  For a detailled description of these and other GnuPG topics, I recommend the available literature
41  recommend the available literature at http://www.gnupg.org. But  at http://www.gnupg.org. But at least a general overview should be given here.
42  at least a general overview should be given here.  
43    The certification scheme of OpenPGP does not base on a hirachical approach. Instead it uses
44  The certification scheme of OpenPGP does not base on a hirachical  a combination of ownertrust and direct key certification.
45  approach. Instead it uses a combination of ownertrust and direct  Here is an example with the imaginary persons called Alice, Bob, Carol and Dave.
46  key certification. Here is an example with Alice, Bob, Carol and Dave.  
47    Alice knows Bob and checked the fingerprint of Bob's key when he met him personally.
48  Alice knows Bob and checked the fingerprint of Bob's key when he  Thus she knows that the key really belongs to its owner and he trusts Bob to certify other keys.
49  met him personally. Thus she knows that the key really belongs to  Then she issued a signature on Bob's key. Bob knows Carol and also checked her identity.
50  its owner and he trusts Bob to certify other keys. Then she issued  Then he signed her key. Alice does not know Carol, but he knows Bob and Bob trusts Carol.
51  a signature on Bob's key. Bob knows Carol and also checked her identity.  And because Alice trusts Bob, at a level she decided before, he also trusts Carol.
52  Then he signed her key. Alice does not know Carol, but he knows Bob  It's a transitiv relation. Dave is isolated and does not know anybody for the mentioned reasons,
53  and Bob trusts Carol. And because Alice trusts Bob, at a level she  thus he is not in the WoT. Another very important point is, that the signer can decide, after the
54  decided before, he also trusts Carol. It's a transitiv relation.  certification, how much he trusts the key owner to certify other keys.
55  Dave is isolated and does not know anybody from the mentioned persons,  
56  thus he is not in the WoT.  It is very important to check the identify of a key owner. Mostly this is done by comparing the
57  Another very important point is, that the signer can decide,  fingerprint, which were submitted by phone or written down at a personal meeting, with the
58  after the certification, how much he trusts the key owner to  fingerprint of the key in the keyring. Please bear in mind that anybody can create a key with an
59  certify other keys.  email address and a specific name.
60    Thus it is not recommend to sign keys without doing this check before!
61  It is very important to check the identify of a key owner. Mostly  
62  this is done by comparing the fingerprint, which were submitted  The fingerprint of the key is hexadecial (160-bit) sequence divided into 10 groups of 4 hex
63  by phone or written down at a personal meeting, with the fingerprint  digits. You can get the fingerprint of a key by opening the key property dialog. There you can
64  of the key in the keyring. Please bear in mind that anybody can create  mark the fingerprint and copy it to the clipboard. The fingerprint of a key can be compared
65  a key with an email address and a specific name. Thus it is not  to human fingerprints, it is unique for each key.
 recommend to sign keys without doing this check before!  
   
 The fingerprint of the key is hexadecial (160-bit) sequence divided  
 into 10 groups of 4 hex digits. You can get the fingerprint of a key  
 by opening the key property dialog. There you can mark the fingerprint  
 and copy it to the clipboard.  
66    
67  Example: 1D75 8108 5BC9 D9FB E78B  2078 ED46 81C9 BF3D F9B4  Example: 1D75 8108 5BC9 D9FB E78B  2078 ED46 81C9 BF3D F9B4
68    
69    It is a good idea to publish your fingerprint wherever possible.
70    For example via a business card or your website.
71    
72  @section Installation of the Program  @section Installation of the Program
73    
74  It is always recommend to use the latest version of the program. You  It is always recommend to use the latest version of the program. You can download it from
75  can download it from http://wald.intevation.org/projects/winpt.  http://wald.intevation.org/projects/winpt. Download the zip file with the binaries inside and
76  Download the zip file with the binaries inside and unpack them in  unpack them in a folder. All files need to be in the same folder, so if you change the folder do
77  a folder. All files need to be in the same folder, so if you change  not forget to move all files.
78  the folder don't forget to move all files.  You should also download and verify the signature of the packet to make sure that the release is
79  You should also download and verify the signature of the packet to  really authentic and were not altered in any way.
80  make sure that the release is really authentic.  
81    To activate the program you just need to start WinPT.exe. You should now see a
82  To activate the program you just need to start WinPT.exe. You should  little (golden key) icon in the taskbar which indicates that the program is running.
83  now see a little (golden key) icon in the taskbar which indicates that  If you want to quit the program, right click on the symbol and select "Exit".
84  the program is running. If you want to quit the program, right click  
85  on the symbol and select "Exit".  Alternative, you may use one of the graphical GPG installers which are available on the internet.
86    I recommend to use Gpg4Win which includes a set of very useful privacy tools, beside WinPT and it
87  Alternative, you may use one of the graphical GPG installers which  is very easy to use with an average size (~4MB). For non-German speaking users, I recommend the
88  are available on the internet. I recommend to use Gpg4Win which  light version because it does not contain the 2 German PDF manuals.
 includes a set of very useful privacy tools, beside WinPT and it  
 is very easy to use with an average size (~4MB). For non-German  
 speaking users, I recommend the light version because it does not  
 contain the 2 German PDF manuals.  
89    
90  @subsection Configure the Program  @subsection Configure the Program
91  After the installation not much of the default settings need to  After the installation not much of the default settings need to be changed. If you prefer a
92  be changed. If you prefer a special keyserver, it is propably a good  special keyserver, it is propably a good idea to open the keyserver dialog and to set one of the
93  idea to open the keyserver dialog and to set one of the existing  existing keyservers as the default or create a new entry and mark it as the new default.
94  keyservers as the default or create a new entry and mark it as the  The default keyserver is subkeys.pgp.net, which is the best choice for most users.
95  new default. The default keyserver is subkeys.pgp.net, which is  
96  the best choice for most users.  @subsection The GPG Preference Dialog
97    In this dialog you can change your GPG config and customize its behaviour. Please be advised that
98  @subsection GPG Options  in most cases there is no need to overwrite the default GPG path settings.
99  For expert users, the GPG preference dialog might contain some  There are three different paths available. First, the GPG home directory. The place where the
100  interesting options. For example to set the expiration date of  keyrings are stored and also the config files. The second path points directly to the gpg.exe.
101  a signature and/or to set the signing level for key signing.  The third is the path to the language files,
102  It also allows to set a default 'encrypt-to' key and to set  where you usually store your winpt.mo/gpg.mo files. These entries should be only changed when
103  the comment in ASCII armored files.  really need and extra caution is needed because with wrong settings, WinPT will not be able to
104    work any longer!
105    
106    The second part of the dialog is the "General GPG options" section. Here you can influence the
107    behaviour of some commands. If you do not know what they mean, it is safe not to change the
108    values and stick with the default ones.
109    For expert users, it is possible to set the signature class of issued key signatures and to set
110    an expiration date for key signatures or to specify an comment in armor files.
111    The "Encrypt to this key" might be useful for anybody who needs to decrypt mails or any data he
112    sent to a recipient. The field value should contain the key ID of the default key pair.
113    
114  @subsection Preferences  @subsection Preferences
115  In the WinPT preference dialog, the user can modify and/or disable  In the WinPT preference dialog, the user can modify and/or disable the default options. For new
116  the default options. For new users it is suggested to leave the  users it is suggested to leave the default values as they are, except when there are problems
117  default values as they are, except when there are problems related  related to the hotkeys.
118  to the hotkeys.  
119    To enable keyring backups, the user can either decide to use the GPG home directory as the backup
120  To enable keyring backups, the user can either decide to use the  folder or any other folder. In the latter case, a folder needs to be chosen.
121  GPG home directory as the backup folder or any other folder. In  
122  the latter case, a folder needs to be chosen.  @subsection Getting the Source of the Program
123    As free software, according to the GNU General Public License, WinPT also offers the source code
124    for the program. It can be used for reviews, to compile your own binary and/or to modify and/or
125    redistribute it or just to learn how it works. The source is available at the same place you
126    downloaded the binary. If not, you should contact the author of the site.
127    The entire program can be build with free software; the default environment is a cross-compiler
128    hosted on a Linux box. All you need is the mingw32 packages, a working autoconf environment
129    and the libs WinPT depends on (currently gpgme and libgpg-error).
130    It is also possible to build the binary with cygwin/mingw32 on Windows but this environment is
131    not actively supported and propably needs adjustment of the source.
132    
133    
134    @section Native Language Support
135    
136    The program has the ability to select different languages to provide dialogs and error messages
137    in the native language of the user. Currently German, Japanese, Portuguese (Brazil) and Slovak.
138    When WinPT has been installed via a graphical installer, for example Gpg4Win, the language was
139    automatically selected based on the locale Windows environment. If the stand-alone binary was
140    downloaded, WinPT offers at the first start to select a language, based on the .mo file it
141    founded in the current directory.
142    Otherwise the user needs to perform the following steps. The WinPT ZIP archive contains various
143    .mo files (de.mo, jp.mo, sk.mo) and the user needs to find his native language, if available and
144    rename the file to "winpt.mo". For example, if the user prefers German, "de.mo" -> "winpt.mo".
145    Now the user needs to save the locale dir, where the winpt.mo is stored, in the GPG preference dialog.
146    
147  @section The First Start  @section The First Start
 This section is only important for people who never installed  
 and/or used WinPT before.  
148    
149  When the program is started the first time, it offers two choices.  This section is only important for people who never installed and/or used WinPT before and thus
150  The one is to generate a key pair and the other is to copy  no keyrings are available.
151  existing GPG keyrings into the current installation.  
152    When the program is started the first time, it offers two choices. The one is to generate a key
153    pair and the other is to copy existing GPG keyrings into the current installation.
154    
155  We assume the user will select the first entry.  We assume the user will select the first entry.
156    
157  Now a new dialog is shown which requests some information from  Now a new dialog is shown which requests some information from the user to allow a meaningful
158  the user to allow a meaningful association between the key and  association between the key and the user. If the user prefer RSA keys, the check box should be
159  the user. If the user prefer RSA keys, the check box should be marked.  marked.
160  If the entered data is OK, WinPT then generates a new key pair. As long  But this is a decision of personal taste and does not influence the security or anything else.
161  as this step takes, a progress dialog is shown to indicate the  If the entered data is OK, WinPT then generates a new key pair. As long as this step takes, a
162  enduring process. When the generation of the keypair is done, WinPT  progress dialog is shown to indicate the enduring process. When the generation of the keypair is
163  offers the chance to backup the existing keyrings. This is definitely  done, WinPT offers the chance to backup the existing keyrings.
164  an important decision because if the keyring will get corrupted  This is definitely an important decision because if the keyring will get corrupted or lost, there
165  or lost, there is no way to recover the encrypted data. That is  is no way to recover the encrypted data. That is why it is also important to store the backup, at
166  why it is also important to store the backup, at least of the  least of the secret keyring, at a @strong{safe} place.
167  secret keyring, at a @strong{safe} place.  
168    @subsection Use existing Keyrings and/or Keys
169    If you already have a valid OpenPGP key pair and you do not want to generate a new key pair, you
170    should select the second choice at the first start. Then the program will copy your existing keyrings
171    to the new home directory. Please bear in mind that you need to set the ownertrust manually for each
172    imported key. You can skip this step if you exported the ownertrust manually to a file, but because
173    this is a step for experienced users it is not described here. The most important step is, to set
174    your own key to ultimate ownertrust after import.
175    
176    If you have other OpenPGP programs and you wish to use the keys from this application, it is a good
177    idea to select all keys you want to use and to export them into a single file. Then open the WinPT
178    Key Manager and drag the file into the Key Manager window.
179    
180    @section The Passphrase for the Secret Key
181    
182    First a short explaination what passphrase is. A passphrase is like a password but usually
183    longer, maybe a sentence, which can consists of any 7-bit ASCII characters. It is used to protect
184    your secret key and thus it is very import to chose a secure passphrase. If your computer, and
185    thus the secret key, were stolen and an attacker can guess your passphrase he is able to decrypt
186    all your data and to create signatures in your name! A good passphrase is difficult to guess but
187    easy to remember and should be at least 10 characters long.
188    An easy way to generate a strong passphrase is to use a sentence only you know but you can easily
189    remind and then take the first letter of each word, plus some special characters and maybe even
190    some intentionally made spelling mistakes.
191    
192    Example: Row - row - row your boat, gently down the stream
193    Passphrase: "R - r - ryb,gdts"
194    
195    Never write down or passphrase or share it among other people!
196    
197  @section Keyserver Access  @section Keyserver Access
 An easy way to retrieve keys is the keyserver. You can think of  
 it like a huge database with a lot of keys as its content. It is  
 possible to search keys by a pattern, a keyid or even a fingerprint.  
 WinPT allows to access different kind of keyservers. For example  
 LDAP, HKP, Finger and HTTP. But the focus will be set on HKP because  
 this is the common case.  
   
 In some situations WinPT asks the user whether to retrieve keys  
 automatically. One example is the signature verification when the  
 key that issued the signature was not found in the keyring.  
198    
199  The main keyserver dialog allows to fetch one or more keys directly  An easy way to retrieve keys is the keyserver. You can think of it like a huge database with a
200  or to search for a given pattern.  lot of keys as its content. It is possible to search keys by a pattern, a keyid or even a
201    fingerprint.
202    WinPT allows to access different kind of keyservers. For example LDAP, HKP, Finger and HTTP.
203    But the focus will be set on HKP because this is the common case.
204    
205    In some situations WinPT asks the user whether to retrieve keys automatically. One example is the
206    signature verification when the key that issued the signature was not found in the keyring.
207    
208    The main keyserver dialog allows to fetch one or more keys directly or to search for a given pattern.
209    
210  @subsection Retrieve a key by Key ID  @subsection Retrieve a key by Key ID
211  The best way to fetch a key from the server is by the key ID.  The best way to fetch a key from the server is by the key ID.
212  Just enter the key ID, it is always a good idea to prefix it  Just enter the key ID, it is a good idea to prefix it with 0x, and click the "Receive" button.
 with 0x and click the "Receive" button.  
213    
214  An example:  An example:
215    
# Line 170  pattern: 0xBF3DF9B4 Line 219  pattern: 0xBF3DF9B4
219    
220    
221  @subsection Retrieve a key by its email address  @subsection Retrieve a key by its email address
222  If you only know the email address from your partner, you can  If you only know the email address from your partner, you can enter it instead of the key ID.
223  enter it instead of the key ID. It is unlikely but possible  It is unlikely but possible that there are more keys with the same address. In this situation,
224  that there are more keys with the same address. In this situation,  WinPT will warn you that multiple keys were imported. The difference to the search function is,
225  WinPT will warn you that multiple keys were imported. The difference  that the keys were dirctly fetched and not displayed as a key result list.
 to the search function is, that the keys were dirctly fetched and  
 not displayed as a key result list.  
226    
227    
228  An example:  An example:
# Line 186  gmx.net Line 233  gmx.net
233    
234    
235  @subsection Search for a key by pattern  @subsection Search for a key by pattern
236  If you want to communicate with a new mail partner and you are  If you want to communicate with a new mail partner and you are not sure about the key ID, it can
237  not sure about the key ID, it can be useful to search for his  be useful to search for his email address. This address is considered as quite unique.
238  email address. This address is considered as quite unique.  Not all keyserver support this query mode, so if you get an error please use subkeys.pgp.net.
239    
240  An example:  An example:
241    
# Line 196  windows-privacy-tray.com Line 243  windows-privacy-tray.com
243    
244  [Search]  [Search]
245    
246  Now a dialog is opened with a list of all keys which matched  Now a dialog is opened with a list of all keys which matched the search string. If the name
247  the search string. If the name @strong{and} the email address  @strong{and} the email address is known, the matching key should be selected and "Receive"
248  is known, the matching key should be selected and "Receive"  should be clicked. Then the key will be downloaded and added to your keyring. Now you can encrypt
249  should be clicked. Then the key will be downloaded and added  data with this key, for example an email.
250  to your keyring. Now you can encrypt data with this key, for  
 example an email.  
251    
252  @subsection Sending a Key to the Keyserver  @subsection Sending a Key to the Keyserver
253  After you generated a new key pair, it is a good idea to send your  After you generated a new key pair, it is a good idea to send your key to the keyserver to make
254  key to the keyserver to make it available for other users. If you  it available for other users. If you issue a signature, the key ID is part of the signature and
255  issue a signature, the key ID is part of the signature and people can  people can  automatically retrieve your key when they try to verify the signature.
256  automatically retrieve your key when they try to verify the signature.  
257    Actually, the action is performed in the Key Manager and not in the keyserver dialog. Just open
258  Actually, the action is performed in the Key Manager and not in the  the Key Manager, select the key you want to send right-click on it and chose "Send to Keyserver"
259  keyserver dialog. Just open the Key Manager, select the key you want  in the popup menu. Then a message box with the result is shown.
 to send right-click on it and chose "Send to Keyserver" in the popup  
 menu. Then a message box with the result is shown.  
260    
261  @subsection Add, Delete or Edit a Keyserver Entry  @subsection Add, Delete or Edit a Keyserver Entry
262  The keyserver dialog allow to change the existing keyserver entries,  The keyserver dialog allow to change the existing keyserver entries, to delete them or to add new
263  to delete them or to add new entries. Just right click on a selected  entries. Just right click on a selected item and a popup menu will be
264  item and a popup menu will be shown with ("Edit", "Remove" and "New").  shown with ("Edit", "Remove" and "New").
265    
266  @section Using the Clipboard  @section Using the Clipboard
267  A major aim from the first day was, that the program does not  
268  depend on a special mailer client. For this reason it uses the  A major aim from the first day was, that the program does not depend on a special mailer client.
269  clipboard to encrypt and/or sign data.  For this reason it uses the clipboard to encrypt and/or sign data.
270  For the examples, let's assume that you want to write a new  For the examples, let's assume that you want to write a new mail or that you received a mail
271  mail or that you received a mail protected by GnuPG.  protected by GnuPG.
272    
273    @subsection The Clipboard Editor
274    This dialog allows it to modify the clipboard contents directly and/or to display the contents of
275    the clipboard. It is also possible to load a text file into the clipboard or store the contents
276    into a file. For the convenience, the dialog also allows to encrypt and/or decrypt clipboard data.
277    
278  @subsection Encrypt Data in the Clipboard  @subsection Encrypt Data in the Clipboard
279  Just copy the text from the mailer window into the clipboard.  Just copy the text from the mailer window into the clipboard. This is usually done by CTRL+C,
280  This is usually done by CTRL+C, make sure you really selected  make sure you really selected all portions of the text. Then right-click on the tray icon and
281  all portions of the text. Then right-click on the tray icon  select Clipboard->Encryption. Now a dialog is shown to select the recipients. This means you need
282  and select Clipboard->Encryption. Now a dialog is shown to  to select all keys which should be able to decrypt the mail. Confirm with "OK". GnuPG now
283  select the recipients. This means you need to select all  encrypts the data with the selected recipients. At the end a message box with the result is
284  keys which should be able to decrypt the mail. Confirm with "OK".  shown. Now the clipboard should  contain the encrypted data. Just paste it into the mailer window.
285  GnuPG now encrypts the data with the selected recipients. At the  The output should contain a header and a footer "BEGIN PGP MESSAGE" and "END PGP MESSAGE.
 end a message box with the result is shown. Now the clipboard should  
 contain the encrypted data. Just paste it into the mailer window.  
 The output should contain a header and a footer  
 "BEGIN PGP MESSAGE" and "END PGP MESSAGE.  
286    
287  @subsection Decrypt/Verify Data from the Clipboard  @subsection Decrypt/Verify Data from the Clipboard
288    The most common case is propably that you got a signed email and now you want to verify it. For
289    this procedure, you have to copy the entire signature in the clipboard. The easiest way is to
290    use CTRL+A and CTRL+C, then all available text will be copied. WinPT (GnuPG) is smart enough to
291    figure out the signature related data. Now go to the taskbar, display the popup menu and select
292    Clipboard->Decrypt/Verify. Now a new dialog, the verify dialog, should be available on screen
293    with all information about the signature. For example who is the signer, when was it signed how
294    much do you try this key and what was signed and most important, the status of it (is the
295    signature good or BAD).
296    A special case is when you don't have the public key to verify the signature, if this happens
297    WinPT offers to download the key from the default keyserver. If the key was not found, the
298    procedure is aborted because without the key the sig cannot bed checked.
299    
300  @subsection Sign the Clipboard  @subsection Sign the Clipboard
301    We assume that text that shall be signed is already in the clipboard. If not, select the text you
302    want to sign and copy with via CTRL+C in the clipboard. Now go to the taskbar and open the peopup
303    menu, Clipboard->Sign. If you just have one secret key, the passphrase dialog will be automatically shown.
304    All you need is to enter your passphrase and confirm. In case of more available secret keys, a
305    list with all keys is shown and you can select which key shall be used for signing.
306    The output is always a cleartext signature which is in text format. Do not try to sign binary
307    clipboard data, the result would be unpredictable and not readable by human beings.
308    
309    @section The Current Window Support
310    Compared to the clipboard mode, the CWS mode has some advantages. Let us assume that you want to
311    extract text from an editor window. With the CWS mode, the program automatically tries to focus
312    the window to select the text and to copy it to the clipboard and execute the
313    selected command (Sign, Encrypt, Decrypt) and pastes back the GPG data to the window.
314    No manual user interaction is needed. Except this different behaviour, it is very likewise to the
315    clipboard mode and thus we do not describe each command again.
316    
317  @section The Key Manager  @section The Key Manager
318  This part of the program is propably most important for many users.  
319  It contains function to manage your keyring and to perform actions  This part of the program is propably most important for many users. It contains function to
320  which are required and/or useful in the OpenPGP environment.  manage your keyring and to perform actions which are required and/or useful in the OpenPGP environment.
321    
322  @subsection Tips  @subsection Tips
323    
324  @itemize @bullet  @itemize @bullet
325    
326  @item  @item
327  If you want to import quickly a key from a into the keyring, just  If you want to import quickly a key from a into the keyring, just drag and drop the file into the
328  drag and drop the file into the Key Manager window. Then the import  Key Manager window. Then the import procedure will be automatically started.
 procedure will be automatically started.  
329    
330  @item  @item
331  Key which were fetched from keyservers often contain a lot of,  Key which were fetched from keyservers often contain a lot of, maybe obsolete, self signatures,
332  maybe obsolete, self signatures, if you want to get rid of them  if you want to get rid of them you can use the Key Edit->Clean feature. Just start the edit
 you can use the Key Edit->Clean feature. Just start the edit  
333  dialog and select the clean command. That's it.  dialog and select the clean command. That's it.
334    
335  @item  @item
336  The keyserver dialog does not allow to import a key directly  The keyserver dialog does not allow to import a key directly via an URL, as an alternative you
337  via an URL, as an alternative you may use the "Import HTTP..."  may use the "Import HTTP..." feature in the Key Manager. With it you can directly fetch keys
 feature in the Key Manager. With it you can directly fetch keys  
338  from the web (Example: http://www.users.my-isp.de/~joe/gpg-keys.asc).  from the web (Example: http://www.users.my-isp.de/~joe/gpg-keys.asc).
339    
340  @item  @item
341  To customize the parameters of the generated key, you can use  To customize the parameters of the generated key, you can use the expert key generation.
342  the expert key generation. It allows you to set the public key  It allows you to set the public key algorithm and/or the size of the key directly.
343  algorithm and/or the size of the key directly.  
344    @item
345    Most of the list view based dialogs allow to use the right mouse button, to show popup menus with
346    available commands.
347    
348  @end itemize  @end itemize
349    
350  @subsection Adding a new secondary key  @subsection Create a Revocation Certificate
351    It is very important to do this step early as possible. With this certificate, you can revoke
352    your entire key. The reason for this can be for example, that your key is no longer used or even
353    compromised.
354    After you generated the revocation cert, you should move it to a secure place because anybody who
355    gets access to it, can render your key unuseable.
356    
357    Just right-click on your key and select "Revoke Cert". If you do this step directly after key
358    generation, there is no need to change the default values. Just select a file name and enter the
359    passphrase. The program issues a warning which should be read carefully.
360    
361    @subsection Adding a new Secondary Key
362    
363  For most users the existing keys in the key pair are enough  For most users the existing keys in the key pair are enough and no extra key is needed. But there
364  and no extra key is needed. But there are some exceptions.  are some exceptions.
365    
366  @itemize @bullet  @itemize @bullet
367    
368  @item  @item
369  The primary key has no secondary key and the primary key is not  The primary key has no secondary key and the primary key is not able to encrypt data. In this
370  able to encrypt data. In this case it can be a good idea to  case it can be a good idea to add a secondary encryption key.
 add a secondary encryption key.  
371    
372  @item  @item
373  A lot of people use secondary encryption keys with an expiration  A lot of people use secondary encryption keys with an expiration date. Usually the key is valid
374  date. Usually the key is valid for 1-2 years. After the key is expired,  for 1-2 years. After the key is expired, a new key is needed in order to encrypt data.
 a new key is needed in order to encrypt data.  
375    
376  @end itemize  @end itemize
377    
378  What kind of public key algorithm should be selected is a matter  What kind of public key algorithm should be selected is a matter of taste. RSA and ElGamal are
379  of taste. RSA and ElGamal are both capable for encryption. For most  both capable for encryption. For most users it's a good idea to let the program chose the key
380  users it's a good idea to let the program chose the key size (in bits).  size (in bits). The default settings should be secure enough for most purposes.
381  The default settings should be secure enough for most purposes.  
382    @subsection Adding a new User ID
383  @subsection Adding a new user ID  If you got a new email account, it's propably a good idea to add these new account to your key
384  If you got a new email account, it's propably a good idea to  also. For example:
 add these new account to your key also. For example:  
385    
386  A new account was registed at gmail.com (john.doo@@gmail.com).  A new account was registed at gmail.com (john.doo@@gmail.com).
387  Then you should create a new user ID with the following fields:  Then you should create a new user ID with the following fields:
388    
389  name: John Doo  name: John Doo
# Line 313  gmail.com Line 392  gmail.com
392    
393  comment: (optional)  comment: (optional)
394    
395  Now email programs are able to associate this address with your  Now email programs are able to associate this address with your key when somebody wants to send
396  key when somebody wants to send you a protected mail to this account.  you a protected mail to this account.
397    
398    @subsection Adding a new Photographic ID
399    With this function you can add a photo to your public. It will be displayed in the key property
400    dialog.
401    
402    You just need to select a JPEG file which contains the photo and enter your passphrase and
403    confirm with OK. Please read the note in the dialog carefully to make sure the photo has a proper
404    size (file, height and weight).
405    
406    @subsection Adding a new Designated Revoker
407    If you want to allow another key to revoke your own key, this might be useful if you lost your
408    secret or a simliar situation, you can use this function to add a designated revoker to your key.
409    
410    All you need to do is to select the key you want to add as a desig revoker. But please bear in
411    mind that this procedure cannot be undone and that this person really has the power to make your
412    public key unuseable. You really should trust the selected key, in case it is not a key owned by yourself.
413    
414    @subsection Export a Public Key
415    There are several reason why to export a public key and there are also several ways to do it. If
416    you want to send the key directly to a mail recipient, you can select the key, right-click,
417    and select "Send Key to Mail Recipient". As an alternative, you can also export it to the
418    clipboard or to a file. To export a key to the clipboard, you can select "Copy key to Clipboard"
419    in the popup menu of the selected key. To export it to a file, you need to select the menu "Key"
420    and then "Export...". The program will automatically suggest a name for the output.
421    
422    @subsection Export your Secret Key
423    This command should be used with caution because it exports your secret key. Please bear in mind
424    that you should never export your key to a place where it can be accessed by others.
425    An USB stick or a likewise mobile storage device should be used for the export.
426    
427    @subsection Import a Public Key
428    Similar to the key import, the import of a key can be done in several ways. First, let's assume
429    you got a mail with an OpenPGP key included as inline text. Then you can use the current window
430    feature and "Decrypt/Verify" to import the key. Alternative you also may use the clipboard.
431    To achieve this, you first need to select the entire key (CTRL+A) and then copy it to the
432    clipboard (CTRL+C), then use the Key Manager (Edit->Paste) to import it. If the key is stored as
433    an attachment, or you want to import a key from a file in general, just drag the file and drop it
434    into the Key Manager window or use "Key" -> "Import...".
435    
436    @subsection Sign a Public Key
437    If you verified that a key really belongs to its owner, you should sign the key to integrate it
438    into your Web of Trust and also to mark the key as valid in your keyring. Do not sign a key you
439    just got via email with the request to sign it. Anybody can create a key with your (or better ANY) name,
440    these information are no hint to whom the key really belongs. You can check a key
441    by meeting or calling the key owner and verify the key fingerprint of the key with the one
442    published by the key owner. Additional checks should be to watch at his driver license or the
443    identity card to make sure that name of the key matches the name of the key owner. After this
444    procedure is done, you can open the Key Manager, select the right key and either use the context
445    menu "Sign Key" or use the toolbar button.
446    
447    The next dialog will summarize the key information and some additional options. For example if
448    the signature should be local or exportable. Local means the signature will be stripped if you
449    export the key and no one else except you can use it to calculate the validity. If you mark the
450    signature exportable, any other user can see and use it. Now you can select the key you want to
451    use to sign and enter the passphrase. Confirm with "OK" and the key will be signed.  Now the validity
452    of the new key is "Full". It is propably a good idea to set the ownertrust of the key.
453    For a detailled description, see the chapter "Key Ownertrust".
454    
455    @subsection Key Ownertrust
456    First we should explain what the ownertrust of a key is. The ownertrust is a measurement how much
457    you trust somebody to certify and check keys of other people. For example, if you know that Bob
458    is really the owner of the key, you should sign it. But he is also known to sign other keys
459    without checking the idenity of the other key owner. Values for the ownertrust are
460    1) Don't Know 2) Don't Trust 3) Marginal 4) Full
461    and thus you should propably use an ownertrust value like "Marginal". But this is a personal
462    decision and stored in a separate file and never exported with the public keys. For further
463    information, please take a look into the GNU Privacy Handbook.
464    Just a last work on Key Pairs, they are automatically marked as "Ultimate" because the key
465    belongs to you and you trust it implicit.
466    
467    @subsection List Signatures
468    This dialog contains a list of all signatures of the selected key. The basic dialog, the tree
469    based version, just shows signatures when the issuer key is in the public keyring. A double click
470    opens the signature property dialog which contains detailled description about the selected
471    signature. A dialog which is useful for people who wants to get all information about the key
472    signatures, can click on the "Edit.." button.
473    
474    @subsection Copy Key Information to the Clipboard
475    Often it is useful to copy parts of the user ID to the clipboard. One example is that you want to
476    send an email to the key owner or that you want to search the key by the email address or you
477    want to copy the fingerprint to the clipboard to paste it somewhere else.
478    This command is available in the popup menu (right click).
479    
480    @subsection Delete one or more Keys
481    To delete a key, or more than one key, you just need to select the keys in the Key Manager and
482    either select "Delete" or use the toolbar button.
483    Be careful if you delete a key pair, because you will not be able to decrypt and/or sign data any
484    longer. In any case you should have a backup of your key pair at a safe place.
485    
486    @subsection Re-verify Signatures
487    After you refreshed or imported a lot of new keys, either from a file or the keyserver, it is a
488    good idea to re-verify the signature in the keyring. This speeds up listing operations.
489    
490    @subsection WinPT Website
491    If you want to check for updates or general information about the Windows Privacy Tray program,
492    you can select this menu item.
493    The WWW webite of WinPT will be loaded in the default browser.
494    If you want to visit the project website directly, select the "Project Website" entry.
495    
496    @subsection The Key Edit Dialog
497    For the average GPG user, the popup menu of the Key Manager contains all command to manage your
498    keys. For example to add a key/userid/revoker/photo, just right click on the click and select the
499    command from the "Add" submenu.
500    But for advanced users, this dialog contain a lot of extra commands to customize your key.
501    
502    The main dialog contains a list of all keys in the first list view box and all user IDs in the
503    second list view box. The help button gives you a short hint about each command and what it does.
504    For example you can set the primary user ID via the "primary" command or with "deluid" you can
505    delete the selected user ID. Please always bear in mind, that most keyserver are not able to
506    remove user IDs in its database so if another user fetch your 'updated' key from the keyserver
507    the user ID might be still part of the key. If you want to make an user ID unuseable, you should
508    revoke it. This is also possible with this dialog.
509    
510    @subsection Update your Preferences in the Key Manager
511    To avoid that the user needs detour to select the taskbar icon, click on it, etc., all
512    preferences can be changed in the Key Manager via the Edit->Preferences... menu.
513    
514    @section The File Manager
515    
516    @subsection Introduction
517    The File Manager is no replacement for an Explorer Extension. If you secure your files frequently
518    and you want to do this fast and easy, I suggest to install GPGee. It is a program which
519    integrates itself into the explorer and provide menu entries in the context menu of files and
520    directory. But the File Manager can be very useful if you just want to decrypt and/or encrypt
521    some files without additional programs. You can find the File Manager via the symbol in the
522    taskbar, right click and then "File Manager".
523    
524    @subsection An Overview of the GUI
525    First there are different ways to add (open) files in the Key Manager. The easiest way is to use
526    drag and drop to add files into the File Manager. Just drag a file from the explorer and drop it
527    into the File Manager window. The second way is to use File->Open. A dialog opens which is common
528    for all "File Open" operations in most Windows application. Now you can select one or more files
529    and confirm. The files will be automatically added to the File Manager window. The main window
530    consists of a listview with three rows.
531    
532    The first row is the status of the file. It can be "ENCRYPTED", "SIGNED", "PUBKEY", "SECKEY",
533    "SIG" or "UNKNOWN". Dependent on the file status, the File Manager offers different choices.
534    For example "SIG" enables the verify options in the (popup) menu. "UNKNOWN" is the default for
535    all plaintext files.
536    The second row is the file name. And the last row is the status of the operation. It can be
537    either "", "SUCCESS" or "FAILED". An empty status means no operation was started yet. FAILED
538    indicates that the  GnuPG operation failed. In this case an error message was issued before.
539    
540    Now it follows an example:
541    We assume that user wants to encrypt "c:\My Ideas\GPG GUI.txt". Drag the file from the Explorer
542    and drop it into the open File Manager, the main window. The file will be added and recognized
543    as "UNKNOWN". Now we select the file and right click, a popup menu is shown and we select
544    "Encrypt". An new dialog is opened which looks similar to the Clipboard Encryption dialog.
545    Just select the recipients and confirm. In contrast to clipboard encryption, file encryption
546    offers some more extra options. They are described later. And hour glass will be shown as long as
547    GnuPG takes to encrypt the file. When the procedure is done, the third row should be change
548    to "SUCCESS" and the first row to "ENCRYPTED".
549    
550    @subsection General Options
551    Now we describe the general options which are possible in some File Manager dialogs.
552    
553    @itemize
554    
555    @item Text Output
556    When this option is checked, the output will be encoded in ASCII armor. This can be useful if the
557    file should be transfered via email. The size of the output file is larger than the usual binary
558    output.
559    
560    @item Wipe Original
561    If this option is checked, the original file will be deleted after successfull encryption.
562    This can be useful if data should not be available in plaintext any longer on a machine.
563    
564    @end itemize
565    
566    
567    @section A short Note about Cryptographic Issues
568    
569  @subsection Adding a photographic ID  WinPT itself does not perform any real encryption, signing or decryption. Instead it uses
570  With this function you can add a photo to your public. It will be  GPG as the backend program which provides all kind of cryptographic code to perform the
571  displayed in the key property dialog.  needed operations.
572    
573  You just need to select a JPEG file which contains the photo and  The default values WinPT uses for key sizes, should be sufficient for personal and commercial
574  enter your passphrase and confirm with OK. Please read the note  security for the next years. If you are concerned about the default values, you can always use
575  in the dialog carefully to make sure the photo has a proper size  the expert key generation to make your own decision. GPG also provides
576  (file, height and weight).  default values for symmetric cipher preferences. By default, the AES (Advanced Encryption Standard)
577    is used which provides a very good security. You can manually modify your key preferences, this
578  @subsection Adding a new designated revoker  includes cipher, hash, and compression but usually this is not necessary and also can do harm if
579  If you want to allow another key to revoke your own key, this  you use algorithms which are not very widespread among other OpenPGP programs.
580  might be useful if you lost your secret or a simliar situation,  
581  you can use this function to add a designated revoker to your key.  @section WinPT and Personal Firewalls
582    
583  All you need to do is to select the key you want to add as a desig  Because the program uses a global hook to remember the last active current window, it might be
584  revoker. But please bear in mind that this procedure cannot be undone  possible that Firewalls warn that the process contains a global hook which is a potential
585  and that this person really has the power to make your public key  security risk. In some cases, there might be even a warning that key logging is possible.
586  unuseable. You really should trust the selected key, in case it is  This is a false alarm because the hook provided by the program, a CTB (Computer Based Training)
587  not a key owned by yourself.  hook, can be only used to save handles of newly created windows, or windows which are
588    activated or in case of a focus change. Details can be found in the source code of the program
589    or additional information about the CTB hook at msdn.microsoft.com
590    
591    To provide access to keyservers and to download HTTP keys, the program
592    needs to be able to make outbound connections to the following ports: 80 (http), 11371 (keyserver)
593    
594    @subsection Using a HTTP Proxy
595    If you are behind a firewall and you have no chance make a connection to a keyserver, maybe
596    because of a policy, you can use a http proxy for outbound connections. Open the Keyserver dialog
597    and click on the button "Change Proxy". A new dialog opens where you can enter the proxy specific
598    host name and ports. If the proxy requires authentication, you also have to provide your user name
599    and your password. Please bear in mind that only a base64 authentication is supported and no other
600    proxy types (SOCKS for example) can be used.
601    
602    
603    @section Reporting a Problem (Bug) or a Feature Request
604    
605    For the case that you have problems with the program, that includes crashes or or the handling,
606    please first check the forum at http://wald.intevation.org to see if someone else reported and/or
607    wrote about the issue. It is possible that the issue is already solved/answered in the forum.
608    Plus all other users can benefit of it because maybe another person has the same problem and then
609    he can check the forum and will find the answer.
610    
611    Feature requests can be submitted at the same site in a different tab (Tracker->Feature Request).
612    There is no guarantee that the request will be implemented in the next version. The reason is,
613    that other issues might be more important or that the request must be first discussed with other
614    developers. But each request will be considered.
615    
616    For the case that you found a bug, it is very important to provide much details as possible to
617    allow the developers to track down the problem and to fix it easily. Please do not forgot to be
618    precise as possible and the best idea is to provide a step-by-step text to reproduce the problem.
619    
620    @section Problem with the Program or an unexpected Behaviour
621    
622    First let me say that it is very important always to use the newest version. Each new version
623    contains bug fixes and might also fix usability issues. This is also valid for GPG, WinPT
624    checks that the minimum GPG version is available but even so it is important and often useful to
625    have the newest GPG version if this is possible.
626    
627    But sometimes the problem is not the software itself, but the software which was involved to
628    transfer the data. Here are some examples of what could happen:
629    
630    - The downloaded file could be broken (FTP ascii->binary issue) and thus WinPT is unable to
631      verify the signature. In this case you should download the file again.
632    
633    - A mailer broke the signature because the line endings were altered or the mail text was wrapped
634      after the signature was issued. There is no solution to this problem, except to use
635      a smart Mail Client.
636    
637    - A public key (file or clipboard) will not be recognized but the data should definitely contain
638      one or more keys. Sometimes line endings are messed up or white spaces were removed. In
639      this case GPG/WinPT is not able to detect when the data begins and the header section starts.
640      You can use the clipboard editor to see if the ascii armor is broken. If this happened, the
641      file must be repaired manually or should be sent again.
642    
643    - WinPT reports that the key could not be imported because of missing self signature or a
644      likewise message. To make sure that the receiver can really verify the key belongs to its
645      owner, the key carries a self signature which can be checked by anybody. Some PGP 2.6 version
646      do not issue this self signature and some other PGP versions might be also able to
647      supress its generation. Such a key cannot be used, even if the import were forced. The solution
648      to this problem is easy but sometimes not possible. Ask the key issuer to self sign his key and
649      to upload it to the keyserver or send it again.
650      But sometimes companies have a policy and thus newly generated keys are not self signed. I do
651      not know what to do in this case except for asking if it would be possible to sign a copy of
652      the key.
653    
654    - You received a message from a user which uses PGP and WinPT/GPG will not be able to decrypt it.
655      First let me say that this should happen very seldom with newer (PGP >= 7) versions of PGP.
656      The reason could be, that IDEA has been used. A patented Cipher which is not included in GPG.
657      GPG will not be able to decrypt the data because it has been ciphered with IDEA. There is no
658      solution for this problem, except to use the IDEA plug-in. But be advised that the IDEA
659      algorithm is only free for private use and NOT for commercial mails.
660    
661      Another problem could be, that your files cannot be automatically decrypted by the receiver
662      (who uses PGP) because the file extension of it is .GPG. You can solve this problem by changing
663      the default extension in the WinPT preferences from .GPG to .PGP.
664    
665      To minimize the change of problems when you communicate with a PGP user, you can add "pgp8" or
666      "pgp7" to your gpg.conf. This can be done via the Key Manager
667      ->Edit->Preferences...->GPG Config Preferences.
668    
669    
670    @section How can I help the Project
671    
672    There are several ways to help the project. For example you could provide (or work on) the
673    existing documentation or write new docs. You could translate WinPT into a new language or
674    maintain an existing language file. Of course it is also possible to contribute code or to
675    become part of the WinPT developer crew.
676    Commercial support for WinPT is available via g10 Code GmbH.
677    
678    @subsection What I need for Development
679    First, you need a Windows C-compiler and knowledge how to use the tools and the Win32 API. There
680    is no need to use MS-Visual C,  you can use Ming-W32 (gcc) and a free IDE to hack some code.
681    The default building environment is a mingw32 hosted on Linux and it produces W32 executables.
682    
683    If you plan to contribute some code or to work on an item from the TODO file, please contact me
684    first to make sure no one else is working on it and that and we can discuss the details.
685    
686    @section Closing Words
687    Please remember that currently the core WinPT crew is just me and thus it might take some time to
688    respond to forum messages, and mails. If my spare time allows it, I try to respond quick as
689    possible. But as a free software project, I do most coding in my spare time and I can't guarantee
690    anything. If you need commercial support for WinPT or GPG in general,
691    please contact g10 Code GmbH.
692    
693  @bye  @bye
Legend:
Removed from v.224  
changed lines
  Added in v.256
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26