ldap-authentication 3.2.2 → 3.2.6

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

@@ -27,7 +27,7 @@ jobs:
         run: sudo apt-get install -y ldap-utils
 
       - name: Start containers
-        run: docker-compose -f "docker-compose.yml" up -d
+        run: docker compose -f "docker-compose.yml" up -d
 
       - name: Wait for LDAP server to become available
         uses: nick-fields/retry@v2
@@ -51,4 +51,4 @@ jobs:
 
       - name: Stop containers
         if: always()
-        run: docker-compose -f "docker-compose.yml" down
+        run: docker compose -f "docker-compose.yml" down

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -187,7 +187,7 @@ In version 2, The user object has a `raw` field that has the raw data from the L
 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:
+want to get back as base64-encoded string. Check the following example on how to get a user's profile photo:
 
 ```javascript
 export async function verifyLogin(email: string, password: string) {
@@ -210,7 +210,7 @@ export async function verifyLogin(email: string, password: string) {
     const profilePhoto = ldapUser['thumbnailPhoto;binary'];
 
     /* using the image
-	<img src={`data:image/*;base64,${user.profilePhoto}`} />
+	<img src={`data:image/*;base64,${profilePhoto}`} />
     */
     return { user: ldapUser };
   }

package/index.js

@@ -1,5 +1,42 @@
 const assert = require('assert')
 const ldap = require('ldapjs')
+// escape the , in CN in DN
+function _ldapEscapeDN(s) {
+  let ret = "";
+  let comaPositions = [];
+  let done = false;
+  let countEq = 0;
+  for (let i = 0; !done && i < s.length; i++) {
+    switch (s[i]) {
+      case "\\":
+        // user already escapped, continue
+        i++;
+        break;
+      case ",":
+        if (countEq == 1) {
+          comaPositions.push(i);
+        }
+        break;
+      case "=":
+        countEq++;
+        if (countEq == 2) {
+          done = true;
+        }
+        break;
+    }
+  }
+  if (done) {
+    comaPositions.pop();
+  }
+  let lastIndex = 0;
+  for (let i of comaPositions) {
+    ret += s.substring(lastIndex, i);
+    ret += "\\,";
+    lastIndex = i + 1;
+  }
+  ret += s.substring(lastIndex);
+  return ret;
+}
 
 // convert an escaped utf8 string returned from ldapjs
 function _isHex(c) {
@@ -55,6 +92,7 @@ function _searchResultToUser(pojo) {
 }
 // bind and return the ldap client
 function _ldapBind(dn, password, starttls, ldapOpts) {
+  dn = _ldapEscapeDN(dn)
   return new Promise(function (resolve, reject) {
     ldapOpts.connectTimeout = ldapOpts.connectTimeout || 5000
     let client = ldap.createClient(ldapOpts)
@@ -406,7 +444,8 @@ async function authenticate(options) {
       options.groupsSearchBase,
       options.groupClass,
       options.groupMemberAttribute,
-      options.groupMemberUserAttribute
+      options.groupMemberUserAttribute,
+      options.attributes
     )
   }
   assert(options.userPassword, 'userPassword must be provided')
@@ -467,4 +506,5 @@ module.exports.exportForTesting = {
   _isHex,
   _parseEscapedHexToUtf8,
   _recursiveParseHexString,
+  _ldapEscapeDN
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldap-authentication",
-  "version": "3.2.2",
+  "version": "3.2.6",
   "description": "A simple async nodejs library for LDAP user authentication",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -39,6 +39,6 @@
     "ldapjs": "^3.0.7"
   },
   "devDependencies": {
-    "jasmine": "^5.1.0"
+    "jasmine": "^5.3.0"
   }
 }

package/test/string.spec.js

@@ -1,5 +1,5 @@
 const { exportForTesting } = require('../index.js')
-const { _isHex, _parseEscapedHexToUtf8, _recursiveParseHexString } =
+const { _isHex, _parseEscapedHexToUtf8, _recursiveParseHexString, _ldapEscapeDN } =
   exportForTesting
 
 describe('string conversion test', () => {
@@ -41,3 +41,22 @@ describe('string conversion test', () => {
     expect(converted).toEqual(target)
   })
 })
+
+describe('escape , in the DN test', ()=>{
+  let cases = [
+    { s: "a", want: "a" },
+    { s: "", want: "" },
+    { s: "CN=a,DN=b", want: "CN=a,DN=b" },
+    { s: "CN=a, c,DN=b", want: "CN=a\\, c,DN=b" },
+    { s: "CN=a\\, c,DN=b", want: "CN=a\\, c,DN=b" },
+    { s: "CN=a, b, c,DN=b", want: "CN=a\\, b\\, c,DN=b" },
+    { s: "CN=a, c", want: "CN=a\\, c" },
+  ]
+  for (let c of cases) {
+    it("escape "+c.s, ()=>{
+      let got = _ldapEscapeDN(c.s)
+      expect(got).toEqual(c.want)
+    })
+    
+  }
+})

package/test/test.spec.js

@@ -20,6 +20,26 @@ describe('ldap-authentication test', () => {
     expect(user).toBeTruthy()
     expect(user.uid).toEqual('gauss')
   })
+  it('Use an admin user to check if user exists and return attributes', async () => {
+    let options = {
+      ldapOpts: {
+        url: url,
+      },
+      adminDn: 'cn=read-only-admin,dc=example,dc=com',
+      adminPassword: 'password',
+      verifyUserExists: true,
+      userSearchBase: 'dc=example,dc=com',
+      usernameAttribute: 'uid',
+      username: 'gauss',
+      attributes: ['uid', 'sn'],
+    }
+
+    let user = await authenticate(options)
+    expect(user).toBeTruthy()
+    expect(user.uid).toEqual('gauss')
+    expect(user.sn).toEqual('Bar1')
+    expect(user.cn).toBeUndefined()
+  })
   it('Use an admin user to authenticate a regular user', async () => {
     let options = {
       ldapOpts: {
@@ -37,7 +57,7 @@ describe('ldap-authentication test', () => {
     expect(user).toBeTruthy()
     expect(user.uid).toEqual('gauss')
   })
-  it('Use an admin user to authenticate a regular user and return attrubutes', async () => {
+  it('Use an admin user to authenticate a regular user and return attributes', async () => {
     let options = {
       ldapOpts: {
         url: url,