ldap-authentication 2.3.3 → 3.0.1

package/.github/workflows/integration-test.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 15.x, 16.x, 17.x, 18.x]
+        node-version: [15.x, 16.x, 17.x, 18.x]
 
     name: 'Integration Node v${{ matrix.node-version }}'
 

package/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Example",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/example/index.js"
+    }
+  ]
+}

package/README.md

@@ -181,19 +181,43 @@ auth()
 
 The user object if `authenticate()` is success.
 
-The user object has a `raw` field that has the raw data from the LDAP/AD server. It can be used to access buffer objects (profile pics for example).
-Buffer data can now be accessed by `user.raw.profilePhoto`, etc, instead of `user.profilePhoto`.
-
-
-
+In version 2, The user object has a `raw` field that has the raw data from the LDAP/AD server. It can be used to access buffer objects (profile pics for example).
 
+Buffer data can now be accessed by `user.raw.profilePhoto`, etc, instead of `user.profilePhoto`.
 
+In version 3, the `raw` field is no longer used. Instead, append `;binary` to the attributes you
+want to get back as buffer. Check the following example on how to get a user's profile photo:
 
+```javascript
+export async function verifyLogin(email: string, password: string) {
 
+  const options = {
+   //...other config options
+    userPassword: password,
+    username: email,
+    attributes: ['thumbnailPhoto;binary', 'givenName', 'sn', 'sAMAccountName', 'userPrincipalName', 'memberOf' ]
+  };
 
+  try {
+    const ldapUser = await authenticate(options);
 
+    if (!ldapUser) {
+      return { error: "user not found" };
+    }
 
+    // accessing the image
+    const profilePhoto = ldapUser['thumbnailPhoto;binary'];
 
+    /* using the image
+	<img src={`data:image/*;base64,${user.profilePhoto}`} />
+    */
+    return { user: ldapUser };
+  }
+}
+```
 
+## Supported Node Versions
 
+Version 2 supports Node version 12, 14, 15, 16, 17 and 18.
 
+Version 3 supports Node version 15, 16, 17 and 18

package/index.js

@@ -1,6 +1,18 @@
 const assert = require('assert')
 const ldap = require('ldapjs')
 
+// convert a SearchResultEntry object in ldapjs 3.0
+// to a user object to maintain backward compatibility
+
+function _searchResultToUser(pojo) {
+  assert(pojo.type == 'SearchResultEntry')
+  let user = { dn: pojo.objectName }
+  pojo.attributes.forEach((attribute) => {
+    user[attribute.type] =
+      attribute.values.length == 1 ? attribute.values[0] : attribute.values
+  })
+  return user
+}
 // bind and return the ldap client
 function _ldapBind(dn, password, starttls, ldapOpts) {
   return new Promise(function (resolve, reject) {
@@ -86,8 +98,7 @@ async function _searchUser(
         return
       }
       res.on('searchEntry', function (entry) {
-        user = entry.object
-        user.raw = entry.raw
+        user = _searchResultToUser(entry.pojo)
       })
       res.on('searchReference', function (referral) {
         // TODO: we don't support reference yet

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldap-authentication",
-  "version": "2.3.3",
+  "version": "3.0.1",
   "description": "A simple async nodejs library for LDAP user authentication",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -36,9 +36,9 @@
   },
   "homepage": "https://github.com/shaozi/ldap-authentication#readme",
   "dependencies": {
-    "ldapjs": "^2.3.3"
+    "ldapjs": "^3.0.1"
   },
   "devDependencies": {
-    "jasmine": "^4.5.0"
+    "jasmine": "^4.6.0"
   }
 }

package/test/test.js

@@ -72,7 +72,6 @@ describe('ldap-authentication test', () => {
     let user = await authenticate(options)
     expect(user).toBeTruthy()
     expect(user.uid).toEqual('einstein')
-    expect(user.raw).toBeTruthy()
   })
   it('Use an regular user to authenticate iteself and return attributes', async () => {
     let options = {