Whatever message this page gives is out now! Go check it out!

EncodeForLDAP

Last update:
May 18, 2026
Description
This function encodes an input string for a safe output in LDAP queries.
Returns
Encoded string
Category

Syntax

encodeForLDAP(inputString [,canonicalize])
History
Added in ColdFusion 10.
See also
Parameters
Parameter
Description
inputString
Required. The string to encode.
canonicalize
Optional. 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.

Example

<cfscript>
       description = "Hi (This) = is * a "; // assume description variable value can come from unsafe sources
       searchFilter = "(&(description= " & encodeForLDAP(description) & "(department=128))";
       searchStart = "dc=uconn,dc=edu";
       attrsToReturn = "cn,description";
       cfldap ( action="query" , server = "ldap.uconn.edu", name = "results", start = "#searchStart#", filter ="#searchFilter#", attributes = "#attrsToReturn#", sort = "cn ASC");
</cfscript>

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page