6 Catalyst::Authentication::Store::LDAP::Backend
7 - LDAP authentication storage backend.
11 # you probably just want Store::LDAP under most cases,
12 # but if you insist you can instantiate your own store:
14 use Catalyst::Authentication::Store::LDAP::Backend;
18 Authentication::Credential::Password
22 'ldap_server' => 'ldap1.yourcompany.com',
23 'ldap_server_options' => {
26 'binddn' => 'anonymous',
27 'bindpw' => 'dontcarehow',
29 'start_tls_options' => {
32 'user_basedn' => 'ou=people,dc=yourcompany,dc=com',
33 'user_filter' => '(&(objectClass=posixAccount)(uid=%s))',
34 'user_scope' => 'one', # or 'sub' for Active Directory
35 'user_field' => 'uid',
36 'user_search_options' => {
38 'attrs' => [qw( distinguishedname name mail )],
40 'user_results_filter' => sub { return shift->pop_entry },
41 'entry_class' => 'MyApp::LDAP::Entry',
42 'user_class' => 'MyUser',
44 'role_basedn' => 'ou=groups,dc=yourcompany,dc=com',
45 'role_filter' => '(&(objectClass=posixGroup)(member=%s))',
46 'role_scope' => 'one',
49 'role_search_options' => {
52 'role_search_as_user' => 0,
53 'persist_in_session' => 'all',
56 our $users = Catalyst::Authentication::Store::LDAP::Backend->new(\%config);
60 You probably want L<Catalyst::Authentication::Store::LDAP>.
62 Otherwise, this lets you create a store manually.
64 See the L<Catalyst::Authentication::Store::LDAP> documentation for
65 an explanation of the configuration options.
71 package Catalyst::Authentication::Store::LDAP::Backend;
72 use base qw( Class::Accessor::Fast );
77 our $VERSION = '1.015';
79 use Catalyst::Authentication::Store::LDAP::User;
81 use Catalyst::Utils ();
84 __PACKAGE__->mk_accessors(
85 qw( ldap_server ldap_server_options binddn
86 bindpw entry_class user_search_options
87 user_filter user_basedn user_scope
88 user_attrs user_field use_roles role_basedn
89 role_filter role_scope role_field role_value
90 role_search_options start_tls start_tls_options
91 user_results_filter user_class role_search_as_user
99 Creates a new L<Catalyst::Authentication::Store::LDAP::Backend> object.
100 $config should be a hashref, which should contain the configuration options
101 listed in L<Catalyst::Authentication::Store::LDAP>'s documentation.
103 Also sets a few sensible defaults.
108 my ( $class, $config ) = @_;
110 unless ( defined($config) && ref($config) eq "HASH" ) {
111 Catalyst::Exception->throw(
112 "Catalyst::Authentication::Store::LDAP::Backend needs to be configured with a hashref."
115 my %config_hash = %{$config};
116 $config_hash{'binddn'} ||= 'anonymous';
117 $config_hash{'user_filter'} ||= '(uid=%s)';
118 $config_hash{'user_scope'} ||= 'sub';
119 $config_hash{'user_field'} ||= 'uid';
120 $config_hash{'role_filter'} ||= '(memberUid=%s)';
121 $config_hash{'role_scope'} ||= 'sub';
122 $config_hash{'role_field'} ||= 'cn';
123 $config_hash{'use_roles'} = '1'
124 unless exists $config_hash{use_roles};
125 $config_hash{'start_tls'} ||= '0';
126 $config_hash{'entry_class'} ||= 'Catalyst::Model::LDAP::Entry';
127 $config_hash{'user_class'}
128 ||= 'Catalyst::Authentication::Store::LDAP::User';
129 $config_hash{'role_search_as_user'} ||= 0;
130 $config_hash{'persist_in_session'} ||= 'username';
131 Catalyst::Exception->throw('persist_in_session must be either username or all')
132 unless $config_hash{'persist_in_session'} =~ /\A(?:username|all)\z/;
134 Catalyst::Utils::ensure_class_loaded( $config_hash{'user_class'} );
135 my $self = \%config_hash;
136 bless( $self, $class );
140 =head2 find_user( I<authinfo>, $c )
142 Creates a L<Catalyst::Authentication::Store::LDAP::User> object
143 for the given User ID. This is the preferred mechanism for getting a
144 given User out of the Store.
146 I<authinfo> should be a hashref with a key of either C<id> or
147 C<username>. The value will be compared against the LDAP C<user_field> field.
152 my ( $self, $authinfo, $c ) = @_;
153 return $self->get_user( $authinfo->{id} || $authinfo->{username}, $c );
156 =head2 get_user( I<id>, $c)
158 Creates a L<Catalyst::Authentication::Store::LDAP::User> object
159 for the given User ID, or calls C<new> on the class specified in
160 C<user_class>. This instance of the store object, the results of
161 C<lookup_user> and $c are passed as arguments (in that order) to C<new>.
162 This is the preferred mechanism for getting a given User out of the Store.
167 my ( $self, $id, $c ) = @_;
168 my $user = $self->user_class->new( $self, $self->lookup_user($id), $c );
174 Returns a L<Net::LDAP> object, connected to your LDAP server. (According
175 to how you configured the Backend, of course)
182 if ( defined( $self->ldap_server_options() ) ) {
184 = Net::LDAP->new( $self->ldap_server,
185 %{ $self->ldap_server_options } )
186 or Catalyst::Exception->throw($@);
189 $ldap = Net::LDAP->new( $self->ldap_server )
190 or Catalyst::Exception->throw($@);
192 if ( defined( $self->start_tls ) && $self->start_tls =~ /(1|true)/i ) {
194 if ( defined( $self->start_tls_options ) ) {
195 $mesg = $ldap->start_tls( %{ $self->start_tls_options } );
198 $mesg = $ldap->start_tls;
200 if ( $mesg->is_error ) {
201 Catalyst::Exception->throw( "TLS Error: " . $mesg->error );
207 =head2 ldap_bind($ldap, $binddn, $bindpw)
209 Bind's to the directory. If $ldap is undef, it will connect to the
210 LDAP server first. $binddn should be the DN of the object you wish
211 to bind as, and $bindpw the password.
213 If $binddn is "anonymous", an anonymous bind will be performed.
218 my ( $self, $ldap, $binddn, $bindpw ) = @_;
219 $ldap ||= $self->ldap_connect;
220 if ( !defined($ldap) ) {
221 Catalyst::Exception->throw("LDAP Server undefined!");
224 # if username is present, make sure password is present too.
225 # see https://rt.cpan.org/Ticket/Display.html?id=81908
226 if ( !defined $binddn ) {
227 $binddn = $self->binddn;
228 $bindpw = $self->bindpw;
231 if ( $binddn eq "anonymous" ) {
232 $self->_ldap_bind_anon($ldap);
236 my $mesg = $ldap->bind( $binddn, 'password' => $bindpw );
237 if ( $mesg->is_error ) {
238 Catalyst::Exception->throw(
239 "Error on Initial Bind: " . $mesg->error );
243 $self->_ldap_bind_anon( $ldap, $binddn );
249 sub _ldap_bind_anon {
250 my ( $self, $ldap, $dn ) = @_;
251 my $mesg = $ldap->bind($dn);
252 if ( $mesg->is_error ) {
253 Catalyst::Exception->throw( "Error on Bind: " . $mesg->error );
257 =head2 ldap_auth( $binddn, $bindpw )
259 Connect to the LDAP server and do an authenticated bind against the
260 directory. Throws an exception if connecting to the LDAP server fails.
261 Returns 1 if binding succeeds, 0 if it fails.
266 my ( $self, $binddn, $bindpw ) = @_;
267 my $ldap = $self->ldap_connect;
268 if ( !defined $ldap ) {
269 Catalyst::Exception->throw("LDAP server undefined!");
271 my $mesg = $ldap->bind( $binddn, password => $bindpw );
272 return $mesg->is_error ? 0 : 1;
275 =head2 lookup_user($id)
277 Given a User ID, this method will:
279 A) Bind to the directory using the configured binddn and bindpw
280 B) Perform a search for the User Object in the directory, using
281 user_basedn, user_filter, and user_scope.
282 C) Assuming we found the object, we will walk it's attributes
283 using L<Net::LDAP::Entry>'s get_value method. We store the
284 results in a hashref. If we do not find the object, then
286 D) Return a hashref that looks like:
289 'ldap_entry' => $entry, # The Net::LDAP::Entry object
290 'attributes' => $attributes,
293 This method is usually only called by find_user().
298 my ( $self, $id ) = @_;
300 # Trim trailing space or we confuse ourselves
302 my $ldap = $self->ldap_bind;
304 if ( defined( $self->user_basedn ) ) {
305 push( @searchopts, 'base' => $self->user_basedn );
308 Catalyst::Exception->throw(
309 "You must set user_basedn before looking up users!");
311 my $filter = $self->_replace_filter( $self->user_filter, $id );
312 push( @searchopts, 'filter' => $filter );
313 push( @searchopts, 'scope' => $self->user_scope );
314 if ( defined( $self->user_search_options ) ) {
315 push( @searchopts, %{ $self->user_search_options } );
317 my $usersearch = $ldap->search(@searchopts);
319 return undef if ( $usersearch->is_error );
322 my $user_field = $self->user_field;
323 my $results_filter = $self->user_results_filter;
325 if ( defined($results_filter) ) {
326 $entry = &$results_filter($usersearch);
329 $entry = $usersearch->pop_entry;
331 if ( $usersearch->pop_entry ) {
332 Catalyst::Exception->throw(
333 "More than one entry matches user search.\n"
334 . "Consider defining a user_results_filter sub." );
337 # a little extra sanity check with the 'eq' since LDAP already
339 # NOTE that Net::LDAP returns exactly what you asked for, but
340 # because LDAP is often case insensitive, FoO can match foo
341 # and so we normalize with lc().
342 if ( defined($entry) ) {
343 unless ( lc( $entry->get_value($user_field) ) eq lc($id) ) {
344 Catalyst::Exception->throw(
345 "LDAP claims '$user_field' equals '$id' but results entry does not match."
353 unless ($userentry) {
357 foreach my $attr ( $userentry->attributes ) {
358 my @attrvalues = $userentry->get_value($attr);
359 if ( scalar(@attrvalues) == 1 ) {
360 $attrhash->{ lc($attr) } = $attrvalues[0];
363 $attrhash->{ lc($attr) } = \@attrvalues;
367 eval { Catalyst::Utils::ensure_class_loaded( $self->entry_class ) };
369 bless( $userentry, $self->entry_class );
370 $userentry->{_use_unicode}++;
373 'ldap_entry' => $userentry,
374 'attributes' => $attrhash,
379 =head2 lookup_roles($userobj, [$ldap])
381 This method looks up the roles for a given user. It takes a
382 L<Catalyst::Authentication::Store::LDAP::User> object
383 as it's first argument, and can optionally take a I<Net::LDAP> object which
384 is used rather than the default binding if supplied.
386 It returns an array containing the role_field attribute from all the
387 objects that match it's criteria.
392 my ( $self, $userobj, $ldap ) = @_;
393 if ( $self->use_roles == 0 || $self->use_roles =~ /^false$/i ) {
396 $ldap ||= $self->role_search_as_user
397 ? $userobj->ldap_connection : $self->ldap_bind;
399 if ( defined( $self->role_basedn ) ) {
400 push( @searchopts, 'base' => $self->role_basedn );
403 Catalyst::Exception->throw(
404 "You must set up role_basedn before looking up roles!");
406 my $filter_value = $userobj->has_attribute( $self->role_value );
407 if ( !defined($filter_value) ) {
408 Catalyst::Exception->throw( "User object "
412 . " attribute, so I can't look up it's roles!" );
414 my $filter = $self->_replace_filter( $self->role_filter, $filter_value );
415 push( @searchopts, 'filter' => $filter );
416 push( @searchopts, 'scope' => $self->role_scope );
417 push( @searchopts, 'attrs' => [ $self->role_field ] );
418 if ( defined( $self->role_search_options ) ) {
419 push( @searchopts, %{ $self->role_search_options } );
421 my $rolesearch = $ldap->search(@searchopts);
423 RESULT: foreach my $entry ( $rolesearch->entries ) {
424 push( @roles, $entry->get_value( $self->role_field ) );
429 sub _replace_filter {
433 $replace =~ s/([*()\\\x{0}])/sprintf '\\%02x', ord($1)/ge;
434 $filter =~ s/\%s/$replace/g;
441 Catalyst::Authentication::Store::LDAP::User->supports(@_).
448 # this can work as a class method
449 Catalyst::Authentication::Store::LDAP::User->supports(@_);
452 =head2 from_session( I<id>, I<$c>, $frozenuser )
454 Revives a serialized user from storage in the session.
456 Supports users stored with a different persist_in_session setting.
461 my ( $self, $c, $frozenuser ) = @_;
463 # we need to restore the user depending on the current storage of the
464 # user in the session store which might differ from what
465 # persist_in_session is set to now
466 if ( ref $frozenuser eq 'HASH' ) {
467 # we can rely on the existance of this key if the user is a hashref
468 if ( $frozenuser->{persist_in_session} eq 'all' ) {
469 return $self->user_class->new( $self, $frozenuser->{user}, $c, $frozenuser->{_roles} );
473 return $self->get_user( $frozenuser, $c );
482 Adam Jacob <holoway@cpan.org>
484 Some parts stolen shamelessly and entirely from
485 L<Catalyst::Plugin::Authentication::Store::Htpasswd>.
487 Currently maintained by Peter Karman <karman@cpan.org>.
491 To nothingmuch, ghenry, castaway and the rest of #catalyst for the help. :)
495 L<Catalyst::Authentication::Store::LDAP>, L<Catalyst::Authentication::Store::LDAP::User>, L<Catalyst::Plugin::Authentication>, L<Net::LDAP>
497 =head1 COPYRIGHT & LICENSE
499 Copyright (c) 2005 the aforementioned authors. All rights
500 reserved. This program is free software; you can redistribute
501 it and/or modify it under the same terms as Perl itself.