view release on metacpan or  search on metacpan

Session/Session.pm  view on Meta::CPAN

=item new()

creates a new Apache::AuthDigest::API::Session object.  Apache::DigestAPI is a
subclass of the Apache class so, with the exception of the addition
of new methods, $r can be used the same as if it were a normal
Apache object

  my $r = Apache::AuthDigest::API::Session->new(Apache->request);

=item get_session()

returns a list.  the first element is the notes key as defined by
DigestSessionKey.  the second element is the session identifier (if
obtainable).

  my ($key, $session) = $r->get_session;

=item set_session()

set the session.  this actually is an interface that abstracts the
notes() stuff I mentioned earlier. 

  $r->set_session($session);

=item compare_digest_response()

same as Apache::AuthDigest::API, except that the nonce value is placed in
$r->notes if the comparison is successful.

=back

=head1 EXAMPLE

for a complete example, see the My/SessionAuthenticator.pm file
in the test suite for this package.

=head1 SEE ALSO

perl(1), mod_perl(1), Apache(3)

=head1 AUTHORS

Geoffrey Young E<lt>geoff@modperlcookbook.orgE<gt>

Paul Lindner E<lt>paul@modperlcookbook.orgE<gt>

Randy Kobes E<lt>randy@modperlcookbook.orgE<gt>

=head1 COPYRIGHT

Copyright (c) 2002, Geoffrey Young, Paul Lindner, Randy Kobes.  

All rights reserved.

This module is free software.  It may be used, redistributed
and/or modified under the same terms as Perl itself.

=head1 HISTORY

This code is derived from the I<Cookbook::DigestAPI> module,
available as part of "The mod_perl Developer's Cookbook".

For more information, visit http://www.modperlcookbook.org/

=cut