org.owasp.fileio

Class StringValidationRule

java.lang.Object

org.owasp.fileio.StringValidationRule

public class StringValidationRule
extends Object

A validator performs syntax and possibly semantic validation of a single piece of data from an untrusted source.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowNull
protected List<Pattern>	blacklistPatterns
protected Encoder	encoder
protected int	maxLength
protected int	minLength
protected String	typeName
protected boolean	validateInputAndCanonical
protected List<Pattern>	whitelistPatterns

Constructor Summary

Constructors

Constructor and Description
StringValidationRule(String typeName)
StringValidationRule(String typeName, Encoder encoder)
StringValidationRule(String typeName, Encoder encoder, String whitelistPattern)

Method Summary

Modifier and Type	Method and Description
void	addBlacklistPattern(Pattern p)
void	addBlacklistPattern(String pattern)
void	addWhitelistPattern(Pattern p)
void	addWhitelistPattern(String pattern)
Encoder	getEncoder()
String	getTypeName()
String	getValid(String context, String input)
boolean	isAllowNull()
String	sanitize(String context, String input)
void	setAllowNull(boolean allowNull)
void	setMaximumLength(int length)
void	setMinimumLength(int length)
void	setValidateInputAndCanonical(boolean flag) Set the flag which determines whether the in input itself is checked as well as the canonical form of the input.
String	whitelist(String input, char[] whitelist)
String	whitelist(String input, Set<Character> whitelist) Removes characters that aren't in the whitelist from the input String.

Methods inherited from class java.lang.Object

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

Field Detail

typeName

protected String typeName

encoder

protected Encoder encoder

allowNull

protected boolean allowNull

whitelistPatterns

protected List<Pattern> whitelistPatterns

blacklistPatterns

protected List<Pattern> blacklistPatterns

minLength

protected int minLength

maxLength

protected int maxLength

validateInputAndCanonical

protected boolean validateInputAndCanonical

Constructor Detail

StringValidationRule

public StringValidationRule(String typeName)

StringValidationRule

public StringValidationRule(String typeName,
                            Encoder encoder)

StringValidationRule

public StringValidationRule(String typeName,
                            Encoder encoder,
                            String whitelistPattern)

Method Detail

addWhitelistPattern

public void addWhitelistPattern(String pattern)

Parameters:

pattern - A String which will be compiled into a regular expression pattern to add to the whitelist

Throws:

IllegalArgumentException - if pattern is null

addWhitelistPattern

public void addWhitelistPattern(Pattern p)

Parameters:

p - A regular expression pattern to add to the whitelist

Throws:

IllegalArgumentException - if p is null

addBlacklistPattern

public void addBlacklistPattern(String pattern)

Parameters:

pattern - A String which will be compiled into a regular expression pattern to add to the blacklist

Throws:

IllegalArgumentException - if pattern is null

addBlacklistPattern

public void addBlacklistPattern(Pattern p)

Parameters:

p - A regular expression pattern to add to the blacklist

Throws:

IllegalArgumentException - if p is null

setMinimumLength

public void setMinimumLength(int length)

setMaximumLength

public void setMaximumLength(int length)

setValidateInputAndCanonical

public void setValidateInputAndCanonical(boolean flag)

Set the flag which determines whether the in input itself is checked as well as the canonical form of the input.

Parameters:

flag - The value to set

getValid

public String getValid(String context,
                       String input)
                throws ValidationException

Throws:

ValidationException

sanitize

public String sanitize(String context,
                       String input)

whitelist

public String whitelist(String input,
                        char[] whitelist)

whitelist

public String whitelist(String input,
                        Set<Character> whitelist)

Removes characters that aren't in the whitelist from the input String. O(input.length) whitelist performance

Parameters:

input - String to be sanitized

whitelist - allowed characters

Returns:

input stripped of all chars that aren't in the whitelist

getTypeName

public String getTypeName()

getEncoder

public Encoder getEncoder()

isAllowNull

public boolean isAllowNull()

setAllowNull

public void setAllowNull(boolean allowNull)