org.owasp.esapi.codecs

Class MySQLCodec

java.lang.Object

org.owasp.esapi.codecs.Codec

org.owasp.esapi.codecs.MySQLCodec

public class MySQLCodec
extends Codec

Implementation of the Codec interface for MySQL strings. See http://mirror.yandex.ru/mirrors/ftp.mysql.com/doc/refman/5.0/en/string-syntax.html for more information.

Since:

June 1, 2007

See Also:

Encoder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MySQLCodec.Mode Specifies the SQL Mode the target MySQL Server is running with.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSI_MODE Target MySQL Server is running in "http://dev.mysql.com/doc/refman/5.0/en/ansi-mode.html" ANSI Mode
private MySQLCodec.Mode	mode
static int	MYSQL_MODE Target MySQL Server is running in Standard MySQL (Default) mode.

Constructor Summary

Constructors

Constructor and Description
MySQLCodec(int mode) Deprecated.
MySQLCodec(MySQLCodec.Mode mode) Instantiate the MySQL Codec with the given SQL MySQLCodec.Mode.

Method Summary

Modifier and Type	Method and Description
java.lang.Character	decodeCharacter(PushbackString input) Returns the decoded version of the next character from the input string and advances the current character in the PushbackString.
private java.lang.Character	decodeCharacterANSI(PushbackString input) decodeCharacterANSI decodes the next character from ANSI SQL escaping
private java.lang.Character	decodeCharacterMySQL(PushbackString input) decodeCharacterMySQL decodes all the potential escaped characters that MySQL is prepared to escape
java.lang.String	encodeCharacter(char[] immune, java.lang.Character c) Default implementation that should be overridden in specific codecs.
private java.lang.String	encodeCharacterANSI(java.lang.Character c) encodeCharacterANSI encodes for ANSI SQL.
private java.lang.String	encodeCharacterMySQL(java.lang.Character c) Encode a character suitable for MySQL

Methods inherited from class org.owasp.esapi.codecs.Codec

containsCharacter, decode, encode, getHexForNonAlphanumeric, toHex, toOctal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MYSQL_MODE

public static final int MYSQL_MODE

Target MySQL Server is running in Standard MySQL (Default) mode.

See Also:

Constant Field Values

ANSI_MODE

public static final int ANSI_MODE

Target MySQL Server is running in "http://dev.mysql.com/doc/refman/5.0/en/ansi-mode.html" ANSI Mode

See Also:

Constant Field Values

mode

private MySQLCodec.Mode mode

Constructor Detail

MySQLCodec

public MySQLCodec(int mode)

Deprecated.

Instantiate the MySQL codec

Parameters:

mode - Mode has to be one of {MYSQL_MODE|ANSI_MODE} to allow correct encoding

See Also:

MySQLCodec(org.owasp.esapi.codecs.MySQLCodec.Mode)

MySQLCodec

public MySQLCodec(MySQLCodec.Mode mode)

Instantiate the MySQL Codec with the given SQL MySQLCodec.Mode.

Parameters:

mode - The mode the target server is running in

Method Detail

encodeCharacter

public java.lang.String encodeCharacter(char[] immune,
                                        java.lang.Character c)

Default implementation that should be overridden in specific codecs. Returns quote-encoded character

Overrides:

encodeCharacter in class Codec

Parameters:

immune -

c - the Character to encode

Returns:

the encoded Character

encodeCharacterANSI

private java.lang.String encodeCharacterANSI(java.lang.Character c)

encodeCharacterANSI encodes for ANSI SQL. Apostrophe is encoded Bug ###: In ANSI Mode Strings can also be passed in using the quotation. In ANSI_QUOTES mode a quotation is considered to be an identifier, thus cannot be used at all in a value and will be dropped completely.

Parameters:

c - character to encode

Returns:

String encoded to standards of MySQL running in ANSI mode

encodeCharacterMySQL

private java.lang.String encodeCharacterMySQL(java.lang.Character c)

Encode a character suitable for MySQL

Parameters:

c - Character to encode

Returns:

Encoded Character

decodeCharacter

public java.lang.Character decodeCharacter(PushbackString input)

Returns the decoded version of the next character from the input string and advances the current character in the PushbackString. If the current character is not encoded, this method MUST reset the PushbackString. Returns the decoded version of the character starting at index, or null if no decoding is possible. Formats all are legal (case sensitive) In ANSI_MODE '' decodes to ' In MYSQL_MODE \x decodes to x (or a small list of specials)

Overrides:

decodeCharacter in class Codec

Parameters:

input - the Character to decode

Returns:

the decoded Character

decodeCharacterANSI

private java.lang.Character decodeCharacterANSI(PushbackString input)

decodeCharacterANSI decodes the next character from ANSI SQL escaping

Parameters:

input - A PushBackString containing characters you'd like decoded

Returns:

A single character, decoded

decodeCharacterMySQL

private java.lang.Character decodeCharacterMySQL(PushbackString input)

decodeCharacterMySQL decodes all the potential escaped characters that MySQL is prepared to escape

Parameters:

input - A string you'd like to be decoded

Returns:

A single character from that string, decoded.