.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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 "Catalyst::Authentication::Credential::Authen::Simple 3pm"
.TH Catalyst::Authentication::Credential::Authen::Simple 3pm "2022-06-09" "perl v5.34.0" "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"
Catalyst::Authentication::Credential::Authen::Simple \- Verify credentials with the Authen::Simple framework
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&  use Catalyst qw(Authentication);
\&  # later on ...
\&  if ($c\->authenticate({ username => \*(Aqmyusername\*(Aq, 
\&                         password => \*(Aqmypassword\*(Aq })){
\&    my $long_name = $c\->user\->get(\*(AqLongName\*(Aq);
\&    # Hello Mr $long_name 
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module helps your Cataylst Application authenticate against a lot of credential databases thanks to the Authen::Simple framework.
.SH "USAGE"
.IX Header "USAGE"
Just configure your Catalyst App Authentication to use class 'Authen::Simple' as the credential verifier, and give it a set of Authen::Simple classes. You can pass arguments to the Authen::Simple:XXX class constructors with the 'args' key. Note that the authen key is an array. If more than one class is specified, when your app authenticates, the username and password is submitted to each class until one of the classes returns that the user/pass pair is valid. If no class validates the credentials, the user is not able to log in.
.PP
.Vb 10
\&  \*(AqPlugin::Authentication\*(Aq => {
\&    \*(Aqrealms\*(Aq => {
\&      \*(Aqdefault\*(Aq => {
\&        \*(Aqstore\*(Aq => { ... }
\&        \*(Aqcredential\*(Aq => {
\&          \*(Aqclass\*(Aq => \*(AqAuthen::Simple\*(Aq,
\&          \*(Aqauthen\*(Aq => [
\&            {
\&              \*(Aqclass\*(Aq => \*(AqPasswd\*(Aq,
\&              \*(Aqargs\*(Aq => {
\&                \*(Aqpath\*(Aq => \*(Aq/etc/shadow\*(Aq
\&              }
\&            },
\&            {
\&              \*(Aqclass\*(Aq => \*(AqSSH\*(Aq,
\&              \*(Aqargs\*(Aq => {
\&                \*(Aqhost\*(Aq => \*(Aqhost.company.com\*(Aq
\&              }
\&            }
\&          ]
\&        }
\&      }
\&    }
\&  }
.Ve
.PP
If the Catalyst log object is compatible with the Authen::Simple log object, Authen::Simple classes will log through Catalyst.
.SS "new"
.IX Subsection "new"
Called by Catalyst::Authentication. Instances the Authen::Simple classes read from the configuration.
.SS "authenticate"
.IX Subsection "authenticate"
.Vb 2
\& Usage     : Call $c\->authenticate({ username => ..., password => ...}); 
\& Returns   : User object if the credentials are verified successfully. undef if user not authenticated.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 5
\&    Jose Luis Martinez
\&    CPAN ID: JLMARTIN
\&    CAPSiDE
\&    jlmartinez@capside.com
\&    http://www.pplusdomain.net
.Ve
.SH "THANKS"
.IX Header "THANKS"
Tobjorn Lindahl, Dylan Martin, Tomas Doran and Inigo Tejedor Arrondo for patches and recommedations
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2008 by Jose Luis Martinez Torres
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Simple and all of the Authen::Simple::XXX classes