doas.conf.5

   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 No ...
  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 persist
  49 After the user successfully authenticates, do not ask for a password
  50 again for some time.
  51 .It Ic keepenv
  52 Environment variables other than those listed in
  53 .Xr doas 1
  54 are retained when creating the environment for the new process.
  55 .It Ic setenv { Oo Ar variable ... Oc Oo Ar variable=value ... Oc Ic }
  56 Keep or set the space-separated specified variables.
  57 Variables may also be removed with a leading
  58 .Sq -
  59 or set using the latter syntax.
  60 If the first character of
  61 .Ar value
  62 is a
  63 .Ql $
  64 then the value to be set is taken from the existing environment
  65 variable of the indicated name.
  66 This option is processed after the default environment has been created.
  67 .El
  68 .It Ar identity
  69 The username to match.
  70 Groups may be specified by prepending a colon
  71 .Pq Sq \&: .
  72 Numeric IDs are also accepted.
  73 .It Ic as Ar target
  74 The target user the running user is allowed to run the command as.
  75 The default is all users.
  76 .It Ic cmd Ar command
  77 The command the user is allowed or denied to run.
  78 The default is all commands.
  79 Be advised that it is best to specify absolute paths.
  80 If a relative path is specified, only a restricted
  81 .Ev PATH
  82 will be searched.
  83 .It Ic args Op Ar argument ...
  84 Arguments to command.
  85 The command arguments provided by the user need to match those specified.
  86 The keyword
  87 .Ic args
  88 alone means that command must be run without any arguments.
  89 .El
  90 .Pp
  91 The last matching rule determines the action taken.
  92 If no rule matches, the action is denied.
  93 .Pp
  94 Comments can be put anywhere in the file using a hash mark
  95 .Pq Sq # ,
  96 and extend to the end of the current line.
  97 .Pp
  98 The following quoting rules apply:
  99 .Bl -dash
 100 .It
 101 The text between a pair of double quotes
 102 .Pq Sq \&"
 103 is taken as is.
 104 .It
 105 The backslash character
 106 .Pq Sq \e
 107 escapes the next character, including new line characters, outside comments;
 108 as a result, comments may not be extended over multiple lines.
 109 .It
 110 If quotes or backslashes are used in a word,
 111 it isn't considered a keyword.
 112 .El
 113 .Sh FILES
 114 .Bl -tag -width /etc/examples/doas.conf -compact
 115 .It Pa /etc/doas.conf
 116 .Xr doas 1
 117 configuration file
 118 .It Pa /etc/examples/doas.conf
 119 example configuration file
 120 .El
 121 .Sh EXAMPLES
 122 The following example permits user aja to install packages
 123 from a preferred mirror;
 124 group wheel to execute commands as any user while keeping the environment
 125 variables
 126 .Ev PS1
 127 and
 128 .Ev SSH_AUTH_SOCK
 129 and
 130 unsetting
 131 .Ev ENV ;
 132 permits tedu to run procmap as root without a password;
 133 and additionally permits root to run unrestricted commands as itself
 134 while retaining the original PATH.
 135 .Bd -literal -offset indent
 136 permit persist setenv { PKG_CACHE PKG_PATH } aja cmd pkg_add
 137 permit setenv { -ENV PS1=$DOAS_PS1 SSH_AUTH_SOCK } :wheel
 138 permit nopass tedu as root cmd /usr/sbin/procmap
 139 permit nopass keepenv setenv { PATH } root as root
 140 .Ed
 141 .Sh SEE ALSO
 142 .Xr doas 1
 143 .Sh HISTORY
 144 The
 145 .Nm
 146 configuration file first appeared in
 147 .Ox 5.8 .
 148 .Sh AUTHORS
 149 .An Ted Unangst Aq Mt tedu@openbsd.org