org.owasp.esapi

Class SafeFile

java.lang.Object

java.io.File

org.owasp.esapi.SafeFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.io.File>

public class SafeFile
extends java.io.File

Extension to java.io.File to prevent against null byte injections and other unforeseen problems resulting from unprintable characters causing problems in path lookups. This does _not_ prevent against directory traversal attacks.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	DIR_BLACKLIST_PAT
private static java.util.regex.Pattern	FILE_BLACKLIST_PAT
private static java.util.regex.Pattern	PERCENTS_PAT
private static long	serialVersionUID

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
SafeFile(java.io.File parent, java.lang.String child)
SafeFile(java.lang.String path)
SafeFile(java.lang.String parent, java.lang.String child)
SafeFile(java.net.URI uri)

Method Summary

Modifier and Type	Method and Description
private int	containsUnprintableCharacters(java.lang.String s)
private void	doDirCheck(java.lang.String path)
private void	doFileCheck(java.lang.String path)

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

PERCENTS_PAT

private static final java.util.regex.Pattern PERCENTS_PAT

FILE_BLACKLIST_PAT

private static final java.util.regex.Pattern FILE_BLACKLIST_PAT

DIR_BLACKLIST_PAT

private static final java.util.regex.Pattern DIR_BLACKLIST_PAT

Constructor Detail

SafeFile

public SafeFile(java.lang.String path)
         throws ValidationException

Throws:

ValidationException

SafeFile

public SafeFile(java.lang.String parent,
                java.lang.String child)
         throws ValidationException

Throws:

ValidationException

SafeFile

public SafeFile(java.io.File parent,
                java.lang.String child)
         throws ValidationException

Throws:

ValidationException

SafeFile

public SafeFile(java.net.URI uri)
         throws ValidationException

Throws:

ValidationException

Method Detail

doDirCheck

private void doDirCheck(java.lang.String path)
                 throws ValidationException

Throws:

ValidationException

doFileCheck

private void doFileCheck(java.lang.String path)
                  throws ValidationException

Throws:

ValidationException

containsUnprintableCharacters

private int containsUnprintableCharacters(java.lang.String s)