View Source eldap (eldap v1.2.13)
LDAP Client
This module provides a client api to the Lightweight Directory Access Protocol (LDAP).
References:
- RFC 4510 - RFC 4519
- RFC 2830
The above publications can be found at IETF.
DATA TYPES
Type definitions that are used more than once in this module:
handle()
- Connection handleattribute() =
-{Type = string(), Values=[string()]}
modify_op()
- Seemod_add/2
,mod_delete/2
,mod_replace/2
scope()
- SeebaseObject/0
,singleLevel/0
,wholeSubtree/0
dereference()
- SeeneverDerefAliases/0
,derefInSearching/0
,derefFindingBaseObj/0
,derefAlways/0
filter()
- Seepresent/1
,substrings/2
,equalityMatch/2
,greaterOrEqual/2
,lessOrEqual/2
,approxMatch/2
,extensibleMatch/2
,'and'/1
,'or'/1
,'not'/1
return_value() =
-ok | {ok, {referral,referrals()}} | {error,Error}
referrals() =
-[Address = string()]
The contents ofAddress
is server dependent.
Summary
Functions
add(Handle, Dn, [Attribute]) -> return_value()
'and'([Filter]) -> filter()
approxMatch(Type, Value) -> filter()
baseObject() -> scope()
close(Handle) -> ok
delete(Handle, Dn) -> return_value()
derefAlways() -> dereference()
derefFindingBaseObj() -> dereference()
derefInSearching() -> dereference()
equalityMatch(Type, Value) -> filter()
extensibleMatch(MatchValue, OptionalAttrs) -> filter()
greaterOrEqual(Type, Value) -> filter()
info(Handle) -> connection_info()
lessOrEqual(Type, Value) -> filter()
mod_add(Type, [Value]) -> modify_op()
mod_delete(Type, [Value]) -> modify_op()
mod_replace(Type, [Value]) -> modify_op()
modify(Handle, Dn, [ModifyOp]) -> return_value()
modify_dn(Handle, Dn, NewRDN, DeleteOldRDN, NewSupDN) -> return_value()
modify_password(Handle, Dn, NewPasswd) -> return_value() | {ok, GenPasswd}
modify_password(Handle, Dn, NewPasswd, OldPasswd) -> return_value() | {ok, GenPasswd}
neverDerefAliases() -> dereference()
'not'(Filter) -> filter()
open([Host]) -> {ok, Handle} | {error, Reason}
open([Host], [Option]) -> {ok, Handle} | {error, Reason}
'or'([Filter]) -> filter()
paged_result_control(PageSize) -> {control, "1.2.840.113556.1.4.319", true, binary()}
paged_result_control(PageSize, Cookie) -> {control, "1.2.840.113556.1.4.319", true, binary()}
paged_result_cookie(SearchResult) -> binary()
present(Type) -> filter()
search(Handle, SearchOptions) -> {ok, #eldap_search_result{}} | {ok, |
{referral,referrals()}} | {error, Reason} |
Search the directory with the supplied the SearchOptions. The base and filter
options must be supplied. Default values: scope is wholeSubtree/0
, deref is
derefAlways/0
, types_only is false
and timeout is 0
(meaning infinity).
simple_bind(Handle, Dn, Password) -> return_value()
singleLevel() -> scope()
start_tls(Handle, Options) -> return_value()
start_tls(Handle, Options, Timeout) -> return_value()
substrings(Type, [SubString]) -> filter()
wholeSubtree() -> scope()
Functions
add(Handle, Dn, [Attribute]) -> return_value()
Add an entry. The entry must not exist.
add(Handle,
"cn=Bill Valentine, ou=people, o=Example Org, dc=example, dc=com",
[{"objectclass", ["person"]},
{"cn", ["Bill Valentine"]},
{"sn", ["Valentine"]},
{"telephoneNumber", ["545 555 00"]}]
)
'and'([Filter]) -> filter()
Creates a filter where all Filter
must be true.
approxMatch(Type, Value) -> filter()
Create a approximation match filter.
baseObject() -> scope()
Search baseobject only.
close(Handle) -> ok
Shutdown the connection after sending an unbindRequest to the server. If the
connection is tls the connection will be closed with ssl:close/1
, otherwise
with gen_tcp:close/1
.
delete(Handle, Dn) -> return_value()
Delete an entry.
delete(Handle, "cn=Bill Valentine, ou=people, o=Example Org, dc=example, dc=com")
derefAlways() -> dereference()
Always dereference aliases.
derefFindingBaseObj() -> dereference()
Dereference aliases only in finding the base.
derefInSearching() -> dereference()
Dereference aliases only when searching.
equalityMatch(Type, Value) -> filter()
Create a equality filter.
extensibleMatch(MatchValue, OptionalAttrs) -> filter()
Creates an extensible match filter. For example,
eldap:extensibleMatch("Bar", [{type,"sn"}, {matchingRule,"caseExactMatch"}]))
creates a filter which performs a caseExactMatch
on the attribute sn
and
matches with the value "Bar"
. The default value of dnAttributes
is false
.
greaterOrEqual(Type, Value) -> filter()
Create a greater or equal filter.
info(Handle) -> connection_info()
Currently available information reveals the socket and the transport protocol, TCP or TLS (SSL), used by the LDAP connection.
lessOrEqual(Type, Value) -> filter()
Create a less or equal filter.
mod_add(Type, [Value]) -> modify_op()
Create an add modification operation.
mod_delete(Type, [Value]) -> modify_op()
Create a delete modification operation.
mod_replace(Type, [Value]) -> modify_op()
Create a replace modification operation.
modify(Handle, Dn, [ModifyOp]) -> return_value()
Modify an entry.
modify(Handle, "cn=Bill Valentine, ou=people, o=Example Org, dc=example, dc=com",
[eldap:mod_replace("telephoneNumber", ["555 555 00"]),
eldap:mod_add("description", ["LDAP Hacker"]) ])
modify_dn(Handle, Entry, NewRDN, DelOldRDN, NewSup)
View Source (since OTP R15B01)modify_dn(Handle, Dn, NewRDN, DeleteOldRDN, NewSupDN) -> return_value()
Modify the DN of an entry. DeleteOldRDN
indicates whether the current RDN
should be removed from the attribute list after the operation. NewSupDN
is the
new parent that the RDN shall be moved to. If the old parent should remain as
parent, NewSupDN
shall be "".
modify_dn(Handle, "cn=Bill Valentine, ou=people, o=Example Org, dc=example, dc=com ",
"cn=Bill Jr Valentine", true, "")
modify_password(Handle, Dn, NewPasswd) -> return_value() | {ok, GenPasswd}
Modify the password of a user. See modify_password/4
.
modify_password(Handle, Dn, NewPasswd, OldPasswd)
View Source (since OTP 18.0)modify_password(Handle, Dn, NewPasswd, OldPasswd) -> return_value() | {ok, GenPasswd}
Modify the password of a user.
Dn
. The user to modify. Should be "" if the modify request is for the user of the LDAP session.NewPasswd
. The new password to set. Should be "" if the server is to generate the password. In this case, the result will be{ok, GenPasswd}
.OldPasswd
. Sometimes required by server policy for a user to change their password. If not required, usemodify_password/3
.
neverDerefAliases() -> dereference()
Never dereference aliases, treat aliases as entries.
'not'(Filter) -> filter()
Negate a filter.
open([Host]) -> {ok, Handle} | {error, Reason}
Setup a connection to an LDAP server, the HOST
's are tried in order.
open([Host], [Option]) -> {ok, Handle} | {error, Reason}
Setup a connection to an LDAP server, the HOST
's are tried in order.
The log function takes three arguments,
fun(Level, FormatString, [FormatArg]) end
.
Timeout set the maximum time in milliseconds that each server request may take.
All TCP socket options are accepted except active
, binary
, deliver
,
list
, mode
and packet
'or'([Filter]) -> filter()
Create a filter where at least one of the Filter
must be true.
paged_result_control(PageSize) -> {control, "1.2.840.113556.1.4.319", true, binary()}
Paged results is an extension to the LDAP protocol specified by RFC2696
This function creates a control with the specified page size for use in
search/3
, for example:
Control = eldap:paged_result_control(50),
{ok, SearchResults} = search(Handle, [{base, "dc=example, dc=com"}], [Control]),
paged_result_control(PageSize, Cookie) -> {control, "1.2.840.113556.1.4.319", true, binary()}
Paged results is an extension to the LDAP protocol specified by RFC2696
This function creates a control with the specified page size and cookie for use
in search/3
to retrieve the next results page.
For example:
PageSize = 50,
Control1 = eldap:paged_result_control(PageSize),
{ok, SearchResults1} = search(Handle, [{base, "dc=example, dc=com"}], [Control1]),
%% retrieve the returned cookie from the search results
{ok, Cookie1} = eldap:paged_result_cookie(SearchResults1),
Control2 = eldap:paged_result_control(PageSize, Cookie1),
{ok, SearchResults2} = eldap:search(Handle, [{base, "dc=example,dc=com"}], [Control2]),
%% etc
paged_result_cookie(SearchResult) -> binary()
Paged results is an extension to the LDAP protocol specified by RFC2696.
This function extracts the cookie returned from the server as a result of a paged search result.
If the returned cookie is the empty string ""
, then these search results
represent the last in the series.
present(Type) -> filter()
Create a filter which filters on attribute type presence.
search(Handle, SearchOptions) -> {ok, #eldap_search_result{}} | {ok, |
{referral,referrals()}} | {error, Reason} |
Search the directory with the supplied the SearchOptions. The base and filter
options must be supplied. Default values: scope is wholeSubtree/0
, deref is
derefAlways/0
, types_only is false
and timeout is 0
(meaning infinity).
Filter = eldap:substrings("cn", [{any,"V"}]),
search(Handle, [{base, "dc=example, dc=com"}, {filter, Filter}, {attributes, ["cn"]}]),
The timeout
option in the SearchOptions
is for the ldap server, while the
timeout in eldap:open/2 is used for each individual request in the
search operation.
simple_bind(Handle, Dn, Password) -> return_value()
Authenticate the connection using simple authentication.
singleLevel() -> scope()
Search the specified level only, i.e. do not recurse.
start_tls(Handle, Options) -> return_value()
Same as start_tls(Handle, Options, infinity)
start_tls(Handle, Options, Timeout) -> return_value()
Upgrade the connection associated with Handle
to a tls connection if possible.
The upgrade is done in two phases: first the server is asked for permission to upgrade. Second, if the request is acknowledged, the upgrade to tls is performed.
Error responses from phase one will not affect the current encryption state of the connection. Those responses are:
tls_already_started
- The connection is already encrypted. The connection is not affected.{response,ResponseFromServer}
- The upgrade was refused by the LDAP server. TheResponseFromServer
is an atom delivered byt the LDAP server explained in section 2.3 of rfc 2830. The connection is not affected, so it is still un-encrypted.
Errors in the second phase will however end the connection:
Error
- Any error responded from ssl:connect/3
The Timeout
parameter is for the actual tls upgrade (phase 2) while the
timeout in eldap:open/2 is used for the initial negotiation about
upgrade (phase 1).
substrings(Type, [SubString]) -> filter()
Create a filter which filters on substrings.
wholeSubtree() -> scope()
Search the entire subtree.