Annotation of src/usr.bin/doas/doas.conf.5, Revision 1.33
1.33 ! jmc 1: .\" $OpenBSD: doas.conf.5,v 1.32 2017/03/20 14:35:06 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.33 ! jmc 16: .Dd $Mdocdate: March 20 2017 $
1.1 tedu 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
1.18 jmc 26: in the
27: .Nm
1.1 tedu 28: configuration file.
29: .Pp
30: The rules have the following format:
1.3 schwarze 31: .Bd -ragged -offset indent
32: .Ic permit Ns | Ns Ic deny
33: .Op Ar options
1.4 bentley 34: .Ar identity
1.3 schwarze 35: .Op Ic as Ar target
1.31 schwarze 36: .Op Ic cmd Ar command Op Ic args No ...
1.1 tedu 37: .Ed
38: .Pp
39: Rules consist of the following parts:
1.3 schwarze 40: .Bl -tag -width 11n
41: .It Ic permit Ns | Ns Ic deny
1.1 tedu 42: The action to be taken if this rule matches.
1.3 schwarze 43: .It Ar options
1.1 tedu 44: Options are:
1.3 schwarze 45: .Bl -tag -width keepenv
46: .It Ic nopass
1.1 tedu 47: The user is not required to enter a password.
1.30 tedu 48: .It Ic persist
49: After the user successfully authenticates, do not ask for a password
50: again for some time.
1.3 schwarze 51: .It Ic keepenv
1.1 tedu 52: The user's environment is maintained.
1.5 benno 53: The default is to reset the environment, except for the variables
54: .Ev DISPLAY ,
55: .Ev HOME ,
56: .Ev LOGNAME ,
57: .Ev MAIL ,
58: .Ev PATH ,
59: .Ev TERM ,
60: .Ev USER
61: and
62: .Ev USERNAME .
1.29 jmc 63: .It Ic setenv { Oo Ar variable ... Oc Oo Ar variable=value ... Oc Ic }
1.12 jmc 64: In addition to the variables mentioned above, keep the space-separated
65: specified variables.
1.29 jmc 66: Variables may also be removed with a leading
67: .Sq -
68: or set using the latter syntax.
1.27 tedu 69: If the first character of
70: .Ar value
71: is a
72: .Ql $
73: then the value to be set is taken from the existing environment
74: variable of the same name.
1.1 tedu 75: .El
1.3 schwarze 76: .It Ar identity
1.1 tedu 77: The username to match.
1.12 jmc 78: Groups may be specified by prepending a colon
79: .Pq Sq \&: .
1.1 tedu 80: Numeric IDs are also accepted.
1.3 schwarze 81: .It Ic as Ar target
1.1 tedu 82: The target user the running user is allowed to run the command as.
1.13 tedu 83: The default is all users.
1.3 schwarze 84: .It Ic cmd Ar command
1.1 tedu 85: The command the user is allowed or denied to run.
86: The default is all commands.
1.23 tedu 87: Be advised that it is best to specify absolute paths.
1.25 tedu 88: If a relative path is specified, only a restricted
1.16 tedu 89: .Ev PATH
90: will be searched.
1.31 schwarze 91: .It Ic args Op Ar argument ...
1.8 zhuk 92: Arguments to command.
1.26 tedu 93: The command arguments provided by the user need to match those specified.
1.25 tedu 94: The keyword
1.8 zhuk 95: .Ic args
1.25 tedu 96: alone means that command must be run without any arguments.
1.1 tedu 97: .El
98: .Pp
99: The last matching rule determines the action taken.
1.24 tedu 100: If no rule matches, the action is denied.
1.5 benno 101: .Pp
102: Comments can be put anywhere in the file using a hash mark
103: .Pq Sq # ,
104: and extend to the end of the current line.
1.10 zhuk 105: .Pp
106: The following quoting rules apply:
107: .Bl -dash
108: .It
109: The text between a pair of double quotes
110: .Pq Sq \&"
111: is taken as is.
112: .It
1.11 jmc 113: The backslash character
1.10 zhuk 114: .Pq Sq \e
1.11 jmc 115: escapes the next character, including new line characters, outside comments;
1.10 zhuk 116: as a result, comments may not be extended over multiple lines.
117: .It
1.11 jmc 118: If quotes or backslashes are used in a word,
1.23 tedu 119: it is not considered a keyword.
1.33 ! jmc 120: .El
! 121: .Sh FILES
! 122: .Bl -tag -width "/etc/doas.conf"
! 123: .It Pa /etc/doas.conf
! 124: Doas configuration file.
1.10 zhuk 125: .El
1.1 tedu 126: .Sh EXAMPLES
1.32 tedu 127: The following example permits user aja to install packages
128: from a preferred mirror;
129: group wheel to execute commands as any user while keeping the environment
1.5 benno 130: variables
1.27 tedu 131: .Ev PS1
132: and
133: .Ev SSH_AUTH_SOCK
134: and
135: unsetting
1.29 jmc 136: .Ev ENV ;
137: permits tedu to run procmap as root without a password;
1.15 reyk 138: and additionally permits root to run unrestricted commands as itself.
1.1 tedu 139: .Bd -literal -offset indent
1.32 tedu 140: permit persist setenv { PKG_CACHE PKG_PATH } aja cmd pkg_add
1.28 tedu 141: permit setenv { -ENV PS1=$DOAS_PS1 SSH_AUTH_SOCK } :wheel
1.14 zhuk 142: permit nopass tedu as root cmd /usr/sbin/procmap
1.15 reyk 143: permit nopass keepenv root as root
1.1 tedu 144: .Ed
1.3 schwarze 145: .Sh SEE ALSO
146: .Xr doas 1
147: .Sh HISTORY
148: The
149: .Nm
150: configuration file first appeared in
151: .Ox 5.8 .
152: .Sh AUTHORS
153: .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