Update man pages for ed25519

This commit is contained in:
Scott Kitterman
2018-02-05 14:27:16 -05:00
parent 6bbbdf9b22
commit dc772430f6
2 changed files with 48 additions and 20 deletions
+23 -6
View File
@@ -128,14 +128,14 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "dkimsign 1" .IX Title "dkimsign 1"
.TH dkimsign 1 "2017-01-23" .TH dkimsign 1 "2018-02-05"
.SH "NAME" .SH "NAME"
dkimsign dkimsign
\- \-
Script for DKIM signing messages on stdin Script for DKIM signing messages on stdin
.SH "VERSION" .SH "VERSION"
.IX Header "VERSION" .IX Header "VERSION"
0\.6\.0 0\.7\.0
.SH "DESCRIPTION" .SH "DESCRIPTION"
.IX Header "DESCRIPTION" .IX Header "DESCRIPTION"
@@ -146,15 +146,32 @@ the same message on standard output with a DKIM-Signature line prepended.
.SH "USAGE" .SH "USAGE"
.IX Header "USAGE" .IX Header "USAGE"
The signing options are specified on the command line: usage: dkimsign.py [\-h] [\-\-hcanon {simple,relaxed}]
[\-\-bcanon {simple,relaxed}]
[\-\-signalg {rsa\-sha256,ed25519\-sha256,rsa\-sha1}]
[\-\-identity IDENTITY]
selector domain privatekeyfile
dkimsign selector domain privatekeyfile [identity] mandatory positional arguments:
selector
domain
privatekeyfile
The identity is optional and defaults to "@domain". optional arguments:
\-h, \-\-help show this help message and exit
\-\-hcanon {simple,relaxed}
Header canonicalization algorithm: default=relaxed
\-\-bcanon {simple,relaxed}
Body canonicalization algorithm: default=simple
\-\-signalg {rsa\-sha256,ed25519\-sha256,rsa\-sha1}
Signature algorithm: default=rsa\-sha256
\-\-identity IDENTITY Optional value for i= tag.
.SH "AUTHORS" .SH "AUTHORS"
.IX Header "AUTHORS" .IX Header "AUTHORS"
This version of \fBdkimsign\fR was written by Greg Hewgill <greg@hewgill.com>. The original version of \fBdkimsign\fR was written by Greg Hewgill
<greg@hewgill.com>. It has been substantially rewritten by Scott Kitterman
<scott@kitterman.com>.
.PP .PP
This man-page was created by Scott Kitterman <scott@kitterman.com> and is This man-page was created by Scott Kitterman <scott@kitterman.com> and is
licensed under the same terms as dkimpy. licensed under the same terms as dkimpy.
+25 -14
View File
@@ -128,37 +128,48 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "dknewkey 1" .IX Title "dknewkey 1"
.TH dknewkey 1 "2017-01-23" .TH dknewkey 1 "2018-02-05"
.SH "NAME" .SH "NAME"
dknewkey dknewkey
\- \-
Generates new DKIM public/private key pairs Generates new DKIM public/private key pairs
.SH "VERSION" .SH "VERSION"
.IX Header "VERSION" .IX Header "VERSION"
0\.6\.0 0\.7\.0
.SH "USAGE"
.IX Header "USAGE"
NOTE: Depending on the packaging and distribution, the exact path and name for
the executable may vary.
dknewkey.py: <keyname>
.SH "DESCRIPTION" .SH "DESCRIPTION"
.IX Header "DESCRIPTION" .IX Header "DESCRIPTION"
dknewykey generates new DKIM keys. dknewykey generates new DKIM keys.
It defaults to 2048 bit key size. This is controlled by the BITS_REQUIRED For RSA keys, it defaults to 2048 bit key size. This is controlled by the
variable. BITS_REQUIRED variable. ed25519 keys do not have a variable size.
It uses openssl to do the generation. By default it assumes this is located For RSA keys, it uses openssl to do the generation. By default it assumes
at /usr/bin/openssl. This is controlled by the OPENSSL_BINARY variable. this is located at /usr/bin/openssl. This is controlled by the OPENSSL_BINARY
variable. For ed25519 keys, PyNaCl (python-nacl in Debian and derivatives) is
used.
.SH "USAGE"
.IX Header "USAGE"
dknewkey.py [\-h] [\-\-ktype {rsa,ed25519}] key_name
mandatory positional arguments:
key_name
optional arguments:
\-h, \-\-help show this help message and exit
\-\-ktype {rsa,ed25519}
DKIM key type: Default is rsa
NOTE: Depending on the packaging and distribution, the exact path and name for
the executable may vary.
.SH "AUTHORS" .SH "AUTHORS"
.IX Header "AUTHORS" .IX Header "AUTHORS"
This version of \fBdknewkey\fR was written by Brandon Long <blong@google.com>. This version of \fBdknewkey\fR was written by Brandon Long <blong@google.com>.
It has been substantially rewritten by Scott Kitterman <scott@kitterman.com>.
.PP .PP
This man-page was created by Scott Kitterman <scott@kitterman.com> and is This man-page was created by Scott Kitterman <scott@kitterman.com> and is
licensed under the same terms as dkimpy. licensed under the same terms as dkimpy.