Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / contrib / sendmail / smrsh / smrsh.8
1 .\" Copyright (c) 1998-2001 Sendmail, Inc. and its suppliers.
2 .\"      All rights reserved.
3 .\" Copyright (c) 1993 Eric P. Allman.  All rights reserved.
4 .\" Copyright (c) 1993
5 .\"     The Regents of the University of California.  All rights reserved.
6 .\"
7 .\" By using this file, you agree to the terms and conditions set
8 .\" forth in the LICENSE file which can be found at the top level of
9 .\" the sendmail distribution.
10 .\"
11 .\"
12 .\"     $Id: smrsh.8,v 8.16 2002/04/25 13:33:40 ca Exp $
13 .\"
14 .TH SMRSH 8 "$Date: 2001/01/24 00:40:47 $"
15 .SH NAME
16 smrsh \- restricted shell for sendmail
17 .SH SYNOPSIS
18 .B smrsh
19 .B \-c
20 command
21 .SH DESCRIPTION
22 The
23 .I smrsh
24 program is intended as a replacement for
25 .I sh
26 for use in the ``prog'' mailer in
27 .IR sendmail (8)
28 configuration files.
29 It sharply limits the commands that can be run using the
30 ``|program'' syntax of
31 .I sendmail
32 in order to improve the over all security of your system.
33 Briefly, even if a ``bad guy'' can get sendmail to run a program
34 without going through an alias or forward file,
35 .I smrsh
36 limits the set of programs that he or she can execute.
37 .PP
38 Briefly,
39 .I smrsh
40 limits programs to be in a single directory,
41 by default
42 /usr/libexec/sm.bin,
43 allowing the system administrator to choose the set of acceptable commands,
44 and to the shell builtin commands ``exec'', ``exit'', and ``echo''.
45 It also rejects any commands with the characters
46 `\`', `<', `>', `;', `$', `(', `)', `\er' (carriage return),
47 or `\en' (newline)
48 on the command line to prevent ``end run'' attacks.
49 It allows ``||'' and ``&&'' to enable commands like:
50 ``"|exec /usr/local/bin/procmail -f- /etc/procmailrcs/user || exit 75"''
51 .PP
52 Initial pathnames on programs are stripped,
53 so forwarding to ``/usr/bin/vacation'',
54 ``/home/server/mydir/bin/vacation'',
55 and
56 ``vacation''
57 all actually forward to
58 ``/usr/libexec/sm.bin/vacation''.
59 .PP
60 System administrators should be conservative about populating
61 the sm.bin directory.
62 Reasonable additions are
63 .IR vacation (1),
64 .IR procmail (1),
65 and the like.
66 No matter how brow-beaten you may be,
67 never include any shell or shell-like program
68 (such as
69 .IR perl (1))
70 in the
71 sm.bin
72 directory.
73 Note that this does not restrict the use of shell or perl scripts
74 in the sm.bin directory (using the ``#!'' syntax);
75 it simply disallows execution of arbitrary programs.
76 .SH COMPILATION
77 Compilation should be trivial on most systems.
78 You may need to use \-DSMRSH_PATH=\e"\fIpath\fP\e"
79 to adjust the default search path
80 (defaults to ``/bin:/usr/bin'')
81 and/or \-DSMRSH_CMDDIR=\e"\fIdir\fP\e"
82 to change the default program directory
83 (defaults to ``/usr/libexec/sm.bin'').
84 .SH FILES
85 /usr/libexec/sm.bin \- directory for restricted programs
86 .SH SEE ALSO
87 sendmail(8)
88 .\" $FreeBSD: src/contrib/sendmail/smrsh/smrsh.8,v 1.3.6.5 2002/09/03 01:50:13 gshapiro Exp $
89 .\" $DragonFly: src/contrib/sendmail/smrsh/Attic/smrsh.8,v 1.2 2003/06/17 04:24:06 dillon Exp $