Apache-AuthCookieURL
view release on metacpan or search on metacpan
AuthCookieURL.pm view on Meta::CPAN
package Apache::AuthCookieURL;
use strict;
use mod_perl qw(1.24 StackedHandlers MethodHandlers Authen Authz);
use Apache::Constants qw(:common M_GET REDIRECT MOVED);
use vars qw($VERSION);
use Apache::URI ();
use Apache::Cookie;
use constant DEBUG => 'AuthCookieURLDebug';
# $Id: AuthCookieURL.pm,v 1.3 2000/11/21 00:46:01 lii Exp $
$VERSION = sprintf '%d.%03d', q$Revision: 1.3 $ =~ /: (\d+)\.(\d+)/;
#======================== NOTE ============================================
### This module is a modification of Ken Williams <ken@forum.swarthmore.edu>
### Apache::AuthCookie apache module.
# Modified July 14, 2000 to handle munged urls and sessions w/o login
# - use cookies or munged urls for sessions
# - can be used with a login script, or without for simple session management
# - Will create sessions without overriding, if you don't care how unique they are.
# Comments to: Bill Moseley moseley@hank.org
#======================== NOTE ============================================
AuthCookieURL.pm view on Meta::CPAN
}
sub recognize_user ($$) {
my ($self, $r) = @_;
my $debug = $r->dir_config( DEBUG ) || 0;
my ($auth_type, $auth_name) = ($r->auth_type, $r->auth_name);
return unless $auth_type && $auth_name;
# return unless $r->header_in('Cookie');
my ($cookie) = ($r->header_in( 'Cookie' ) || '') =~ /${auth_type}_$auth_name=([^;]+)/;
# Get session from URI if not set in a cookie
# (won't likely be here if this isn't a protected doc)
$cookie ||= $r->notes( 'URI_Session' ) || '';
$r->log_error("session provided = '$cookie'" ) if $debug >= 1;
return OK unless $cookie;
AuthCookieURL.pm view on Meta::CPAN
$r->log_error("No session returned from authen_cred" ) if $debug >= 2;
# Pass a cookie with the error reason that can be read after the redirect.
# Use a cookie with no time limit
$self->send_cookie( name=>'Reason', value=>$error_message, expires=>undef ) if $error_message;
} else {
# Delete error message cookie, if found
$self->send_cookie( value=>'none', name=>'Reason', expires=>'-1d' )
if ($r->header_in( 'Cookie' ) || '') =~ /${auth_type}_${auth_name}Reason/;
$r->log_error("ses_key returned from authen_cred = '$ses_key'" ) if $debug >= 2;
# Send cookie if a session was returned from authen_cred
$self->send_cookie(value=>$ses_key);
AuthCookieURL.pm view on Meta::CPAN
# Note -- should redirect without adding the session for URL-based logout?
# Might be smart to override this method so that the session can be marked as logged out
# in whatever database you are using
sub logout($$) {
my ($self,$r) = @_;
my $debug = $r->dir_config( DEBUG ) || 0;
my ($auth_type, $auth_name) = ($r->auth_type, $r->auth_name);
# Send the Set-Cookie header to expire the auth cookie.
$self->send_cookie(value=>'none', expires=>'-1d');
return FORBIDDEN;
# This doesn't seem to work.
$r->no_cache(1) unless $r->dir_config( $auth_name . 'Cache' );
my $location = $r->dir_config( $auth_name . 'LogoutURI' ) || '/';
AuthCookieURL.pm view on Meta::CPAN
my ($authen_script, $auth_user);
my $debug = $r->dir_config( DEBUG ) || 0;
$r->log_error( '** In authenticate **' ) if $debug >= 3;
$r->log_error( "auth_type= '$auth_type'" ) if $debug >= 3;
# This is a way to open up some documents/directories
return OK if lc $r->auth_name eq 'none';
return OK if $r->dir_config('DisableAuthCookieURL');
# Only authenticate the first internal request
return OK unless $r->is_initial_req;
# How to solve the problem of protecting from the root downward yet allow access to login script?
# Don't really want to set another PerlSetVar, so currently the action of the login script must
# be '/LOGIN' if protecting from the root down.
return OK if $r->uri =~ m[^/LOGIN];
AuthCookieURL.pm view on Meta::CPAN
unless ($auth_name) {
$r->log_reason("AuthName not set, AuthType=$auth_type", $r->uri);
return SERVER_ERROR;
}
## Check and get session from cookie or URL ##
# Get the Cookie header. If there is a session key for this realm, strip
# off everything but the value of the cookie.
my ($ses_key_cookie) = ($r->header_in( 'Cookie' ) || "") =~ /${auth_type}_$auth_name=([^;]+)/;
my $cookie = $ses_key_cookie || '';
# Get session from URI if not set in a cookie
$ses_key_cookie ||= $r->notes( 'URI_Session' ) || '';
$r->log_error("session provided = '$ses_key_cookie'" ) if $debug >= 1;
$r->log_error("requested uri = '" . $r->uri . "'" ) if $debug >= 2;
unless ($ses_key_cookie) {
$r->subprocess_env( AuthCookieURLReason => 'no_session_provided' );
} else {
# Check and convert the session key into a user
if ($auth_user = $auth_type->authen_ses_key($r, $ses_key_cookie)) {
# We have a valid session key, so we return with an OK value.
# Tell the rest of Apache what the authentication method and
# user is.
$r->connection->auth_type($auth_type);
$r->connection->user($auth_user);
$r->log_error("user authenticated as $auth_user. Exiting Authen") if $debug >= 1;
$r->log_error( "Cookie: '$cookie' and URI_Session: '" . ($r->notes( 'URI_Session' ) || '') ."'") if $debug >= 4;
# Clean up the path by redirecting if cookies are in use
if ( $cookie && $r->notes( 'URI_Session' ) ) {
my $query = $r->args ? '?' . $r->args : '';
$query = $r->uri . $query;
$r->log_error("Cookies are in use -- redirecting to '$query'") if $debug >= 3;
# prevent the error_document from adding the session back in.
$r->notes('SESSION', undef );
$r->header_out( Location => $query );
return REDIRECT;
}
return OK;
} else {
# There was a session key set, but it's invalid for some reason. So,
# remove it from the client now so when the credential data is posted
# we act just like it's a new session starting.
# Do this even if no cookie was sent -- can't hurt.
$auth_type->send_cookie( value=>'vanish', expires=>'-1d');
$r->subprocess_env( AuthCookieURLReason => 'bad_session_provided' );
}
}
# Invalid or no session was provided -- send to the login form
# If the LoginScript is set to 'NONE' then only generating a session
# So call login() directly instead of calling the login form.
AuthCookieURL.pm view on Meta::CPAN
sub authorize ($$) {
my ($auth_type, $r) = @_;
my $debug = $r->dir_config( DEBUG ) || 0;
$r->log_error( "** In authorize **" ) if $debug >= 3;
# This is a way to open up some documents/directories
return OK if lc $r->auth_name eq 'none';
return OK if $r->dir_config('DisableAuthCookieURL');
return OK unless $r->is_initial_req; #only the first internal request
# How to solve the problem of protecting from the root downward?
# Don't really want to set another PerlSetVar.
return OK if $r->uri =~ m[^/LOGIN];
if ($r->auth_type ne $auth_type) {
AuthCookieURL.pm view on Meta::CPAN
return $forbidden ? FORBIDDEN : OK;
}
sub send_cookie {
my ($self, %settings ) = @_;
my $r = Apache->request();
my ( $auth_name, $auth_type ) = ( $r->auth_name, $r->auth_type );
return if $r->dir_config( $auth_name . 'NoCookie' );
$settings{name} = $settings{name}
? "${auth_type}_$auth_name$settings{name}"
: "${auth_type}_$auth_name";
for (qw/Path Expires Domain Secure/) {
next if exists $settings{ lc() };
if (my $value = $r->dir_config( $auth_name . $_ )) {
$settings{ lc() } = $value;
}
}
# Remove any undef settings
my @deletes = grep { ! defined $settings{$_} } keys %settings;
delete $settings{$_} for @deletes;
$settings{path} ||= '/'; # need to do this so will return cookie when url is munged.
my $cookie = Apache::Cookie->new( $r, %settings );
$cookie->bake;
my $debug = $r->dir_config( DEBUG ) || 0;
$r->log_error('Send cookie: ' . $cookie->as_string ) if $debug >= 3;
}
sub key {
my $self = shift;
my $r = Apache->request;
my ( $auth_name, $auth_type ) = ( $r->auth_name, $r->auth_type );
my ( $ses_key_cookie ) = ($r->header_in( 'Cookie' ) || '') =~ /${auth_type}_$auth_name=([^;]+)/;
return $ses_key_cookie || $r->notes( 'URI_Session' ) || undef;
}
1;
__END__
=head1 NAME
Apache::AuthCookieURL - Perl Authentication and Authorization
or session management via cookies or URL munging
=head1 SYNOPSIS
In httpd.conf
# Your module that overrides AuthCookieURL methods
PerlModule My::AuthCookieURLHandler
# Or to use simple session generation w/o persistence
#PerlModule Apache::AuthCookieURL
## Some settings -- "Whatever" is set by AuthName ##
# most can be set within <directory> sections
# Send expires with cookie
PerlSetVar WhateverExpires +90d
# Other cookie settings
#PerlSetVar WhateverDomain some.domain
AuthCookieURL.pm view on Meta::CPAN
#PerlSetVar WhateverSecure 1
# Login script to call
PerlSetVar WhateverLoginScript /login.pl
# Or for just session management without a login script
#PerlSetVar WhateverLoginScript NONE
# Debugging options
#PerlSetVar AuthCookieURLDebug 5
# Disable cookies (only URL based sessions)
#PerlSetVar WhateverNoCookie 1
# Define a string that indicates to AuthCookieURL
# what a session looks like
# This can only be in main config
#PerlSetVar SessionPrefix Session-
# This block enables URL session handling
PerlTransHandler Apache::AuthCookieURLHandler->URLsession
ErrorDocument 302 /MISSING
ErrorDocument 301 /MISSING
<Location /MISSING>
SetHandler perl-script
PerlHandler Apache::AuthCookieURLHandler->error_document
</Location>
<Location /protected>
AuthType Apache::AuthCookieURLHandler
AuthName Whatever
PerlAuthenHandler Apache::AuthCookieURLHandler->authenticate
PerlAuthzHandler Apache::AuthCookieURLHandler->authorize
require valid-user
</Location>
# provide open access to some areas below
<Location /protected/open>
PerlSetVar DisableAuthCookieURL 1
</Location>
# or if the entire directory tree was protected
<Location /images>
PerlSetVar DisableAuthCookieURL 1
</Location>
# Make sure the login script can be run
<Files login.pl>
Options +ExecCGI
SetHandler perl-script
PerlHandler Apache::Registry
</Files>
# LOGIN is the action defined by the login.pl script
<Files LOGIN>
AuthType Apache::AuthCookieURLHandler
AuthName Whatever
SetHandler perl-script
PerlHandler Apache::AuthCookieURLHandler->login
</Files>
# Note: If protecting the entire web site (from root down) then
# the action *must* be C</LOGIN> as the module looks for this string.
# better to just invalidate the session, of course
<Files LOGOUT>
AuthType Apache::AuthCookieURLHandler
PerlSetVar WhateverLogoutURI /
AuthName Whatever
SetHandler perl-script
PerlHandler Apache::AuthCookieURLHandler->logout
</Files>
=head1 DESCRIPTION
** Warning: beta software. This should be used for testing purposes only.
That said, there are a few people using it and I've been using it for a
few months without problem. The interface may change (or disappear) without notice.
Please report any problems or comments back to Bill Moseley E<lt>moseley@hank.orgE<gt>.
This module is a modification of Ken Williams E<lt>ken@forum.swarthmore.eduE<gt> Apache::AuthCookie.
Please see perldoc Apache::AuthCookie for complete instructions. As this is intended to be
a drop-in replacement for Apache::AuthCookie you may wish to install and test with Ken's
Apache::AuthCookie before trying AuthCookieURL.
Basically, this module allows you to catch any unauthenticated access and redirect to a
login script that you define. The login script posts credentials (e.g. username and password)
and your module can then validate and provide a session key. The session key is sent in a cookie,
and also in a munged URL and a redirect is issued and the process starts all over.
Typically, you will write your own module that will override methods in Apache::AuthCookieURL.
These methods are described completely in Ken's Apache::AuthCookie. Your methods will be used
to generate and validate session keys. You can use Apache::AuthCookieURL without overriding
its methods and then AuthCookieURL can be used as a simple session manager.
With this module you should be able to enable session management for an entire site
using E<lt>Location /E<gt>, and then allow access to, say, the images directory, and also require
password access to other locations. One issue at this point is that the session key is
stripped from URLs in a Trans handler. So you would need to use cookies to use different
session keys for different parts of your web tree.
Apache::AuthCookieURL adds the following features to Apache::AuthCookie.
=over 4
=item * URL munging
If the PerlTransHandler is enabled in httpd.conf the session key will also be placed in the URL.
The session will be removed from the URL if cookies are enabled
on the next request. Typically, someone visiting your site with cookies enabled
will never see the munged URL.
To make URL sessions work you must use relative links in your documents so the client/browser
knows to place the session key on all links. CGI scripts can also access the session
information via the environment.
=item * Simple Session Management
If the login script is set to `NONE' with PerlSetVar WhateverLoginScript NONE then
Apache::AuthCookeURL acts like a simple session manager: your module will provide a new
session key if one is not provided with the request, or if the one provided is invalid.
=item * Really Simple Session Management
Apache::AuthCookieURL provides default authen_cred() and authen_ses_key() methods that
generates a (questionably) random session key. This means you can use AuthCookieURL
directly without subclassing for really simple session management without any persistence of
session keys.
=back
Unless you are not subclassing this module (and using the default methods provide),
your own module must define two methods: authen_cred() and authen_ses_key(), and then
subclass by including Apache::AuthCookieURL in your module's @ISA array.
Again, please see Apache::AuthCookie for
complete documentation.
=over 4
=item * authen_cred()
This method verifies the credentials (e.g. username/password) and returns a session key. If the credentials are
not acceptable then you can return a list, with the second element being an error message
that is placed in a cookie. This allows your login script to display a failure reason. This
method is needed since a redirect is done before your login script is executed again. Of course,
this requires that the client has cookies enabled.
Another method is to return a session key that is really an error code and generate
messages based on that returned session (error) code.
=item * authen_ses_key()
This method's job is to validate and convert a session key into a username and return it.
AuthCookieURL places the returned value into $ENV{REMOTE_USER}.
=back
=head1 CONFIGURATION SETTINGS
Configuration settings are set with the PerlSetVar directive:
PerlSetVar WhateverExpires +90d
"Whatever" is whatever the current AuthName is set. I think I might remove this
and instead just use the settings as Apache dir_merge returns them. In other words,
if you want a setting to override a global setting, then use it within a E<lt>directoryE<gt>,
E<lt>fileE<gt>, or E<lt>locationE<gt> section.
=over 4
=item * AuthCookieURLDebug
Sets the debugging level. Since some debugging info is generated in the Trans
handler this needs to be set in the main httpd config. Default is 0.
Example: PerlSetVar AuthCookieURLDebug 5
=item * SessionPrefix
SessionPrefix sets the prefix used by the Trans handler to recognize the session
in the URL (thus needs to be set in the main config), and to create the session ID.
Default is 'Session-'.
Example: PerlSetVar SessionPrefix ID-
=item * WhateverCache
AuthCookieURL.pm view on Meta::CPAN
Example: PerlSetVar WhateverCache 1
=item * WhateverLogoutURI
Sets where you are redirected after requesting the logout URL (see SYNOPSIS).
Defaults to '/'.
Example: PerlSetVar WhateverLogoutURI /gone.html
=item * DisableAuthCookieURL
This causes the Authen and Authz handlers to return OK. In other words,
<Location /protected/notprotected>
PerlSetVar DisableAuthCookieURL 1
</Location>
Allows full access to the notprotected directory.
=item * WhateverLoginScript
This sets the Login script to be executed when authorization is
required (no valid session key was sent by cookie or URL). This login script can be a
CGI script, Apache::Registry script, or a mod_perl handler.
If set to `NONE' then AuthCookieURL will be in simple session management mode.
AuthCookieURL-E<gt>login will be called which calls authen_cred() to generate a session key.
authen_cred() should just return a session key without checking the credentials.
If you do not override AuthCookieURL::authen_cred(), then AuthCookieURL::authen_cred()
simply returns this for a session key.
return time . $$ . int rand $$;
Example: PerlSetVar WhateverLoginScript /login.pl
PerlSetVar WhateverLoginScript NONE
=item * WhateverNoCookie
Turns off cookies.
Example: PerlSetVar WhateverNoCookie 1
=item * Whatever(Path|Expires|Domain|Secure)
These all control the values sent in cookies. Path, if used, must be '/' if
using URL-based sessions.
Example: PerlSetVar WhateverPath /
=back
=head1 ENVIRONMENT AND NOTES
Apache::AuthCookieURL sets some environment variables and Apache notes:
authen_ses_key() returns a value that is placed in $ENV{REMOTE_USER}. authen_ses_key()
normally converts the session key into a username.
$ENV{SESSION} contains the current session key
$ENV{AuthCookieURLReason} contains the reason authentication failed. Either
'no_session_provided' or 'bad_session_provided'.
$r-E<gt>notes( 'URI_Session' ) is the session extracted from the URI
$r-E<gt>notes('Session_prefix') is the prefix used with the session keys, of course.
$r-E<gt>notes( 'SESSION' ) is the full session, including the prefix.
=head1 WARNING
URL munging has security issues. Session keys can get written to access logs, cached by
browsers, leak outside your site, and are broken if your pages use absolute links to other
pages on-site.
=head1 TO DO
Apache::AuthCookieURL uses error documents to try to fixup any redirects. The obvious
example is when a request is made for a directory without a trailing slash and Apache
issues a redirect. (Actually, AuthCookieURL tries to detect this case and rewrite the URL
before Apache redirects.) I wish I knew a better way to fixup Location: headers in
redirects without sub-requesting every request. There's no way to catch a CGI script
or module that might issue a Location: header or REDIRECT.
I guess that's left for Apache 2.0 when all output can be filtered.
=head1 REQUIRED
mod_perl 1.24, Apache::Cookie
=head1 AUTHOR
Bill Moseley E<lt>moseley@hank.orgE<gt> made minor changes to Ken Williams' E<lt>ken@forum.swarthmore.eduE<gt>
Apache::AuthCookie.
Thanks very much to Ken for Apache::AuthCookie.
=head1 VERSION
$Revision: 1.3 $
=head1 SEE ALSO
L<Apache::AuthCookie>
=cut
Revision history for Perl extension Apache::AuthCookieURL.
0.01 July 14, 2000
-- Modified Apache::AuthCookie to work with munged URLs
0.02 Mon Sep 11 09:01:37 2000
-- Packaged up
AuthCookieURL.pm
Changes
MANIFEST
Makefile.PL
test.pl
Makefile.PL view on Meta::CPAN
use ExtUtils::MakeMaker;
# See lib/ExtUtils/MakeMaker.pm for details of how to influence
# the contents of the Makefile that is written.
WriteMakefile(
NAME => 'Apache::AuthCookieURL',
VERSION_FROM => 'AuthCookieURL.pm', # finds $VERSION
PREREQ_PM => {
Apache::Cookie => 0,
Apache::URI => 0,
},
NORECURS => 1,
DIR => [],
dist => {
COMPRESS => 'gzip',
SUFFIX => 'gz',
},
# Before `make install' is performed this script should be runnable with
# `make test'. After `make install' it should work as `perl test.pl'
######################### We start with some black magic to print on failure.
# Change 1..1 below to 1..last_test_to_print .
# (It may become useful if the test is moved to ./t subdirectory.)
BEGIN { $| = 1; print "1..1\n"; }
END {print "not ok 1\n" unless $loaded;}
use Apache::AuthCookieURL;
$loaded = 1;
print "ok 1\n";
######################### End of black magic.
# Insert your test code below (better if it prints "ok 13"
# (correspondingly "not ok 13") depending on the success of chunk 13
# of the test code):
( run in 0.529 second using v1.01-cache-2.11-cpan-e9199f4ba4c )