Mercurial > ~mikael > mcabber > hg
comparison mcabber/doc/README_PGP.txt @ 1110:6db427a14ee8
Update documentation
Fix a typo in the mcabberrc sample file and add README_PGP.txt for a
PGP quickstart guide.
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 16 Dec 2006 16:13:17 +0100 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
1109:7e383aa48b3d | 1110:6db427a14ee8 |
---|---|
1 MCabber OpenPGP support | |
2 | |
3 This files explains how to use PGP support in mcabber. | |
4 | |
5 Please note that you need libgpgme > 1.0.0 (for example, libgpgme11 in Debian) | |
6 on your system. | |
7 | |
8 | |
9 ## Enabling OpenPGP support ## | |
10 | |
11 In the configuration file, enable pgp and set pgp_private_key to your key id. | |
12 Your key id can be found with the following command: | |
13 % gpg --list-keys --keyid-format long your_name | |
14 | |
15 Example (in $HOME/.mcabber/mcabberrc): | |
16 | |
17 set pgp = 1 | |
18 set pgp_private_key = "E3E6A9C1A6A013D3" | |
19 | |
20 | |
21 ## Encrypting messages ## | |
22 | |
23 Now when you start mcabber, it should ask for your passphrase (unless you put | |
24 it in your configuration file or you use gpg-agent). | |
25 | |
26 If you want to know if a contact is using PGP, select the contact and use the | |
27 command /info. If (s)he is, it should display something like: | |
28 | |
29 PGP key id: E2C4C9A1601A5A4 | |
30 Last PGP signature: unknown | |
31 | |
32 The signature is "unknown", because we don't have the contact's key. We could | |
33 get it with gpg, for example: | |
34 % gpg --recv-keys E2C4C9A1601A5A4 | |
35 | |
36 Then, wait for the next presence message. | |
37 | |
38 If the contact has your key and you have their key, you should have | |
39 bidirectional encrypted messages. | |
40 | |
41 | |
42 ## Per-contact settings ## | |
43 | |
44 You can provide a PGP key to be used for a given Jabber user or disable PGP on | |
45 a per-account basis, using the command /pgp. | |
46 | |
47 If you provide a KeyId for a contact, it will be compared to the key the | |
48 contact uses to sign their presence/messages and it will be used for all | |
49 outgoing encrypted messages (by default, mcabber will use the contact | |
50 signature's key). | |
51 | |
52 Example: | |
53 /pgp disable foo@bar.org | |
54 (disables encryption of messages sent to foo@bar.org) | |
55 /pgp setkey bar@foo.net C9940A9BB0B92210 | |
56 (set the encryption key for bar@foo.net and warn if this contact doesn't | |
57 use this key for their signatures) | |
58 /pgp info | |
59 (show the PGP settings we've set for the currently selected contact) | |
60 | |
61 Try "/help pgp" for a usage description. | |
62 | |
63 The command /pgp can be used in the configuration file (without the leading /). |