]> git.armaanb.net Git - opendoas.git/blob - doas.conf.5
tweak previous;
[opendoas.git] / doas.conf.5
1 .\" $OpenBSD: doas.conf.5,v 1.10 2015/07/22 20:15:24 zhuk Exp $
2 .\"
3 .\"Copyright (c) 2015 Ted Unangst <tedu@openbsd.org>
4 .\"
5 .\"Permission to use, copy, modify, and distribute this software for any
6 .\"purpose with or without fee is hereby granted, provided that the above
7 .\"copyright notice and this permission notice appear in all copies.
8 .\"
9 .\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .Dd $Mdocdate: July 22 2015 $
17 .Dt DOAS.CONF 5
18 .Os
19 .Sh NAME
20 .Nm doas.conf
21 .Nd doas configuration file
22 .Sh DESCRIPTION
23 The
24 .Xr doas 1
25 utility executes commands as other users according to the rules
26 in the
27 .Nm
28 configuration file.
29 .Pp
30 The rules have the following format:
31 .Bd -ragged -offset indent
32 .Ic permit Ns | Ns Ic deny
33 .Op Ar options
34 .Ar identity
35 .Op Ic as Ar target
36 .Op Ic cmd Ar command Op Ic args ...
37 .Ed
38 .Pp
39 Rules consist of the following parts:
40 .Bl -tag -width 11n
41 .It Ic permit Ns | Ns Ic deny
42 The action to be taken if this rule matches.
43 .It Ar options
44 Options are:
45 .Bl -tag -width keepenv
46 .It Ic nopass
47 The user is not required to enter a password.
48 .It Ic keepenv
49 The user's environment is maintained.
50 The default is to reset the environment, except for the variables
51 .Ev DISPLAY ,
52 .Ev HOME ,
53 .Ev LOGNAME ,
54 .Ev MAIL ,
55 .Ev PATH ,
56 .Ev TERM ,
57 .Ev USER
58 and
59 .Ev USERNAME .
60 .It Ic keepenv { Oo variable names Oc Ic }
61 Reset the environment, but keep the space-separated specified variables.
62 .El
63 .It Ar identity
64 The username to match.
65 Groups may be specified by prepending a colon (:).
66 Numeric IDs are also accepted.
67 .It Ic as Ar target
68 The target user the running user is allowed to run the command as.
69 The default is root.
70 .It Ic cmd Ar command
71 The command the user is allowed or denied to run.
72 The default is all commands.
73 Be advised that it's best to specify absolute paths.
74 .It Ic args ...
75 Arguments to command.
76 If specified, the command arguments provided by the user
77 need to match for the command to be successful.
78 Specifying
79 .Ic args
80 alone means that command should be run without any arguments.
81 .El
82 .Pp
83 The last matching rule determines the action taken.
84 .Pp
85 Comments can be put anywhere in the file using a hash mark
86 .Pq Sq # ,
87 and extend to the end of the current line.
88 .Pp
89 The following quoting rules apply:
90 .Bl -dash
91 .It
92 The text between a pair of double quotes
93 .Pq Sq \&"
94 is taken as is.
95 .It
96 The backslash character
97 .Pq Sq \e
98 escapes the next character, including new line characters, outside comments;
99 as a result, comments may not be extended over multiple lines.
100 .It
101 If quotes or backslashes are used in a word,
102 it isn't considered a keyword.
103 .El
104 .Sh EXAMPLES
105 The following example permits users in group wsrc to build ports,
106 wheel to execute commands as root while keeping the environment
107 variables
108 .Ev ENV ,
109 .Ev PS1 ,
110 and
111 .Ev SSH_AUTH_SOCK ,
112 and additionally permits tedu to run procmap as root without a password.
113 .Bd -literal -offset indent
114 # Non-exhaustive list of variables needed to
115 # build release(8) and ports(7)
116 permit nopass keepenv { \e
117         FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
118         DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
119         MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
120         PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
121         SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
122 permit nopass keepenv { ENV PS1 SSH_AUTH_SOCK } :wheel
123 permit nopass tedu cmd /usr/sbin/procmap
124 .Ed
125 .Sh SEE ALSO
126 .Xr doas 1
127 .Sh HISTORY
128 The
129 .Nm
130 configuration file first appeared in
131 .Ox 5.8 .
132 .Sh AUTHORS
133 .An Ted Unangst Aq Mt tedu@openbsd.org