File Coverage

blib/lib/CGI/Application/Plugin/Authentication/Driver/HTPasswd.pm

Criterion	Covered	Total	%
statement	20	20	100.0
branch	4	4	100.0
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	30	30	100.0

package CGI::Application::Plugin::Authentication::Driver::HTPasswd;

use strict;
use warnings;
our $VERSION = '0.20';

use base qw(CGI::Application::Plugin::Authentication::Driver);
use Apache::Htpasswd;

=head1 NAME

CGI::Application::Plugin::Authentication::Driver::HTPasswd - HTPasswd
Authentication driver

=head1 VERSION

This document describes CGI::Application::Plugin::Authentication::Driver::HTPasswd version 0.20

=head1 SYNOPSIS

 use base qw(CGI::Application);
 use CGI::Application::Plugin::Authentication;

 __PACKAGE__->authen->config(
   DRIVER => ['HTPasswd', '/etc/apache/htpasswd', '/etc/apache/otherhtpasswd']
 );

=head1 DESCRIPTION

This Driver allows you to authenticate against an htpasswd file.  For
information on the format of the htpasswd file, see the documentation for the
Apache webserver.  This driver requires that the L module is
installed.


=head1 METHODS

=head2 verify_credentials

This method will test the provided credentials against the htpasswd file(s)
defined in the DRIVER config.

=cut

sub verify_credentials {
    my $self = shift;
    my ( $username, $password ) = @_;

    # verify that all the options are OK
    my @files = $self->options;
    die "The HTPasswd driver requires at least one htpasswd file"
        unless @files;

    foreach my $file (@files) {
        my $htpasswd = Apache::Htpasswd->new(
            {   passwdFile => $file,
                ReadOnly   => 1,
            }
        );
        return $username
            if $htpasswd->htCheckPassword( $username, $password );
    }
    return;
}

=head1 SEE ALSO

L,
L, perl(1)


=head1 LICENCE AND COPYRIGHT

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.


=head1 DISCLAIMER OF WARRANTY

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.

=cut

1;