/ 
Catalyst-Authentication-AuthTkt-0.17
River stage zero No dependents
/ Catalyst::Authentication::Store::AuthTkt

NAME

Catalyst::Authentication::Store::AuthTkt - shim for Apache::AuthTkt

DESCRIPTION

This module implements the Catalyst::Plugin::Authentication API for Apache::AuthTkt. See Catalyst::Authentication::AuthTkt for complete user documentation.

METHODS

new( config, app )

Instantiate the store. config is used to set the cookie name to check in find_user(), and optionally, to set the timeout and timeout_refresh values.

find_user( userinfo, context )

Returns a Catalyst::Authentication::User::AuthTkt object on success, undef on failure.

find_user() checks the context request object for a cookie named cookie_name() or a param named cookie_name(), in that order. If neither are present, or if present but invalid, find_user() returns undef.

See also the 'mock' feature as per the example in Catalyst::Authentication::AuthTkt SYNOPSIS.

ticket_expired( context, ticket )

Returns true if the ticket has expired. ticket should be a hashref as returned from the Apache::AuthTkt->valid_ticket() method.

renew_ticket( context, ticket )

If the timeout_refresh configuration option is set and the opportunity window is appropriate, the cookie ticket value will be regenerated and set in the context response() object. The new ticket will also be set in the context user() object if one exists.

Returns true if the ticket was renewed, false otherwise.

expire_ticket

Sets AuthTkt cookie with expiration in the past and an empty value.

for_session( context, user )

Implements required method for stashing user in a session.

from_session( context, frozen_user )

Implements required method for de-serializing frozen_user from a session store.

AUTHOR

Peter Karman, <karman at cpan dot org>

BUGS

Please report any bugs or feature requests to bug-catalyst-authentication-authtkt at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Authentication-AuthTkt. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Catalyst::Authentication::AuthTkt

You can also look for information at:

ACKNOWLEDGEMENTS

The Minnesota Supercomputing Institute http://www.msi.umn.edu/ sponsored the development of this software.

COPYRIGHT & LICENSE

Copyright 2008 by the Regents of the University of Minnesota.

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