You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 100 Next »

Increasing the accessibility of overridden or hidden methods permits a malicious subclass to offer wider access to the restricted method than was originally intended. Consequently, programs must override methods only when necessary and must declare methods final whenever possible to prevent malicious subclassing. When methods cannot be declared final, programs must refrain from increasing the accessibility of overridden methods.

The access modifier of an overriding or hiding method must provide at least as much access as the overridden or hidden method (Java Language Specification, §8.4.8.3, "Requirements in Overriding and Hiding" [JLS 2005]). The following are the allowed accesses:

Overridden/hidden method modifier

Overriding/hiding method modifier

public

public

protected

protected or public

default

default or protected or public

private

Cannot be overridden

Noncompliant Code Example

This noncompliant code example demonstrates how a malicious subclass Sub can both override the doLogic() method of the superclass and increase the accessibility of the overriding method. Any user of Sub can invoke the doLogic method because the base class Super defines it to be protected, consequently allowing class Sub to increase the accessibility of doLogic() by declaring its own version of the method to be public.

class Super {
  protected void doLogic() {
    System.out.println("Super invoked");
  }
}

public class Sub extends Super {
  public void doLogic() {
    System.out.println("Sub invoked");
    // Do sensitive operations
  }
}

Compliant Solution

This compliant solution declares the doLogic() method final to prevent malicious overriding.

class Super {
  protected final void doLogic() { // declare as final
    System.out.println("Super invoked");
    // Do sensitive operations
  }
}

Exceptions

MET04-EX0: For classes that implement the java.lang.Cloneable interface, the accessibility of the Object.clone() method should be increased from protected to public [SCG 2009].

Risk Assessment

Subclassing allows weakening of access restrictions, which can compromise the security of a Java application.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

MET04-J

medium

probable

medium

P8

L2

Automated Detection

Detecting violations of this rule is straightforward.

Related Guidelines

MITRE CWE

CWE-487. Reliance on package-level scope

Secure Coding Guidelines for the Java Programming Language, Version 3.0

Guideline 1-1. Limit the accessibility of classes, interfaces, methods, and fields

Bibliography

[JLS 2005]

§8.4.8.3, Requirements in Overriding and Hiding


      05. Methods (MET)      

  • No labels