From aaa7fe7b2dc463bfe3d8873fa18c04396cd2dde0 Mon Sep 17 00:00:00 2001 From: Matthieu Lalonde Date: Sat, 8 Jan 2011 01:05:59 -0500 Subject: [PATCH] More readme fixes --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fc00817..6f414c1 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ LDAP Search Bindings for Node.JS This is a fork and merge of [node-LDAP](https://github.com/jeremycx/node-LDAP) and [node-ldapauth](https://github.com/joewalnes/node-ldapauth). -Provides a simple function for running search queries on an LDAP server. - -It binds to the native OpenLDAP library (libldap) and calls ldap_simple_bind(). +Provides a simple LDAP bindings function for running search queries on an LDAP server. It has SSL (ldaps) and LDAP URI support see `man 3 ldap_url`. @@ -25,20 +23,33 @@ Ensure libldap (OpenLDAP client library) is installed. You need to add ldap.node to your application. - var sys = require("sys"), - LDAPClient = require("./build/default/ldap.node"); // Path to ldapauth.node + var LDAPClient = require("./build/default/ldap.node"); // Path to ldapauth.node + var LDAPUri = "ldaps://ldap.example.tld/ou=people,dc=example,dc=tld?cn,sn?sub?(uid=*)"; - LDAPClient.Search("ldaps://ldap.example.tld/ou=people,dc=example,dc=tld?*?sub?uid=*", + LDAPClient.Search(LDAPUri, function(err, result) { if (err) { - sys.puts(err); + console.log(err); } else { - sys.puts("Result: "); + console.log("Results: "); console.log(result); } } ); + /* + LDAP URI: + + scheme://hostport/dn[?attrs[?scope[?filter]]] + scheme is the ldap scheme, either ldap, ldaps or ldapi + hostport is a host name with an optional ":portnumber" + dn is the search base + attrs is a comma separated list of attributes to request + scope is one of these three strings: + base one sub (default=base) + filter is ldap filter + */ + Related projects ----------------