LDAP 目录协议函数库

ldap (lightweight directory access protocol) 是一种轻量的目录存取协议，提供客户从各个角落连接到目录服务器中。在 rfc 1777 及 rfc 1778 中对 ldap 有较深入的描述，亦可参考 netscape 站上有关 ldap 方面的资料。
在 ldap 的协议之中，很像硬盘目录结构或倒过来的树状结构。ldap 的根就是全世界，第一级是属于国别 (countries) 性质的层级，之后可能会有公司 (organization) 的层级，接着是部门 (organizationalunit)，再来为个人。而就像文件，每个人都会有所谓的显名 (distinguished name, 简称 dn)，dn 可能像酱子 cn=john smith,ou=accounts,o=my company,c=us。
ldap 搜寻测试" ;
echo "连接中 ..." ;
$ds = ldap_connect ( "localhost" ); // 先连上有效的 ldap 服务器
echo "连上 " . $ds . "" ;
if ( $ds ) {
echo "binding ..." ;
$r = ldap_bind ( $ds ); // 匿名的 bind，为只读属性
echo "bind 返回 " . $r . "" ;
echo "searching for (sn=s*) ..." ; // 找寻 s 开头的姓氏
$sr = ldap_search ( $ds , "o=my company, c=us" , "sn=s*" );
echo "search 返回 " . $sr . "" ;
echo "s 开头的姓氏有 " . ldap_count_entries ( $ds , $sr ). " 个" ;
echo "取回姓氏资料 ..." ;
$info = ldap_get_entries ( $ds , $sr );
echo "资料返回 " . $info [ "count" ]. " 笔:" ;
for ( $i = 0 ; $i " ;
}
echo "关闭链接" ;
ldap_close ( $ds );
} else {
echo "无法连接到 ldap 服务器" ;
}
?>
欲使用 ldap 服务器功能要先在 web 服务器安装 ldap 客户端程序，较着名的有美国密西根大学的 ldap-3.3 套件或者是 netscape 的 directory sdk。可到下列网址找回来安装

• netscape http://developer.netscape.com/tech/directory/
  
• 密西根大学 http://www.umich.edu/~dirsvcs/ldap/index.html
  
• openldap 计划 http://www.openldap.com
  
• ldap world http://elvira.innosoft.com/ldapworld

ldap_add: 增加 ldap 名录的条目。
ldap_mod_add: 增加 ldap 名录的属性。
ldap_mod_del: 删除 ldap 名录的属性。
ldap_mod_replace: 新的 ldap 名录取代旧属性。
ldap_bind: 系住 ldap 目录。
ldap_close: 结束 ldap 链接。
ldap_connect: 连上 ldap 服务器。
ldap_count_entries: 搜寻结果的数目。
ldap_delete: 删除指定资源。
ldap_dn2ufn: 将 dn 转成易读的名字。
ldap_explode_dn: 切开 dn 的字段。
ldap_first_attribute: 取得第一笔资源的属性。
ldap_first_entry: 取得第一笔结果代号。
ldap_free_result: 释放返回资料内存。
ldap_get_attributes: 取得返回资料的属性。
ldap_get_dn: 取得 dn 值。
ldap_get_entries: 取得全部返回资料。
ldap_get_values: 取得全部返回值。
ldap_list: 列出简表。
ldap_modify: 改变 ldap 名录的属性。
ldap_next_attribute: 取得返回资料的下笔属性。
ldap_next_entry: 取得下一笔结果代号。
ldap_read: 取得目前的资料属性。
ldap_search: 列出树状简表。
ldap_unbind: 结束 ldap 链接。
ldap_add
增加 ldap 名录的条目。
语法: boolean ldap_add(int handle, string dn, array entry);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来加入新的条目到 ldap 名录之中。参数 handle 为打开 ldap 的代号。参数 dn 为要加入条目的具体 dn 字符串。参数 entry 为数组，为个体所有的条目，数组的内容是条目的相关信息。若无错误则返回 true 值。
使用范例
ldap_mod_add
增加 ldap 名录的属性。
语法: boolean ldap_mod_add(int handle, string dn, array entry);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来加入新的属性到 ldap 名录之中。参数 handle 为打开 ldap 的代号。参数 dn 为要加入条目的具体 dn 字符串。参数 entry 为数组，为个体所有的属性，数组的内容是名录属性的相关信息。若无错误则返回 true 值。
参考: ldap_modify()
ldap_mod_del
删除 ldap 名录的属性。
语法: boolean ldap_mod_del(int handle, string dn, array entry);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来删除到 ldap 名录之中的指定属性。参数 handle 为打开 ldap 的代号。参数 dn 为要加入条目的具体 dn 字符串。参数 entry 为数组，为个体所有的属性，数组的内容是名录属性的相关信息。若无错误则返回 true 值。
ldap_mod_replace
新的 ldap 名录取代旧属性。
语法: boolean ldap_mod_replace(int handle, string dn, array entry);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来用新的指定属性取代 ldap 名录之中的属性。参数 handle 为打开 ldap 的代号。参数 dn 为要加入条目的具体 dn 字符串。参数 entry 为数组，为个体所有的属性，数组的内容是名录属性的相关信息。若无错误则返回 true 值。
ldap_bind
系住 ldap 目录。
语法: boolean ldap_bind(int handle, string [bind_rdn], string [bind_password]);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来系住特定的 rdn 和用户密码。参数 handle 为打开 ldap 的代号。参数 bind_rdn 及 bind_password 可省略。当未指定用户的 rdn 及密码时，则系住匿名用户。若无错误则返回 true 值。
ldap_close
结束 ldap 链接。
语法: boolean ldap_close(int handle);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数将关闭与 ldap 服务器的链接。参数 handle 为打开 ldap 的代号。实际上这个函数就是 ldap_unbind() 的别名而已。若无错误则返回 true 值。
参考: ldap_unbind()
ldap_connect
连上 ldap 服务器。
语法: int ldap_connect(string [hostname], int [port]);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来链接 ldap 的服务器。参数 hostname 若省略，则返回现在的链接代号，也就是 handle。参数 port 亦可省略，默认值为 389。执行若无错误则返回链接代号，发生错误则返回 false。
ldap_count_entries
搜寻结果的数目。
语法: int ldap_count_entries(int handle, int result_identifier);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来取得搜寻的结果数目。参数 handle 为打开 ldad 服务器的代号。参数 result_identifier 为 ldap_search() 所返回的搜寻代号。执行若无错误则返回寻找到的数目，发生错误则返回 false。
ldap_delete
删除指定资源。
语法: boolean ldap_delete(int handle, string dn);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来删除指定 dn 的资料。参数 handle 为打开 ldad 服务器的代号。参数 dn 为指定的显名 (distinguished name)。发生错误则返回 false，若无错误则返回 true。
ldap_dn2ufn
将 dn 转成易读的名字。
语法: string ldap_dn2ufn(string dn);
返回值: 字符串
函数种类: 网络系统
内容说明: 本函数用来转换 dn 的名字成为较易读取的名字 ufn (user friendly name)。参数 dn 为欲转换的字符串。返回值即为 ufn 字符串。
ldap_explode_dn
切开 dn 的字段。
语法: array ldap_explode_dn(string dn, int attrib);
返回值: 数组
函数种类: 网络系统
内容说明: 本函数将 dn 中的各字段切开，切开后的每个字段即为 rdn (relative distinguished name)。参数 dn 为欲切开的字符串。参数 attrib 若为 0 表示返回该栏的属性，若为 1 则表示返回该栏的值。返回值置于数组之中。
ldap_first_attribute
取得第一笔资源的属性。
语法: string ldap_first_attribute(int handle, int result_entry_identifier, int ber_identifier);
返回值: 字符串
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 中第一笔资源的属性。参数 handle 为打开 ldap 的代号。参数 result_entry_identifier 将由 ldap_next_attribute() 沿用。参数 ber_identifier 为指针，意即需在前面加上 & 符号。
参考: ldap_get_attributes() ldap_next_attribute()
ldap_first_entry
取得第一笔结果代号。
语法: int ldap_first_entry(int handle, int result_identifier);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 中第一笔结果的代号 id。参数 handle 为打开 ldap 的代号。参数 result_identifier 为 ldap_search() 所返回的搜寻代号。若有错误则返回 false。
参考: ldap_get_entries()
ldap_free_result
释放返回资料内存。
语法: int ldap_free_result(int result_identifier);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来释放返回资料所使用的内存。若没有使用本函数释放内存，程序结束时也会自动释放。
ldap_get_attributes
取得返回资料的属性。
语法: array ldap_get_attributes(int handle, int result_entry_identifier);
返回值: 数组
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 中所有资源的属性。参数 handle 为打开 ldap 的代号。参数 result_entry_identifier 将由 ldap_next_attribute() 沿用。返回值为数组资料，数组元素从零开始依次为属性的值。例如
return_value["count"] : 属性个数
return_value[0] : 第一个属性
return_value[n] : 第n+1个属性
return_value["attribute"]["count"] : 属性值个数
return_value["attribute"][0] : 第一个属性值
return_value["attribute"] : 第i+1个属性值
使用范例
下面范例为片段的程序
\n";
for ($i=0; $i
参考: ldap_first_attribute() ldap_next_attribute()
ldap_get_dn
取得 dn 值。
语法: string ldap_get_dn(int handle, int result_entry_identifier);
返回值: 字符串
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 的显名 (dn, distinguished name)字符串值。参数 handle 为打开 ldap 的代号。参数 result_identifier 为 ldap_search() 所返回的搜寻代号。若有错误则返回 false。
ldap_get_entries
取得全部返回资料。
语法: array ldap_get_entries(int handle, int result_identifier);
返回值: 数组
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 的全部返回资料。参数 handle 为打开 ldap 的代号。返回值为数组资料，例如
return_value["count"] : 返回资料笔数
return_value[0] : 第一笔返回资料
return_value["dn"] : 第 i+1 笔资料的 dn
return_value["count"] : 第 i+1 笔资料的数目
return_value[j] : 第 i+1 笔资料的第 j 值
return_value["attribute"]["count"] : 第 i+1 笔资料的属性数
return_value["attribute"][j] : 第 i+1 笔资料的第 j 个属性
参考: ldap_first_entry() ldap_next_entry()
ldap_get_values
取得全部返回值。
语法: array ldap_get_values(int handle, int result_entry_identifier, string attribute);
返回值: 数组
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 的全部返回资料值。参数 handle 为打开 ldap 的代号。参数 attribute 有 surname 及 mail 二种。返回值为数组资料值，例如
return_value["count"] : 属性值总数
return_value[0] : 第一个属性值
return_value : 第 i+1 个属性值
使用范例
下例为片段程序
\n";
for ($i=0; $i  
ldap_list
列出简表。
语法: int ldap_list(int handle, string base_dn, string filter, array [attributes]);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来列出单层 (one level) 的资料，实际上它等于ldap_searchldap_search()，只是将值域改成 ldap_scope_onelevel，本函数作用有点像 dos 的 dir 或是 unix 的 ls。参数 handle 为打开 ldap 的代号。参数 base_dn 为最基本的 dn 条件值，例如包括 o 和 c 二字段。参数 filter 为布尔条件，它的语法可以在 netscape 站上找一份 dirsdkpg.pdf 文件，其中的 search syntax 一部份有详细的说明。参数 attributes 可省略，用来配置更细的列出属性。
使用范例
这个范例为片段程序

参考: ldap_read() ldap_search()
ldap_modify
改变 ldap 名录的属性。
语法: boolean ldap_modify(int handle, string dn, array entry);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数用来改变 ldap 服务器上目前所在名录上的属性。参数 handle 为打开 ldap 的代号。参数 dn 为要加入条目的具体 dn 字符串。参数 entry 为数组，为个体所有的属性，数组的内容是名录属性的相关信息。若无错误则返回 true 值。
使用范例
本例为 [email protected] 提出的片段 (23-apr-1999)

参考: ldap_mod_add()
ldap_next_attribute
取得返回资料的下笔属性。
语法: string ldap_next_attribute(int handle, int result_entry_identifier, int ber_identifier);
返回值: 字符串
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 中所在返回的下笔属性。参数 handle 为打开 ldap 的代号。参数 result_entry_identifier 将由 ldap_next_attribute() 沿用。参数 ber_identifier 为指针，意即需在前面加上 & 符号。
参考: ldap_get_attributes() ldap_first_attribute()
ldap_next_entry
取得下一笔结果代号。
语法: int ldap_next_entry(int handle, int result_entry_identifier);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来取得 ldap 中目前指针的下笔资料代号。参数 handle 为打开 ldap 的代号。参数 result_identifier 为 ldap_search() 所返回的搜寻代号。若有错误则返回 false。
参考: ldap_first_entry() ldap_get_entries()
ldap_read
取得目前的资料属性。
语法: int ldap_read(int handle, string base_dn, string filter, array [attributes]);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来列出树状资料，它的值域条件是 ldap_scope_base。参数 handle 为打开 ldap 的代号。参数 base_dn 为最基本的 dn 条件值，例如包括 o 和 c 二字段。参数 filter 为布尔条件，它的语法可以在 netscape 站上找一份 dirsdkpg.pdf 文件，其中的 search syntax 一部份有详细的说明。参数 attributes 可省略，用来配置更细的列出属性。
参考: ldap_list() ldap_search()
ldap_search
列出树状简表。
语法: int ldap_search(int handle, string base_dn, string filter, array [attributes]);
返回值: 整数
函数种类: 网络系统
内容说明: 本函数用来列出树状资料，它的值域条件是 ldap_scope_subtree。参数 handle 为打开 ldap 的代号。参数 base_dn 为最基本的 dn 条件值，例如包括 o 和 c 二字段。参数 filter 为布尔条件，它的语法可以在 netscape 站上找一份 dirsdkpg.pdf 文件，其中的 search syntax 一部份有详细的说明。参数 attributes 可省略，用来配置更细的列出属性。
使用范例
下面范例为片段程序
";
?>
参考: ldap_list() ldap_read()
ldap_unbind
结束 ldap 链接。
语法: boolean ldap_unbind(int handle);
返回值: 布尔值
函数种类: 网络系统
内容说明: 本函数将关闭与 ldap 服务器的链接。参数 handle 为打开 ldap 的代号。若无错误则返回 true 值。
参考: ldap_close()