File Coverage

blib/lib/Authen/PAAS/LoginModule.pm

Criterion	Covered	Total	%
statement	19	23	82.6
branch	3	6	50.0
condition	1	3	33.3
subroutine	5	7	71.4
pod	5	5	100.0
total	33	44	75.0

# -*- perl -*-
#
# Authen::PAAS::LoginModule by Daniel Berrange
#
# Copyright (C) 2004-2006 Dan Berrange
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# $Id: LoginModule.pm,v 1.1 2005/08/21 07:39:37 dan Exp $

=pod

=head1 NAME

Authen::PAAS::LoginModule - a pluggable authentication module

=head1 SYNOPSIS

  use Authen::PAAS::LoginModule;

  my $result = $module->login($subject, \%callbacks);

=head1 DESCRIPTION

This module provides the API for authenticating a subject
for the purposes of session login. It will be subclassed
to provide the implementations of different authentication
schemes.

=head1 METHODS

=over 4

=cut

package Authen::PAAS::LoginModule;

use warnings;
use strict;

our $VERSION = '1.0.0';


=item my $module = Authen::PAAS::LoginModule->new(flags => $flags, options => \%options);

Creates a new login modules. The C parameter should be one of the
keywords C, C, C and C. The
C parameter is a hash reference containing sub-class specific
configuration options.

=cut

sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = {};
    my %params = @_;

    $self->{flags} = exists $params{flags} ? $params{flags} : die "flags parameter is required";
    $self->{options} = exists $params{options} ? $params{options} : {};

    bless $self, $class;

    return $self;
}


=item $module->option($name, $default);

Retrieves the value of the configuration option identified by
the C<$name> parameter. If the named configuration option is
not set, then the C<$default> value is returned.

=cut

sub option {
    my $self = shift;
    my $name = shift;
    return exists $self->{options}->{$name} ? $self->{options}->{$name} : shift;
}


=item my $flags = $module->flags;

Retrieves the flags for the module, one of the keywords C,
C, C and C.

=cut

sub flags {
    my $self = shift;
    return $self->{flags};
}


=item my $res = $module->login($subject, $callbacks);

Attempt to login using authentication data obtained
from the callbacks, if successful, adding principals
and credentials to the subject. The C<$callbacks>
parameter is a hash reference, whose keys are the
names of authentication tokes, and values are instances
of th L class. If successful,
this method must return a true value, otherwise a false
value. This method must be implemented by subclasses.

=cut

sub login {
    my $self = shift;
    die "module " . ref($self) . " forgot to implement login";
}


=item $module->logout($subject);

Attempt to logout a subject, by removing any principals
anc credentials added during the C method.
This method must be implemented by subclasses.

=cut


sub logout {
    my $self = shift;
    die "module " . ref($self) . " forgot to implement logout";
}


1 # So that the require or use succeeds.

__END__