opendoas

A portable version of the OpenBSD `doas` command
git clone https://pi.duncano.de/git/opendoas.git

doas.conf.5 (4409B)


      1 .\" $OpenBSD: doas.conf.5,v 1.13 2015/07/27 21:44:11 tedu Exp $
      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.
     16 .Dd $Mdocdate: July 27 2015 $
     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:
     31 .Bd -ragged -offset indent
     32 .Ic permit Ns | Ns Ic deny
     33 .Op Ar options
     34 .Ar identity
     35 .Op Ic as Ar target
     36 .Op Ic cmd Ar command Op Ic args ...
     37 .Ed
     38 .Pp
     39 Rules consist of the following parts:
     40 .Bl -tag -width 11n
     41 .It Ic permit Ns | Ns Ic deny
     42 The action to be taken if this rule matches.
     43 .It Ar options
     44 Options are:
     45 .Bl -tag -width keepenv
     46 .It Ic nopass
     47 The user is not required to enter a password.
     48 .It Ic keepenv
     49 The user's environment is maintained.
     50 The default is to reset the environment, except for the variables
     51 .Ev DISPLAY ,
     52 .Ev HOME ,
     53 .Ev LOGNAME ,
     54 .Ev MAIL ,
     55 .Ev PATH ,
     56 .Ev TERM ,
     57 .Ev USER
     58 and
     59 .Ev USERNAME .
     60 .It Ic setenv { Oo Ar variable ... Oc Oo Ar variable=value ... Oc Ic }
     61 In addition to the variables mentioned above, keep the space-separated
     62 specified variables.
     63 Variables may also be removed with a leading
     64 .Sq -
     65 or set using the latter syntax.
     66 If the first character of
     67 .Ar value
     68 is a
     69 .Ql $
     70 then the value to be set is taken from the existing environment
     71 variable of the same name.
     72 .El
     73 .It Ar identity
     74 The username to match.
     75 Groups may be specified by prepending a colon
     76 .Pq Sq \&: .
     77 Numeric IDs are also accepted.
     78 .It Ic as Ar target
     79 The target user the running user is allowed to run the command as.
     80 The default is all users.
     81 .It Ic cmd Ar command
     82 The command the user is allowed or denied to run.
     83 The default is all commands.
     84 Be advised that it is best to specify absolute paths.
     85 If a relative path is specified, only a restricted
     86 .Ev PATH
     87 will be searched.
     88 .It Ic args ...
     89 Arguments to command.
     90 The command arguments provided by the user need to match those specified.
     91 The keyword
     92 .Ic args
     93 alone means that command must be run without any arguments.
     94 .El
     95 .Pp
     96 The last matching rule determines the action taken.
     97 If no rule matches, the action is denied.
     98 .Pp
     99 Comments can be put anywhere in the file using a hash mark
    100 .Pq Sq # ,
    101 and extend to the end of the current line.
    102 .Pp
    103 The following quoting rules apply:
    104 .Bl -dash
    105 .It
    106 The text between a pair of double quotes
    107 .Pq Sq \&"
    108 is taken as is.
    109 .It
    110 The backslash character
    111 .Pq Sq \e
    112 escapes the next character, including new line characters, outside comments;
    113 as a result, comments may not be extended over multiple lines.
    114 .It
    115 If quotes or backslashes are used in a word,
    116 it isn't considered a keyword.
    117 .El
    118 .Sh EXAMPLES
    119 The following example permits users in group wsrc to build ports;
    120 wheel to execute commands as any user while keeping the environment
    121 variables
    122 .Ev PS1
    123 and
    124 .Ev SSH_AUTH_SOCK
    125 and
    126 unsetting
    127 .Ev ENV ;
    128 permits tedu to run procmap as root without a password;
    129 and additionally permits root to run unrestricted commands as itself.
    130 .Bd -literal -offset indent
    131 # Non-exhaustive list of variables needed to
    132 # build release(8) and ports(7)
    133 permit nopass setenv { \e
    134         FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
    135         DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
    136         MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
    137         PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
    138         SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
    139 permit setenv { -ENV PS1=$DOAS_PS1 SSH_AUTH_SOCK } :wheel
    140 permit nopass tedu as root cmd /usr/sbin/procmap
    141 .Ed
    142 .Sh SEE ALSO
    143 .Xr doas 1
    144 .Sh HISTORY
    145 The
    146 .Nm
    147 configuration file first appeared in
    148 .Ox 5.8 .
    149 .Sh AUTHORS
    150 .An Ted Unangst Aq Mt tedu@openbsd.org