diff options
| -rw-r--r-- | smtpd/forward.5 | 6 | ||||
| -rw-r--r-- | smtpd/sendmail.8 | 30 | ||||
| -rw-r--r-- | smtpd/smtpctl.8 | 11 | ||||
| -rw-r--r-- | smtpd/smtpd.conf.5 | 53 | ||||
| -rw-r--r-- | smtpd/table.5 | 39 |
5 files changed, 76 insertions, 63 deletions
diff --git a/smtpd/forward.5 b/smtpd/forward.5 index 4b957eb0..2fd7da52 100644 --- a/smtpd/forward.5 +++ b/smtpd/forward.5 @@ -51,16 +51,16 @@ or if the file is not owned by the user. .Pp Users should avoid editing directly the .Nm .forward -file to prevent delivery failures from occuring if a message +file to prevent delivery failures from occurring if a message arrives while the file is not fully written. The best option is to use a temporary file and use the .Xr mv 1 command to atomically overwrite the former -.Nm .forward. +.Nm .forward . Alternatively, setting the .Xr sticky 8 bit on the home directory will cause the -.Xr .forward +.Nm .forward lookup to return a temporary failure, causing mails to be deferred. .Sh FILES .Bl -tag -width "~/.forwardXXX" -compact diff --git a/smtpd/sendmail.8 b/smtpd/sendmail.8 index 6ae0c2b6..a3e74f9b 100644 --- a/smtpd/sendmail.8 +++ b/smtpd/sendmail.8 @@ -1,3 +1,5 @@ +.\" $OpenBSD$ +.\" .\" Copyright (C) 2013 Ryan Kavanagh <rak@debian.org> .\" All rights reserved. .\" @@ -22,17 +24,17 @@ .Sh SYNOPSIS .Nm .Op Fl tv -.Op Fl f Ar from .Op Fl F Ar name +.Op Fl f Ar from .Ar to ... .Sh DESCRIPTION The .Nm -utility is a -.Xr mailwrapper 8 -compatible interface which acts as a local enqueuer for the +utility is a local enqueuer for the .Xr smtpd 8 -daemon. +daemon, +compatible with +.Xr mailwrapper 5 . The message is read on standard input (stdin) until .Nm encounters an end-of-file. @@ -48,32 +50,34 @@ one or more recipients must be specified on the command line. .Pp The options are as follows: .Bl -tag -width Ds +.It Fl F +Set the sender's full name. +.It Fl f +Set the sender's address. .It Fl t Read the message's To:, Cc:, and Bcc: fields for recipients. The Bcc: field will be deleted before sending. .It Fl v Enable verbose output. -.It Fl f -Set the sender's address. -.It Fl F -Set the sender's full name. .El .Pp To maintain compatibility with Sendmail, Inc.'s implementation of .Nm , various other flags are accepted, -but these have no effect. +but have no effect. .Sh EXIT STATUS .Ex -std .Sh SEE ALSO -.Xr smtpd 8 , -.Xr smtpctl 8 +.Xr smtpctl 8 , +.Xr smtpd 8 .Sh AUTHORS .Sy OpenSMTPD is primarily developed by Gilles Chehade, Eric Faurot, and Charles Longeau, -with contridutions from various OpenBSD hackers. +with contributions from various +.Ox +hackers. It is distributed under the ISC license. .Pp This manpage was written by diff --git a/smtpd/smtpctl.8 b/smtpd/smtpctl.8 index 5825f7de..83b227bb 100644 --- a/smtpd/smtpctl.8 +++ b/smtpd/smtpctl.8 @@ -121,10 +121,10 @@ as ready for immediate delivery. .It Cm show envelope Ar envelope-id Display envelope content for the given ID. .It Cm show hosts -Display the list of known remote MX hosts. For each of them, it shows -the IP address, the canonical hostname, a reference count, the number -of active connections to this host, the elapsed time since the last -connection. +Display the list of known remote MX hosts. +For each of them, it shows the IP address, the canonical hostname, +a reference count, the number of active connections to this host, +and the elapsed time since the last connection. .It Cm show hoststats Display status of last delivery for domains that have been active in the last 4 hours. @@ -185,7 +185,8 @@ Error string for the last failed delivery or relay attempt. .It Cm show relays Display the list of currently active relays and associated connectors. For each relay, it shows a number of counters and information on its -internal state on a single line. Then comes the list of connectors +internal state on a single line. +Then comes the list of connectors (source addresses to connect from for this relay). .It Cm show routes Display status of routes currently known by diff --git a/smtpd/smtpd.conf.5 b/smtpd/smtpd.conf.5 index af3bb428..3d699df4 100644 --- a/smtpd/smtpd.conf.5 +++ b/smtpd/smtpd.conf.5 @@ -79,8 +79,7 @@ from first to last. The first matching rule decides what action is taken. If no rule matches the message, the default action is to reject the message. -.Pp -Whenever \! is used, it will performe a reverse match. +An exclamation mark may be specified to perform a reverse match. .Pp Following the accept/reject decision comes the optional tag matching: @@ -90,11 +89,11 @@ decision comes the optional tag matching: .Op Ic \! .Ic tag .Xc -If specified, the rule will only be matched if the client session was tagged +If specified, the rule will only be matched if the client session was tagged with .Ar tag . .El .Pp -Then, comes the client's IP address filter: +After that the client's IP address filter is specified: .Bl -tag -width Ds .It Ic from any Make the rule match regardless of the IP of connecting client. @@ -253,14 +252,15 @@ Further filtering may be achieved on specific recipients if desired: .Bl -tag -width Ds .It Xo .Ic recipient -.Op Ic \! -.Ic recipients +.Op Ic \&! +.Ar recipients .Xc If specified, the rule will only be matched if the recipient email address is found in the table .Ar recipients . The table may contain complete email addresses or apply to an entire -domain if prefixed with @. +domain if prefixed with +.Sq @ . .El .Pp If the method of delivery is local, a user database may be @@ -308,7 +308,9 @@ This parameter may use conversion specifiers that are expanded before use .Op Ic backup Op Ar mx .Op Ic as Ar address .Op Ic source Ar source +.Bk -words .Op Ic hostnames Ar names +.Ek .Op Ic pki Ar pkiname .Op Ic tls | verify .Xc @@ -364,7 +366,8 @@ when connected to the remote server. .Pp When relaying, STARTTLS is always attempted if available on remote host and OpenSMTPD will try to present a certificate matching the outgoing -hostname if one is registered in the pki. If +hostname if one is registered in the pki. +If .Ic pki is specified, the certificate registered for .Ar pkiname @@ -421,10 +424,10 @@ In addition, credentials for authenticated relaying may be provided when using a secure schema. For example: .Bd -literal -offset indent -tls+auth://label@mx.example.org # over TLS -smtps+auth://label@mx.example.org # over SMTPS -secure+auth://label@mx.example.org # over either \e - # SMTPS or TLS +tls+auth://label@mx.example.org # over TLS +smtps+auth://label@mx.example.org # over SMTPS +secure+auth://label@mx.example.org # over either \e + # SMTPS or TLS .Ed .Pp If a pki entry exists for the outgoing hostname, or one is provided @@ -601,12 +604,12 @@ instead of the default server name. .Pp The .Ic hostnames -parameter allows to override the server name for specific addresses. +parameter overrides the server name for specific addresses. Table .Ar names contains a mapping of IP addresses to hostnames and .Xr smtpd 8 -will use the host name that matches the address on which the connection arrives +will use the hostname that matches the address on which the connection arrives if it is found in the mapping. .Pp If the @@ -617,7 +620,7 @@ when prepending the "Received" header. If the listener is configured to provide SMTPS or STARTTLS and the .Ic verify parameter is used, then clients will be required to present a -certificate than can be verified before a SMTP session can be +certificate that can be verified before a SMTP session can be initiated. .It Ic max-message-size Ar n Specify a maximum message size of @@ -627,27 +630,27 @@ The argument may contain a multiplier, as documented in .Xr scan_scaled 3 . The default maximum message size is 35MB if none is specified. .It Ic pki Ar hostname Ic certificate Ar certfile -Associate certificate located in +Associate the certificate located in .Ar certfile -to +with .Ar hostname . .Pp -A certificate chain may be created by appending one or many -certificates, including a Certificate Authority certificate, +A certificate chain may be created by appending one or many certificates, +including a Certificate Authority certificate, to .Ar certfile . .Pp Creation of certificates is documented in .Xr starttls 8 . .It Ic pki Ar hostname Ic key Ar keyfile -Associate key located in +Associate the key located in .Ar keyfile -to +with .Ar hostname . .It Ic pki Ar hostname Ic dhparams Ar dhfile -Associate Diffie-Hellman parameters located in +Associate the Diffie-Hellman parameters located in .Ar dhfile -to +with .Ar hostname . .Pp The parameters are used for ephemeral key exchange. @@ -874,9 +877,9 @@ accept for any relay .Ed .Sh SEE ALSO .Xr mailer.conf 5 , +.Xr table 5 , .Xr makemap 8 , -.Xr smtpd 8 , -.Xr table 5 +.Xr smtpd 8 .Sh HISTORY .Xr smtpd 8 first appeared in diff --git a/smtpd/table.5 b/smtpd/table.5 index 23e14421..1b467338 100644 --- a/smtpd/table.5 +++ b/smtpd/table.5 @@ -30,8 +30,8 @@ The format described here applies to tables as defined in .Xr smtpd.conf 5 . .Sh TABLE TYPES There are two types of tables: lists and mappings. -A list consists of a serie of values while a mapping consists of a serie -of keys and their associated values. +A list consists of a series of values, +while a mapping consists of a seriesof keys and their associated values. The following illustrates how to declare them as static tables: .Bd -literal -offset indent table mylist { value1, value2, value3 } @@ -57,7 +57,7 @@ key3 value3 .Pp A file table can be converted to a .Xr db 3 -databases using the +database using the .Xr makemap 8 utility with no syntax change. .Pp @@ -80,8 +80,8 @@ accept for domain example.org alias <myaliases> deliver to mbox accept for domain example.org virtual <myaliases> deliver to mbox .Ed .Pp -In a primary domain context, the key is the user-part of the recipient address, -the value is one or many recipients as described in +In a primary domain context, the key is the user part of the recipient address, +whilst the value is one or many recipients as described in .Xr aliases 5 : .Bd -literal -offset indent user1 otheruser @@ -89,7 +89,7 @@ user2 otheruser1,otheruser2 user3 otheruser@example.com .Ed .Pp -In a virtual domain context, the key is either a user-part, a full email +In a virtual domain context, the key is either a user part, a full email address or a catch all, following selection rules described in .Xr smtpd.conf 5 , and the value is one or many recipients as described in @@ -137,9 +137,12 @@ user2 $2a$06$bwSmUOBGcZGamIfRuXGTvuTo3VLbPG9k5yeKNMBtULBhksV5KdGsK The passwords are encrypted using the .Xr crypt 3 function provided by the host. -On OpenBSD, the +On +.Ox , +the .Xr encrypt 1 -utility may be used, on other systems the +utility may be used; +on other systems the .Ql mkpasswd utility is the most common method for obtaining a proper password. .Pp @@ -164,7 +167,7 @@ accept from source <netaddr> for domain example.org deliver to mbox When used as a "from source", the address of a client is compared to the list of addresses in the table until a match is found. .Pp -A netaddr table can contain exact addresses or netmasks, it looks as follow: +A netaddr table can contain exact addresses or netmasks, and looks as follow: .Bd -literal -offset indent 192.168.1.1 ::1 @@ -174,13 +177,13 @@ ipv6:::1 .Ss Userinfo tables User info tables are used to described virtual system users. They are used in rule context to specify an alternate user base, mapping -virtual users to local system uid, gid and home directory. +virtual users to local system UID, GID and home directory. .Bd -literal -offset indent accept for domain example.org userbase <userinfo> deliver to maildir .Ed .Pp The userinfo table is a mapping from virtual user names to a set of system user -id, group id and path to home directory. +ID, group ID and path to home directory. .Pp A userinfo table looks as follows: .Bd -literal -offset indent @@ -189,8 +192,10 @@ jack 1000:100:/home/virtual/jack .Ed .Pp In this example, both joe and jack are virtual users mapped to the local -system user with uid 1000 and gid 100, but different home directories. -These directories may contain a .forward file. +system user with UID 1000 and GID 100, but different home directories. +These directories may contain a +.Xr forward 5 +file. .Ss Source tables Source tables are lists of IPv4 and IPv6 addresses. They can only be used in the following context: @@ -227,16 +232,16 @@ user user@domain .Ed .Ss Addrname tables -Addrname tables are user to map IP addresses to hostnames. +Addrname tables are used to map IP addresses to hostnames. They can be used in both listen context and relay context: .Bd -literal -offset indent listen on 0.0.0.0 hostnames <addrname> accept for any relay hostnames <addrname> .Ed .Pp -In listen context, the table is used to lookup the server name to advertise +In listen context, the table is used to look up the server name to advertise depending on the local address of the socket on which a connection is accepted. -In relay context, the table is used to determine the host name for the HELO +In relay context, the table is used to determine the hostname for the HELO sequence of the SMTP protocol, depending on the local address used for the outgoing connection. .Pp @@ -247,6 +252,6 @@ The format is a mapping from inet4 or inet6 addresses to hostnames: 88.190.23.165 www.opensmtpd.org .Ed .Sh SEE ALSO -.Xr smtpd.conf 5 +.Xr smtpd.conf 5 , .Xr makemap 8 , .Xr smtpd 8 |