ldap-escape - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "ldap-escape",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Escape functions for LDAP filters and distinguished names to prevent LDAP injection attacks.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -39,3 +39,3 @@ # ldap-escape
 
-### ldapEscape.filter(format, unsafe)
+### ldapEscape.filter(format [, unsafe])
 
@@ -52,3 +52,3 @@ Parameters:
 
-### ldapEscape.dn(format, unsafe)
+### ldapEscape.dn(format [, unsafe])
 
@@ -65,4 +65,6 @@ Parameters:
 
-## Example
+## Examples
 
+### Escape a Search Filter
+
     "use strict";
@@ -77,2 +79,16 @@
 
+    var safeFilter = ldapEscape.filter('(uid=${uid})', alice);
+    console.log(safeFilter); // -> '(uid=1337)'
+
+### Create a Function for Escaping Search Filters
+
+    "use strict";
+
+    var ldapEscape = require('ldap-escape');
+
+    var alice = {
+        uid: 1337,
+        cn: 'alice',
+    };
+
     var bob = {
@@ -83,15 +99,48 @@ uid: 42,
 
-    var safeFilter = ldapEscape.filter('(uid=${uid})', alice);
-    // -> (uid=1337)
-
     var userEscape = ldapEscape.filter('(uid=${uid})');
-    safeFilter = userEscape(alice);
-    // -> (uid=1337)
 
+    var safeFilter = userEscape(alice);
+    console.log(safeFilter); // -> '(uid=1337)'
+
     safeFilter = userEscape(bob);
-    // -> (uid=42)
+    console.log(safeFilter); // -> '(uid=42)'
 
+### Escape a DN
+
+    "use strict";
+
+    var ldapEscape = require('ldap-escape');
+
+    var alice = {
+        uid: 1337,
+        cn: 'alice',
+    };
+
     var safeDn = ldapEscape.dn('cn=${cn},dc=test', alice);
-    // -> cn=alice,dc=test
+    console.log(safeDn); // -> 'cn=alice,dc=test'
 
+### Create a Function for Escaping DNs
+
+    "use strict";
+
+    var ldapEscape = require('ldap-escape');
+
+    var alice = {
+        uid: 1337,
+        cn: 'alice',
+    };
+
+    var bob = {
+        uid: 42,
+        cn: 'bob',
+    };
+
+    var dnEscape = ldapEscape.dn('cn=${cn},dc=test');
+
+    var safeDn = dnEscape(alice);
+    console.log(safeDn); // -> 'cn=alice,dc=test'
+
+    safeDn = dnEscape(bob);
+    console.log(safeDn); // -> 'cn=bob,dc=test'
+
 ## Testing
@@ -98,0 +147,0 @@

No alert changes

Improved metrics

Total package byte prevSize

11468

increased by8.74%

Number of lines in readme file

148

increased by49.49%

No dependency changes