Page History

The java.security.AccessController class is part of Java's security mechanism; it is responsible for enforcing the applicable security policy. This class's static doPrivileged() method doPrivileged is used to affirm that the invoking method is taking responsibility for exercising its own permissions and that the access permissions of its callers should be ignored. For example, an application may have permissions to operate on a sensitive file, however, a caller of this application may be allowed to operate with only basic user permissions. Invoking doPrivileged() in the context of this method allows it to exercise its own (possibly elevated) permissions under such circumstances.

Noncompliant Code Example

executes a code block with a relaxed security policy. The doPrivileged() method stops permissions from being checked further down the call chain.

Consequently, any method that invokes doPrivileged() must assume responsibility for enforcing its own security on the code block supplied to doPrivileged(). Likewise, code in the doPrivileged() method must not leak sensitive information or capabilities.

For example, suppose that a web application must maintain a sensitive password file for a web service and also must run untrusted code. The application could then enforce a security policy preventing the majority of its own code—as well as all untrusted code—from accessing the sensitive file. Because it must also provide mechanisms for adding and changing passwords, it can call the doPrivileged() method to temporarily allow untrusted code to access the sensitive file. In this case, any privileged block must prevent all information about passwords from being accessible to untrusted code.

Noncompliant Code Example

In this noncompliant code example, the doPrivileged() method is called from the openPasswordFile() method. The openPasswordFile() method is privileged and returns a FileInputStream for the sensitive password file. Because the method is public, it could be invoked by an untrusted callerThere are two fallacies in this noncompliant code example. First, the doPrivileged method is being called from inside the openPasswordFile method. The openPasswordFile method is privileged and returns a FileInputStream reference to its caller. This allows any caller to call openPasswordFile() directly and obtain a reference to the sensitive file due to the inherent privileges present within the corresponding code. Second, the name of the sensitive password file is user controllable which introduces other risks such as unaccounted misuse of miscellaneous sensitive files.

public class PasswordPasswordManager {

 
 public static void changePassword(String password_file) throws FileNotFoundException {
    FileInputStream fin;
    fin = openPasswordFile(password_file);
 }
	
 public static FileInputStream openPasswordFile(String password_file) throws FileNotFoundException {
    //Declare asTest finalold andpassword assignwith beforepassword thein bodyfile ofcontents; the anonymous inner classchange password,
    //Array f[] is used to maintain language semantics while using final 
 then close the password file
  }

  public static FileInputStream openPasswordFile()
      finalthrows FileInputStreamFileNotFoundException f[]={null};
    final String password_file =  "password_file";
    //UseFileInputStream ownfin privilege= tonull;
 open the sensitive passwordtry file{
      fin = AccessController.doPrivileged(
        new PrivilegedActionPrivilegedExceptionAction<FileInputStream>() {
          public ObjectFileInputStream run() throws FileNotFoundException {
            // 
Sensitive action; can't be done outside tryprivileged {block
            f[0]FileInputStream in = new FileInputStream("c:\\" + file);	//Perform privileged action
  password_file);
            return in;
          }
      });
    } catch (FileNotFoundExceptionPrivilegedActionException cnfx) { System.err.println(cnf.getMessage()); }
      return null;
      Exception cause = x.getException();
      if (cause instanceof FileNotFoundException) {
    //Still mandatory to return fromthrow run(FileNotFoundException) cause;
      } else {
       } throw new Error("Unexpected exception type", cause); 
      return f[0];}
   //Returns a}
 reference to privileged objects (inappropriate)
return fin;
  }	
}

Compliant Solution

The openPasswordFile method controls access to the sensitive password file and returns its reference. Since it cannot control being invoked by untrusted user methods, it should not assert its privileges within the body. Instead, changePassword() the caller method, can safely assert its own privilege whenever someone else calls it. This is because changePassword() does not return a reference to the sensitive file to any caller but processes the file internally. Also, since the name of the password file is hard-coded in the code, caller supplied (tainted) inputs are not used. Also, notice that the methods have been declared private in this case to limit scope.In general, when any method containing a privileged block exposes a field (such as an object reference) beyond its own boundary, it becomes trivial for untrusted callers to exploit the program. This compliant solution mitigates the vulnerability by declaring openPasswordFile() to be private. Consequently, an untrusted caller can call changePassword() but cannot directly invoke the openPasswordFile() method.

public class PasswordPasswordManager {
  privatepublic static void changePassword() throws FileNotFoundException {
    //Use ...
 own privilege}

 to openprivate thestatic sensitiveFileInputStream passwordopenPasswordFile() file
  final String password_file = "password"; throws FileNotFoundException {
  final  FileInputStream f[] = {null};
  AccessController.doPrivileged(new PrivilegedAction() {
  public Object run// ...
  }
}

Compliant Solution (Hiding Exceptions)

The previous noncompliant code example and the previous compliant solution throw a FileNotFoundException when the password file is missing. If the existence of the password file is itself considered sensitive information, this exception also must be prevented from leaking outside the trusted code.

This compliant solution suppresses the exception, leaving the array to contain a single null value to indicate that the file does not exist. It uses the simpler PrivilegedAction class rather than PrivilegedExceptionAction to prevent exceptions from propagating out of the doPrivileged() block. The Void return type is recommended for privileged actions that do not return any value.

class PasswordManager {

  public static void changePassword() {
   try {
FileInputStream         f[0] fin = openPasswordFile(password_file); 
 //call the privileged methodif here
(fin   }catch(FileNotFoundException cnf== null) { System.err.println("Error: Operation could not be performed"); }
   return null;

      // No password file; handle error
    }

   });
 //Perform otherTest operationsold suchpassword aswith password verification
 in file contents; change password
  }	

  private static FileInputStream openPasswordFile(String password_file) throws FileNotFoundException {
  FileInputStream f =final new FileInputStream("c:\\" + password_file)String password_file = "password";
  //Perform read/write operationsfinal onFileInputStream password file
  return f;
 }
}

Note that the above compliant solution prints a general Error instead of revealing sensitive information (See EXC01-J. Do not allow exceptions to transmit sensitive information). If no sensitive information can be potentially revealed by any of the possible exceptions, an equivalent mechanism that allows exceptions to be wrapped can be used. For example, if an applet doesn't have access to read system files that contain fonts, it can accomplish the task from a privileged block without revealing any sensitive information. In fact, by not swallowing exceptions, the client will be able to deduce the symptoms of a read failure easily. In summary, if the code can throw a checked exception safely, use the form of doPrivileged method that takes a PrivilegedExceptionAction instead of a PrivilegedAction.

public static void readFont() throws FileNotFoundException {
  //Use own privilege to open the font file
  final String font_file = "fontfile";
fin[] = { null };
    AccessController.doPrivileged(new PrivilegedAction<Void>() {
        public Void run() {
          try {
    final InputStream in =
    AccessController.doPrivileged(new PrivilegedExceptionAction<InputStream>() {
				  
     public InputStream run() throws FileNotFoundException {
 // Sensitive action; can't be done outside
            // doPrivileged() return openFontFile(font_file); //call the privileged method here
block
           }
 fin[0] = new }FileInputStream(password_file);
     //Perform other operations 
  } catch (PrivilegedActionExceptionFileNotFoundException excx) {				

            Exception// causeReport = exc.getException();to handler
      if (cause instanceof FileNotFoundException) {}
          throw (FileNotFoundException)causereturn null;
      } else {}
 throw new Error("Unexpected exception type",cause });
  }
  return fin[0];
  }			
}

Risk Assessment

Invoking doPrivileged with too large a scope may seriously compromise the security of a Java applicationReturning references to sensitive resources from within a doPrivileged() block can break encapsulation and confinement and can leak capabilities. Any caller who can invoke the privileged code directly and obtain a reference to a sensitive resource or field can maliciously modify its elements.

Automated Detection

TODO

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

References

\[[API 06|AA. Java References#API 06]\] [method doPrivileged()|http://java.sun.com/javase/6/docs/api/java/security/AccessController.html#doPrivileged(java.security.PrivilegedAction)]
\[[Gong 03|AA. Java References#Gong 03]\] Sections 6.4, AccessController and 9.5 Privileged Code
\[[SCG 07|AA. Java References#SCG 07]\] Guideline 6-1 Safely invoke java.security.AccessController.doPrivileged
\[[MITRE 09|AA. Java References#MITRE 09]\] [CWE ID 266|http://cwe.mitre.org/data/definitions/266.html] "Incorrect Privilege Assignment", [CWE ID 272|http://cwe.mitre.org/data/definitions/272.html] "Least Privilege Violation" 

Identifying sensitive information requires assistance from the programmer; fully automated identification of sensitive information is beyond the current state of the art.

Assuming user-provided tagging of sensitive information, escape analysis could be performed on the doPrivileged() blocks to prove that nothing sensitive leaks out from them. Methods similar to those used in thread-role analysis could be used to identify the methods that must, or must not, be called from doPrivileged() blocks.

Related Guidelines

Android Implementation Details

The java.security package exists on Android for compatibility purposes only, and it should not be used.

Bibliography

...

Image Added Image Added Image Added00. Security (SEC)      00. Security (SEC)      SEC02-J. Beware of standard APIs that may bypass Security Manager checks