Catalyst-Authentication-Credential-Authen-Simple

 view release on metacpan or  search on metacpan

META.yml  view on Meta::CPAN

---
abstract: 'Verify credentials with the Authen::Simple framework'
author:
  - 'Jose Luis Martinez Torres <jlmartin@cpan.org>'
build_requires:
  Test::More: 0
  Test::Simple: 0.44
configure_requires:
  ExtUtils::MakeMaker: 6.30
dynamic_config: 0
generated_by: 'Dist::Zilla version 4.300028, CPAN::Meta::Converter version 2.120921'
license: perl

Makefile.PL  view on Meta::CPAN

use strict;
use warnings;



use ExtUtils::MakeMaker 6.30;



my %WriteMakefileArgs = (
  "ABSTRACT" => "Verify credentials with the Authen::Simple framework",
  "AUTHOR" => "Jose Luis Martinez Torres <jlmartin\@cpan.org>",
  "BUILD_REQUIRES" => {
    "Test::More" => 0,
    "Test::Simple" => "0.44"
  },
  "CONFIGURE_REQUIRES" => {
    "ExtUtils::MakeMaker" => "6.30"
  },
  "DISTNAME" => "Catalyst-Authentication-Credential-Authen-Simple",
  "EXE_FILES" => [],

README  view on Meta::CPAN

NAME
    Catalyst::Authentication::Credential::Authen::Simple - Verify
    credentials with the Authen::Simple framework

SYNOPSIS
      use Catalyst qw(Authentication);
      # later on ...
      if ($c->authenticate({ username => 'myusername', 
                             password => 'mypassword' })){
        my $long_name = $c->user->get('LongName');
        # Hello Mr $long_name 
      }

README  view on Meta::CPAN

    of credential databases thanks to the Authen::Simple framework.

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.

      'Plugin::Authentication' => {
        'realms' => {
          'default' => {
            'store' => { ... }
            'credential' => {
              'class' => 'Authen::Simple',
              'authen' => [
                {
                  'class' => 'Passwd',

README  view on Meta::CPAN

    If the Catalyst log object is compatible with the Authen::Simple log
    object, Authen::Simple classes will log through Catalyst.

  new
    Called by Catalyst::Authentication. Instances the Authen::Simple classes
    read from the configuration.

  authenticate
     Usage     : Call $c->authenticate({ username => ..., password => ...}); 
     Returns   : User object if the credentials are verified successfully. undef if user not authenticated.

AUTHOR
        Jose Luis Martinez
        CPAN ID: JLMARTIN
        CAPSiDE
        jlmartinez@capside.com
        http://www.pplusdomain.net

THANKS
    Tobjorn Lindahl, Dylan Martin, Tomas Doran and Inigo Tejedor Arrondo for

lib/Catalyst/Authentication/Credential/Authen/Simple.pm  view on Meta::CPAN

    } else {
        $c->log->debug("None of the Authen::Simple classes authed $user") if $c->debug;;
        return;
    }
}

#################### main pod documentation begin ###################

=head1 NAME

Catalyst::Authentication::Credential::Authen::Simple - Verify credentials with the Authen::Simple framework

=head1 SYNOPSIS

  use Catalyst qw(Authentication);
  # later on ...
  if ($c->authenticate({ username => 'myusername', 
                         password => 'mypassword' })){
    my $long_name = $c->user->get('LongName');
    # Hello Mr $long_name 
  }

=head1 DESCRIPTION

This module helps your Cataylst Application authenticate against a lot of credential databases thanks to the Authen::Simple framework.

=head1 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 ...

  'Plugin::Authentication' => {
    'realms' => {
      'default' => {
        'store' => { ... }
        'credential' => {
          'class' => 'Authen::Simple',
          'authen' => [
            {
              'class' => 'Passwd',

lib/Catalyst/Authentication/Credential/Authen/Simple.pm  view on Meta::CPAN

=head2 new

Called by Catalyst::Authentication. Instances the Authen::Simple classes read from the configuration.

=cut

=head2 authenticate 

 Usage     : Call $c->authenticate({ username => ..., password => ...}); 
 Returns   : User object if the credentials are verified successfully. undef if user not authenticated.

=cut

=head1 AUTHOR

    Jose Luis Martinez
    CPAN ID: JLMARTIN
    CAPSiDE
    jlmartinez@capside.com
    http://www.pplusdomain.net