},
'user_basedn' => 'ou=people,dc=yourcompany,dc=com',
'user_filter' => '(&(objectClass=posixAccount)(uid=%s))',
- 'user_scope' => 'one',
+ 'user_scope' => 'one', # or 'sub' for Active Directory
'user_field' => 'uid',
'user_search_options' => {
'deref' => 'always',
our $users = Catalyst::Authentication::Store::LDAP::Backend->new(\%config);
- sub action : Local {
- my ( $self, $c ) = @_;
-
- $c->login( $users->get_user( $c->req->param("login") ),
- $c->req->param("password") );
- }
-
=head1 DESCRIPTION
-You probably want L<Catalyst::Authentication::Store::LDAP>, unless
-you are mixing several stores in a single app and one of them is LDAP.
+You probably want L<Catalyst::Authentication::Store::LDAP>.
-Otherwise, this lets you create a store manually.
+Otherwise, this lets you create a store manually.
See the L<Catalyst::Authentication::Store::LDAP> documentation for
an explanation of the configuration options.
use strict;
use warnings;
-our $VERSION = '0.1004';
+our $VERSION = '1.014';
use Catalyst::Authentication::Store::LDAP::User;
use Net::LDAP;
$config_hash{'use_roles'} ||= '1';
$config_hash{'start_tls'} ||= '0';
$config_hash{'entry_class'} ||= 'Catalyst::Model::LDAP::Entry';
- $config_hash{'user_class'} ||= 'Catalyst::Authentication::Store::LDAP::User';
+ $config_hash{'user_class'}
+ ||= 'Catalyst::Authentication::Store::LDAP::User';
$config_hash{'role_search_as_user'} ||= 0;
- Catalyst::Utils::ensure_class_loaded($config_hash{'user_class'});
+ Catalyst::Utils::ensure_class_loaded( $config_hash{'user_class'} );
my $self = \%config_hash;
bless( $self, $class );
return $self;
}
-=head2 find_user( I<authinfo> )
+=head2 find_user( I<authinfo>, $c )
Creates a L<Catalyst::Authentication::Store::LDAP::User> object
for the given User ID. This is the preferred mechanism for getting a
sub find_user {
my ( $self, $authinfo, $c ) = @_;
- return $self->get_user( $authinfo->{id} || $authinfo->{username} );
+ return $self->get_user( $authinfo->{id} || $authinfo->{username}, $c );
}
-=head2 get_user($id)
+=head2 get_user( I<id>, $c)
Creates a L<Catalyst::Authentication::Store::LDAP::User> object
-for the given User ID. This is the preferred mechanism for getting a
-given User out of the Store.
+for the given User ID, or calls C<new> on the class specified in
+C<user_class>. This instance of the store object, the results of
+C<lookup_user> and $c are passed as arguments (in that order) to C<new>.
+This is the preferred mechanism for getting a given User out of the Store.
=cut
sub get_user {
- my ( $self, $id ) = @_;
- my $user = $self->user_class->new( $self,
- $self->lookup_user($id) );
+ my ( $self, $id, $c ) = @_;
+ my $user = $self->user_class->new( $self, $self->lookup_user($id), $c );
return $user;
}
sub ldap_bind {
my ( $self, $ldap, $binddn, $bindpw, $forauth ) = @_;
$forauth ||= 0;
- $ldap ||= $self->ldap_connect;
+ $ldap ||= $self->ldap_connect;
if ( !defined($ldap) ) {
Catalyst::Exception->throw("LDAP Server undefined!");
}
- $binddn ||= $self->binddn;
- $bindpw ||= $self->bindpw;
+
+ # if username is present, make sure password is present too.
+ # see https://rt.cpan.org/Ticket/Display.html?id=81908
+ if ( !defined $binddn ) {
+ $binddn = $self->binddn;
+ $bindpw = $self->bindpw;
+ }
+
if ( $binddn eq "anonymous" ) {
$self->_ldap_bind_anon($ldap);
}
else {
- if ($bindpw) {
+ # Don't fall back to unauthenticated bind when authenticating
+ if ($bindpw or $forauth eq 'forauth') {
my $mesg = $ldap->bind( $binddn, 'password' => $bindpw );
if ( $mesg->is_error ) {
}
}
else {
- $self->_ldap_bind_anon($ldap, $binddn);
+ $self->_ldap_bind_anon( $ldap, $binddn );
}
}
return $ldap;
}
sub _ldap_bind_anon {
- my ($self, $ldap, $dn) = @_;
+ my ( $self, $ldap, $dn ) = @_;
my $mesg = $ldap->bind($dn);
if ( $mesg->is_error ) {
Catalyst::Exception->throw( "Error on Bind: " . $mesg->error );
A) Bind to the directory using the configured binddn and bindpw
B) Perform a search for the User Object in the directory, using
user_basedn, user_filter, and user_scope.
- C) Assuming we found the object, we will walk it's attributes
+ C) Assuming we found the object, we will walk it's attributes
using L<Net::LDAP::Entry>'s get_value method. We store the
- results in a hashref.
- D) Return a hashref that looks like:
-
+ results in a hashref. If we do not find the object, then
+ undef is returned.
+ D) Return a hashref that looks like:
+
$results = {
'ldap_entry' => $entry, # The Net::LDAP::Entry object
'attributes' => $attributes,
sub lookup_user {
my ( $self, $id ) = @_;
- # No sneaking in wildcards!
- if ( $id =~ /\*/ ) {
- Catalyst::Exception->throw("ID $id contains wildcards!");
- }
+ # Trim trailing space or we confuse ourselves
+ $id =~ s/\s+$//;
my $ldap = $self->ldap_bind;
my @searchopts;
if ( defined( $self->user_basedn ) ) {
push( @searchopts, %{ $self->user_search_options } );
}
my $usersearch = $ldap->search(@searchopts);
- if ( $usersearch->is_error ) {
- Catalyst::Exception->throw(
- "LDAP Error while searching for user: " . $usersearch->error );
- }
+
+ return undef if ( $usersearch->is_error );
+
my $userentry;
my $user_field = $self->user_field;
my $results_filter = $self->user_results_filter;
$attrhash->{ lc($attr) } = \@attrvalues;
}
}
-
- eval { Catalyst::Utils::ensure_class_loaded($self->entry_class) };
+
+ eval { Catalyst::Utils::ensure_class_loaded( $self->entry_class ) };
if ( !$@ ) {
bless( $userentry, $self->entry_class );
$userentry->{_use_unicode}++;
my $self = shift;
my $filter = shift;
my $replace = shift;
+ $replace =~ s/([*()\\\x{0}])/sprintf '\\%02x', ord($1)/ge;
$filter =~ s/\%s/$replace/g;
return $filter;
}
Catalyst::Authentication::Store::LDAP::User->supports(@_);
}
-=head2 from_session( I<id> )
+=head2 from_session( I<id>, I<$c> )
Returns get_user() for I<id>.
sub from_session {
my ( $self, $c, $id ) = @_;
- $self->get_user($id);
+ $self->get_user( $id, $c );
}
1;
projects / catagits/Catalyst-Authentication-Store-LDAP.git / blobdiff