Page History

Although creating a file is generally usually accomplished with a single method call, it actually has several issues to considerthis single action raises multiple security-related questions. What should be done if the file cannot be created? What should be done if the file already exists? What should be the file's initial attributes, such as permissions?

Java provides several generations of file-handling facilities.   The original input/output facilities, which included basic file handling, are in the package java.io.   More comprehensive facilities were included in JDK 1.4 with the so called " New I/O " package java.nio (see New I/O APIs [Oracle 2010b]). This package . Still more comprehensive facilities were included in JDK 1.7 with the New I/O 2 package java.nio.file. Both packages introduced a number of methods to handle finesupport finer-grained control over file creation.

FIO01-J. Create files with appropriate access permissions explains how to specify the permissions of a newly created file creation.

Noncompliant Code Example

This noncompliant code example tries to open a file for writing:

public void createFile(String filename) 
 = // Name ofthrows fileFileNotFoundException{
 to write
OutputStream out = new FileOutputStream(filename);
  // Work with FILEfile
}

If the file existed before being opened, its former contents will be overwritten with the contents provided by the program.

Noncompliant Code Example (

...

This noncompliant code example tries to avoid overwriting an existing file:

String filename = // Name of file to write
OutputStream out = new FileOutputStream(filename, true);
// Work with FILE

If the file existed before being opened, its new contents will be appended to the former contents. This code is compliant only if this was the intention of the programmer.

...

TOCTOU)

This noncompliant code example tries to avoid altering an existing file by creating an empty file using java.io.File.createNewfile(). If a file with the given name already exists, then createNewFile() will return false without destroying the named file's contents.

public void createFile(String filename)
    throws IOException{
  OutputStream out = new FileOutputStream(filename, true);
  if (!new File(filename).createNewFile()) {
      // File cannot be created...handle error
  } else {
    OutputStream  out = new FileOutputStream(filename);
      // Work with FILEfile
  }
} 

Unfortunately, this solution is subject to a TOCTOU (time-of-check-, time-of-use) race condition. It is possible for an attacker to modify the file system after the empty file is created but before the file is opened, such that the file that is created opened is not distince from the file that is openedwas created.

Compliant Solution (Files)

This compliant solution uses the java.nio.file.Files.newOutputStream() method to atomically create the file and throw throws an exception if the file already exists:

public void createFile(String filename) 
    throws FileNotFoundException{
  try (OutputStream out = new BufferedOutputStream(
         Files.newOutputStream( Paths.get(filename),
                               StandardOpenOption.CREATE_NEW))) {
        // Work with out
  } catch (IOException x) {
      // File not writable...handle error
  }
} 

Applicability

The ability to determine if whether an existing file has been opened or a new file has been created provides greater assurance that a file other than only the intended file is not opened or overwritten and that other files remain undisturbed.

Bibliography

...

Image Modified Image Modified Image Modified