doas.1

   1 .\" $OpenBSD: doas.1,v 1.13 2015/07/26 23:00:15 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 26 2015 $
  17 .Dt DOAS 1
  18 .Os
  19 .Sh NAME
  20 .Nm doas
  21 .Nd execute commands as another user
  22 .Sh SYNOPSIS
  23 .Nm doas
  24 .Op Fl Lns
  25 .Op Fl C Ar config
  26 .Op Fl u Ar user
  27 .Ar command
  28 .Op Ar args
  29 .Sh DESCRIPTION
  30 The
  31 .Nm
  32 utility executes the given command as another user.
  33 The
  34 .Ar command
  35 argument is mandatory unless
  36 .Fl C ,
  37 .Fl L ,
  38 or
  39 .Fl s
  40 is specified.
  41 .Pp
  42 By default, the environment is reset.
  43 The variables
  44 .Ev HOME ,
  45 .Ev LOGNAME ,
  46 .Ev PATH ,
  47 .Ev SHELL ,
  48 and
  49 .Ev USER
  50 and the
  51 .Xr umask 2
  52 are set to values appropriate for the target user.
  53 The variables
  54 .Ev DISPLAY
  55 and
  56 .Ev TERM
  57 are inherited from the current environment.
  58 This behavior may be modified by the config file.
  59 The working directory is not changed.
  60 .Pp
  61 The options are as follows:
  62 .Bl -tag -width tenletters
  63 .It Fl C Ar config
  64 Parse and check the configuration file
  65 .Ar config ,
  66 then exit.
  67 If
  68 .Ar command
  69 is supplied,
  70 .Nm
  71 will also perform command matching.
  72 In the latter case
  73 either
  74 .Sq permit ,
  75 .Sq permit nopass
  76 or
  77 .Sq deny
  78 will be printed on standard output, depending on command
  79 matching results.
  80 No command is executed.
  81 .It Fl L
  82 Clear any persisted authorizations from previous invocations,
  83 then immediately exit.
  84 No command is executed.
  85 .It Fl n
  86 Non interactive mode, fail if
  87 .Nm
  88 would prompt for password.
  89 .It Fl s
  90 Execute the shell from
  91 .Ev SHELL
  92 or
  93 .Pa /etc/passwd .
  94 .It Fl u Ar user
  95 Execute the command as
  96 .Ar user .
  97 The default is root.
  98 .El
  99 .Sh EXIT STATUS
 100 .Ex -std doas
 101 It may fail for one of the following reasons:
 102 .Pp
 103 .Bl -bullet -compact
 104 .It
 105 The config file
 106 .Pa /etc/doas.conf
 107 could not be parsed.
 108 .It
 109 The user attempted to run a command which is not permitted.
 110 .It
 111 The password was incorrect.
 112 .It
 113 The specified command was not found or is not executable.
 114 .El
 115 .Sh SEE ALSO
 116 .Xr su 1 ,
 117 .Xr doas.conf 5
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 command first appeared in
 122 .Ox 5.8 .
 123 .Sh AUTHORS
 124 .An Ted Unangst Aq Mt tedu@openbsd.org