contrib/wpa/wpa_supplicant/doc/docbook/wpa_priv.8

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "WPA_PRIV" "8" "07 September 2010" "" ""
   7
   8 .SH NAME
   9 wpa_priv \- wpa_supplicant privilege separation helper
  10 .SH SYNOPSIS
  11
  12 \fBwpa_priv\fR [ \fB-c \fIctrl path\fB\fR ] [ \fB-Bdd\fR ] [ \fB-P \fIpid file\fB\fR ] [ \fBdriver:ifname \fI[driver:ifname ...]\fB\fR ]
  13
  14 .SH "OVERVIEW"
  15 .PP
  16 \fBwpa_priv\fR is a privilege separation helper that
  17 minimizes the size of \fBwpa_supplicant\fR code that needs
  18 to be run with root privileges.
  19 .PP
  20 If enabled, privileged operations are done in the wpa_priv process
  21 while leaving rest of the code (e.g., EAP authentication and WPA
  22 handshakes) to operate in an unprivileged process (wpa_supplicant) that
  23 can be run as non-root user. Privilege separation restricts the effects
  24 of potential software errors by containing the majority of the code in an
  25 unprivileged process to avoid the possibility of a full system
  26 compromise.
  27 .PP
  28 \fBwpa_priv\fR needs to be run with network admin
  29 privileges (usually, root user). It opens a UNIX domain socket for each
  30 interface that is included on the command line; any other interface will
  31 be off limits for \fBwpa_supplicant\fR in this kind of
  32 configuration. After this, \fBwpa_supplicant\fR can be run as
  33 a non-root user (e.g., all standard users on a laptop or as a special
  34 non-privileged user account created just for this purpose to limit access
  35 to user files even further).
  36 .SH "EXAMPLE CONFIGURATION"
  37 .PP
  38 The following steps are an example of how to configure
  39 \fBwpa_priv\fR to allow users in the
  40 \fBwpapriv\fR group to communicate with
  41 \fBwpa_supplicant\fR with privilege separation:
  42 .PP
  43 Create user group (e.g., wpapriv) and assign users that
  44 should be able to use wpa_supplicant into that group.
  45 .PP
  46 Create /var/run/wpa_priv directory for UNIX domain sockets and
  47 control user access by setting it accessible only for the wpapriv
  48 group:
  49 .sp
  50 .RS
  51
  52 .nf
  53 mkdir /var/run/wpa_priv
  54 chown root:wpapriv /var/run/wpa_priv
  55 chmod 0750 /var/run/wpa_priv
  56 .fi
  57 .RE
  58 .PP
  59 Start \fBwpa_priv\fR as root (e.g., from system
  60 startup scripts) with the enabled interfaces configured on the
  61 command line:
  62 .sp
  63 .RS
  64
  65 .nf
  66 wpa_priv -B -c /var/run/wpa_priv -P /var/run/wpa_priv.pid wext:wlan0
  67 .fi
  68 .RE
  69 .PP
  70 Run \fBwpa_supplicant\fR as non-root with a user
  71 that is in the wpapriv group:
  72 .sp
  73 .RS
  74
  75 .nf
  76 wpa_supplicant -i ath0 -c wpa_supplicant.conf
  77 .fi
  78 .RE
  79 .SH "COMMAND ARGUMENTS"
  80 .TP
  81 \fB-c ctrl path\fR
  82 Specify the path to wpa_priv control directory
  83 (Default: /var/run/wpa_priv/).
  84 .TP
  85 \fB-B\fR
  86 Run as a daemon in the background.
  87 .TP
  88 \fB-P file\fR
  89 Set the location of the PID
  90 file.
  91 .TP
  92 \fBdriver:ifname [driver:ifname ...]\fR
  93 The <driver> string dictates which of the
  94 supported \fBwpa_supplicant\fR driver backends is to be
  95 used. To get a list of supported driver types see wpa_supplicant help
  96 (e.g, wpa_supplicant -h). The driver backend supported by most good
  97 drivers is \fBwext\fR\&.
  98
  99 The <ifname> string specifies which network
 100 interface is to be managed by \fBwpa_supplicant\fR
 101 (e.g., wlan0 or ath0).
 102
 103 \fBwpa_priv\fR does not use the network interface
 104 before \fBwpa_supplicant\fR is started, so it is fine to
 105 include network interfaces that are not available at the time wpa_priv
 106 is started. wpa_priv can control multiple interfaces with one process,
 107 but it is also possible to run multiple \fBwpa_priv\fR
 108 processes at the same time, if desired.
 109 .SH "SEE ALSO"
 110 .PP
 111 \fBwpa_supplicant\fR(8)
 112 .SH "LEGAL"
 113 .PP
 114 wpa_supplicant is copyright (c) 2003-2007,
 115 Jouni Malinen <j@w1.fi> and
 116 contributors.
 117 All Rights Reserved.
 118 .PP
 119 This program is dual-licensed under both the GPL version 2
 120 and BSD license. Either license may be used at your option.