~ubuntu-branches/ubuntu/hoary/postfix/hoary-security

« back to all changes in this revision

Viewing changes to man/man8/spawn.8

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2004-10-06 11:50:33 UTC
  • Revision ID: james.westby@ubuntu.com-20041006115033-ooo6yfg6kmoteu04
Tags: upstream-2.1.3
ImportĀ upstreamĀ versionĀ 2.1.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH SPAWN 8 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
spawn
 
6
\-
 
7
Postfix external command spawner
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
\fBspawn\fR [generic Postfix daemon options] command_attributes...
 
12
.SH DESCRIPTION
 
13
.ad
 
14
.fi
 
15
The \fBspawn\fR daemon provides the Postfix equivalent of \fBinetd\fR.
 
16
It listens on a port as specified in the Postfix \fBmaster.cf\fR file
 
17
and spawns an external command whenever a connection is established.
 
18
The connection can be made over local IPC (such as UNIX-domain
 
19
sockets) or over non-local IPC (such as TCP sockets).
 
20
The command\'s standard input, output and error streams are connected
 
21
directly to the communication endpoint.
 
22
 
 
23
This daemon expects to be run from the \fBmaster\fR(8) process
 
24
manager.
 
25
.SH "COMMAND ATTRIBUTE SYNTAX"
 
26
.na
 
27
.nf
 
28
.ad
 
29
.fi
 
30
The external command attributes are given in the \fBmaster.cf\fR
 
31
file at the end of a service definition.  The syntax is as follows:
 
32
.IP "\fBuser\fR=\fIusername\fR (required)"
 
33
.IP "\fBuser\fR=\fIusername\fR:\fIgroupname\fR"
 
34
The external command is executed with the rights of the
 
35
specified \fIusername\fR.  The software refuses to execute
 
36
commands with root privileges, or with the privileges of the
 
37
mail system owner. If \fIgroupname\fR is specified, the
 
38
corresponding group ID is used instead of the group ID of
 
39
of \fIusername\fR.
 
40
.IP "\fBargv\fR=\fIcommand\fR... (required)"
 
41
The command to be executed. This must be specified as the
 
42
last command attribute.
 
43
The command is executed directly, i.e. without interpretation of
 
44
shell meta characters by a shell command interpreter.
 
45
.SH BUGS
 
46
.ad
 
47
.fi
 
48
In order to enforce standard Postfix process resource controls,
 
49
the \fBspawn\fR daemon runs only one external command at a time.
 
50
As such, it presents a noticeable overhead by wasting precious
 
51
process resources. The \fBspawn\fR daemon is expected to be
 
52
replaced by a more structural solution.
 
53
.SH DIAGNOSTICS
 
54
.ad
 
55
.fi
 
56
The \fBspawn\fR daemon reports abnormal child exits.
 
57
Problems are logged to \fBsyslogd\fR(8).
 
58
.SH "SECURITY"
 
59
.na
 
60
.nf
 
61
.fi
 
62
.ad
 
63
This program needs root privilege in order to execute external
 
64
commands as the specified user. It is therefore security sensitive.
 
65
However the \fBspawn\fR daemon does not talk to the external command
 
66
and thus is not vulnerable to data-driven attacks.
 
67
.SH "CONFIGURATION PARAMETERS"
 
68
.na
 
69
.nf
 
70
.ad
 
71
.fi
 
72
Changes to \fBmain.cf\fR are picked up automatically as spawn(8)
 
73
processes run for only a limited amount of time. Use the command
 
74
"\fBpostfix reload\fR" to speed up a change.
 
75
 
 
76
The text below provides only a parameter summary. See
 
77
postconf(5) for more details including examples.
 
78
 
 
79
In the text below, \fItransport\fR is the first field of the entry
 
80
in the \fBmaster.cf\fR file.
 
81
.SH "RESOURCE AND RATE CONTROL"
 
82
.na
 
83
.nf
 
84
.ad
 
85
.fi
 
86
.IP "\fItransport\fB_time_limit ($command_time_limit)\fR"
 
87
The amount of time the command is allowed to run before it is
 
88
terminated.
 
89
.SH "MISCELLANEOUS"
 
90
.na
 
91
.nf
 
92
.ad
 
93
.fi
 
94
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
95
The default location of the Postfix main.cf and master.cf
 
96
configuration files.
 
97
.IP "\fBdaemon_timeout (18000s)\fR"
 
98
How much time a Postfix daemon process may take to handle a
 
99
request before it is terminated by a built-in watchdog timer.
 
100
.IP "\fBexport_environment (see 'postconf -d' output)\fR"
 
101
The list of environment variables that a Postfix process will export
 
102
to non-Postfix processes.
 
103
.IP "\fBipc_timeout (3600s)\fR"
 
104
The time limit for sending or receiving information over an internal
 
105
communication channel.
 
106
.IP "\fBmail_owner (postfix)\fR"
 
107
The UNIX system account that owns the Postfix queue and most Postfix
 
108
daemon processes.
 
109
.IP "\fBmax_idle (100s)\fR"
 
110
The maximum amount of time that an idle Postfix daemon process
 
111
waits for the next service request before exiting.
 
112
.IP "\fBmax_use (100)\fR"
 
113
The maximal number of connection requests before a Postfix daemon
 
114
process terminates.
 
115
.IP "\fBprocess_id (read-only)\fR"
 
116
The process ID of a Postfix command or daemon process.
 
117
.IP "\fBprocess_name (read-only)\fR"
 
118
The process name of a Postfix command or daemon process.
 
119
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 
120
The location of the Postfix top-level queue directory.
 
121
.IP "\fBsyslog_facility (mail)\fR"
 
122
The syslog facility of Postfix logging.
 
123
.IP "\fBsyslog_name (postfix)\fR"
 
124
The mail system name that is prepended to the process name in syslog
 
125
records, so that "smtpd" becomes, for example, "postfix/smtpd".
 
126
.SH "SEE ALSO"
 
127
.na
 
128
.nf
 
129
postconf(5), configuration parameters
 
130
master(8), process manager
 
131
syslogd(8), system logging
 
132
.SH "LICENSE"
 
133
.na
 
134
.nf
 
135
.ad
 
136
.fi
 
137
The Secure Mailer license must be distributed with this software.
 
138
.SH "AUTHOR(S)"
 
139
.na
 
140
.nf
 
141
Wietse Venema
 
142
IBM T.J. Watson Research
 
143
P.O. Box 704
 
144
Yorktown Heights, NY 10598, USA