.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Authen::Simple::ActiveDirectory 3pm"
.TH Authen::Simple::ActiveDirectory 3pm "2021-01-04" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Authen::Simple::ActiveDirectory \- Simple ActiveDirectory authentication
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Authen::Simple::ActiveDirectory;
\&    
\&    my $ad = Authen::Simple::ActiveDirectory\->new( 
\&        host      => \*(Aqad.company.com\*(Aq,
\&        principal => \*(Aqcompany.com\*(Aq
\&    );
\&    
\&    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>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Authenticate against Active Directory.
.PP
This implementation differs from Authen::Simple::LDAP in way that it will 
try to bind directly as the users principial.
.SH "METHODS"
.IX Header "METHODS"
.IP "\(bu" 4
new
.Sp
This method takes a hash of parameters.  The following options are
valid:
.RS 4
.IP "\(bu" 8
host
.Sp
Connection host, can be a hostname, \s-1IP\s0 number or a \s-1URI.\s0 Defaults to \f(CW\*(C`localhost\*(C'\fR.
.Sp
.Vb 4
\&    host => ldap.company.com
\&    host => 10.0.0.1
\&    host => ldap://ldap.company.com:389
\&    host => ldaps://ldap.company.com
.Ve
.IP "\(bu" 8
port
.Sp
Connection port, default to 389. May be overridden by host if host is a \s-1URI.\s0
.Sp
.Vb 1
\&    port => 389
.Ve
.IP "\(bu" 8
timeout
.Sp
Connection timeout, defaults to 60.
.Sp
.Vb 1
\&    timeout => 60
.Ve
.IP "\(bu" 8
principal
.Sp
The suffix in users principal, usally the domain or forrest. Required.
.Sp
.Vb 1
\&    principal => \*(Aqcompany.com\*(Aq
.Ve
.IP "\(bu" 8
log
.Sp
Any object that supports \f(CW\*(C`debug\*(C'\fR, \f(CW\*(C`info\*(C'\fR, \f(CW\*(C`error\*(C'\fR and \f(CW\*(C`warn\*(C'\fR.
.Sp
.Vb 1
\&    log => Log::Log4perl\->get_logger(\*(AqAuthen::Simple::ActiveDirectory\*(Aq)
.Ve
.RE
.RS 4
.RE
.IP "\(bu" 4
authenticate( \f(CW$username\fR, \f(CW$password\fR )
.Sp
Returns true on success and false on failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Simple::LDAP.
.PP
Authen::Simple.
.PP
Net::LDAP.
.SH "AUTHOR"
.IX Header "AUTHOR"
Christian Hansen \f(CW\*(C`chansen@cpan.org\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software, you can redistribute it and/or modify 
it under the same terms as Perl itself.