EncodeForSQL()

Encodes the given string for safe output in a query to reduce the risk Cross Site Scripting attacks.

Requires Extension: ESAPI extension

EncodeForSQL( string=string, dialect=string, canonicalize=boolean );

Returns: String

Argument Description Default
string
string, required

string to encode
dialect
string, required

SQL dialect used to encode, possible values are: * db2 * mysql_ansi * mysql * oracle
canonicalize
boolean, 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.

Introduced: 5.0.0.0

false

Examples

// example of an url variable:
// http://some.example.domain/dogs.cfm?name=lassie
url.name="lassie";
SQLQuery="SELECT * FROM dogs WHERE name='#url.name#';";
dump( SQLQuery );
// example of an url sql injection:
// http://some.example.domain/dogs.cfm?name='%20or%20'1'='1
url.name= "' or '1'='1";
SQLQuery="SELECT * FROM dogs WHERE name='#url.name#';";
dump( SQLQuery );
// example of preventing sql injection with encodeForSQL in MySQL:
SQLQuery="SELECT * FROM dogs WHERE name='#encodeForSQL( url.name, 'mySql' )#';";
dump( SQLQuery );

See also