Return to doas.conf.5 CVS log

Up to [local] / src / usr.bin / doas

Annotation of src/usr.bin/doas/doas.conf.5, Revision 1.4

1.4     ! bentley     1: .\" $OpenBSD: doas.conf.5,v 1.3 2015/07/17 20:50:31 schwarze 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.4     ! bentley    16: .Dd $Mdocdate: July 17 2015 $
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
                     26: in the
                     27: .Nm
                     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
                     36: .Op Ic cmd Ar command
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.3       schwarze   48: .It Ic keepenv
1.1       tedu       49: The user's environment is maintained.
                     50: The default is to reset the environment.
1.3       schwarze   51: .It Ic keepenv { Oo variable names Oc Ic }
1.1       tedu       52: Reset the environment, but keep the specified variables.
                     53: .El
1.3       schwarze   54: .It Ar identity
1.1       tedu       55: The username to match.
                     56: Groups may be specified by prepending a colon (:).
                     57: Numeric IDs are also accepted.
1.3       schwarze   58: .It Ic as Ar target
1.1       tedu       59: The target user the running user is allowed to run the command as.
                     60: The default is root.
1.3       schwarze   61: .It Ic cmd Ar command
1.1       tedu       62: The command the user is allowed or denied to run.
                     63: The default is all commands.
                     64: Be advised that it's best to specify absolute paths.
                     65: .El
                     66: .Pp
                     67: The last matching rule determines the action taken.
                     68: .Sh EXAMPLES
1.2       nicm       69: The following example permits users in group wheel to execute commands as root,
1.1       tedu       70: and additionally permits tedu to run procmap as root without a password.
                     71: .Bd -literal -offset indent
                     72: permit :wheel
                     73: permit nopass tedu cmd /usr/sbin/procmap
                     74: .Ed
1.3       schwarze   75: .Sh SEE ALSO
                     76: .Xr doas 1
                     77: .Sh HISTORY
                     78: The
                     79: .Nm
                     80: configuration file first appeared in
                     81: .Ox 5.8 .
                     82: .Sh AUTHORS
                     83: .An Ted Unangst Aq Mt tedu@openbsd.org