...
This noncompliant code example instantiates a Hashtable
and defines a removeEntry()
method to allow the removal of its entries. This method is considered sensitive, perhaps because the hash table contains sensitive information. However, the method is public and nonfinal, which leaves it exposed to malicious callers.
Code Block | ||
---|---|---|
| ||
class SensitiveHash { private Hashtable<Integer,String> ht = new Hashtable<Integer,String>(); public void removeEntry(Object key) { ht.remove(key); } } |
...
This compliant solution installs a security check to protect entries from being maliciously removed from the Hashtable
instance. A SecurityException
is thrown if the caller lacks the java.security.SecurityPermission
removeKeyPermission
.
Code Block | ||
---|---|---|
| ||
class SensitiveHash { private Hashtable<Integer,String> ht = new Hashtable<Integer,String>(); public void removeEntry(Object key) { check("removeKeyPermission"); ht.remove(key); } private void check(String directive) { SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkSecurityAccess(directive); } } } |
The SecurityManager.checkSecurityAccess()
method determines whether or not the action controlled by the particular permission is allowed or not.
Noncompliant Code Example (check*()
)
This noncompliant code example uses the SecurityManager.checkRead()
method to check whether the file schema.dtd
can be read from the file system. The check*()
methods lack support for fine-grained access control. For example, the check*()
methods are inadequate to enforce a policy permitting read access to all files with the dtd
extension and forbidding read access to all other files. Non-JDK code Code that is not itself part of the JDK must not use override the check*()
methods because the default implementations of the Java libraries already use these methods to protect sensitive operations.
Code Block | ||
---|---|---|
| ||
SecurityManager sm = System.getSecurityManager(); if (sm != null) { // checkCheck whether file may be read sm.checkRead("/local/schema.dtd"); } |
Compliant Solution (checkPermission()
)
Java SE 1.2 added two methods — methods—checkPermission(Permission perm)
and checkPermission(Permission perm, Object context)
— to —to the SecurityManager
class. The motivations for this change included
- eliminating Eliminating the need to hard - code names of checks in method names.
- encapsulating Encapsulating the complicated algorithms and code for examining the Java runtime in a single
checkPermission()
method. - supporting Supporting introduction of additional permissions by subclassing the
Permission
class.
The single-argument checkPermission()
method uses the context of the currently executing thread environment to perform the checks. If the context has the permissions defined in the local policy file, the check succeeds; otherwise, a SecurityException
is thrown.
This compliant solution shows the single-argument checkPermission()
method that checks to see if whether the files in the local
directory with that have the dtd
extension can be read. DTDPermission
is a custom permission that enforces this level of access. Even if the java.io.FilePermission
is granted to the application with the action read
, DTD
files are subject to additional access control.
Code Block | ||
---|---|---|
| ||
SecurityManager sm = System.getSecurityManager(); if (sm != null) { //check Check whether file canmay be read or not DTDPermission perm = new DTDPermission("/local/", "readDTD"); sm.checkPermission(perm); } |
...
Occasionally, the security check code exists in one context (such as a worker thread), while whereas the check must be conducted on a different context, such as on another thread. The two-argument checkPermission()
method is used in this case. It accepts an AccessControlContext
instance as the context
argument. The effective permissions are those of the context
argument only rather than the intersection of the permissions of the two contexts.
Both the single- and double-argument checkPermission()
methods defer to the single-argument java.security.AccessController.checkPermission(Permission perm)
method. When invoked directly, this method operates only on the current execution context and, as a result, does not supersede the security manager's two-argument version.
A cleaner approach to making a security check from a different context is to take a snapshot of the execution context in which the check must be performed, using the java.security.AccessController.getContext()
method that returns an AccessControlContext
object. The AccessControlContext
class itself defines a checkPermission()
method that encapsulates a context instead of accepting the current executing context as an argument. This approach allows the check to be performed at a later time, as shown in the following example.
Code Block | ||
---|---|---|
| ||
// Take the snapshot of the required context, store in acc, and pass it to another context AccessControlContext acc = AccessController.getContext(); // Accept acc in another context and invoke checkPermission() on it acc.checkPermission(perm); |
...
Failure to enforce security checks in code that performs sensitive operations can lead to malicious tampering of sensitive data.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
SEC04-J |
High |
Probable |
Medium | P12 | L1 |
Automated Detection
Identifying sensitive operations requires assistance from the programmer; fully automated identification of sensitive operations is beyond the current state of the art.
Given knowledge of which operations are sensitive, as well as which specific security checks must be enforced for each operation, an automated tool could reasonably enforce the invariant that the sensitive operations are invoked only from contexts where the required security checks have been performed.
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="622a0050-67e9-4102-82bd-0f7aa939c009"><ac:plain-text-body><![CDATA[ | [[API 2006 | AA. References#API 06]] | ]]></ac:plain-text-body></ac:structured-macro> |
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Parasoft Jtest |
| CERT.SEC04.SCF | Enforce 'SecurityManager' checks before setting or getting fields |
Android Implementation Details
The java.security
package exists on Android for compatibility purposes only, and it should not be used.
Bibliography
[API 2014] |
...