.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Authen::Simple::LDAP 3pm"
.TH Authen::Simple::LDAP 3pm "2012-04-23" "perl v5.14.2" "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::LDAP \- Simple LDAP authentication
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Authen::Simple::LDAP;
\&    
\&    my $ldap = Authen::Simple::LDAP\->new( 
\&        host    => \*(Aqldap.company.com\*(Aq,
\&        basedn  => \*(Aqou=People,dc=company,dc=net\*(Aq
\&    );
\&    
\&    if ( $ldap\->authenticate( $username, $password ) ) {
\&        # successfull authentication
\&    }
\&    
\&    # or as a mod_perl Authen handler
\&    
\&    PerlModule Authen::Simple::Apache
\&    PerlModule Authen::Simple::LDAP
\&
\&    PerlSetVar AuthenSimpleLDAP_host   "ldap.company.com"
\&    PerlSetVar AuthenSimpleLDAP_basedn "ou=People,dc=company,dc=net"
\&
\&    <Location /protected>
\&      PerlAuthenHandler Authen::Simple::LDAP
\&      AuthType          Basic
\&      AuthName          "Protected Area"
\&      Require           valid\-user
\&    </Location>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Authenticate against a \s-1LDAP\s0 service.
.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 \f(CW389\fR. 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
version
.Sp
The \s-1LDAP\s0 version to use, defaults to 3.
.Sp
.Vb 1
\&    version => 3
.Ve
.IP "\(bu" 8
binddn
.Sp
The distinguished name to bind to the server with, defaults to bind
anonymously.
.Sp
.Vb 1
\&    binddn => \*(Aquid=proxy,cn=users,dc=company,dc=com\*(Aq
.Ve
.IP "\(bu" 8
bindpw
.Sp
The credentials to bind with.
.Sp
.Vb 1
\&    bindpw => \*(Aqsecret\*(Aq
.Ve
.IP "\(bu" 8
basedn
.Sp
The distinguished name of the search base.
.Sp
.Vb 1
\&    basedn => \*(Aqcn=users,dc=company,dc=com\*(Aq
.Ve
.IP "\(bu" 8
filter
.Sp
\&\s-1LDAP\s0 filter to use in search, defaults to \f(CW\*(C`(uid=%s)\*(C'\fR.
.Sp
.Vb 1
\&    filter => \*(Aq(uid=%s)\*(Aq
.Ve
.IP "\(bu" 8
scope
.Sp
The search scope, can be \f(CW\*(C`base\*(C'\fR, \f(CW\*(C`one\*(C'\fR or \f(CW\*(C`sub\*(C'\fR, defaults to \f(CW\*(C`sub\*(C'\fR.
.Sp
.Vb 1
\&    filter => \*(Aqsub\*(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::LDAP\*(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 "EXAMPLE USAGE"
.IX Header "EXAMPLE USAGE"
.SS "Apple Open Directory"
.IX Subsection "Apple Open Directory"
.Vb 5
\&    my $ldap = Authen::Simple::LDAP\->new(
\&        host    => \*(Aqod.company.com\*(Aq,
\&        basedn  => \*(Aqcn=users,dc=company,dc=com\*(Aq,
\&        filter  => \*(Aq(&(objectClass=inetOrgPerson)(objectClass=posixAccount)(uid=%s))\*(Aq
\&    );
.Ve
.SS "Microsoft Active Directory"
.IX Subsection "Microsoft Active Directory"
.Vb 7
\&    my $ldap = Authen::Simple::LDAP\->new(
\&        host    => \*(Aqad.company.com\*(Aq,
\&        binddn  => \*(Aqproxyuser@company.com\*(Aq,
\&        bindpw  => \*(Aqsecret\*(Aq,
\&        basedn  => \*(Aqcn=users,dc=company,dc=com\*(Aq,
\&        filter  => \*(Aq(&(objectClass=organizationalPerson)(objectClass=user)(sAMAccountName=%s))\*(Aq
\&    );
.Ve
.PP
Active Directory by default does not allow anonymous binds. It's recommended
that a proxy user is used that has sufficient rights to search the desired
tree and attributes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Simple::ActiveDirectory.
.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.