1
2policy-spf.peruser(5)         File Formats Manual        policy-spf.peruser(5)
3
4
5

NAME

7       policyd-spf - policyd-spf python per-user configuration
8

VERSION

10       2.0.0
11
12

USAGE

14       Usage:
15         policyd-spf [/etc/policyd-spf/policyd-spf.conf]
16
17

OTHER DOCUMENTATION

19       This documentation assumes you have read Postfix's README_FILES/
20       SMTPD_POLICY_README and are generally familiar with Sender Policy
21       Framework (SPF).  See RFC 7208 for details.
22
23       man 1 policyd-spf provides general operation documentation for this
24       package.
25
26       See man 5 policyd-spf.conf for configuration file information.
27

SYNOPSIS

29       python-policyd-spf operates with a default installed configuration file
30       and set of default configuration options that are used if the configu‐
31       ration file cannot be found.  These options can be changed by changing
32       the installed configuration files or through giving a path to an alter‐
33       nate configuration file.
34
35       Additionally, different configurations can be provided on a per user
36       basis.  This man page describes setup and user of per user (mail recip‐
37       ient) configurations.  Currently these configurations can only be
38       stored in a text file.  If there is sufficient interest, other data
39       storage methods may be supported in the future.
40
41

DESCRIPTION

43       Use of per-user configuration is defined in the application configura‐
44       tion file with the setting "Per_User".  The value of the setting gives
45       the type and location of the per-user configuration information.  Cur‐
46       rently supported types is text.  User is defined an email address of a
47       recipient of the message.
48
49       Most options available at the application level (See man 5 policyd-
50       spf.conf) can be adjusted on a per-user basis.  Per-user checks can
51       only be done as part of smtpd_recipient_restrictions.  Per-user actions
52       are not possible at other stages of the SMTP dialogue.  The user is not
53       yet known for smtpd_client_restrictions, smtpd_helo_restrictions, or
54       smtpd_sender_restrictions.  If used during smtpd_data_restrictions or
55       smtpd_end_of_data_restrictions, the entire message will be available
56       only if the message was only to a single recipient.  If per-user con‐
57       figurations are used when recipient information is not available, warn‐
58       ings will be logged and the per-user information will be ignored.
59
60       The following options cannot be modified on a per user basis:
61       Lookup_Time, Header_Type, Hide_Receiver, Authserv_Id, Prospective,
62       debugLevel, and Mock.
63
64       In addition to specifying individual users, regular expression matching
65       is also available, but may have performance implications since the
66       entire user table has to be traversed for each message recipient.
67
68

OPTIONS

70
71

Text Per-User Configuration File

73       The text file option is useful for testing and when only a small number
74       of users require per-user configurations.  It is specified in the main
75       configuration file:
76
77       "Per_User = text,/etc/pypolicyd-spf/userconf"
78
79       Lines beginning with "#" are treated as comments and ignored.  The
80       location of the file is determined by the system administrator. No
81       default file is provided in or installed by the package.
82
83       The configuration of the file is a comma separated combination of user
84       and configuration information, with one line per user's configuration
85       information (NOTE: due to man page formatting requirements, these lines
86       may be wrapped in your pager - in the config file, it must be one line
87       per user):
88
89       postmaster@example.com,Mail_From_reject=No_Check|PermEr‐
90       ror_reject=False|HELO_reject=SPF_Not_Pass|TestOnly=1|debu‐
91       gLevel=5|skip_addresses=127.0.0.0/8,::ffff:127.0.0.0//104,::1//128|Tem‐
92       pError_Defer=False strict@example.com,PermEr‐
93       ror_reject=True|HELO_reject=SPF_Not_Pass|TempError_Defer=True
94
95       It is not necessary to specify all configuration parameters for each
96       user, only those that are different than the overall configuration need
97       to be specified.
98
99       If the specified per user configuration file is missing, an error is
100       logged and the global configuration is used instead.
101
102

SEE ALSO

104       man 1 policyd-spf, man 5 policyd-spf.conf, python-spf,
105       <http://www.openspf.org>, RFC 7208
106
107

AUTHORS

109       This version of policyd-spf was written by Copyright © 2007-2016, Scott
110       Kitterman <scott@kitterman.com>.  It is derived from Tumgreyspf, writ‐
111       ten by Sean Reifschneider, tummy.com, ltd <jafo@tummy.com>.
112
113       This man-page was created by Scott Kitterman <scott@kitterman.com> and
114       is licensed under the same terms as the program.
115
116
117
118                                                         policy-spf.peruser(5)
Impressum