| Lemonldap-Portal-Standard documentation | Contained in the Lemonldap-Portal-Standard distribution. |
Lemonldap::Portal::Standard - Perl extension for the Lemonldap SSO system
use Lemonldap::Portal::Standard;
sub my_method {
my $self = shift;
my $user = $self->{'user'};
$user.="-cp" if $user !~ /-cp$/;
$self->{'user'} = $user;
return ;
}
my $message = '';
my %params =Vars;
my $stack_user=Lemonldap::Portal::Standard->new('formateUser' => \&my_method);
my $urlc;
my $urldc;
$retour=$stack_user->process(param => \%params,
server => $ReverseProxyConfig::ldap_serveur,
port => $ReverseProxyConfig::ldap_port,
DnManager => $ReverseProxyConfig::ldap_admin_dn,
passwordManager => $ReverseProxyConfig::ldap_admin_pd,
branch => $ReverseProxyConfig::ldap_branch_people
);
if ($retour) {
$message=$retour->message;
$erreur=$retour->error;
}
See in directory examples for more details
Lemonldap is a SSO system under GPL. The authentification phase need to display a form with user / password . Standard.pm manage all the cycle of authentification :
step 0 : setting configuration step 1 : manage the source of request step 2 : manage timeout step 3 : control the input form of user and password step 4 : formate the userid if needing step 5 : build the filter for the search step 6 : build subtree for the search ldap step 7 : make socket upon ldap server step 8 : bind operation step 9 : make search step 10 : confection of %session from ldap infos step 11 : unbind step 12 : re-bind for validing user's credentials
Any step can bee overload for include your custom method.
standards errors messages : 1 => 'Your connection has expired; You must to be authentified once again', 2 => 'User and password fields must be filled', 3 => 'Wrong directory manager account or password' , 4 => 'not found in directory', 5 => 'wrong credentials' , warning the value 9 for error message is returned then the form is empty is't not an real error , perhaps it's the initial request.
my $stack_user= Lemonldap::Portal::Standard->new('standard_method' => \&my_method);
$retour=$stack_user->process(param => \%params,
server => 'ldap_serveur',
port => 'ldap_port',
DnManager => 'ldap_admin_dn',
passwordManager => 'ldap_admin_pd',
branch => 'ldap_branch_people'
);
You can keep DnManager and passwordManager in undef state in order to provide anonymous bind.
Don't pass them like parameter for this.
%params is the hash initialized whith CGI params
Lemonldap provide several parameters like :
identifiant , secret (user and password)
urlc : url of the original request .
return the text of error
return the number of error
return a reference of hash of session
return a plaintext url of redirection
return a list of encoded url and decoded url of redirection
Lemonldap(3), Lemonldap::Handler::Intrusion(3)
http://lemonldap.sourceforge.net/
"Writing Apache Modules with Perl and C" by Lincoln Stein & Doug MacEachern - O'REILLY
See the examples directory
Copyright (C) 2004 by Eric German
Lemonldap originaly written by Eric german who decided to publish him in 2003 under the terms of the GNU General Public License version 2.
This program 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; version 2 dated June, 1991. 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. A copy of the GNU General Public License is available in the source tree; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
| Lemonldap-Portal-Standard documentation | Contained in the Lemonldap-Portal-Standard distribution. |
#!/usr/bin/perl -w package Lemonldap::Portal::Standard; use strict; use warnings; use Net::LDAP; use IO::Socket; use MIME::Base64; use Data::Dumper; use Net::LDAP::Constant qw(LDAP_SUCCESS LDAP_INVALID_CREDENTIALS LDAP_OPERATIONS_ERROR); use Crypt::SaltedHash; our $VERSION = '3.2.1'; #-------------------------------------------------------------------------------------------------- sub new { my $class =shift; my %args = @_ ; my $self= bless { },ref($class)||$class; $self->{controlUrlOrigin} =\&__controlUrlOrigin; $self->{controlCache} =\&__controlCache; $self->{controlTimeOut} =\&__controlTimeOut; $self->{controlSyntax} =\&__controlSyntax; $self->{controlIP} =\&__controlIP; $self->{bind} =\&__bind; $self->{formateUser} =\&__none; $self->{formateFilter} =\&__Filter; $self->{formateBaseLDAP} =\&__none; $self->{contactServer} =\&__contactServer; $self->{search} =\&__ldapsearch; $self->{setSessionInfo} =\&__session; $self->{unbind} =\&__unbind; $self->{credentials} =\&__credentials; my $mess= { 1 => 'Votre connection a expir�. Vous devez vous authentifier de nouveau.', 2 => 'Les champs \'login\' et \'mot de passe \' doivent etre remplis', 3 => 'L\'identifiant ou le mot de passe administrateur est incorrect' , 4 => 'Recherche LDAP infructueuse', 5 => 'wrong credentials' , 6 => 'Votre adresse IP a chang�, vous devez vous authentifier de nouveau', 9 => 'Service Indisponible.<br>Le serveur de cache est injoignable, veuillez signaler ce problème à votre administrateur réseau.' }; $self->{msg} =$mess; foreach (keys %args) { $self->{$_} = $args{$_}; } return $self; } #-------------------------------------------------------------------------------------------------- ## method none : This method does nothing .. #-------------------------------------------------------------------------------------------------- sub __none { #does ...nothing; } #-------------------------------------------------------------------------------------------------- ## method controlUrlOrigin ## This method looks at param cgi 'urlc' in order to determine if ## the request comes with a vip url (redirection) or for the menu #-------------------------------------------------------------------------------------------------- sub __controlUrlOrigin { my $urldc; my $self = shift; my $urlc = $self->{param}->{'url'}; my $service = $self->{param}->{'service'}; if ( defined($service) ) { $self->{service} = $service; $self->{CAS} = 'CASREQUESTED'; } my $renew = $self->{param}->{'renew'}; if ( defined($renew) ) { $self->{renew} = $service; $self->{CAS} = 'CASREQUESTED'; } my $gateway = $self->{param}->{'gateway'}; if ( defined($gateway) ) { $self->{gateway} = $gateway; $self->{CAS} = 'CASREQUESTED'; } if ( defined ( $urlc) ) { $urldc = decode_base64($urlc); # $urldc =~ s#:\d+/#/#; # Suppress port number in URL $urlc = encode_base64($urldc,''); $self->{'urlc'} = $urlc; $self->{'urldc'} = $urldc; }else{ undef($self->{'urlc'}); undef($self->{'urldc'}); } } #-------------------------------------------------------------------------------------------------- ## method controlTimeOut ## This method looks at param cgi 'op' ## if op eq 't' (like timeout) the handler couldn't retrieve the ## storage session from id session #-------------------------------------------------------------------------------------------------- sub __controlTimeOut { my $self = shift; my $operation = $self->{param}->{'op'}; $self->{operation} = $operation; if( defined( $operation ) and $operation eq 't' ){ $self->{'message'} = $self->{msg}{1} ; $self->{'error'} =1 ; } } #-------------------------------------------------------------------------------------------------- ## method controlCache ## This method looks at param cgi 'op' ## if op eq 'm' (like memcached) the handler couldn't retrieve the ## storage session from id session #-------------------------------------------------------------------------------------------------- sub __controlCache { my $self = shift; my $operation = $self->{param}->{'op'}; $self->{operation} = $operation; if( defined( $operation ) and $operation eq 'm' ) { $self->{'message'} = $self->{msg}{9} ; $self->{'error'} =10 ; } } #-------------------------------------------------------------------------------------------------- ## method controlIP ## This method looks at param cgi 'op' ## if op eq 'i' (like IP) the handler couldn't retrieve the ## storage session from id session #-------------------------------------------------------------------------------------------------- sub __controlIP{ my $self = shift; my $operation = $self->{param}->{'op'}; $self->{operation} = $operation; if( defined( $operation ) and $operation eq 'i' ) { $self->{'message'} = $self->{msg}{6} ; #Penser a trouver un code erreur. $self->{'error'} =6 ; } } #-------------------------------------------------------------------------------------------------- ## method controlSyntax ## This method looks at param cgi 'identifant' and 'secret' ## #-------------------------------------------------------------------------------------------------- sub __controlSyntax { my $self = shift; my $user = $self->{param}->{'identifiant'}; if ( $self->{param}->{'username'} ) { $user = $self->{param}->{'username'}; $self->{CAS} = 'CASREQUESTED'; } $self->{'user'} = $user; my $password = $self->{param}->{'secret'}; if ( defined ($self->{param}->{'password'}) ) { $password = $self->{param}->{'password'}; $self->{CAS} = 'CASREQUESTED'; } if ( $self->{param}->{'lt'} ) { $self->{it} = $self->{param}->{'lt'}; $self->{CAS} = 'CASREQUESTED'; } $self->{'password'} = $password; if( defined( $user ) or defined( $password ) ) { if( ! defined( $user ) or $user eq '' or ! defined( $password ) or $password eq '' ) { $self->{'message'} = $self->{msg}{2}; if ($self->{log}) { $self->{log}->notice("User uid=$user -> \"login\" and \"password \" must not be empty"); } else { print STDERR ("User uid=$user -> \"login\" and \"password\" must not be empty"); } $self->{'error'} = 2 ; } } if( ! defined( $user ) and ! defined( $password ) ){ # empty form $self->{'message'} = ''; $self->{'error'} = 9 ; } } #-------------------------------------------------------------------------------------------------- ## Connection ldap on server and port ldap #-------------------------------------------------------------------------------------------------- sub __contactServer { my $self= shift; unless ($self->{ldap}) { my $ldap = Net::LDAP->new( $self->{server}, port => $self->{port},onerror => undef, ) or print STDERR ('Net::LDAP->new: '.$@); $self->{ldap}= $ldap; if ($self->{openldap} && $ldap){ &{$self->{bind}}($self); } } } #-------------------------------------------------------------------------------------------------- sub func_bind { my $ldap = shift; my $dn = shift; my $password = shift; my $mesg ; if ($dn and defined($password)){ #named bind $mesg = $ldap->bind( $dn, password => $password ); }else{ # anonymous bind $mesg = $ldap->bind(); } return $mesg->code(); } #-------------------------------------------------------------------------------------------------- ## formate filter #-------------------------------------------------------------------------------------------------- sub __Filter { my $self=shift; if ( ! defined $self->{filter} ) { my $user = $self->{user}; my $filterattribute = $self->{Attributes}; my $filtre; if (defined($filterattribute)){ $filtre = $filterattribute."=".$user; }else{ $filtre = "uid=$user"; } $self->{filter}=$filtre; } if ($self->{log} ) { $self->{log}->info("LDAP Search Filter : " . $self->{filter} ); } else { print STDERR ("LDAP Search Filter : " . $self->{filter}."\n" ); } } #-------------------------------------------------------------------------------------------------- ## Connection on server LDAP with manager credential ## in order to extract user infos #-------------------------------------------------------------------------------------------------- sub __bind { my $self = shift; __contactServer ($self); if ( ! defined $self->{ldap} ) { $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; return; } ##--------------------------------------------------------------------------- ## Authentification ##--------------------------------------------------------------------------- my $mesg = &func_bind( $self->{ldap},$self->{DnManager},$self->{passwordManager} ); if( $mesg == LDAP_INVALID_CREDENTIALS ) { if ($self->{log}) { $self->{log}->notice("Authentication Failed for DnManager -> Invalid Credentials : " . $self->{DnManager} ); } else { print STDERR ("Authentication Failed for DnManager -> Invalid Credentials : " . $self->{DnManager} ); } $self->{'message'} = $self->{msg}{3}; $self->{'error'} =3 ; }elsif ( $mesg == LDAP_OPERATIONS_ERROR ) { $self->{ldap} = undef; __contactServer ($self); my $mesg = &func_bind( $self->{ldap},$self->{DnManager},$self->{passwordManager} ); if ( $mesg == LDAP_OPERATIONS_ERROR ) { if ($self->{log}) { $self->{log}->notice("Authentication Failed for DnManager -> LDAP Operations Error : " . $self->{DnManager} ); } else { print STDERR ("Authentication Failed for DnManager -> LDAP Operations Error : " . $self->{DnManager} ); } $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; $self->{ldap} = undef; } }elsif ( $mesg ) { $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; $self->{ldap} = undef; } } #-------------------------------------------------------------------------------------------------- sub __ldapsearch { my $self=shift; __contactServer ($self); if ( ! defined $self->{ldap} ) { $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; return; } my $ldap=$self->{ldap}; my $filter= $self->{filter}; my $base=$self->{branch}; my $mesg; my @tbase; @tbase = @{ $self->{'base'} } if $self->{'base'}; push @tbase, $self->{branch} unless @tbase; foreach $base ( @tbase ){ if ($self->{log} ) { $self->{log}->info("LDAP Search Operation :"); $self->{log}->info(" Search Base : " . $base); $self->{log}->info(" Search Filter : " . $filter); $self->{log}->info(" Search Attributes : " . $self->{'attrs'} ); } else { print STDERR ("LDAP Search Operation :\n"); print STDERR (" Search Base : " . $base."\n"); print STDERR (" Search Filter : " . $filter."\n"); print STDERR (" Search Attributes : " . $self->{'attrs'}."\n" ); } $mesg = $ldap->search( base => $base, scope => 'sub', filter => $filter, attrs => $self->{'attrs'}, ); if ( $mesg->code() == LDAP_OPERATIONS_ERROR) { if ($self->{log} ) { $self->{log}->notice("Authentication Failed for DnManager -> LDAP Operations Error : " . $self->{DnManager} ); } else { print STDERR ("Authentication Failed for DnManager -> LDAP Operations Error : " . $self->{DnManager} ); } $self->{ldap} = undef; } if( $mesg->code() != 0 ) { if ($self->{log} ) { $self->{log}->notice($mesg->error); } else { print STDERR ($mesg->error); } $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; $self->{'ldap'} = undef ; return; } if ( $mesg->count() > 0 ){ last; } } if ($mesg->count() > 1 ){ $self->{'message'} = $self->{msg}{7}; $self->{'error'} = 7 ; return; } my $retour=$mesg->entry(0); my $identifiantCopy=$self->{user}; if( ! defined( $retour )) { $self->{'message'} = "$identifiantCopy :".$self->{msg}{4}; if ($self->{log}) { $self->{log}->notice("Authentification Failed : $identifiantCopy hasn\'nt been found in the LDAP Server"); } else { print STDERR ("Authentification Failed : $identifiantCopy hasn\'nt been found in the LDAP Server"); } $self->{'error'} = 4 ; return; } $self->{entry}= $retour; return; } #-------------------------------------------------------------------------------------------------- ## function _session #-------------------------------------------------------------------------------------------------- sub __session { my $self =shift; my %session; my $entry =$self->{entry} ; $session{dn} = $entry->dn(); $self->{dn} = $entry->dn(); $session{uid} = $entry->get_value('uid'); $session{cn} = $entry->get_value('cn'); $session{personaltitle} = $entry->get_value('personaltitle'); $session{mail} = $entry->get_value('mail'); $session{title} = $entry->get_value('title'); $self->{infosession} = \%session; } #-------------------------------------------------------------------------------------------------- ## Function unbind ## do unbind; #-------------------------------------------------------------------------------------------------- sub __unbind { my $self=shift; if ($self->{ldap}) { $self->{ldap}->unbind; $self->{'ldap'} = undef ; } } #-------------------------------------------------------------------------------------------------- ## Function credentials #-------------------------------------------------------------------------------------------------- sub __credentials { my $self = shift; __contactServer ($self); if ( ! defined $self->{ldap} ) { $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; return; } ##--------------------------------------------------------------------------- ## Authentification ##--------------------------------------------------------------------------- if ($self->{openldap}){ my $ldap_pass = $self->{entry}->get_value('userPassword'); my $valid; if ($ldap_pass =~ /^\{SSHA\}/ ){ my $csh = Crypt::SaltedHash->new(); $valid = Crypt::SaltedHash->validate($ldap_pass, $self->{password} ); }else{ if ($ldap_pass eq $self->{password} ) { $valid = 1; }else{ $valid = 0; } } if ($valid) { if ($self->{log}) { $self->{log}->notice("Authentication Successful for : " . $self->{dn} ); } else { print STDERR ("Authentication Successful for : " . $self->{dn}); } }else{ # bad password if ($self->{log} ) { $self->{log}->notice("Authentication Failed -> Invalid Password for : " . $self->{dn} ); } else {print STDERR ("Authentication Failed -> Invalid Password for : " . $self->{dn} ); } $self->{'message'} = $self->{msg}{5}; $self->{'error'} = 5 ; } }else{ my $mesg = &func_bind( $self->{ldap},$self->{dn},$self->{password} ); if( $mesg == LDAP_OPERATIONS_ERROR ) { if ($self->{log} ) { $self->{log}->notice("Authentication Failed -> LDAP Operations Error for : " . $self->{dn} ); } else { print STDERR ("Authentication Failed -> LDAP Operations Error for : " . $self->{dn} ); } $self->{'message'} = $self->{msg}{8}; $self->{'error'} = 8 ; $self->{ldap} = undef; }elsif( $mesg == LDAP_INVALID_CREDENTIALS ) { # bad password if ($self->{log}) { $self->{log}->notice("Authentication Failed -> Invalid Password for : " . $self->{dn} ); } else { print STDERR ("Authentication Failed -> Invalid Password for : " . $self->{dn} );} $self->{'message'} = $self->{msg}{5}; $self->{'error'} = 5 ; }elsif ($mesg == LDAP_SUCCESS ) { if ($self->{log} ) { $self->{log}->notice("Authentication Successful for : " . $self->{dn} ); } else { print STDERR ("Authentication Successful for : " . $self->{dn} );} } } } #-------------------------------------------------------------------------------------------------- sub message { my $self= shift; return ($self->{message}); } #-------------------------------------------------------------------------------------------------- sub infoSession { my $self= shift; return ($self->{infosession}); } #-------------------------------------------------------------------------------------------------- sub CAS { my $self = shift; return ( $self->{CASREQUESTED} ); } #-------------------------------------------------------------------------------------------------- sub CASit { my $self = shift; return ( $self->{it} ); } #-------------------------------------------------------------------------------------------------- sub CASservice { my $self = shift; return ( $self->{service} ); } #-------------------------------------------------------------------------------------------------- sub getRedirection { my $self= shift; return ($self->{urldc}); } #-------------------------------------------------------------------------------------------------- sub getAllRedirection { my $self= shift; return ($self->{urlc},$self->{urldc}); } #-------------------------------------------------------------------------------------------------- sub user { my $self= shift; return ($self->{user}); } #-------------------------------------------------------------------------------------------------- sub secret { my $self= shift; return ($self->{password}); } #-------------------------------------------------------------------------------------------------- sub error { my $self= shift; return ($self->{error}); } #-------------------------------------------------------------------------------------------------- sub process { my $self = shift; my %args = @_; foreach (keys %args) { $self->{$_} = $args{$_}; } #--------------------------------------------------------------- ## method process ## This method step after step calls methods for dealing the ## connection ## step 0 : setting configuration ## step 1 : manage the source of request ## step 2 : manage timeout ## step 3 : control the input form of user and password ## step 4 : formate the user id if needing ## step 5 : build the filter for the search ## step 6 : build subtree for the search ldap ## step 7 : make socket upon ldap server ## step 8 : bind operation ## step 9 : make search ## step 10 : confection of %session from ldap infos ## step 11 : unbind ## step 12 : re-bind for validing user's credentials ##------------------------------------------------------------- &{$self->{controlUrlOrigin}}($self); # no error avaiable in this step &{$self->{controlTimeOut}}($self); return ($self) if $self->{'error'} ; # it's not necessary to go next. &{$self->{controlIP}}($self); return ($self) if $self->{'error'} ; # it's not necessary to go next. &{$self->{controlCache}}($self); return ($self) if $self->{'error'} ; # it's not necessary to go next. &{$self->{controlSyntax}}($self); return ($self) if $self->{'error'} ; # it's not necessary to go next. &{$self->{formateUser}}($self); # no error avaiable in this step &{$self->{formateFilter}}($self); # no error avaiable in this step &{$self->{formateBaseLDAP}}($self); # no error avaiable in this step # &{$self->{contactServer}}($self); # can die if the server if unreachable: critical error if (!$self->{openldap}){ &{$self->{bind}}($self); } if ($self->{'error'}) { # it's not necessary to go next. &{$self->{unbind}}($self); $self->{ldap} = undef; return($self); } &{$self->{search}}($self) ; if ($self->{'error'}){ # it's not necessary to go next. if($self->{'error'} != 4){ &{$self->{unbind}}($self); $self->{ldap} = undef; } return($self); } &{$self->{setSessionInfo}}($self); # no error avaiable in this step &{$self->{unbind}}($self); &{$self->{credentials}}($self); &{$self->{unbind}}($self); return($self); } 1; __END__