commit 55999c731010fbd441209a93fa0b0e0481a65938 from: Martijn van Duren date: Thu Aug 22 17:39:16 2019 UTC Rename manpage to filter-dkim.8 commit - 6840f1a1324e44cbaa373c963504b7b0eedeb569 commit + 55999c731010fbd441209a93fa0b0e0481a65938 blob - 162410079b5787f759025db694c5a456932a50f6 blob + 9ebe37ebe1d537fd05f9bfae65c93aebdc718f0d --- Makefile +++ Makefile @@ -1,6 +1,7 @@ # $OpenBSD: Makefile,v 1.1 2018/04/26 13:57:13 eric Exp $ PROG= filter-dkim +MAN= filter-dkim.8 BINDIR= /usr/libexec/smtpd/ SRCS+= main.c blob - 18fee80d2299c7e4fff8667e6aba71006f622039 (mode 644) blob + /dev/null --- filter-dkim.1 +++ /dev/null @@ -1,78 +0,0 @@ -.\" $OpenBSD$ -.\" -.\" Copyright (c) 2019 Martijn van Duren -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate$ -.Dt FILTER-DKIM 8 -.Os -.Sh NAME -.Nm filter-dkim -.Nd add dkim signature to messages -.Sh SYNOPSIS -.Nm -.Op Fl tz -.Op Fl a Ar algorithm -.Op Fl c Ar canonicalization -.Op Fl h Ar headers -.Op Fl x Ar seconds -.Fl d Ar domain -.Fl k Ar file -.Fl s Ar selector -.Sh DESCRIPTION -.Nm -adds a dkim signature to the message. -The following flags are supported: -.Bl -tag -width Ds -.It Fl a -The algorithm to use. -This implementation only supports rsa cryptography. -Only sha256 should be used for hashing, since other algorithms are most likely -not supported by verifiers. -Defaults to -.Ar rsa-sha256 . -.It Fl c -The canonicalization algorithm used to sign the messge. -Defaults to -.Ar simple/simple . -.It Fl d -The domain where the public key can be found. -.It Fl h -The email headers which are included in the mail signature. -Per RFC this option requires at least the from header to be included. -The headers are specified by separating them with a colon. -The default is -from:reply-to:subject:date:to:cc:resent-date:resent-from:resent-to:resent-cc:in-reply-to:references:list-id:list-help:list-unsubscribe:list-subscribe:list-post:list-owner:list-archive . -.It Fl k -.Ar file -should point to a file containing the RSA private key to sign the messages. -.It Fl s -The selector within the _domainkey subdomain of -.Ar domain -where the public key can be found. -.It Fl t -Add the time of signing to the dkim header. -.It Fl x -Add the amount of -.Ar seconds -the signature is valid to the dkim header. -.It Fl z -Add the mail headers used in the dkim signature to the dkim header. -If a second -.Fl z -is specified all headers will be included in the dkim header. -Useful for debugging purposes. -.El -.Sh SEE ALSO -.Xr smtpd 8 blob - /dev/null blob + 18fee80d2299c7e4fff8667e6aba71006f622039 (mode 644) --- /dev/null +++ filter-dkim.8 @@ -0,0 +1,78 @@ +.\" $OpenBSD$ +.\" +.\" Copyright (c) 2019 Martijn van Duren +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate$ +.Dt FILTER-DKIM 8 +.Os +.Sh NAME +.Nm filter-dkim +.Nd add dkim signature to messages +.Sh SYNOPSIS +.Nm +.Op Fl tz +.Op Fl a Ar algorithm +.Op Fl c Ar canonicalization +.Op Fl h Ar headers +.Op Fl x Ar seconds +.Fl d Ar domain +.Fl k Ar file +.Fl s Ar selector +.Sh DESCRIPTION +.Nm +adds a dkim signature to the message. +The following flags are supported: +.Bl -tag -width Ds +.It Fl a +The algorithm to use. +This implementation only supports rsa cryptography. +Only sha256 should be used for hashing, since other algorithms are most likely +not supported by verifiers. +Defaults to +.Ar rsa-sha256 . +.It Fl c +The canonicalization algorithm used to sign the messge. +Defaults to +.Ar simple/simple . +.It Fl d +The domain where the public key can be found. +.It Fl h +The email headers which are included in the mail signature. +Per RFC this option requires at least the from header to be included. +The headers are specified by separating them with a colon. +The default is +from:reply-to:subject:date:to:cc:resent-date:resent-from:resent-to:resent-cc:in-reply-to:references:list-id:list-help:list-unsubscribe:list-subscribe:list-post:list-owner:list-archive . +.It Fl k +.Ar file +should point to a file containing the RSA private key to sign the messages. +.It Fl s +The selector within the _domainkey subdomain of +.Ar domain +where the public key can be found. +.It Fl t +Add the time of signing to the dkim header. +.It Fl x +Add the amount of +.Ar seconds +the signature is valid to the dkim header. +.It Fl z +Add the mail headers used in the dkim signature to the dkim header. +If a second +.Fl z +is specified all headers will be included in the dkim header. +Useful for debugging purposes. +.El +.Sh SEE ALSO +.Xr smtpd 8