Annotation of src/usr.bin/doas/doas.conf.5, Revision 1.25
1.25 ! tedu 1: .\" $OpenBSD: doas.conf.5,v 1.24 2016/06/11 04:56:16 tedu Exp $
1.1 tedu 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.
1.24 tedu 16: .Dd $Mdocdate: June 11 2016 $
1.1 tedu 17: .Dt DOAS.CONF 5
18: .Os
19: .Sh NAME
20: .Nm doas.conf
21: .Nd doas configuration file
1.17 tedu 22: .Sh SYNOPSIS
23: .Nm /etc/doas.conf
1.1 tedu 24: .Sh DESCRIPTION
25: The
26: .Xr doas 1
27: utility executes commands as other users according to the rules
1.18 jmc 28: in the
29: .Nm
1.1 tedu 30: configuration file.
31: .Pp
32: The rules have the following format:
1.3 schwarze 33: .Bd -ragged -offset indent
34: .Ic permit Ns | Ns Ic deny
35: .Op Ar options
1.4 bentley 36: .Ar identity
1.3 schwarze 37: .Op Ic as Ar target
1.9 jmc 38: .Op Ic cmd Ar command Op Ic args ...
1.1 tedu 39: .Ed
40: .Pp
41: Rules consist of the following parts:
1.3 schwarze 42: .Bl -tag -width 11n
43: .It Ic permit Ns | Ns Ic deny
1.1 tedu 44: The action to be taken if this rule matches.
1.3 schwarze 45: .It Ar options
1.1 tedu 46: Options are:
1.3 schwarze 47: .Bl -tag -width keepenv
48: .It Ic nopass
1.1 tedu 49: The user is not required to enter a password.
1.3 schwarze 50: .It Ic keepenv
1.1 tedu 51: The user's environment is maintained.
1.5 benno 52: The default is to reset the environment, except for the variables
53: .Ev DISPLAY ,
54: .Ev HOME ,
55: .Ev LOGNAME ,
56: .Ev MAIL ,
57: .Ev PATH ,
58: .Ev TERM ,
59: .Ev USER
60: and
61: .Ev USERNAME .
1.22 tedu 62: .It Ic keepenv { Oo Ar variable ... Oc Ic }
1.12 jmc 63: In addition to the variables mentioned above, keep the space-separated
64: specified variables.
1.1 tedu 65: .El
1.3 schwarze 66: .It Ar identity
1.1 tedu 67: The username to match.
1.12 jmc 68: Groups may be specified by prepending a colon
69: .Pq Sq \&: .
1.1 tedu 70: Numeric IDs are also accepted.
1.3 schwarze 71: .It Ic as Ar target
1.1 tedu 72: The target user the running user is allowed to run the command as.
1.13 tedu 73: The default is all users.
1.3 schwarze 74: .It Ic cmd Ar command
1.1 tedu 75: The command the user is allowed or denied to run.
76: The default is all commands.
1.23 tedu 77: Be advised that it is best to specify absolute paths.
1.25 ! tedu 78: If a relative path is specified, only a restricted
1.16 tedu 79: .Ev PATH
80: will be searched.
1.9 jmc 81: .It Ic args ...
1.8 zhuk 82: Arguments to command.
1.9 jmc 83: If specified, the command arguments provided by the user
1.25 ! tedu 84: need to match those specified.
! 85: The keyword
1.8 zhuk 86: .Ic args
1.25 ! tedu 87: alone means that command must be run without any arguments.
1.1 tedu 88: .El
89: .Pp
90: The last matching rule determines the action taken.
1.24 tedu 91: If no rule matches, the action is denied.
1.5 benno 92: .Pp
93: Comments can be put anywhere in the file using a hash mark
94: .Pq Sq # ,
95: and extend to the end of the current line.
1.10 zhuk 96: .Pp
97: The following quoting rules apply:
98: .Bl -dash
99: .It
100: The text between a pair of double quotes
101: .Pq Sq \&"
102: is taken as is.
103: .It
1.11 jmc 104: The backslash character
1.10 zhuk 105: .Pq Sq \e
1.11 jmc 106: escapes the next character, including new line characters, outside comments;
1.10 zhuk 107: as a result, comments may not be extended over multiple lines.
108: .It
1.11 jmc 109: If quotes or backslashes are used in a word,
1.23 tedu 110: it is not considered a keyword.
1.10 zhuk 111: .El
1.1 tedu 112: .Sh EXAMPLES
1.5 benno 113: The following example permits users in group wsrc to build ports,
1.14 zhuk 114: wheel to execute commands as any user while keeping the environment
1.5 benno 115: variables
116: .Ev ENV ,
117: .Ev PS1 ,
118: and
119: .Ev SSH_AUTH_SOCK ,
1.15 reyk 120: permits tedu to run procmap as root without a password,
121: and additionally permits root to run unrestricted commands as itself.
1.1 tedu 122: .Bd -literal -offset indent
1.6 jmc 123: # Non-exhaustive list of variables needed to
1.5 benno 124: # build release(8) and ports(7)
125: permit nopass keepenv { \e
126: FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
127: DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
128: MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
129: PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
130: SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
1.22 tedu 131: permit nopass keepenv { ENV PS1 SSH_AUTH_SOCK } :wheel
1.14 zhuk 132: permit nopass tedu as root cmd /usr/sbin/procmap
1.15 reyk 133: permit nopass keepenv root as root
1.1 tedu 134: .Ed
1.3 schwarze 135: .Sh SEE ALSO
136: .Xr doas 1
137: .Sh HISTORY
138: The
139: .Nm
140: configuration file first appeared in
141: .Ox 5.8 .
142: .Sh AUTHORS
143: .An Ted Unangst Aq Mt tedu@openbsd.org
![[BACK]](/icons/back.gif){kind=icon}
Return to doas.conf.5 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / doas