/[winpt]/trunk/README
ViewVC logotype

Contents of /trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 129 - (show annotations)
Fri Dec 30 13:56:10 2005 UTC (19 years, 2 months ago) by twoaday
File size: 13668 byte(s)
2005-12-27  Timo Schulz  <ts@g10code.com>
                                                                                
        * wptListView.cpp (listview_set_view): New.
        (listview_del_column): New.
        * wptW32API.cpp (get_locale_date): New.
        (get_menu_state): New.
        (force_foreground_window): New.
        * wptVerifyList.cpp (strtimestamp): Support for
        locale date formats.
        * wptGPGUtil.cpp (gpg_revoke_cert): Handle bad
        passphrases.
        * wptKeyEditCB.cpp (editkey_command_handler): Immediately
        return when a bad passphrase was submitted.
        * wptKeyRevokersDlg.cpp (keyrevokers_dlg_proc): Change
        column order.
        * wptKeylist.cpp (keylist_upd_col): New.
        * wptKeyManagerDlg.cpp (update_ui_items): Deactivate
        'Revocation' for public keys.
        (translate_menu_strings): s/Revoke/Revoke Cert.
        (modify_listview_columns): New.


1 The Windows Privacy Tray
2 Version 0.5.5
3
4 *** WARNING: this file is obsolete ***
5
6 Index
7 1. Notice
8 2. Bugs and improvements
9 3. What is WinPT?
10 4. Install
11 4.1 Keyserver config file
12 5. Verify the packet signature
13 6. Native language support
14 7. Other documentation
15 8. Mailing lists
16 9. Hotkeys for common commands
17 10. Current window support
18 11. Word wrapping
19 12. Default key for signing
20 13. Commands
21 13.1 File manager
22 13.2 Key manager
23 13.2.1 Edit
24 13.2.2 UserID
25 13.2.3 Delete
26 13.2.4 Sign
27 13.2.5 Revoke cert
28 13.2.6 Check sigs
29 13.2.7 List trust path
30 13.3 Keyserver
31 13.3.1 Keyserver searching
32 13.3.2 Proxy support
33 14. Debug mode
34 15. Agent support
35 16. Features of the dialogs
36 16. Features of the dialogs
37
38
39 1. Notice
40 ---------
41
42 This is only a quick guide for WinPT. For the moment the program is its own
43 documentation. This is subject to change. Please note, this text needs many
44 improvements, because English isn't my native lanuage ;-(. Please feel free
45 to send me spelling corrections.
46
47
48 2. Bugs and improvements
49 ------------------------
50
51 I have tried to thoroughly debug this program, but if you've found a bug,
52 please send me a message with a full error description!
53
54 Please include as much detail as possible including OS version, WinPT
55 version, and GPG version in use. Please summarize your gpg configuration
56 and describe any special programs or configurations on your machine.
57
58 I try to fix bugs as quickly as possible and will upload all updates to
59 http://www.winpt.org
60
61
62 3. What is WinPT?
63 -----------------
64
65 WinPT is a tool to protect your privacy! Because I'm NOT a crypto expert,
66 I use another program, the GNU Privacy Guard for the cryptographic
67 functionality.
68
69 GnuPG was written by Werner Koch and is GNU Open Source. GnuPG contains all
70 of the functions WinPT uses for data encrypting and e-signatures and
71 key management.
72
73 WinPT is a Windows utility that sits on the taskbar. In the Windows
74 Clipboard, you can encrypt, sign, decrypt and verify data. You can also
75 import and export keys to the Clipboard.
76
77 Practically, WinPT is a taskbar front-end for GnuPG. Without GnuPG, WinPT
78 doesn't work! Currently not all GnuPG functions are supported. Because of
79 all the new features, WinPT is more then just an universal e-mail plugin.
80 Together with the filemanager and the keymanager, it's like a real GUI.
81
82
83 4. Install
84 ----------
85
86 First you should install the GPG binary into C:\GNUPG (Version 1.0.5 or
87 later.) (If you want to use a directory other than C:\GNUPG you must modify
88 the preferences in the WinPT program at Preferences->GPG Prefs.
89
90
91 ** GPG 1.0.5 is needed for WinPT but because of the security problem
92 with this version, it's recommend to use 1.0.6! **
93
94 Next, download the WinPT binary package from the Internet. You can find the
95 latest WinPT version at http://www.winpt.org/download.html. Create a
96 directory and extract all WinPT releated files.
97
98
99 With the 0.5.0 version of WinPT, all modules are now integrated in
100 the main package. So you don't need the wipe-ext.dll or the ldap-ext.dll!
101
102
103 4.1 Keyserver config file
104 -------------------------
105
106 Now the keyserver config is read dynamically. That means there is a file
107 which WinPT reads the keyserver from. The name of this file MUST be
108 "keyserver.conf". I added a sample config file with the most common
109 keyservers. Of course it's possible to add own entries. Take a look
110 at the hints inside the file how to format the entries. If there no file,
111 the format can be described like this: 'DNS-Name=IP-Address'. Each line
112 of the file contains such an entry.
113
114
115 5. Verify the packet signature
116 ------------------------------
117
118 To verify that the source (or the binary) wasn't changed, you should
119 verify the package signature with GnuPG. For the process you will need
120 my OpenPGP public key. If you don't have it, please take a look at
121 http://www.winpt.org/twoaday.asc
122
123 # gpg --verify WinPT-x.x.x-exe.zip.asc
124 # gpg --verify WinPT-x.x.x-src.zip.asc
125
126 gpg should output that the signature was correct and that the signature
127 was created by me.
128
129 My key ID is 0xBF3DF9B4: 'Timo Schulz <[email protected]>'.
130
131
132 6. Native language support
133 --------------------------
134
135 As a new feature WinPT now can handle multiple languages. To activate this
136 do the following:
137
138 - Create a directory where you want to store the locale files
139 (the .mo files)
140
141 - Rename your favourite .mo file to winpt.mo
142
143 - Put all .mo files into this directory
144 (For example the gnupg.mo and the winpt.mo)
145
146 - Start WinPT and choose the menu entry 'Preferences->GPG Prefs'.
147 Set your locale directory to the directory containing winpt.mo.
148
149 - Now WinPT runs in the language you have selected.
150
151 For the moment, WinPT supports these languages:
152
153 * Italian winpt-it.mo
154 * French winpt-fr.mo
155 * German winpt-de.mo
156 * Spanish winpt-es.mo
157 * Russian winpt-ru.mo
158 * Portuguese (Brazilian) winpt-pt_BR.mo
159 * Portuguese winpt-pt_PT.mo
160 * Hungarian winpt-hu.mo
161 * Chinese winpt-zh_CN.mo
162 * Czech winpt-ch.mo
163
164 If you are interested in translating WinPT in your native language, please
165 let me know :-). It's not much work and you do NOT need to be a developer!
166
167
168 7. Other documentation
169 ----------------------
170
171 For those who are inexperienced with GnuPG it makes sense to download the
172 GnuPG guide or a HOWTO. There are many sites for this, but you can start
173 with the GnuPG site. This site is available in many languages. I prefer
174 the GNU Privacy Handbook. It contains background information that makes
175 working with GnuPG more effective.
176
177 http://www.gnupg.org
178
179 General questions (look first at the topic point), can be sent to one of the
180 mailing lists. All GnuPG lists are in English.
181
182 PGP User list (German) [email protected]
183 GPG User list (English) [email protected]
184 GPG Developer list (English) [email protected]
185
186 At the moment the only available documentation for WinPT is this file. In
187 future releases I will include HTML documentation.
188
189
190 8. Mailing lists
191 ----------------
192
193 If you want to get the latest information, reports, or discussions about
194 WinPT you can subscribe to one of the WinPT mailing lists. There is a list
195 for users and one for developers. Both lists are in English! To subscribe
196 send a message to '[email protected]' with "subscribe listname" in the
197 body.
198
199 Example: subscribe winpt-name_of_thelist
200
201 [email protected] - The developer list
202 [email protected] - The users list
203
204 Please, before you send a message to the list take a look at the FAQ
205 or the README files. It's possible that your question is already answered
206 there!
207
208
209 9. Hotkey for common commands
210 -----------------------------
211
212 WinPT supports shortcuts, or 'Hotkeys', for the main gpg commands. These
213 keys are registered system wide, so you can use them from any window. If you
214 have some problems with this keys, you can change the hotkeys in the
215 preferences dialog.
216
217 Encrypt Clipboard CTRL+ALT+e
218 Sign & Encrypt CTRL+ALT+b
219 Decrypt/verify Clipboard CTRL+ALT+d
220 Sign Clipboard CTRL+ALT+s
221 Export Clipboard CTRL+ALT+x
222 Import Clipboard CTRL+ALT+i
223
224 In the event of an error, it's possible that another program already uses
225 some of the hotkeys. WinPT will tell you which hotkey wasn't installed properly
226 so it's easier to figure out which hotkey caused the problem.
227
228
229 10. Current window support
230 --------------------------
231
232 WinPT allows you to use the main operations (sign and encrypt)
233 within the current window. This only works if the current window contains
234 text. For example, a mailer window with the message, a text editor or a
235 simple edit field. There are some kind of windows that are NOT supported
236 yet!
237
238 The easiest way to access this feature is using the hotkeys. Note: if
239 you use this feature the text will automatically be cut, encrypted
240 and pasted again in the window. You don't need to do anything manually.
241
242 Encrypt current window ALT+SHIFT+e
243 Decrypt/verify current window ALT+SHIFT+d
244 Sign current window ALT+SHIFT+s
245
246 Alternately you can use the WinPT menu for the current window support.
247 Please note, that the mode doesn't work very well if you use the menu
248 entry. I recommend to use it with the hotkeys until I fix this problem.
249
250
251 11. Word wrapping
252 -----------------
253
254 As a new feature, WinPT can wrap lines at a specific column. You can set
255 the value for this feature in the preferences dialog. If you don't want
256 to use this feature, you only need to set the value to "0".
257
258
259 12.Default keyid for signing
260 ----------------------------
261
262 There are two ways to set the default keyid. The best solution is to
263 set the "default-key" entry in the GPG options file. Alternative you can
264 also use "encrypt-to" for the default keyid.
265 The second solution is to let WinPT figure out it from the secret key cache,
266 the first key in this cache is the default keyid. Warning, with this method
267 it's possible that another keyid is chosen (because of the order in which the keyring
268 was read!).
269
270
271 13. Commands
272 ------------
273
274
275 13.1 Filemanager
276 ----------------
277
278 The filemanager is used to perform GPG operations on files. In further releases
279 I'll add more commands. Currently, encrypt, decrypt, sign and verify
280 is available. To add a file to the list element, you can use drag & drop
281 or use the 'Open' menu entry, like Windows Explorer.
282
283 Please note that this code is under heavy development, but is should be
284 fairly stable. It possible that some parts don't work as expected, but
285 feel free to mail me about any bugs!
286
287
288 13.2 Keymanager
289 ---------------
290
291 13.2.1 Edit
292 -----------
293
294 Here you access some of the "edit-key" command from the GPG command
295 line.
296
297
298 13.2.2 UserID
299 -------------
300
301 Gives you an overview about all user id's from a public key. The validity
302 of each is also listed.
303
304
305 13.2.3 Delete
306 -------------
307
308 With it you can delete public keys and/or key pairs.
309
310
311 13.2.4 Sign
312 -----------
313
314 This is an interface to sign a public key.
315
316
317 13.2.5 Revoke cert
318 ------------------
319
320 Generate a revocation certificate for the chosen key.
321
322
323 13.2.6 List trust path
324 ----------------------
325
326 TODO.
327
328
329 13.2.7 Check sigs
330 -----------------
331
332 With this command you can check the signatures from a special public key.
333
334
335 13.2.7 Key properties
336 ---------------------
337
338 This dialog is an easy way to get an overview about the given key.
339 To activate this dialog, you've to double click on a key item in the
340 key management dialog. Then a dialog with all related information about
341 the selected key will open.
342
343
344 13.3 Keyserver
345 --------------
346
347 13.3.1 Keyserver searching
348 --------------------------
349
350 This new feature works exactly like the normal keyserver support.
351 You have to enter the pattern, then chose a keyserver. The command
352 is started with the "Search" button. The next dialog contains all
353 found keys from the keyserver. If you want, you can import a key
354 from this list by select the key and press the "Receive" button.
355
356 13.3.2 Proxy support
357 --------------------
358
359 If you are not able to connect directly to the internet, you can
360 use the proxy settings. To enable proxy support, you need to add
361 "use_proxy=xx.xx.xx.xx:port" to your keyserver.conf. Then restart
362 WinPT. Now the keyserver code uses the proxy instead of the direct
363 connection.
364
365 If your proxy needs some kind of authentification, you can use
366 "proxy_user" and "proxy_pass". Then for each request the data
367 is used. The code was tested with some HTTP/WWW proxies but it's
368 also possible that it does *not* work with some proxies! Please tell
369 me if you've problems with your proxy server.
370
371
372 14. Debug mode
373 --------------
374
375 To make the detection of bugs and programming mistakes easier, WinPT
376 contains a built-in debug mode.
377
378 It can be activated with the '--enable-debug'
379 switch on the command line. Then the WinPT output is more verbose and all
380 steps are logged a in a file with the name "gpgme.dbg". This file is stored
381 in the current directory and ONLY contains GPG related information. If you
382 think it is a WinPT problem, you can find a debug file in c:\windows\temp.
383 The name of this file is "winpt.log". It's possible that this file is very
384 large, so do NOT forget to compress it.
385
386 After an error has occured, it would be very useful to send this file to me.
387 Which file you'll send depends on the occured error. Don't use the debug
388 mode for your usual work; it slows down both GPG and WinPT.
389
390
391 15. Agent support
392 -----------------
393
394 To use the Windows GPG Agent, you must start the process BEFORE running
395 WinPT. When there was no error, WinPT runs in a passphrase-less mode. All
396 passphrase requests are send to the client. As a result the sign and
397 sign & encrypt dialogs contain NO passphrase items! To force WinPT to use
398 the internal passphrase routines, you can use the "--no-agent" option on
399 the command line.
400
401
402 16. Features of the dialogs
403 ----------------------------
404
405 This sections contains hints about the special features of some dialogs.
406 Currently this is only valid for dialog with listview controls.
407
408 o Selection of an entry for the GPG main commands
409
410 If you only want to select one recipient, you can also double click
411 the line which the recipient you want to choose. Then the command
412 is automatically invoked and you don't need to click the "OK" button.
413
414 o Context menu for the key manager
415
416 Now the keymanager supports a context menu. To activate it, you should
417 click with the right mouse button on a selected item.
418
419 o Generic keys known from the Explorer
420
421 For example the key manager supports generic keys like:
422 DELETE = secure the selected key.
423
424 o Context menu for the file manager
425
426 This popup menu is similar to the key manager menu.
427

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26