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