org.owasp.esapi.codecs

Interface Codec<T>

All Known Implementing Classes:

AbstractCharacterCodec, AbstractCodec, AbstractIntegerCodec, CSSCodec, DB2Codec, HTMLEntityCodec, JavaScriptCodec, JSONCodec, LegacyHTMLEntityCodec, MySQLCodec, OracleCodec, PercentCodec, UnixCodec, VBScriptCodec, WindowsCodec, XMLEntityCodec

public interface Codec<T>

The Codec interface defines a set of methods for encoding and decoding application level encoding schemes, such as HTML entity encoding and percent encoding (aka URL encoding). Codecs are used in output encoding and canonicalization. The design of these codecs allows for character-by-character decoding, which is necessary to detect double-encoding and the use of multiple encoding schemes, both of which are techniques used by attackers to bypass validation and bury encoded attacks in data.

Since:

June 1, 2007, June 1, 2017

Author:

Jeff Williams (jeff.williams .at. aspectsecurity.com) Aspect Security, Matt Seil (mseil .at. owasp.org)

See Also:

Encoder

Method Summary

Modifier and Type	Method and Description
boolean	containsCharacter(char c, char[] array) Utility to search a char[] for a specific char.
String	decode(String input) Decode a String that was encoded using the encode method in this Class
T	decodeCharacter(PushbackSequence<T> input) Returns the decoded version of the next character from the input string and advances the current character in the PushbackSequence.
String	encode(char[] immune, String input) Encode a String so that it can be safely used in a specific context.
String	encodeCharacter(char[] immune, Character c) Default implementation that should be overridden in specific codecs.
String	encodeCharacter(char[] immune, int codePoint) Default codepoint implementation that should be overridden in specific codecs.
String	getHexForNonAlphanumeric(char c) Lookup the hex value of any character that is not alphanumeric.
String	getHexForNonAlphanumeric(int c) Lookup the hex value of any character that is not alphanumeric.
String	toHex(char c) Convert the char parameter to its hexadecimal representation.
String	toHex(int c) Convert the int parameter to its hexadecimal representation.
String	toOctal(char c) Convert the char parameter to its octal representation.

Method Detail

encode

String encode(char[] immune,
              String input)

Encode a String so that it can be safely used in a specific context.

Parameters:

immune -

input - the String to encode

Returns:

the encoded String

encodeCharacter

String encodeCharacter(char[] immune,
                       Character c)

Default implementation that should be overridden in specific codecs.

Parameters:

immune - array of chars to NOT encode. Use with caution.

c - the Character to encode

Returns:

the encoded Character

encodeCharacter

String encodeCharacter(char[] immune,
                       int codePoint)

Default codepoint implementation that should be overridden in specific codecs.

Parameters:

immune -

codePoint - the integer to encode

Returns:

the encoded Character

decode

String decode(String input)

Decode a String that was encoded using the encode method in this Class

Parameters:

input - the String to decode

Returns:

the decoded String

decodeCharacter

T decodeCharacter(PushbackSequence<T> input)

Returns the decoded version of the next character from the input string and advances the current character in the PushbackSequence. If the current character is not encoded, this method MUST reset the PushbackString.

Parameters:

input - the Character to decode

Returns:

the decoded Character

getHexForNonAlphanumeric

String getHexForNonAlphanumeric(char c)

Lookup the hex value of any character that is not alphanumeric.

Parameters:

c - The character to lookup.

Returns:

return null if alphanumeric or the character code in hex.

getHexForNonAlphanumeric

String getHexForNonAlphanumeric(int c)

Lookup the hex value of any character that is not alphanumeric.

Parameters:

c - The character to lookup.

Returns:

return null if alphanumeric or the character code in hex.

toOctal

String toOctal(char c)

Convert the char parameter to its octal representation.

Parameters:

c - the character for which to return the new representation.

Returns:

the octal representation.

toHex

String toHex(char c)

Convert the char parameter to its hexadecimal representation.

Parameters:

c - the character for which to return the new representation.

Returns:

the hexadecimal representation.

toHex

String toHex(int c)

Convert the int parameter to its hexadecimal representation.

Parameters:

c - the character for which to return the new representation.

Returns:

the hexadecimal representation.

containsCharacter

boolean containsCharacter(char c,
                          char[] array)

Utility to search a char[] for a specific char.

Parameters:

c -

array -

Returns:

True if the supplied array contains the specified character. False otherwise.