source: squid-ssl/trunk/fuentes/helpers/external_acl/SQL_session/ext_sql_session_acl.8 @ 5495

Last change on this file since 5495 was 5495, checked in by Juanma, 23 months ago

Initial release

File size: 7.1 KB
Line 
1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings.  \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27.    ds -- \(*W-
28.    ds PI pi
29.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31.    ds L" ""
32.    ds R" ""
33.    ds C` ""
34.    ds C' ""
35'br\}
36.el\{\
37.    ds -- \|\(em\|
38.    ds PI \(*p
39.    ds L" ``
40.    ds R" ''
41.    ds C`
42.    ds C'
43'br\}
44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el       .ds Aq '
48.\"
49.\" If the F register is turned on, we'll generate index entries on stderr for
50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51.\" entries marked with X<> in POD.  Of course, you'll have to process the
52.\" output yourself in some meaningful fashion.
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
56..
57.nr rF 0
58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60.    if \nF \{
61.        de IX
62.        tm Index:\\$1\t\\n%\t"\\$2"
63..
64.        if !\nF==2 \{
65.            nr % 0
66.            nr F 2
67.        \}
68.    \}
69.\}
70.rr rF
71.\"
72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74.    \" fudge factors for nroff and troff
75.if n \{\
76.    ds #H 0
77.    ds #V .8m
78.    ds #F .3m
79.    ds #[ \f1
80.    ds #] \fP
81.\}
82.if t \{\
83.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84.    ds #V .6m
85.    ds #F 0
86.    ds #[ \&
87.    ds #] \&
88.\}
89.    \" simple accents for nroff and troff
90.if n \{\
91.    ds ' \&
92.    ds ` \&
93.    ds ^ \&
94.    ds , \&
95.    ds ~ ~
96.    ds /
97.\}
98.if t \{\
99.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105.\}
106.    \" troff and (daisy-wheel) nroff accents
107.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114.ds ae a\h'-(\w'a'u*4/10)'e
115.ds Ae A\h'-(\w'A'u*4/10)'E
116.    \" corrections for vroff
117.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119.    \" for low resolution devices (crt and lpr)
120.if \n(.H>23 .if \n(.V>19 \
121\{\
122.    ds : e
123.    ds 8 ss
124.    ds o a
125.    ds d- d\h'-1'\(ga
126.    ds D- D\h'-1'\(hy
127.    ds th \o'bp'
128.    ds Th \o'LP'
129.    ds ae ae
130.    ds Ae AE
131.\}
132.rm #[ #] #H #V #F C
133.\" ========================================================================
134.\"
135.IX Title "EXT_SQL_SESSION_ACL 8"
136.TH EXT_SQL_SESSION_ACL 8 "2017-07-11" "perl v5.22.1" "User Contributed Perl Documentation"
137.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
141.SH "NAME"
142.Vb 1
143\& ext_sql_session_acl \- SQL Database session lookup helper for Squid
144.Ve
145.SH "SYNOPSIS"
146.IX Header "SYNOPSIS"
147.Vb 1
148\& ext_sql_session_acl [options]
149.Ve
150.SH "DESCRIPTION"
151.IX Header "DESCRIPTION"
152Validates an \s-1HTTP\s0 requests access authorization with a session database.
153.PP
154Taking an identity token to be validated (as determined by the external_acl_type format)
155it returns a username or tag associated with the identity token passed in.
156.PP
157Common forms of identifiers are \s-1IP\s0 address, \s-1EUI \s0(\s-1MAC\s0) address, passwords, or \s-1UUID\s0 tokens.
158.PP
159This program uses Squid concurrency support.
160.SH "OPTIONS"
161.IX Header "OPTIONS"
162.IP "\fB\-\-dsn\fR" 12
163.IX Item "--dsn"
164Database \s-1DSN.\s0 Default \*(L"DBI:mysql:database=squid\*(R"
165.IP "\fB\-\-user\fR" 12
166.IX Item "--user"
167Database User
168.IP "\fB\-\-password\fR" 12
169.IX Item "--password"
170Database password
171.IP "\fB\-\-table\fR" 12
172.IX Item "--table"
173Database table. Default \*(L"passwd\*(R".
174.IP "\fB\-\-uidcol\fR" 12
175.IX Item "--uidcol"
176Unique Session Identifier column. Default \*(L"id\*(R".
177.IP "\fB\-\-usercol\fR" 12
178.IX Item "--usercol"
179External \s-1ACL\s0 user= result column.
180.IP "\fB\-\-tagcol\fR" 12
181.IX Item "--tagcol"
182External \s-1ACL\s0 tag= result column.
183.IP "\fB\-\-cond\fR" 12
184.IX Item "--cond"
185Condition, defaults to enabled=1. Specify 1 or "" for no condition
186.IP "\fB\-\-persist\fR" 12
187.IX Item "--persist"
188Keep a persistent database connection open between queries.
189.IP "\fB\-\-debug\fR" 12
190.IX Item "--debug"
191Write debug info to stderr.
192.SH "AUTHOR"
193.IX Header "AUTHOR"
194This program and documentation was written by \fIAmos Jeffries <amosjeffries@squid\-cache.org\fR>
195.PP
196Based on original work in DB_auth by Henrik Nordstrom <henrik@henriknordstrom.net>
197With assistance of Nishant Sharma <codemarauder@gmail.com>
198.SH "COPYRIGHT"
199.IX Header "COPYRIGHT"
200.Vb 5
201\& * Copyright (C) 1996\-2015 The Squid Software Foundation and contributors
202\& *
203\& * Squid software is distributed under GPLv2+ license and includes
204\& * contributions from numerous individuals and organizations.
205\& * Please see the COPYING and CONTRIBUTORS files for details.
206\&
207\& Copyright (C) 2012 Amos Jeffries <amosjeffries@squid\-cache.org>
208\&
209\& This program is free software. You may redistribute copies of it under the
210\& terms of the GNU General Public License version 2, or (at your opinion) any
211\& later version.
212.Ve
213.SH "QUESTIONS"
214.IX Header "QUESTIONS"
215Questions on the usage of this program can be sent to the \fISquid Users mailing list <squid\-users@squid\-cache.org\fR>
216.SH "REPORTING BUGS"
217.IX Header "REPORTING BUGS"
218Bug reports need to be made in English.
219See http://wiki.squid\-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
220.PP
221Report bugs or bug fixes using http://bugs.squid\-cache.org/
222.PP
223Report serious security bugs to \fISquid Bugs <squid\-bugs@squid\-cache.org\fR>
224.PP
225Report ideas for new improvements to the \fISquid Developers mailing list <squid\-dev@squid\-cache.org\fR>
226.SH "SEE ALSO"
227.IX Header "SEE ALSO"
228squid (8), \s-1GPL \\fIs0\fR\|(7),
229.PP
230The Squid \s-1FAQ\s0 wiki http://wiki.squid\-cache.org/SquidFaq
231.PP
232The Squid Configuration Manual http://www.squid\-cache.org/Doc/config/
Note: See TracBrowser for help on using the repository browser.