.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RT::Authen::ExternalAuth::DBI::Cookie 3pm"
.TH RT::Authen::ExternalAuth::DBI::Cookie 3pm "2016-09-06" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
RT::Authen::ExternalAuth::DBI::Cookie \- Database\-backed, cookie SSO source for RT authentication
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides the Cookie implementation for RT::Authen::ExternalAuth.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&    Set($ExternalSettings, {
\&        # An example SSO cookie service
\&        \*(AqMy_SSO_Cookie\*(Aq  => {
\&            \*(Aqtype\*(Aq            =>  \*(Aqcookie\*(Aq,
\&            \*(Aqname\*(Aq            =>  \*(AqloginCookieValue\*(Aq,
\&            \*(Aqu_table\*(Aq         =>  \*(Aqusers\*(Aq,
\&            \*(Aqu_field\*(Aq         =>  \*(Aqusername\*(Aq,
\&            \*(Aqu_match_key\*(Aq     =>  \*(AquserID\*(Aq,
\&            \*(Aqc_table\*(Aq         =>  \*(Aqlogin_cookie\*(Aq,
\&            \*(Aqc_field\*(Aq         =>  \*(AqloginCookieValue\*(Aq,
\&            \*(Aqc_match_key\*(Aq     =>  \*(AqloginCookieUserID\*(Aq,
\&            \*(Aqdb_service_name\*(Aq =>  \*(AqMy_MySQL\*(Aq
\&        },
\&        \*(AqMy_MySQL\*(Aq => {
\&            ...
\&        },
\&    } );
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
Cookie-specific options are described here. Shared options
are described in the \fIetc/RT_SiteConfig.pm\fR file included
in this distribution.
.PP
The example in the \*(L"\s-1SYNOPSIS\*(R"\s0 lists all available options
and they are described below.
.IP "name" 4
.IX Item "name"
The name of the cookie to be used.
.IP "u_table" 4
.IX Item "u_table"
The users table.
.IP "u_field" 4
.IX Item "u_field"
The username field in the users table.
.IP "u_match_key" 4
.IX Item "u_match_key"
The field in the users table that uniquely identifies a user
and also exists in the cookies table. See c_match_key below.
.IP "c_table" 4
.IX Item "c_table"
The cookies table.
.IP "c_field" 4
.IX Item "c_field"
The field that stores cookie values.
.IP "c_match_key" 4
.IX Item "c_match_key"
The field in the cookies table that uniquely identifies a user
and also exists in the users table. See u_match_key above.
.IP "db_service_name" 4
.IX Item "db_service_name"
The \s-1DB\s0 service in this configuration to use to lookup the cookie
information. See RT::Authen::ExternalAuth::DBI.