encodeForDN

Encodes the given string for safe output in LDAP Distinguished Names (DN). Intended to prevent LDAP Injection.

encodeForDN( string [,canonicalize]); → returns string

  1. CFDocs
  2. Functions
  3. ColdFusion 10 New Functions and Tags
  4. encodeForDN
  5. CF10+
  6. Lucee4.5+
  7. BL 1.0.0+
  8. 0 Issue
  9. Edit
See Also:   encodeForLDAP   encodeForHTML   EncodeForHTMLAttribute   EncodeForURL   Canonicalize

Argument Reference

string string
Required

String to encode.

canonicalize boolean
Default: false

If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false.
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding.

Compatibility

BoxLang:

Version 1.0.0+ Requires the bx-esapi module.

Links more information about encodeForDN

Examples
Sample code invoking the encodeForDN function 

encodeForDN("x,y")

Expected Result: x\,y

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub