.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 "CGI::Application::Plugin::Authentication::Driver::DBIC 3pm" .TH CGI::Application::Plugin::Authentication::Driver::DBIC 3pm "2024-01-07" "perl v5.36.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" CGI::Application::Plugin::Authentication::Driver::DBIC \- DBIx::Class Authentication Driver .SH "VERSION" .IX Header "VERSION" Version 0.02 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use base qw(CGI::Application); \& use CGI::Application::Plugin::Authentication; \& \& _\|_PACKAGE_\|_\->authen\->config( \& DRIVER => [ \& \*(AqDBIC\*(Aq, \& SCHEMA => My::DBIC\->connect($dsn), # or existing $schema object \& CLASS => \*(AqUsers\*(Aq, # = My::DBIC::Users \& FIELD_METHODS => [qw(user MD5:passphrase)] \& ], \& CREDENTIALS => [qw(auth_username auth_password)], \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This Authentication driver uses the DBIx::Class module to allow you to authenticate against any \fIDBIx::Class\fR class. .SH "PARAMETERS" .IX Header "PARAMETERS" The \fIDBIx::Class\fR authentication driver accepts the following required parameters. .IP "\s-1SCHEMA\s0 (required)" 4 .IX Item "SCHEMA (required)" Specifies the \fIDBIx::Class::Schema\fR object to use for authentication. This class must be loaded prior to use. .IP "\s-1CLASS\s0 (required)" 4 .IX Item "CLASS (required)" Specifies the \fIDBIx::Class\fR class within the schema which contains authentication information. .IP "\s-1FIELD_METHODS\s0 (required)" 4 .IX Item "FIELD_METHODS (required)" \&\s-1FIELD_METHODS\s0 is an arrayref of the methods in the \fIDBIx::Class\fR class specified by \s-1CLASS\s0 to be used during authentication. The order of these methods needs to match the order of the \s-1CREDENTIALS.\s0 For example, if \&\s-1CREDENTIALS\s0 is set to: .Sp .Vb 1 \& CREDENTIALS => [qw(auth_user auth_domain auth_password)] .Ve .Sp Then \s-1FIELD_METHODS\s0 must be set to: .Sp .Vb 1 \& FIELD_METHODS => [qw(userid domain password)] .Ve .Sp \&\s-1FIELD_METHODS\s0 supports filters as specified by CGI::Application::Plugin::Authentication::Driver .SH "METHODS" .IX Header "METHODS" .SS "verify_credentials" .IX Subsection "verify_credentials" This method will test the provided credentials against the values found in the database, according to the Driver configuration. .SH "SEE ALSO" .IX Header "SEE ALSO" CGI::Application::Plugin::Authentication::Driver, CGI::Application::Plugin::Authentication, \fBperl\fR\|(1) .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-cgi\-application\-plugin\-authentication\-driver\-dbic at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc CGI::Application::Plugin::Authentication::Driver::DBIC .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "THANKS" .IX Header "THANKS" Cees Hek for \fICGI::Application::Plugin::Authentication\fR .PP Shawn Sorichetti for \fICGI::Application::Plugin::Authentication::Driver::CDBI\fR which this module is shamelessly copied from. .SH "AUTHOR" .IX Header "AUTHOR" Jaldhar H. Vyas, \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2007, Consolidated Braincells Inc., all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.