|crypt - provided by perl crypt function|
|MD5 - requires Digest::MD5|
|SHA1 - requires Digest::SHA1|
|uc - provided by the perl uc function|
|lc - provided by the perl lc function|
|trim - removed whitespace from the start and end of the field|
This is a constructor that can create a new Driver object. It requires an Authentication object as its first parameter, and any number of other parameters that will be used as options depending on which Driver object is being created. You shouldnt need to call this as the Authentication plugin takes care of creating Driver objects.
This method will be called right after a new Driver object is created. So any startup customizations can be dealt with here.
This will return a list of options that were provided when this driver was configured by the user.
This will return the underlying CGI::Application::Plugin::Authentication object. In most cases it will not be necessary to access this.
This method will search the Driver options for a specific key and return the value it finds.
This method needs to be provided by the driver class. It needs to be an object method that accepts a list of credentials, and will verify that the credentials are valid, and return a username that will be used to identify this login (usually you will just return the value of the first credential, however you are not bound to that)..
This method can be used to filter a field (usually password fields) using a number of standard or custom encoding techniques. See the section on Builtin Filters above to see what filters are available When using a custom filter, you will need to provide a FILTERS option in the configuration of the DRIVER (See the section on FIELD FILTERS above for an example). By default, if no filter is specified, it is returned as is. This means that you can run all fields through this function even if they dont have any filters to simplify the driver code.
This method can be used to test filtered fields (usually password fields) against a number of standard or custom encoding techniques. The following encoding techniques are provided: plain, MD5, SHA1, crypt. When using a custom encoder, you will need to provide it in the configuration of the DRIVERS (See the section on ENCODED PASSWORDS above for an example). By default, if no encoding is specified, it is assumed to be plain. This means that you can run all fields through this function even if they dont have any encoding to simplify the driver code.
my $verified = $self->check_filtered(MD5:password, foobar, OFj2IjCsPJFfMAxmQxLGPw); - or - # custom encoder my $verified = $self->check_filtered(foobar:password, foo, bar); - or - # a field that isnt filtered (effectively just checks for equality on second and third args) my $verified = $self->check_filtered(username, foobar, foobar); my $verified = $self->check_filtered(plain:username, foobar, foobar);
This method will take a field name (or list of names) and strip off the leading encoding type. For example if you passed in MD5:password the method would return password.
Cees Hek <email@example.com>
Copyright (c) 2005, SiteSuite. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|perl v5.20.3||CGI::APPLICATION::PLUGIN::AUTHENTICATION::DRIVER (3)||2016-03-17|