Peter Flanigan > CatalystX-Usul > CatalystX::Usul::Authentication



Annotate this POD



Open  0
View/Report Bugs
Module Version: v0.17.1   Source  

Name ^

CatalystX::Usul::Authentication - Use a Catalyst model as an authentication store

Version ^

Describes v0.17.$Rev: 1 $

Synopsis ^

   package MyApp;
   use Catalyst qw( ... Authentication ... );

   # The Catalyst::Authentication config below uses this module as an
   # authentication store for both realms

   <component name="Plugin::Authentication">

Description ^

Implements the Catalyst::Authentication::Store interface. Uses any Catalyst::Model that implements the methods; find_user, check_password, for_session, get, get_object, id, and supports

Configuration and Environment ^

Defined the following attributes


The constructor stores a copy of the config on itself

Subroutines/Methods ^


Uses the model method to obtain a copy of the identity object. This identity object is instantiated by Catalyst when the application restarts. In the example config the R01-Localhost authentication realm uses MyApp::Model::UsersUnix as an identity class (the MyApp::Model:: prefix is automatically applied to the store class value). The identity object's find_user method returns a user object. The config for the authentication store defines the user field in the input parameters.


Exposes the for_session method in the user class. This allows the user class to remove attribute from the user object prior to serialisation on the session store


Return the user object if it already exists otherwise create one by calling our own "find_user" method


Expose the supports class method in the user class. Allows the user class to define which optional features it supports

Diagnostics ^


Dependencies ^


Incompatibilities ^

There are no known incompatibilities in this module

Bugs and Limitations ^

There are no known bugs in this module. Please report problems to the address below. Patches are welcome

Author ^

Peter Flanigan, <Support at>

License and Copyright ^

Copyright (c) 2014 Peter Flanigan. All rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic

This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

syntax highlighting: