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 ...
  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 keepenv { Oo Ar variable ... Oc Ic }
  61 In addition to the variables mentioned above, keep the space-separated
  62 specified variables.
  63 .El
  64 .It Ar identity
  65 The username to match.
  66 Groups may be specified by prepending a colon
  67 .Pq Sq \&: .
  68 Numeric IDs are also accepted.
  69 .It Ic as Ar target
  70 The target user the running user is allowed to run the command as.
  71 The default is all users.
  72 .It Ic cmd Ar command
  73 The command the user is allowed or denied to run.
  74 The default is all commands.
  75 Be advised that it's best to specify absolute paths.
  76 .It Ic args ...
  77 Arguments to command.
  78 If specified, the command arguments provided by the user
  79 need to match for the command to be successful.
  80 Specifying
  81 .Ic args
  82 alone means that command should be run without any arguments.
  83 .El
  84 .Pp
  85 The last matching rule determines the action taken.
  86 .Pp
  87 Comments can be put anywhere in the file using a hash mark
  88 .Pq Sq # ,
  89 and extend to the end of the current line.
  90 .Pp
  91 The following quoting rules apply:
  92 .Bl -dash
  93 .It
  94 The text between a pair of double quotes
  95 .Pq Sq \&"
  96 is taken as is.
  97 .It
  98 The backslash character
  99 .Pq Sq \e
 100 escapes the next character, including new line characters, outside comments;
 101 as a result, comments may not be extended over multiple lines.
 102 .It
 103 If quotes or backslashes are used in a word,
 104 it isn't considered a keyword.
 105 .El
 106 .Sh EXAMPLES
 107 The following example permits users in group wsrc to build ports,
 108 wheel to execute commands as any user while keeping the environment
 109 variables
 110 .Ev ENV ,
 111 .Ev PS1 ,
 112 and
 113 .Ev SSH_AUTH_SOCK ,
 114 and additionally permits tedu to run procmap as root without a password.
 115 .Bd -literal -offset indent
 116 # Non-exhaustive list of variables needed to
 117 # build release(8) and ports(7)
 118 permit nopass keepenv { \e
 119         FTPMODE PKG_CACHE PKG_PATH SM_PATH SSH_AUTH_SOCK \e
 120         DESTDIR DISTDIR FETCH_CMD FLAVOR GROUP MAKE MAKECONF \e
 121         MULTI_PACKAGES NOMAN OKAY_FILES OWNER PKG_DBDIR \e
 122         PKG_DESTDIR PKG_TMPDIR PORTSDIR RELEASEDIR SHARED_ONLY \e
 123         SUBPACKAGE WRKOBJDIR SUDO_PORT_V1 } :wsrc
 124 permit nopass keepenv { ENV PS1 SSH_AUTH_SOCK } :wheel
 125 permit nopass tedu as root cmd /usr/sbin/procmap
 126 .Ed
 127 .Sh SEE ALSO
 128 .Xr doas 1
 129 .Sh HISTORY
 130 The
 131 .Nm
 132 configuration file first appeared in
 133 .Ox 5.8 .
 134 .Sh AUTHORS
 135 .An Ted Unangst Aq Mt tedu@openbsd.org