.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "LWP::Protocol::ldap 3"
.TH LWP::Protocol::ldap 3 2024-09-01 "perl v5.40.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
LWP::Protocol::ldap \- Provide LDAP support for LWP::UserAgent
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use LWP::UserAgent;
\&
\&  $ua = LWP::UserAgent\->new();
\&  $res = $ua\->get(\*(Aqldap://ldap.example.com/\*(Aq .
\&                  \*(Aqo=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)\*(Aq,
\&                   Accept => \*(Aqtext/json\*(Aq):
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The LWP::Protocol::ldap module provides support for using \fIldap\fR schemed
URLs following RFC 4516 with LWP.  This module is a plug-in to the LWP
protocol handling, so you don't use it directly.
.PP
In addition to being used with LDAP URIs, LWP::Protocol::ldap also acts
as the base class for its sibling modules LWP::Protocol::ldaps
and LWP::Protocol::ldapi.
.SS Features
.IX Subsection "Features"
\fIHTTP methods supported\fR
.IX Subsection "HTTP methods supported"
.PP
LWP::Protocol::ldap implements the HTTP \fIGET\fR and \fIHEAD\fR methods.
They are mapped to the LDAP search operation,
.PP
\fIResponse format\fR
.IX Subsection "Response format"
.PP
Depending on the HTTP \fIAccept\fR header provided by the user agent,
LWP::Protocol::ldap can answer the requests in one of the following
formats:
.IP DSML 4
.IX Item "DSML"
When the HTTP \fIAccept\fR header contains the \f(CW\*(C`text/dsml\*(C'\fR MIME type,
the response is sent as DSMLv1.
.IP JSON 4
.IX Item "JSON"
When the HTTP \fIAccept\fR header contains the \f(CW\*(C`text/json\*(C'\fR MIME type,
the response is sent as JSON.
For this to work the \fIJSON\fR Perl module needs to be installed.
.IP LDIF 4
.IX Item "LDIF"
When the HTTP \fIAccept\fR header contains the \f(CW\*(C`text/ldif\*(C'\fR MIME type,
the response is sent in LDIFv1 format.
.IP HTML 4
.IX Item "HTML"
In case no HTTP \fIAccept\fR header has been sent or none of the above
MIME types can be detected, and the \fIx\-format\fR extension has not been provided
either, the response is sent using HTML markup in a 2\-column table format
(roughly modeled on LDIF).
.PP
As an alternative to sending an HTTP \fIAccept\fR header, LWP::Protocol::ldap
also accepts the \f(CW\*(C`x\-format\*(C'\fR extension
.PP
Example:
.PP
.Vb 1
\& ldap://ldap.example.com/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)?x\-format=dsml
.Ve
.PP
\fITLS support\fR
.IX Subsection "TLS support"
.PP
For \fIldap\fR and \fIldapi\fR URIs, the module implements the \f(CW\*(C`x\-tls\*(C'\fR extension
that switches the LDAP connection to TLS using a call of the
start_tls method.
.PP
Example:
.PP
.Vb 1
\& ldap://ldap.example.com/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)?x\-tls=1
.Ve
.PP
Note:
In the above example, ideally giving \f(CW\*(C`x\-tls\*(C'\fR should be sufficient,
but unfortunately the parser in URI::ldap has a little flaw.
.PP
\fIAuthorization\fR
.IX Subsection "Authorization"
.PP
Usually the connection is done anonymously, but if the HTTP \fIAuthorization\fR
header is provided with credentials for HTTP Basic authorization,
the credentials given in that header will be used to do a simple
bind to the LDAP server.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
LWP::Protocol::ldaps, LWP::Protocol::ldapi
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 1998\-2004 Graham Barr, 2012 Peter Marschall.
All rights reserved.  This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.