1 .\" $OpenBSD: doas.conf.5,v 1.13 2015/07/27 21:44:11 tedu Exp $
3 .\"Copyright (c) 2015 Ted Unangst <tedu@openbsd.org>
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.
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 27 2015 $
21 .Nd doas configuration file
25 utility executes commands as other users according to the rules
30 The rules have the following format:
31 .Bd -ragged -offset indent
32 .Ic permit Ns | Ns Ic deny
36 .Op Ic cmd Ar command Op Ic args ...
39 Rules consist of the following parts:
41 .It Ic permit Ns | Ns Ic deny
42 The action to be taken if this rule matches.
45 .Bl -tag -width keepenv
47 The user is not required to enter a password.
49 The user's environment is maintained.
50 The default is to reset the environment, except for the variables
60 .It Ic setenv { Oo Ar variable ... Oc Ic Oo Ar variable=value ... Oc Ic }
61 In addition to the variables mentioned above, keep the space-separated
63 Variables may also be removed with a leading - or set using the latter syntax.
64 If the first character of
68 then the value to be set is taken from the existing environment
69 variable of the same name.
72 The username to match.
73 Groups may be specified by prepending a colon
75 Numeric IDs are also accepted.
77 The target user the running user is allowed to run the command as.
78 The default is all users.
80 The command the user is allowed or denied to run.
81 The default is all commands.
82 Be advised that it is best to specify absolute paths.
83 If a relative path is specified, only a restricted
88 The command arguments provided by the user need to match those specified.
91 alone means that command must be run without any arguments.
94 The last matching rule determines the action taken.
95 If no rule matches, the action is denied.
97 Comments can be put anywhere in the file using a hash mark
99 and extend to the end of the current line.
101 The following quoting rules apply:
104 The text between a pair of double quotes
108 The backslash character
110 escapes the next character, including new line characters, outside comments;
111 as a result, comments may not be extended over multiple lines.
113 If quotes or backslashes are used in a word,
114 it isn't considered a keyword.
117 The following example permits users in group wsrc to build ports,
118 wheel to execute commands as any user while keeping the environment
126 permits tedu to run procmap as root without a password,
127 and additionally permits root to run unrestricted commands as itself.
128 .Bd -literal -offset indent
129 # Non-exhaustive list of variables needed to
130 # build release(8) and ports(7)
131 permit nopass setenv { \e
132 FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
133 DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
134 MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
135 PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
136 SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
137 permit setenv { -ENV PS1=$DOAS_PS1 SSH_AUTH_SOCK } :wheel
138 permit nopass tedu as root cmd /usr/sbin/procmap
145 configuration file first appeared in
148 .An Ted Unangst Aq Mt tedu@openbsd.org