ldap-escape
v3.0.0
Published
Escape functions for LDAP filters and distinguished names to prevent LDAP injection attacks.
Maintainers
Readme
ldap-escape
Escape functions for LDAP filters and distinguished names to prevent LDAP injection attacks. Uses the escape codes from Active Directory: Characters to Escape.
Installation
npm install --save ldap-escapeSpecification
escapes for search filter
| Character | Escape |
|-----------|--------|
| * | \2A |
| ( | \28 |
| ) | \29 |
| \ | \5C |
| NUL | \00 |
escapes for distinguished names
| Character | Escape |
|-----------------------------|--------|
| , | \, |
| \ | \\ |
| # | \# |
| + | \+ |
| < | \< |
| > | \> |
| ; | \; |
| " | \" |
| = | \= |
| SPC (leading or trailing) | \ |
API
ldapEscape.filter(format [, unsafe])
Parameters:
formatstring with${propertyName}placeholder(s) wherepropertyNameis the name of a property ofunsafeunsafean object containing values to escape and substitute in the format string.
Returns:
- safe string (when
unsafeis supplied). - function (when
unsafeis not supplied).
ldapEscape.dn(format [, unsafe])
Parameters:
formatstring with${propertyName}placeholder(s) wherepropertyNameis the name of a property ofunsafeunsafean object containing values to escape and substitute in the format string.
Returns:
- safe string (when
unsafeis supplied). - function (when
unsafeis not supplied).
Examples
Escape a Search Filter
"use strict";
const ldapEscape = require('ldap-escape');
const alice = {
uid: 1337,
cn: 'alice',
};
const safeFilter = ldapEscape.filter('(uid=${uid})', alice);
console.log(safeFilter); // -> '(uid=1337)'Create a Function for Escaping Search Filters
"use strict";
const ldapEscape = require('ldap-escape');
const alice = {
uid: 1337,
cn: 'alice',
};
const bob = {
uid: 42,
cn: 'bob',
};
const userEscape = ldapEscape.filter('(uid=${uid})');
const safeFilter = userEscape(alice);
console.log(safeFilter); // -> '(uid=1337)'
safeFilter = userEscape(bob);
console.log(safeFilter); // -> '(uid=42)'Escape a DN
"use strict";
const ldapEscape = require('ldap-escape');
const alice = {
uid: 1337,
cn: 'alice',
};
const safeDn = ldapEscape.dn('cn=${cn},dc=test', alice);
console.log(safeDn); // -> 'cn=alice,dc=test'Create a Function for Escaping DNs
"use strict";
const ldapEscape = require('ldap-escape');
const alice = {
uid: 1337,
cn: 'alice',
};
const bob = {
uid: 42,
cn: 'bob',
};
const dnEscape = ldapEscape.dn('cn=${cn},dc=test');
const safeDn = dnEscape(alice);
console.log(safeDn); // -> 'cn=alice,dc=test'
safeDn = dnEscape(bob);
console.log(safeDn); // -> 'cn=bob,dc=test'Testing
npm testLicense
See LICENSE.md
