debian man page for authen::simple::activedirectory

Authen::Simple::ActiveDirectory(3pm)			User Contributed Perl Documentation		      Authen::Simple::ActiveDirectory(3pm)

NAME
       Authen::Simple::ActiveDirectory - Simple ActiveDirectory authentication

SYNOPSIS
	   use Authen::Simple::ActiveDirectory;

	   my $ad = Authen::Simple::ActiveDirectory->new(
	       host	 => 'ad.company.com',
	       principal => 'company.com'
	   );

	   if ( $ad->authenticate( $username, $password ) ) {
	       # successfull authentication
	   }

	   # or as a mod_perl Authen handler

	   PerlModule Authen::Simple::Apache
	   PerlModule Authen::Simple::ActiveDirectory

	   PerlSetVar AuthenSimpleActiveDirectory_host	    "ad.company.com"
	   PerlSetVar AuthenSimpleActiveDirectory_principal "company.com"

	   <Location /protected>
	     PerlAuthenHandler Authen::Simple::ActiveDirectory
	     AuthType	       Basic
	     AuthName	       "Protected Area"
	     Require	       valid-user
	   </Location>

DESCRIPTION
       Authenticate against Active Directory.

       This implementation differs from Authen::Simple::LDAP in way that it will try to bind directly as the users principial.

METHODS
       o   new

	   This method takes a hash of parameters.  The following options are valid:

	   o	   host

		   Connection host, can be a hostname, IP number or a URI. Defaults to "localhost".

		       host => ldap.company.com
		       host => 10.0.0.1
		       host => ldap://ldap.company.com:389
		       host => ldaps://ldap.company.com

	   o	   port

		   Connection port, default to 389. May be overridden by host if host is a URI.

		       port => 389

	   o	   timeout

		   Connection timeout, defaults to 60.

		       timeout => 60

	   o	   principal

		   The suffix in users principal, usally the domain or forrest. Required.

		       principal => 'company.com'

	   o	   log

		   Any object that supports "debug", "info", "error" and "warn".

		       log => Log::Log4perl->get_logger('Authen::Simple::ActiveDirectory')

       o   authenticate( $username, $password )

	   Returns true on success and false on failure.

SEE ALSO
       Authen::Simple::LDAP.

       Authen::Simple.

       Net::LDAP.

AUTHOR
       Christian Hansen "chansen@cpan.org"

COPYRIGHT
       This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-04-23				      Authen::Simple::ActiveDirectory(3pm)