-.\" $OpenBSD$
+.\" $OpenBSD: doas.conf.5,v 1.13 2015/07/27 21:44:11 tedu Exp $
.\"
.\"Copyright (c) 2015 Ted Unangst <tedu@openbsd.org>
.\"
.\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd $Mdocdate$
+.Dd $Mdocdate: July 27 2015 $
.Dt DOAS.CONF 5
.Os
.Sh NAME
configuration file.
.Pp
The rules have the following format:
-.Bd -literal -offset indent
-permit|deny [options] [identity] [as target] [cmd command]
+.Bd -ragged -offset indent
+.Ic permit Ns | Ns Ic deny
+.Op Ar options
+.Ar identity
+.Op Ic as Ar target
+.Op Ic cmd Ar command Op Ic args ...
.Ed
.Pp
Rules consist of the following parts:
-.Bl -tag -width tenletters
-.It permit|deny
+.Bl -tag -width 11n
+.It Ic permit Ns | Ns Ic deny
The action to be taken if this rule matches.
-.It options
+.It Ar options
Options are:
-.Bl -tag -width tenletters
-.It nopass
+.Bl -tag -width keepenv
+.It Ic nopass
The user is not required to enter a password.
-.It keepenv
+.It Ic keepenv
The user's environment is maintained.
-The default is to reset the environment.
-.It keepenv { [variable names] }
-Reset the environment, but keep the specified variables.
+The default is to reset the environment, except for the variables
+.Ev DISPLAY ,
+.Ev HOME ,
+.Ev LOGNAME ,
+.Ev MAIL ,
+.Ev PATH ,
+.Ev TERM ,
+.Ev USER
+and
+.Ev USERNAME .
+.It Ic keepenv { Oo Ar variable ... Oc Ic }
+In addition to the variables mentioned above, keep the space-separated
+specified variables.
.El
-.It identity
+.It Ar identity
The username to match.
-Groups may be specified by prepending a colon (:).
+Groups may be specified by prepending a colon
+.Pq Sq \&: .
Numeric IDs are also accepted.
-.It as target
+.It Ic as Ar target
The target user the running user is allowed to run the command as.
-The default is root.
-.It cmd command
+The default is all users.
+.It Ic cmd Ar command
The command the user is allowed or denied to run.
The default is all commands.
Be advised that it's best to specify absolute paths.
+.It Ic args ...
+Arguments to command.
+If specified, the command arguments provided by the user
+need to match for the command to be successful.
+Specifying
+.Ic args
+alone means that command should be run without any arguments.
.El
.Pp
The last matching rule determines the action taken.
+.Pp
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+.Pp
+The following quoting rules apply:
+.Bl -dash
+.It
+The text between a pair of double quotes
+.Pq Sq \&"
+is taken as is.
+.It
+The backslash character
+.Pq Sq \e
+escapes the next character, including new line characters, outside comments;
+as a result, comments may not be extended over multiple lines.
+.It
+If quotes or backslashes are used in a word,
+it isn't considered a keyword.
+.El
.Sh EXAMPLES
-The following example permits users in group wheel to exeucte commands as root,
+The following example permits users in group wsrc to build ports,
+wheel to execute commands as any user while keeping the environment
+variables
+.Ev ENV ,
+.Ev PS1 ,
+and
+.Ev SSH_AUTH_SOCK ,
and additionally permits tedu to run procmap as root without a password.
.Bd -literal -offset indent
-permit :wheel
-permit nopass tedu cmd /usr/sbin/procmap
+# Non-exhaustive list of variables needed to
+# build release(8) and ports(7)
+permit nopass keepenv { \e
+ FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
+ DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
+ MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
+ PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
+ SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
+permit nopass keepenv { ENV PS1 SSH_AUTH_SOCK } :wheel
+permit nopass tedu as root cmd /usr/sbin/procmap
.Ed
+.Sh SEE ALSO
+.Xr doas 1
+.Sh HISTORY
+The
+.Nm
+configuration file first appeared in
+.Ox 5.8 .
+.Sh AUTHORS
+.An Ted Unangst Aq Mt tedu@openbsd.org
projects / opendoas.git / blobdiff