Initial commit

Author: jsumners

.gitignore

@@ -0,0 +1,79 @@
+*.ldif
+*.tar.*
+*.tgz
+
+.nova/
+
+# Lock files
+pnpm-lock.yaml
+shrinkwrap.yaml
+package-lock.json
+yarn.lock
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# 0x
+.__browserify_string_empty.js
+profile-*
+*.flamegraph
+
+# tap --cov
+.nyc_output/
+
+# JetBrains IntelliJ IDEA
+.idea/
+*.iml
+
+# VS Code
+.vscode/
+
+# xcode
+build/*
+*.mode1
+*.mode1v3
+*.mode2v3
+*.perspective
+*.perspectivev3
+*.pbxuser
+*.xcworkspace
+xcuserdata
+
+# macOS
+.DS_Store
+
+# keys
+*.pem
+*.env.json
+*.env

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2011 Mark Cavage, All rights reserved.
+Copyright (c) 2022 The LDAPJS Collaborators.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE

Readme.md

@@ -0,0 +1,5 @@
+# `@ldapjs/protocol`
+
+This package provides a set of constant values and ASN.1 tags that are used
+throughout the LDAP protocol. The constants are taken primarily from the
+corresponding RFC: https://datatracker.ietf.org/doc/html/rfc4511.

index.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const path = require('path')
+const fs = require('fs')
+
+const componentsPath = path.join(__dirname, 'lib')
+const components = fs.readdirSync(componentsPath)
+
+const protocol = {}
+
+for (const component of components) {
+  if (component.endsWith('test.js')) continue
+
+  protocol[path.basename(component, '.js')] = Object.freeze(
+    require(path.join(componentsPath, component))
+  )
+}
+
+module.exports = Object.freeze(protocol)

index.test.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const tap = require('tap')
+const protocol = require('./')
+
+tap.test('exports expected object', async t => {
+  t.equal(Object.isFrozen(protocol), true);
+  ['core', 'operations', 'search'].forEach(component => {
+    t.ok(protocol[component])
+    t.equal(Object.isFrozen(protocol[component]), true)
+  })
+})

lib/core.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = {
+  LDAP_VERSION_3: 0x03,
+  LBER_SET: 0x31,
+  LDAP_CONTROLS: 0xa0
+}

lib/core.test.js

@@ -0,0 +1,8 @@
+'use strict'
+
+const tap = require('tap')
+const core = require('./core')
+
+tap.test('exports object', async t => {
+  t.type(core, 'Object')
+})

lib/operations.js

@@ -0,0 +1,25 @@
+'use strict'
+
+module.exports = {
+  LDAP_REQ_BIND: 0x60,
+  LDAP_REQ_UNBIND: 0x42,
+  LDAP_REQ_SEARCH: 0x63,
+  LDAP_REQ_MODIFY: 0x66,
+  LDAP_REQ_ADD: 0x68,
+  LDAP_REQ_DELETE: 0x4a,
+  LDAP_REQ_MODRDN: 0x6c,
+  LDAP_REQ_COMPARE: 0x6e,
+  LDAP_REQ_ABANDON: 0x50,
+  LDAP_REQ_EXTENSION: 0x77,
+
+  LDAP_RES_BIND: 0x61,
+  LDAP_RES_SEARCH_ENTRY: 0x64,
+  LDAP_RES_SEARCH_REF: 0x73,
+  LDAP_RES_SEARCH: 0x65,
+  LDAP_RES_MODIFY: 0x67,
+  LDAP_RES_ADD: 0x69,
+  LDAP_RES_DELETE: 0x6b,
+  LDAP_RES_MODRDN: 0x6d,
+  LDAP_RES_COMPARE: 0x6f,
+  LDAP_RES_EXTENSION: 0x78
+}

lib/operations.test.js

@@ -0,0 +1,8 @@
+'use strict'
+
+const tap = require('tap')
+const operations = require('./operations')
+
+tap.test('exports object', async t => {
+  t.type(operations, 'Object')
+})

lib/search.js

@@ -0,0 +1,27 @@
+'use strict'
+
+/**
+ * Value constants and ASN.1 tags as defined in:
+ * https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.1
+ */
+module.exports = {
+  SCOPE_BASE_OBJECT: 0,
+  SCOPE_ONE_LEVEL: 1,
+  SCOPE_SUBTREE: 2,
+
+  NEVER_DEREF_ALIASES: 0,
+  DEREF_IN_SEARCHING: 1,
+  DEREF_BASE_OBJECT: 2,
+  DEREF_ALWAYS: 3,
+
+  FILTER_AND: 0xa0,
+  FILTER_OR: 0xa1,
+  FILTER_NOT: 0xa2,
+  FILTER_EQUALITY: 0xa3,
+  FILTER_SUBSTRINGS: 0xa4,
+  FILTER_GE: 0xa5,
+  FILTER_LE: 0xa6,
+  FILTER_PRESENT: 0x87,
+  FILTER_APPROX: 0xa8,
+  FILTER_EXT: 0xa9
+}

lib/search.test.js

@@ -0,0 +1,8 @@
+'use strict'
+
+const tap = require('tap')
+const search = require('./search')
+
+tap.test('exports object', async t => {
+  t.type(search, 'Object')
+})

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@ldapjs/protocol",
+  "version": "1.0.0",
+  "description": "Provides constants for LDAP ASN.1 tags and values.",
+  "main": "index.js",
+  "scripts": {
+    "test": "tap --no-cov -R terse",
+    "test:ci": "tap --coverage-report=lcovonly -R terse",
+    "test:cov": "tap -R terse",
+    "test:cov:html": "tap --coverage-report=html -R terse",
+    "test:watch": "tap -n -w --no-coverage-report -R terse"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/ldapjs/protocol.git"
+  },
+  "keywords": [
+    "ldapjs"
+  ],
+  "author": "James Sumners",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ldapjs/protocol/issues"
+  },
+  "homepage": "https://github.com/ldapjs/protocol#readme",
+  "devDependencies": {
+    "@fastify/pre-commit": "^2.0.2",
+    "eslint": "^8.17.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "tap": "^16.2.0"
+  }
+}