README

   1 NAME
   2     Catalyst::Authentication::Store::Htpasswd - Authen::Htpasswd based user
   3     storage/authentication.
   4
   5 SYNOPSIS
   6         use Catalyst qw/
   7           Authentication
   8         /;
   9
  10         __PACKAGE__->config(
  11             authentication => {
  12                 default_realm => 'test',
  13                 realms => {
  14                     test => {
  15                         credential => {
  16                             class          => 'Password',
  17                             password_field => 'password',
  18                             password_type  => 'self_check',
  19                         },
  20                         store => {
  21                             class => 'Htpasswd',
  22                             file => 'htpasswd',
  23                         },
  24                     },
  25                 },
  26             },
  27         );
  28
  29         sub login : Global {
  30             my ( $self, $c ) = @_;
  31
  32             $c->authenticate({ username => $c->req->param("login"), password => $c->req->param("password") });
  33         }
  34
  35 DESCRIPTION
  36     This plugin uses "Authen::Htpasswd" to let your application use
  37     ".htpasswd" files for it's authentication storage.
  38
  39 METHODS
  40   new
  41     Simple constructor, dies if the htpassword file can't be found
  42
  43   find_user
  44     Looks up the user, and returns a
  45     Catalyst::Authentication::Store::Htpasswd::User object.
  46
  47   user_supports
  48     Delegates to
  49     Catalyst::Authentication::Store::Htpasswd::User-user_supports|Catalyst::
  50     Authentication::Store::Htpasswd::User#user_supports>
  51
  52   from_session
  53     Delegates the user lookup to " find_user "
  54
  55 CONFIGURATION
  56   file
  57     The path to the htpasswd file, this is taken from the application root.
  58
  59 AUTHORS
  60     Yuval Kogman "nothingmuch@woobling.org"
  61
  62     David Kamholz "dkamholz@cpan.org"
  63
  64     Tomas Doran "bobtfish@bobtfish.net"
  65
  66 SEE ALSO
  67     Authen::Htpasswd.
  68
  69 COPYRIGHT & LICENSE
  70             Copyright (c) 2005-2008 the aforementioned authors. All rights
  71             reserved. This program is free software; you can redistribute
  72             it and/or modify it under the same terms as Perl itself.
  73