.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Template::Plugin::GantryAuthCookie 3"
.TH Template::Plugin::GantryAuthCookie 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Template::Plugin::GantryAuthCookie \- decrypter for AuthCookie plugin
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In a Template Toolkit:
.PP
.Vb 5
\& [% USE decrypter = GantryAuthCookie( {
\& cookie = cookies.cookie_name,
\& conf_instance = 'gantry_conf_instance',
\& conf_file = '/etc/strange.gantry.conf',
\& } ) %]
.Ve
.PP
.Vb 1
\& [% user_name = decrypter.user_name %]
.Ve
.PP
conf_file is optional and defaults to /etc/gantry.conf
.PP
Alternatively, you could omit conf_instance and conf and directly supply
the auth_secret key:
.PP
.Vb 4
\& [% USE decrypter = GantryAuthCookie( {
\& cookie = cookies.cookie_name,
\& auth_secret = env.auth_secret
\& } ) %]
.Ve
.PP
In httpd.conf (or something it includes):
.PP
.Vb 3
\& PerlModule Apache::Template
\& PerlSetEnv auth_secret '$ecr3t'
\& TT2Params cookies env
.Ve
.PP
.Vb 4
\&
\& SetHandler perl-script
\& PerlHandler Apache::Template
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You don't need this module if your page is generated by a Gantry controller.
In that case, you can use Gantry::Plugins::AuthCookie and call its
validate_user function directly. Use this when you need to display user
information on a page which is generated by Apache::Template.
.PP
This module is a Template Toolkit plugin for decrypting
Gantry::Plugins::AuthCookie cookies. In the \s-1USE\s0 statement in
your template, pass at least the contents of the cookie and either the
name of your Gantry::Conf instance or your auth_secret. If your
master Gantry::Conf file is not /etc/gantry.conf, it as well.
.PP
You must define auth_secret in Gantry::Conf, or pass it directly.
If you pass it directly, you probably want to use PerlSetEnv to keep
it out of the template. That's what I did in the \s-1SYNOPSIS\s0 above.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Called for you by \s-1TT\s0 when you \s-1USE\s0 the plugin. There are four parameters:
.Sp
.Vb 4
\& cookie - the auth cookie content
\& conf_instance - your Gantry::Conf instance
\& conf_file - your master Gantry::Conf file (optional)
\& auth_secret - the compression secret key
.Ve
.Sp
Usually you get the cookie contents from the Apache::Template module's
TT2Params cookies parameter. If you pass the secret directly, you
should get it by these commands in httpd.conf:
.Sp
.Vb 2
\& PerlSetEnv auth_secret '4our$ecr3t1ssaf3'
\& TT2Params cookie env
.Ve
.Sp
Then fish it out of the env hash in your template. See the \s-1SYNOPSIS\s0 above.
.IP "user_name" 4
.IX Item "user_name"
Returns the name of the user from the cookie, if there is one.
.IP "auth_secret" 4
.IX Item "auth_secret"
Used by Gantry::Plugins::CRUD to retrieve the decryption key. This
is taken from the Gantry::Conf variable or constructor argument of
the same name. Precendence is given to the constructor argument if
both are suppied.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gantry::Plutings::AuthCookie, Gantry::Conf
.SH "AUTHOR"
.IX Header "AUTHOR"
Phil Crow
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (c) 2006, Phil Crow
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.