EJB Bad Practices: Use of Class Loader

The program violates the Enterprise JavaBeans (EJB) specification by using the class loader.


Description

The Enterprise JavaBeans specification requires that every bean provider follow a set of programming guidelines designed to ensure that the bean will be portable and behave consistently in any EJB container. In this case, the program violates the following EJB guideline: "The enterprise bean must not attempt to create a class loader; obtain the current class loader; set the context class loader; set security manager; create a new security manager; stop the JVM; or change the input, output, and error streams." The specification justifies this requirement in the following way: "These functions are reserved for the EJB container. Allowing the enterprise bean to use these functions could compromise security and decrease the container's ability to properly manage the runtime environment."

Demonstrations

The following examples help to illustrate the nature of this weakness and describe methods or techniques which can be used to mitigate the risk.

Note that the examples here are by no means exhaustive and any given weakness may have many subtle varieties, each of which may require different detection methods or runtime controls.

Example One

The following Java example is a simple stateless Enterprise JavaBean that retrieves the interest rate for the number of points for a mortgage. The interest rates for various points are retrieved from an XML document on the local file system, and the EJB uses the Class Loader for the EJB class to obtain the XML document from the local file system as an input stream.

@Stateless
public class InterestRateBean implements InterestRateRemote {


  private Document interestRateXMLDocument = null;

  public InterestRateBean() {

    try {


      // get XML document from the local filesystem as an input stream

      // using the ClassLoader for this class
      ClassLoader loader = this.getClass().getClassLoader();
      InputStream in = loader.getResourceAsStream(Constants.INTEREST_RATE_FILE);





  DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
    DocumentBuilder db = dbf.newDocumentBuilder();
    interestRateXMLDocument = db.parse(interestRateFile);
  } catch (IOException ex) {...}

}


  public BigDecimal getInterestRate(Integer points) {
    return getInterestRateFromXML(points);
  }

  /* member function to retrieve interest rate from XML document on the local file system */

  private BigDecimal getInterestRateFromXML(Integer points) {...}

}

This use of the Java Class Loader class within any kind of Enterprise JavaBean violates the restriction of the EJB specification against obtaining the current class loader as this could compromise the security of the application using the EJB.

Example Two

An EJB is also restricted from creating a custom class loader and creating a class and instance of a class from the class loader, as shown in the following example.

@Stateless
public class LoaderSessionBean implements LoaderSessionRemote {


  public LoaderSessionBean() {
    try {
      ClassLoader loader = new CustomClassLoader();
      Class c = loader.loadClass("someClass");
      Object obj = c.newInstance();
      /* perform some task that uses the new class instance member variables or functions */
      ...
    } catch (Exception ex) {...}
  }

  public class CustomClassLoader extends ClassLoader {

  }

}

See Also

SFP Secondary Cluster: Use of an Improper API

This category identifies Software Fault Patterns (SFPs) within the Use of an Improper API cluster (SFP3).

Comprehensive CWE Dictionary

This view (slice) covers all the elements in CWE.

Weaknesses Introduced During Implementation

This view (slice) lists weaknesses that can be introduced during implementation.

Weaknesses Introduced During Design

This view (slice) lists weaknesses that can be introduced during design.


Common Weakness Enumeration content on this website is copyright of The MITRE Corporation unless otherwise specified. Use of the Common Weakness Enumeration and the associated references on this website are subject to the Terms of Use as specified by The MITRE Corporation.