A B C D E F G H I K L M N O P R S T U V W

A

addBlacklistPattern(String) - Method in class org.owasp.fileio.StringValidationRule

addBlacklistPattern(Pattern) - Method in class org.owasp.fileio.StringValidationRule

addWhitelistPattern(String) - Method in class org.owasp.fileio.StringValidationRule

addWhitelistPattern(Pattern) - Method in class org.owasp.fileio.StringValidationRule

allowNull - Variable in class org.owasp.fileio.StringValidationRule

ALPHANUMERICS - Static variable in class org.owasp.fileio.Encoder

arrayToSet(char...) - Static method in class org.owasp.fileio.util.CollectionsUtil

Converts an array of chars to a Set of Characters.

arrayToSet(char...) - Static method in class org.owasp.fileio.util.Utils

Converts an array of chars to a Set of Characters.

arrayToUnmodifiableSet(char...) - Static method in class org.owasp.fileio.util.CollectionsUtil

Convert a char array to a unmodifiable Set.

assertValidFileUpload(String, String, String, File, byte[], int, List<String>, boolean) - Method in class org.owasp.fileio.FileValidator

Validates the filepath, filename, and content of a file.

assertValidFileUpload(String, String, String, File, byte[], int, List<String>, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileUpload with the supplied List to capture ValidationExceptions

B

blacklistPatterns - Variable in class org.owasp.fileio.StringValidationRule

C

canonicalize(String) - Method in class org.owasp.fileio.Encoder

canonicalize(String, boolean) - Method in class org.owasp.fileio.Encoder

canonicalize(String, boolean, boolean) - Method in class org.owasp.fileio.Encoder

CHAR_ALPHANUMERICS - Static variable in class org.owasp.fileio.Encoder

clear() - Method in class org.owasp.fileio.codecs.HashTrie

Clear all entries.

clear() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

clear() - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

Codec - Class in org.owasp.fileio.codecs

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).

Codec() - Constructor for class org.owasp.fileio.codecs.Codec

Default constructor

CollectionsUtil - Class in org.owasp.fileio.util

Are these necessary? Are there any libraries or java.lang classes to take care of the conversions? FIXME: we can convert to using this, but it requires that the array be of Character, not char new HashSet(Arrays.asList(array))

containsCharacter(char, char[]) - Static method in class org.owasp.fileio.codecs.Codec

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

containsKey(Object) - Method in class org.owasp.fileio.codecs.HashTrie

containsKey(Object) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

containsValue(Object) - Method in class org.owasp.fileio.codecs.HashTrie

containsValue(Object) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

D

decode(String) - Method in class org.owasp.fileio.codecs.Codec

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

decodeCharacter(PushbackString) - Method in class org.owasp.fileio.codecs.Codec

Returns the decoded version of the next character from the input string and advances the current character in the PushbackString.

decodeCharacter(PushbackString) - Method in class org.owasp.fileio.codecs.HTMLEntityCodec

Returns the decoded version of the next character from the input string and advances the current character in the PushbackString.

decodeCharacter(PushbackString) - Method in class org.owasp.fileio.codecs.PercentCodec

Returns the decoded version of the next character from the input string and advances the current character in the PushbackString.

DIRECTORY_NAME_REGEX - Static variable in class org.owasp.fileio.FileValidator

E

encode(char[], String) - Method in class org.owasp.fileio.codecs.Codec

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

encodeCharacter(char[], Character) - Method in class org.owasp.fileio.codecs.Codec

Default implementation that should be overridden in specific codecs.

encodeCharacter(char[], Character) - Method in class org.owasp.fileio.codecs.HTMLEntityCodec

Default implementation that should be overridden in specific codecs.

encodeCharacter(char[], Character) - Method in class org.owasp.fileio.codecs.PercentCodec

Encode a character for URLs

Encoder - Class in org.owasp.fileio

Reference implementation of the Encoder interface.

Encoder() - Constructor for class org.owasp.fileio.Encoder

Instantiates a new DefaultEncoder with the default codecs

Encoder(List<Codec>) - Constructor for class org.owasp.fileio.Encoder

Instantiates a new DefaultEncoder with the default codecs

encoder - Variable in class org.owasp.fileio.StringValidationRule

entrySet() - Method in class org.owasp.fileio.codecs.HashTrie

entrySet() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

entrySet() - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

equals(Object) - Method in class org.owasp.fileio.codecs.HashTrie

equals(Object) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

equals(Object, Object) - Static method in class org.owasp.fileio.util.NullSafe

Object.equals(Object) that safely handles nulls.

F

FILE_NAME_REGEX - Static variable in class org.owasp.fileio.FileValidator

FileValidator - Class in org.owasp.fileio

Reference implementation of the FileValidator.

FileValidator() - Constructor for class org.owasp.fileio.FileValidator

Initialize file validator with an appropriate set of codecs

FileValidator(Encoder) - Constructor for class org.owasp.fileio.FileValidator

Initialize file validator with an appropriate set of codecs

G

get(Object) - Method in class org.owasp.fileio.codecs.HashTrie

Get the value for a key.

get(Object) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

getAllowedExtensions() - Method in class org.owasp.fileio.FileValidator

getContext() - Method in exception org.owasp.fileio.ValidationException

Returns the UI reference that caused this ValidationException

getEncoder() - Method in class org.owasp.fileio.StringValidationRule

getFileEncoder() - Method in class org.owasp.fileio.FileValidator

getHexForNonAlphanumeric(char) - Static method in class org.owasp.fileio.codecs.Codec

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

getInstance() - Static method in class org.owasp.fileio.Encoder

getLogMessage() - Method in exception org.owasp.fileio.ValidationException

Returns the UI reference that caused this ValidationException

getLongestMatch(CharSequence) - Method in class org.owasp.fileio.codecs.HashTrie

Get the key value entry who's key is the longest prefix match.

getLongestMatch(PushbackReader) - Method in class org.owasp.fileio.codecs.HashTrie

Get the key value entry who's key is the longest prefix match.

getLongestMatch(CharSequence) - Method in interface org.owasp.fileio.codecs.Trie

getLongestMatch(PushbackReader) - Method in interface org.owasp.fileio.codecs.Trie

getLongestMatch(CharSequence) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

getLongestMatch(PushbackReader) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

getMaxFilePathSize() - Method in class org.owasp.fileio.FileValidator

getMaxFileUploadSize() - Method in class org.owasp.fileio.FileValidator

getMaxKeyLength() - Method in class org.owasp.fileio.codecs.HashTrie

Get the maximum key length.

getMaxKeyLength() - Method in interface org.owasp.fileio.codecs.Trie

getMaxKeyLength() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

getTypeName() - Method in class org.owasp.fileio.StringValidationRule

getValid(String, String) - Method in class org.owasp.fileio.StringValidationRule

getValidDirectoryPath(String, String, File, boolean) - Method in class org.owasp.fileio.FileValidator

Returns a canonicalized and validated directory path as a String, provided that the input maps to an existing directory that is an existing subdirectory (at any level) of the specified parent.

getValidDirectoryPath(String, String, File, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidDirectoryPath with the supplied error List to capture ValidationExceptions

getValidFileContent(String, byte[], boolean) - Method in class org.owasp.fileio.FileValidator

Returns validated file content as a byte array.

getValidFileContent(String, byte[], long, boolean) - Method in class org.owasp.fileio.FileValidator

Returns validated file content as a byte array.

getValidFileContent(String, byte[], int, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileContent with the supplied List to capture ValidationExceptions

getValidFileName(String, String, List<String>, boolean) - Method in class org.owasp.fileio.FileValidator

Returns a canonicalized and validated file name as a String.

getValidFileName(String, String, List<String>, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileName with the supplied List to capture ValidationExceptions

getValidInput(String, String, String, int, boolean) - Method in class org.owasp.fileio.FileValidator

Validates data received from the browser and returns a safe version.

getValidInput(String, String, String, int, boolean, boolean) - Method in class org.owasp.fileio.FileValidator

Validates data received from the browser and returns a safe version.

getWrapped() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

H

hashCode() - Method in class org.owasp.fileio.codecs.HashTrie

hashCode() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

hashCode(Object) - Static method in class org.owasp.fileio.util.NullSafe

Object.hashCode() of an object.

HashTrie<T> - Class in org.owasp.fileio.codecs

Trie implementation for CharSequence keys.

HashTrie() - Constructor for class org.owasp.fileio.codecs.HashTrie

hasNext() - Method in class org.owasp.fileio.codecs.PushbackString

HTMLEntityCodec - Class in org.owasp.fileio.codecs

Implementation of the Codec interface for HTML entity encoding.

HTMLEntityCodec() - Constructor for class org.owasp.fileio.codecs.HTMLEntityCodec

I

index() - Method in class org.owasp.fileio.codecs.PushbackString

Get the current index of the PushbackString.

isAllowNull() - Method in class org.owasp.fileio.StringValidationRule

isEmpty() - Method in class org.owasp.fileio.codecs.HashTrie

isEmpty() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

isEmpty(String) - Static method in class org.owasp.fileio.util.Utils

Helper function to check if a String is empty

isEmpty(byte[]) - Static method in class org.owasp.fileio.util.Utils

Helper function to check if a byte array is empty

isEmpty(char[]) - Static method in class org.owasp.fileio.util.Utils

Helper function to check if a char array is empty

isHexDigit(Character) - Static method in class org.owasp.fileio.codecs.PushbackString

Returns true if the parameter character is a hexidecimal digit 0 through 9, a through f, or A through F.

isOctalDigit(Character) - Static method in class org.owasp.fileio.codecs.PushbackString

Returns true if the parameter character is an octal digit 0 through 7.

isRestrictMixed() - Method in class org.owasp.fileio.Encoder

isRestrictMultiple() - Method in class org.owasp.fileio.Encoder

isValidDirectoryPath(String, String, File, boolean) - Method in class org.owasp.fileio.FileValidator

Calls getValidDirectoryPath and returns true if no exceptions are thrown.

isValidDirectoryPath(String, String, File, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidDirectoryPath and returns true if no exceptions are thrown.

isValidFileContent(String, byte[], int, boolean) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileContent and returns true if no exceptions are thrown.

isValidFileContent(String, byte[], int, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileContent and returns true if no exceptions are thrown.

isValidFileName(String, String, boolean) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileName with the default list of allowedExtensions

isValidFileName(String, String, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileName with the default list of allowedExtensions

isValidFileName(String, String, List<String>, boolean) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileName with the default list of allowedExtensions

isValidFileName(String, String, List<String>, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileName with the default list of allowedExtensions

isValidFileUpload(String, String, String, File, byte[], int, boolean) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileUpload and returns true if no exceptions are thrown.

isValidFileUpload(String, String, String, File, byte[], int, boolean, List<ValidationException>) - Method in class org.owasp.fileio.FileValidator

Calls getValidFileUpload and returns true if no exceptions are thrown.

K

keySet() - Method in class org.owasp.fileio.codecs.HashTrie

keySet() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

keySet() - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

L

logMessage - Variable in exception org.owasp.fileio.ValidationException

M

mark() - Method in class org.owasp.fileio.codecs.PushbackString

maxLength - Variable in class org.owasp.fileio.StringValidationRule

minLength - Variable in class org.owasp.fileio.StringValidationRule

N

next() - Method in class org.owasp.fileio.codecs.PushbackString

nextHex() - Method in class org.owasp.fileio.codecs.PushbackString

nextOctal() - Method in class org.owasp.fileio.codecs.PushbackString

NullSafe - Class in org.owasp.fileio.util

O

org.owasp.fileio - package org.owasp.fileio

org.owasp.fileio.codecs - package org.owasp.fileio.codecs

org.owasp.fileio.util - package org.owasp.fileio.util

P

peek() - Method in class org.owasp.fileio.codecs.PushbackString

Return the next character without affecting the current index.

peek(char) - Method in class org.owasp.fileio.codecs.PushbackString

Test to see if the next character is a particular value without affecting the current index.

PercentCodec - Class in org.owasp.fileio.codecs

Implementation of the Codec interface for percent encoding (aka URL encoding).

PercentCodec() - Constructor for class org.owasp.fileio.codecs.PercentCodec

pushback(Character) - Method in class org.owasp.fileio.codecs.PushbackString

PushbackString - Class in org.owasp.fileio.codecs

The pushback string is used by Codecs to allow them to push decoded characters back onto a string for further decoding.

PushbackString(String) - Constructor for class org.owasp.fileio.codecs.PushbackString

Constructs a new instance of PushbackString

put(CharSequence, T) - Method in class org.owasp.fileio.codecs.HashTrie

Add mapping.

put(CharSequence, T) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

put(CharSequence, T) - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

putAll(Map<? extends CharSequence, ? extends T>) - Method in class org.owasp.fileio.codecs.HashTrie

putAll(Map<? extends CharSequence, ? extends T>) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

putAll(Map<? extends CharSequence, ? extends T>) - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

R

remainder() - Method in class org.owasp.fileio.codecs.PushbackString

remove(Object) - Method in class org.owasp.fileio.codecs.HashTrie

Remove a entry.

remove(Object) - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

remove(CharSequence) - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

reset() - Method in class org.owasp.fileio.codecs.PushbackString

S

SafeFile - Class in org.owasp.fileio

Extension to java.io.File to prevent against null byte injections and other unforeseen problems resulting from unprintable characters causing problems in path lookups.

SafeFile(String) - Constructor for class org.owasp.fileio.SafeFile

SafeFile(String, String) - Constructor for class org.owasp.fileio.SafeFile

SafeFile(File, String) - Constructor for class org.owasp.fileio.SafeFile

SafeFile(URI) - Constructor for class org.owasp.fileio.SafeFile

sanitize(String, String) - Method in class org.owasp.fileio.StringValidationRule

serialVersionUID - Static variable in exception org.owasp.fileio.ValidationException

setAllowedExtensions(List<String>) - Method in class org.owasp.fileio.FileValidator

setAllowNull(boolean) - Method in class org.owasp.fileio.StringValidationRule

setContext(String) - Method in exception org.owasp.fileio.ValidationException

Set's the UI reference that caused this ValidationException

setFileEncoder(Encoder) - Method in class org.owasp.fileio.FileValidator

setMaxFilePathSize(Integer) - Method in class org.owasp.fileio.FileValidator

setMaxFileUploadSize(Long) - Method in class org.owasp.fileio.FileValidator

setMaximumLength(int) - Method in class org.owasp.fileio.StringValidationRule

setMinimumLength(int) - Method in class org.owasp.fileio.StringValidationRule

setRestrictMixed(boolean) - Method in class org.owasp.fileio.Encoder

setRestrictMultiple(boolean) - Method in class org.owasp.fileio.Encoder

setValidateInputAndCanonical(boolean) - Method in class org.owasp.fileio.StringValidationRule

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

size() - Method in class org.owasp.fileio.codecs.HashTrie

Get the number of entries.

size() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

StringValidationRule - Class in org.owasp.fileio

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

StringValidationRule(String) - Constructor for class org.owasp.fileio.StringValidationRule

StringValidationRule(String, Encoder) - Constructor for class org.owasp.fileio.StringValidationRule

StringValidationRule(String, Encoder, String) - Constructor for class org.owasp.fileio.StringValidationRule

strToChars(String) - Static method in class org.owasp.fileio.util.CollectionsUtil

Convert a String to a char array

strToSet(String) - Static method in class org.owasp.fileio.util.CollectionsUtil

Convert a String to a set of characters.

strToUnmodifiableSet(String) - Static method in class org.owasp.fileio.util.CollectionsUtil

Convert a String to a unmodifiable set of characters.

T

toHex(char) - Static method in class org.owasp.fileio.codecs.Codec

toOctal(char) - Static method in class org.owasp.fileio.codecs.Codec

toString() - Method in class org.owasp.fileio.codecs.HashTrie

toString(Object) - Static method in class org.owasp.fileio.util.NullSafe

Object.toString() of an object.

Trie<T> - Interface in org.owasp.fileio.codecs

Trie.TrieProxy<T> - Class in org.owasp.fileio.codecs

Trie.Unmodifiable<T> - Class in org.owasp.fileio.codecs

Trie.Util - Class in org.owasp.fileio.codecs

typeName - Variable in class org.owasp.fileio.StringValidationRule

U

Utils - Class in org.owasp.fileio.util

This class provides a number of utility functions.

Utils() - Constructor for class org.owasp.fileio.util.Utils

V

validateInputAndCanonical - Variable in class org.owasp.fileio.StringValidationRule

ValidationException - Exception in org.owasp.fileio

A ValidationException should be thrown to indicate that the data provided by the user or from some other external source does not match the validation rules that have been specified for that data.

ValidationException() - Constructor for exception org.owasp.fileio.ValidationException

Instantiates a new validation exception.

ValidationException(String, String) - Constructor for exception org.owasp.fileio.ValidationException

Creates a new instance of ValidationException.

ValidationException(String, String, Throwable) - Constructor for exception org.owasp.fileio.ValidationException

Instantiates a new ValidationException.

ValidationException(String, String, String) - Constructor for exception org.owasp.fileio.ValidationException

Creates a new instance of ValidationException.

ValidationException(String, String, Throwable, String) - Constructor for exception org.owasp.fileio.ValidationException

Instantiates a new ValidationException.

values() - Method in class org.owasp.fileio.codecs.HashTrie

values() - Method in class org.owasp.fileio.codecs.Trie.TrieProxy

values() - Method in class org.owasp.fileio.codecs.Trie.Unmodifiable

W

whitelist(String, char[]) - Method in class org.owasp.fileio.StringValidationRule

whitelist(String, Set<Character>) - Method in class org.owasp.fileio.StringValidationRule

Removes characters that aren't in the whitelist from the input String.

whitelistPatterns - Variable in class org.owasp.fileio.StringValidationRule

A B C D E F G H I K L M N O P R S T U V W