src/auth/basic/RADIUS/basic_radius_auth.8

   1 .if !'po4a'hide' .TH basic_radius_auth 8 "7 August 2004"
   2 .
   3 .SH NAME
   4 basic_radius_auth \- Squid RADIUS authentication helper
   5 .
   6 .SH SYNOPSIS
   7 .if !'po4a'hide' .B basic_radius_auth
   8 .if !'po4a'hide' .B \-f
   9 config file
  10 .br
  11 .if !'po4a'hide' .B basic_radius_auth
  12 .if !'po4a'hide' .B "\-h \(dq"
  13 server name
  14 .if !'po4a'hide' .B "\(dq [\-p "
  15 port
  16 .if !'po4a'hide' .B "] [\-i "
  17 identifier
  18 .if !'po4a'hide' .B "] \-w "
  19 secret
  20 .if !'po4a'hide' .B "[\-t "
  21 timeout
  22 .if !'po4a'hide' .B "]"
  23 .
  24 .SH DESCRIPTION
  25 .B basic_radius_auth
  26 allows Squid to connect to a RADIUS server to
  27 validate the user name and password of Basic HTTP authentication.
  28 .
  29 .SH OPTIONS
  30 .if !'po4a'hide' .TP 12
  31 .if !'po4a'hide' .B "\-f configfile"
  32 Specifies the path to a configuration file. See the CONFIGURATION section
  33 for details on the file content.
  34 .
  35 .if !'po4a'hide' .TP
  36 .if !'po4a'hide' .B "\-h server"
  37 Alternative method of specifying the server to connect to
  38 .
  39 .if !'po4a'hide' .TP
  40 .if !'po4a'hide' .B "\-p port"
  41 Specify another server port where the RADIUS server listens for requests
  42 if different from the default RADIUS port.  Normally not specified.
  43 .
  44 .if !'po4a'hide' .TP
  45 .if !'po4a'hide' .B "\-i identifier"
  46 Unique identifier identifying this Squid proxy to the RADIUS server.
  47 If not specified the IP address is used to identify the proxy.
  48 .
  49 .if !'po4a'hide' .TP
  50 .if !'po4a'hide' .B "\-w secret"
  51 Alternative method of specifying the shared secret. Using the
  52 .B \-f
  53 option with a configuration file is generally more secure and recommended.
  54 .
  55 .if !'po4a'hide' .TP
  56 .if !'po4a'hide' .B "\-t timeout"
  57 RADIUS request timeout. Default is 10 seconds.
  58 .
  59 .SH CONFIGURATION
  60 The configuration specifies how the helper connects to RADIUS.
  61 The file contains a list of directives (one per line). Lines
  62 beginning with a
  63 .B #
  64 are ignored.
  65 .
  66 .if !'po4a'hide' .TP
  67 .if !'po4a'hide' .BI "server " radiusserver
  68 specifies the name or address of the RADIUS server to connect to.
  69 .
  70 .if !'po4a'hide' .TP
  71 .if !'po4a'hide' .BI "secret " somesecretstring
  72 specifies the shared RADIUS secret.
  73 .
  74 .if !'po4a'hide' .TP
  75 .if !'po4a'hide' .BI "identifier " nameofserver
  76 specifies what name the proxy should use to identify itself to the RADIUS server.
  77 This directive is optional.
  78 .
  79 .if !'po4a'hide' .TP
  80 .if !'po4a'hide' .BI "port " portnumber
  81 Specifies the port number or service name where the helper should connect.
  82 .
  83 .if !'po4a'hide' .TP
  84 .if !'po4a'hide' .BI "timeout " seconds
  85 Specifies the RADIUS request timeout.
  86 .
  87 .SH AUTHOR
  88 This program is written by
  89 .if !'po4a'hide' .I Marc van Selm <selm@cistron.nl>
  90 .if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
  91 .PP
  92 With contributions from many others.
  93 .PP
  94 This manual was written by
  95 .if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
  96 .
  97 .SH COPYRIGHT
  98 .PP
  99  * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
 100  *
 101  * Squid software is distributed under GPLv2+ license and includes
 102  * contributions from numerous individuals and organizations.
 103  * Please see the COPYING and CONTRIBUTORS files for details.
 104 .PP
 105 This program and documentation is copyright to the authors named above.
 106 .PP
 107 Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
 108 .
 109 .SH QUESTIONS
 110 Questions on the usage of this program can be sent to the
 111 .I Squid Users mailing list
 112 .if !'po4a'hide' <squid-users@lists.squid-cache.org>
 113 .PP
 114 Or contact your favorite RADIUS list/friend if the question is more related to
 115 RADIUS than Squid.
 116 .
 117 .SH REPORTING BUGS
 118 Bug reports need to be made in English.
 119 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
 120 .PP
 121 Report bugs or bug fixes using http://bugs.squid-cache.org/
 122 .PP
 123 Report serious security bugs to
 124 .I Squid Bugs <squid-bugs@lists.squid-cache.org>
 125 .PP
 126 Report ideas for new improvements to the
 127 .I Squid Developers mailing list
 128 .if !'po4a'hide' <squid-dev@lists.squid-cache.org>
 129 .
 130 .SH SEE ALSO
 131 .if !'po4a'hide' .BR squid "(8), "
 132 .if !'po4a'hide' .BR GPL "(7), "
 133 .br
 134 .BR RFC2058 " - Remote Authentication Dial In User Service (RADIUS)"
 135 .br
 136 The Squid FAQ wiki
 137 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
 138 .br
 139 The Squid Configuration Manual
 140 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/
 141