raddb/sites-available/control-socket

   1 # -*- text -*-
   2 ######################################################################
   3 #
   4 #       Control socket interface.
   5 #
   6 #       HIGHLY experimental!  It should NOT be used in production
   7 #       environments.
   8 #
   9 #       In the future, we will add username/password checking for
  10 #       connections to the control socket.  We will also add
  11 #       command authorization, where the commands entered by the
  12 #       administrator are run through a virtual server before
  13 #       they are executed.
  14 #
  15 #       For now, anyone who has permission to connect to the socket
  16 #       has nearly complete control over the server.  Be warned!
  17 #
  18 #       This functionality is NOT enabled by default.
  19 #
  20 #       See also the "radmin" program, which is used to communicate
  21 #       with the server over the control socket.
  22 #
  23 #       $Id$
  24 #
  25 ######################################################################
  26 listen {
  27         #
  28         #  Listen on the control socket.
  29         #
  30         type = control
  31
  32         #
  33         #  Socket location.
  34         #
  35         #  This file is created with the server's uid and gid.
  36         #  It's permissions are r/w for that user and group, and
  37         #  no permissions for "other" users.  These permissions form
  38         #  minimal security, and should not be relied on.
  39         #
  40         socket = ${run_dir}/${name}.sock
  41
  42         #
  43         #  The following two parameters perform authentication and
  44         #  authorization of connections to the control socket.
  45         #
  46         #  If not set, then ANYONE can connect to the control socket,
  47         #  and have complete control over the server.  This is likely
  48         #  not what you want.
  49         #
  50         #  One, or both, of "uid" and "gid" should be set.  If set, the
  51         #  corresponding value is checked.  Unauthorized users result
  52         #  in an error message in the log file, and the connection is
  53         #  closed.
  54         #
  55
  56         #
  57         #  Name of user that is allowed to connect to the control socket.
  58         #
  59 #       uid = radius
  60
  61         #
  62         #  Name of group that is allowed to connect to the control socket.
  63         #
  64 #       gid = radius
  65
  66         #
  67         #  Access mode.
  68         #
  69         #  This can be used to give *some* administrators access to
  70         #  monitor the system, but not to change it.
  71         #
  72         #       ro = read only access (default)
  73         #       rw = read/write access.
  74         #
  75 #       mode = rw
  76 }