LDAP-client 技术文档

1. 安装指南

在开始使用 ldap-client 之前，您需要确保已经安装了最新的 OpenLDAP 客户端库，可以从 OpenLDAP 官网 获取。

安装 ldap-client 的步骤如下：

npm install --save ldap-client

对于 Ubuntu 系统，您可能还需要安装 LDAP 开发库：

sudo apt-get install libldap2-dev

如果需要 SASL 认证支持，请确保安装了 Cyrus SASL 库，并且 OpenLDAP 在编译时启用了 SASL 支持。

2. 项目使用说明

ldap-client 是一个为 Node.js 提供的 OpenLDAP 客户端绑定库。以下是使用该库的一些基本步骤。

创建 LDAP 客户端实例

var LDAP = require('ldap-client');

var ldap = new LDAP({
    uri: 'ldap://server',
    validatecert: false,
    connecttimeout: -1,
    base: 'dc=com',
    attrs: '*',
    filter: '(objectClass=*)',
    scope: LDAP.SUBTREE
}, function(err) {
    // 连接并准备就绪
});

连接处理

连接处理器在初始连接和重连时都会被调用，因此这是一个进行 bind() 或其他需要为每个连接设置的操作的好地方。

var ldap = new LDAP({
    uri: 'ldap://server',
    connect: function() {
        this.bind({
            binddn: 'cn=admin,dc=com',
            password: 'supersecret'
        }, function(err) {
            // 处理错误...
        });
    }
});

使用 TLS

如果您想通过 TLS 加密连接，可以在 URI 中使用 ldaps:// 协议。如果您有自签名证书并希望跳过服务器证书验证，可以将 verifycert 属性设置为 LDAP.LDAP_OPT_X_TLS_NEVER 或其他相关值。

3. 项目 API 使用文档

以下是 ldap-client 的一些主要 API 方法。

ldap.bind()

调用 bind() 会自动进行匿名绑定以检查连接是否打开。如果您调用 bind()，将升级现有的匿名绑定。

ldap.bind({
    binddn: '',
    password: ''
}, function(err) {});

ldap.saslbind()

使用 SASL 升级现有的匿名绑定到认证绑定。

ldap.saslbind(function(err) {
    if (err) throw err;
});

ldap.search()

进行 LDAP 搜索。

ldap.search({
    base: 'dc=com',
    scope: LDAP.SUBTREE,
    filter: '(objectClass=*)',
    attrs: '*'
}, function(err, data) {});

ldap.add()

向 LDAP 服务器添加记录。

var attrs = [
    { attr: 'objectClass', vals: [ 'organizationalPerson', 'person', 'top' ] },
    { attr: 'sn', vals: [ 'Smith' ] },
    { attr: 'badattr', vals: [ 'Fried' ] }
];

ldap.add('dn', attrs, function(err) {});

ldap.modify()

修改 LDAP 服务器上的记录。

ldap.modify('dn', [/* changes */], function(err) {});

4. 项目安装方式

项目的安装方式已在“安装指南”一节中说明。您可以使用 npm 来安装 ldap-client：

npm install --save ldap-client

确保在安装前已经安装了必要的 OpenLDAP 客户端库和开发库。