Merge ~stefanor/dkimpy-milter:table-docs into dkimpy-milter:master

Proposed by Stefano Rivera
Status: Merged
Approved by: Scott Kitterman
Approved revision: 7be865d7d74ce5068caa017913035f720d2ffe0a
Merged at revision: 7be865d7d74ce5068caa017913035f720d2ffe0a
Proposed branch: ~stefanor/dkimpy-milter:table-docs
Merge into: dkimpy-milter:master
Diff against target: 29 lines (+4/-4)
2 files modified
README.md (+3/-3)
man/dkimpy-milter.conf.5.in (+1/-1)
Reviewer Review Type Date Requested Status
Scott Kitterman Approve
Review via email: mp+382336@code.launchpad.net

Commit message

Clarify documentation around SigningTable and KeyTable

Description of the change

I recently had to migrate my dkimpy setup to SigningTable, to use selector names compatible with debian.org's policy.

From my reading of the docs, I assumed I needed to use separate key names for RSA and ed25519 keys, and then select them both in SigningTable. Turned out to be wrong.

To post a comment you must log in.
Revision history for this message
Scott Kitterman (kitterman) wrote :

Looks good. Thanks.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index 9d82735..49efe6f 100644
3--- a/README.md
4+++ b/README.md
5@@ -136,9 +136,9 @@ for the above might look like this:
6 comkey example.com:bar:/usr/local/etc/dkim/keys/excom
7 netkey example.net:baz:/usr/local/etc/dkim/keys/exnet
8
9-If also signing with ed25519, specify a KeyTableEd25519 pointing to the keys
10-needed for ed25519. Both KeyTable and KeyTableEd25519 are evaluated if there
11-is a SigningTable (see below).
12+If also signing with ed25519, specify a KeyTableEd25519, with the same
13+names, pointing to the keys needed for ed25519. Both KeyTable and
14+KeyTableEd25519 are evaluated if there is a SigningTable (see below).
15
16 Per the documentation, multi-field data sets that are made of flat files have
17 the fields separated by colons, but the key and value(s) are separated by
18diff --git a/man/dkimpy-milter.conf.5.in b/man/dkimpy-milter.conf.5.in
19index 9a776af..45e3097 100644
20--- a/man/dkimpy-milter.conf.5.in
21+++ b/man/dkimpy-milter.conf.5.in
22@@ -428,7 +428,7 @@ of this field.
23 .TP
24 .I SigningTable (dataset)
25
26-Defines a table used to select one or more signing identities to apply to a message based on the address found in the From: header field. Keys in this table vary depending on the type of table used; values in this data set should include one field that contains a name found in the KeyTable (see above) that identifies which key should be used in generating the signature, and an optional second field naming the signer of the message that will be included in the "i=" tag in the generated signature. Note that the "i=" value will not be included in the signature if it conflicts with the signing domain (the "d=" value).
27+Defines a table used to select a signing identity to apply to a message based on the address found in the From: header field. Keys in this table vary depending on the type of table used; values in this data set should include one field that contains a name found in the KeyTable (see above) that identifies which key should be used in generating the signature, and an optional second field naming the signer of the message that will be included in the "i=" tag in the generated signature. Note that the "i=" value will not be included in the signature if it conflicts with the signing domain (the "d=" value).
28
29 If the first field contains only a "%" character, it will be replaced by the domain found in the From: header field. Similarly, within the optional second field, any "%" character will be replaced by the domain found in the From: header field.
30

Subscribers

People subscribed via source and target branches