209 lines
5.6 KiB
Perl
209 lines
5.6 KiB
Perl
##@file
|
|
# SSL authentication backend file
|
|
|
|
##@class
|
|
# SSL authentication backend class
|
|
package Lemonldap::NG::Portal::AuthSSL;
|
|
|
|
use strict;
|
|
use Lemonldap::NG::Portal::Simple;
|
|
use Lemonldap::NG::Portal::AuthNull;
|
|
|
|
our $VERSION = '2.0.0';
|
|
our @ISA = qw(Lemonldap::NG::Portal::AuthNull);
|
|
|
|
## @apmethod int authInit()
|
|
# Check if SSL environment variables are set.
|
|
# @return Lemonldap::NG::Portal constant
|
|
sub authInit {
|
|
my $self = shift;
|
|
$self->{SSLVar} ||= 'SSL_CLIENT_S_DN_Email';
|
|
PE_OK;
|
|
}
|
|
|
|
## @apmethod int extractFormInfo()
|
|
# Read username in SSL environment variables, or return an error
|
|
# @return Lemonldap::NG::Portal constant
|
|
sub extractFormInfo {
|
|
my $self = shift;
|
|
my $user = $self->https ? $ENV{ $self->{SSLVar} } : 0;
|
|
if ($user) {
|
|
$self->{user} = $user;
|
|
return PE_OK;
|
|
}
|
|
elsif ( $ENV{SSL_CLIENT_S_DN} ) {
|
|
$self->_sub( 'userError',
|
|
"$self->{SSLVar} was not found in user certificate" );
|
|
return PE_BADCERTIFICATE;
|
|
}
|
|
else {
|
|
$self->_sub( 'userError', 'No certificate found' );
|
|
return PE_CERTIFICATEREQUIRED;
|
|
}
|
|
}
|
|
|
|
## @apmethod int setAuthSessionInfo()
|
|
# Set _user and authenticationLevel.
|
|
# @return Lemonldap::NG::Portal constant
|
|
sub setAuthSessionInfo {
|
|
my $self = shift;
|
|
|
|
# Store user certificate login for basic rules
|
|
$self->{sessionInfo}->{'_user'} = $self->{'user'};
|
|
|
|
$self->{sessionInfo}->{authenticationLevel} = $self->{SSLAuthnLevel};
|
|
PE_OK;
|
|
}
|
|
|
|
## @apmethod int authenticate()
|
|
# Just test that SSL authentication has been done: job is done in
|
|
# extractFormInfo()
|
|
# @return Lemonldap::NG::Portal constant
|
|
sub authenticate {
|
|
my $self = shift;
|
|
return ( $self->{user} and $ENV{ $self->{SSLVar} } )
|
|
? PE_OK
|
|
: PE_ERROR;
|
|
}
|
|
|
|
## @method string getDisplayType
|
|
# @return display type
|
|
sub getDisplayType {
|
|
return "logo";
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
=encoding utf8
|
|
|
|
Lemonldap::NG::Portal::AuthSSL - Perl extension for building Lemonldap::NG
|
|
compatible portals with SSL authentication.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
With Lemonldap::NG::Portal::SharedConf, set authentication field to "SSL" in
|
|
configuration database.
|
|
|
|
With Lemonldap::NG::Portal::Simple:
|
|
|
|
use Lemonldap::NG::Portal::Simple;
|
|
my $portal = new Lemonldap::NG::Portal::Simple(
|
|
domain => 'example.com',
|
|
globalStorage => 'Apache::Session::MySQL',
|
|
globalStorageOptions => {
|
|
DataSource => 'dbi:mysql:database',
|
|
UserName => 'db_user',
|
|
Password => 'db_password',
|
|
TableName => 'sessions',
|
|
},
|
|
ldapServer => 'ldap.domaine.com',
|
|
securedCookie => 1,
|
|
authentication => 'SSL',
|
|
|
|
# SSLVar: field to search in client certificate
|
|
# default: SSL_CLIENT_S_DN_Email the mail address
|
|
SSLVar => 'SSL_CLIENT_S_DN_CN',
|
|
);
|
|
|
|
if($portal->process()) {
|
|
# Write here the menu with CGI methods. This page is displayed ONLY IF
|
|
# the user was not redirected here.
|
|
print $portal->header('text/html; charset=utf-8'); # DON'T FORGET THIS (see CGI(3))
|
|
print "...";
|
|
|
|
# or redirect the user to the menu
|
|
print $portal->redirect( -uri => 'https://portal/menu');
|
|
}
|
|
else {
|
|
# If the user enters here, IT MEANS THAT YOUR SSL PARAMETERS ARE BAD
|
|
print $portal->header('text/html; charset=utf-8'); # DON'T FORGET THIS (see CGI(3))
|
|
print "<html><body><h1>Unable to work</h1>";
|
|
print "This server isn't well configured. Contact your administrator.";
|
|
print "</body></html>";
|
|
}
|
|
|
|
Modify your httpd.conf:
|
|
|
|
<Location /My/File>
|
|
SSLVerifyClient optional # or 'require' if login/password are disabled
|
|
SSLOptions +StdEnvVars
|
|
</Location>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This library just overload few methods of Lemonldap::NG::Portal::Simple to use
|
|
Apache SSLv3 mechanism: we've just to verify that
|
|
C<$ENV{SSL_CLIENT_S_DN_Email}> exists. So remenber to export SSL variables
|
|
to CGI.
|
|
|
|
If SSL is used, authenticationLevel is set to 5. You can use this parameter in
|
|
L<Lemonldap::NG::Handler> rules to force users to use certificates in some
|
|
applications:
|
|
|
|
virtualHost1 => {
|
|
'default' => '$authenticationLevel > 5 and $uid = "jeff"',
|
|
},
|
|
|
|
Note that you can use Apache SSL environment variables in "exported variables".
|
|
|
|
See L<Lemonldap::NG::Portal::Simple> for usage and other methods.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<Lemonldap::NG::Portal>, L<Lemonldap::NG::Portal::Simple>,
|
|
L<http://lemonldap-ng.org/>
|
|
|
|
=head1 AUTHOR
|
|
|
|
=over
|
|
|
|
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
|
|
|
|
=item François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
|
|
|
|
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
|
|
|
|
=back
|
|
|
|
=head1 BUG REPORT
|
|
|
|
Use OW2 system to report bug or ask for features:
|
|
L<http://jira.ow2.org>
|
|
|
|
=head1 DOWNLOAD
|
|
|
|
Lemonldap::NG is available at
|
|
L<http://forge.objectweb.org/project/showfiles.php?group_id=274>
|
|
|
|
=head1 COPYRIGHT AND LICENSE
|
|
|
|
=over
|
|
|
|
=item Copyright (C) 2006-2010 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
|
|
|
|
=item Copyright (C) 2012-2013 by François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
|
|
|
|
=item Copyright (C) 2006-2012 by Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
|
|
|
|
=back
|
|
|
|
This library is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see L<http://www.gnu.org/licenses/>.
|
|
|
|
=cut
|
|
|