{"@ID": "575", "@Name": "EJB Bad Practices: Use of AWT Swing", "@Abstraction": "Variant", "@Structure": "Simple", "@Status": "Draft", "Description": "The product violates the Enterprise JavaBeans (EJB) specification by using AWT/Swing.", "Extended_Description": "The Enterprise JavaBeans specification [REF-1543] 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 product violates the following EJB guideline: \"An enterprise bean must not use the AWT functionality to attempt to output information to a display, or to input information from a keyboard.\" The specification justifies this requirement in the following way: \"Most servers do not allow direct interaction between an application program and a keyboard/display attached to the server system.\"", "Related_Weaknesses": {"Related_Weakness": {"@Nature": "ChildOf", "@CWE_ID": "695", "@View_ID": "1000", "@Ordinal": "Primary"}}, "Weakness_Ordinalities": {"Weakness_Ordinality": {"Ordinality": "Primary"}}, "Applicable_Platforms": {"Language": {"@Name": "Java", "@Prevalence": "Undetermined"}}, "Modes_Of_Introduction": {"Introduction": {"Phase": "Implementation"}}, "Common_Consequences": {"Consequence": {"Scope": "Other", "Impact": "Quality Degradation"}}, "Detection_Methods": {"Detection_Method": {"@Detection_Method_ID": "DM-14", "Method": "Automated Static Analysis", "Description": "Automated static analysis, commonly referred to as Static Application Security Testing (SAST), can find some instances of this weakness by analyzing source code (or binary/compiled code) without having to execute it. Typically, this is done by building a model of data flow and control flow, then searching for potentially-vulnerable patterns that connect \"sources\" (origins of input) with \"sinks\" (destinations where the data interacts with external components, a lower layer such as the OS, etc.)"}}, "Potential_Mitigations": {"Mitigation": {"Phase": "Architecture and Design", "Description": "Do not use AWT/Swing when writing EJBs."}}, "Demonstrative_Examples": {"Demonstrative_Example": {"Intro_Text": "The following Java example is a simple converter class for converting US dollars to Yen. This converter class demonstrates the improper practice of using a stateless session Enterprise JavaBean that implements an AWT Component and AWT keyboard event listener to retrieve keyboard input from the user for the amount of the US dollars to convert to Yen.", "Example_Code": [{"@Nature": "Bad", "@Language": "Java", "xhtml:div": {"xhtml:br": null, "xhtml:div": {"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": [null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null], "xhtml:i": ["/* member variables for receiving keyboard input using AWT API */", "/* conversion rate on US dollars to Yen */", "/* member functions for implementing AWT KeyListener interface */", "/* member functions for receiving keyboard input and displaying output */"], "xhtml:div": [{"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": [null, null, null, null], "xhtml:i": "/* method calls for setting up AWT Component for receiving keyboard input */", "#text": "super();\n                                 \n                                 \n                                 ...addKeyListener(this);"}}, {"@style": "margin-left:1em;", "xhtml:br": null, "#text": "BigDecimal result = dollars.multiply(yenRate);return result.setScale(2, BigDecimal.ROUND_DOWN);"}, {"@style": "margin-left:1em;", "#text": "..."}], "#text": "...private StringBuffer enteredText = new StringBuffer();\n                           \n                           \n                           \n                           private BigDecimal yenRate = new BigDecimal(\"115.3100\");\n                           public ConverterSessionBean() {}\n                           public BigDecimal dollarToYen(BigDecimal dollars) {}\n                           \n                           \n                           \n                           public void keyTyped(KeyEvent event) {}\n                           public void keyPressed(KeyEvent e) {}\n                           public void keyReleased(KeyEvent e) {}\n                           \n                           \n                           \n                           public void paint(Graphics g) {...}\n                           ..."}}, "#text": "@Statelesspublic class ConverterSessionBean extends Component implements KeyListener, ConverterSessionRemote {}"}, "#text_blocks": ["@Stateless", "public class ConverterSessionBean extends Component implements KeyListener, ConverterSessionRemote {", "/* member variables for receiving keyboard input using AWT API */", "...", "private StringBuffer enteredText = new StringBuffer();", "/* conversion rate on US dollars to Yen */", "private BigDecimal yenRate = new BigDecimal(\"115.3100\");", "public ConverterSessionBean() {", "super();", "/* method calls for setting up AWT Component for receiving keyboard input */", "...", "addKeyListener(this);", "}", "public BigDecimal dollarToYen(BigDecimal dollars) {", "BigDecimal result = dollars.multiply(yenRate);", "return result.setScale(2, BigDecimal.ROUND_DOWN);", "}", "/* member functions for implementing AWT KeyListener interface */", "public void keyTyped(KeyEvent event) {", "...", "}", "public void keyPressed(KeyEvent e) {", "}", "public void keyReleased(KeyEvent e) {", "}", "/* member functions for receiving keyboard input and displaying output */", "public void paint(Graphics g) {...}", "...", "}"]}, {"@Nature": "Good", "@Language": "Java", "xhtml:div": {"xhtml:br": null, "xhtml:div": {"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": [null, null, null, null, null, null, null, null, null], "xhtml:i": ["/* conversion rate on US dollars to Yen */", "/* remote method to convert US dollars to Yen */"], "xhtml:div": {"@style": "margin-left:1em;", "xhtml:br": null, "#text": "BigDecimal result = dollars.multiply(yenRate);return result.setScale(2, BigDecimal.ROUND_DOWN);"}, "#text": "private BigDecimal yenRate = new BigDecimal(\"115.3100\");\n                           public ConverterSessionBean() {}\n                           \n                           \n                           \n                           public BigDecimal dollarToYen(BigDecimal dollars) {}"}}, "#text": "@Statelesspublic class ConverterSessionBean implements ConverterSessionRemoteInterface {}"}, "#text_blocks": ["@Stateless", "public class ConverterSessionBean implements ConverterSessionRemoteInterface {", "/* conversion rate on US dollars to Yen */", "private BigDecimal yenRate = new BigDecimal(\"115.3100\");", "public ConverterSessionBean() {", "}", "/* remote method to convert US dollars to Yen */", "public BigDecimal dollarToYen(BigDecimal dollars) {", "BigDecimal result = dollars.multiply(yenRate);", "return result.setScale(2, BigDecimal.ROUND_DOWN);", "}", "}"]}, {"@Nature": "Good", "@Language": "JSP", "xhtml:div": {"xhtml:br": [null, null, null], "xhtml:div": [{"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": [null, null], "xhtml:div": [{"@style": "margin-left:1em;", "xhtml:div": [{"@style": "margin-left:1em;", "xhtml:br": null, "#text": "InitialContext ic = new InitialContext();converter = (Converter) ic.lookup(Converter.class.getName());"}, {"@style": "margin-left:1em;", "#text": "System.out.println(\"Couldn't create converter bean.\"+ ex.getMessage());"}], "#text": "try {} catch (Exception ex) {}"}, {"@style": "margin-left:1em;", "#text": "converter = null;"}], "#text": "private Converter converter = null;public void jspInit() {}public void jspDestroy() {}"}}, {"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": null, "xhtml:div": {"@style": "margin-left:1em;", "xhtml:div": {"xhtml:br": [null, null, null, null, null, null, null, null, null, null], "xhtml:div": [{"@style": "margin-left:1em;", "xhtml:br": [null, null, null], "#text": "<input type=\"text\" name=\"amount\" size=\"25\"><br><p><input type=\"submit\" value=\"Submit\"><input type=\"reset\" value=\"Reset\">"}, {"@style": "margin-left:1em;", "xhtml:br": null, "xhtml:div": {"@style": "margin-left:1em;", "xhtml:br": null, "#text": "BigDecimal d = new BigDecimal(amount);BigDecimal yenAmount = converter.dollarToYen(d);"}, "#text": "String amount = request.getParameter(\"amount\");if ( amount != null && amount.length() > 0 ) {"}, {"@style": "margin-left:1em;", "#text": "}"}], "#text": "<h1>Converter</h1><hr><p>Enter an amount to convert:</p><form method=\"get\"></form><%\n                                 %><p><%= amount %> dollars are <%= yenAmount %> Yen.<p><%\n                                 %>"}}, "#text": "<head><title>Converter</title></head><body bgcolor=\"white\"></body>"}}], "#text": "<%@ page import=\"converter.ejb.Converter, java.math.*, javax.naming.*\"%><%!\n                     %><html></html>"}, "#text_blocks": ["<%@ page import=\"converter.ejb.Converter, java.math.*, javax.naming.*\"%>", "<%!", "private Converter converter = null;", "public void jspInit() {", "try {", "InitialContext ic = new InitialContext();", "converter = (Converter) ic.lookup(Converter.class.getName());", "} catch (Exception ex) {", "System.out.println(\"Couldn't create converter bean.\"+ ex.getMessage());", "}", "}", "public void jspDestroy() {", "converter = null;", "}", "%>", "<html>", "<head><title>Converter</title></head>", "<body bgcolor=\"white\">", "<h1>Converter</h1>", "<hr>", "<p>Enter an amount to convert:</p>", "<form method=\"get\">", "<input type=\"text\" name=\"amount\" size=\"25\"><br>", "<p>", "<input type=\"submit\" value=\"Submit\">", "<input type=\"reset\" value=\"Reset\">", "</form>", "<%", "String amount = request.getParameter(\"amount\");", "if ( amount != null && amount.length() > 0 ) {", "BigDecimal d = new BigDecimal(amount);", "BigDecimal yenAmount = converter.dollarToYen(d);", "%>", "<p>", "<%= amount %> dollars are <%= yenAmount %> Yen.", "<p>", "<%", "}", "%>", "</body>", "</html>"]}], "Body_Text": ["This use of the AWT and Swing APIs within any kind of Enterprise JavaBean not only violates the restriction of the EJB specification against using AWT or Swing within an EJB but also violates the intended use of Enterprise JavaBeans to separate business logic from presentation logic.", "The Stateless Session Enterprise JavaBean should contain only business logic. Presentation logic should be provided by some other mechanism such as Servlets or Java Server Pages (JSP) as in the following Java/JSP example."]}}, "Taxonomy_Mappings": {"Taxonomy_Mapping": {"@Taxonomy_Name": "Software Fault Patterns", "Entry_ID": "SFP3", "Entry_Name": "Use of an improper API"}}, "References": {"Reference": {"@External_Reference_ID": "REF-1543", "@Section": "Why isn't AWT available from within an enterprise bean?"}}, "Mapping_Notes": {"Usage": "Allowed", "Rationale": "This CWE entry is at the Variant level of abstraction, which is a preferred level of abstraction for mapping to the root causes of vulnerabilities.", "Comments": "Carefully read both the name and description to ensure that this mapping is an appropriate fit. Do not try to 'force' a mapping to a lower-level Base/Variant simply to comply with this preferred level of abstraction.", "Reasons": {"Reason": {"@Type": "Acceptable-Use"}}}, "Content_History": {"Submission": {"Submission_Name": "CWE Community", "Submission_Date": "2006-12-15", "Submission_Version": "Draft 5", "Submission_ReleaseDate": "2006-12-15", "Submission_Comment": "Submitted by members of the CWE community to extend early CWE versions"}, "Modification": [{"Modification_Name": "Eric Dalci", "Modification_Organization": "Cigital", "Modification_Date": "2008-07-01", "Modification_Version": "1.0", "Modification_ReleaseDate": "2008-09-09", "Modification_Comment": "updated Potential_Mitigations, Time_of_Introduction"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2008-09-08", "Modification_Version": "1.0", "Modification_ReleaseDate": "2008-09-09", "Modification_Comment": "updated Relationships, Other_Notes"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2009-10-29", "Modification_Version": "1.6", "Modification_ReleaseDate": "2009-10-29", "Modification_Comment": "updated Description, Other_Notes"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2009-12-28", "Modification_Version": "1.7", "Modification_ReleaseDate": "2009-12-28", "Modification_Comment": "updated Demonstrative_Examples, Potential_Mitigations"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2011-06-01", "Modification_Version": "1.13", "Modification_ReleaseDate": "2011-06-01", "Modification_Comment": "updated Common_Consequences"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2011-06-27", "Modification_Version": "2.0", "Modification_ReleaseDate": "2011-06-27", "Modification_Comment": "updated Common_Consequences"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2012-05-11", "Modification_Version": "2.2", "Modification_ReleaseDate": "2012-05-15", "Modification_Comment": "updated Relationships"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2014-07-30", "Modification_Version": "2.8", "Modification_ReleaseDate": "2014-07-31", "Modification_Comment": "updated Relationships, Taxonomy_Mappings"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2020-02-24", "Modification_Version": "4.0", "Modification_ReleaseDate": "2020-02-24", "Modification_Comment": "updated Relationships"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2023-01-31", "Modification_Version": "4.10", "Modification_ReleaseDate": "2023-01-31", "Modification_Comment": "updated Description"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2023-04-27", "Modification_Version": "4.11", "Modification_ReleaseDate": "2023-04-27", "Modification_Comment": "updated Relationships, Time_of_Introduction"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2023-06-29", "Modification_Version": "4.12", "Modification_ReleaseDate": "2023-06-29", "Modification_Comment": "updated Mapping_Notes"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2025-12-11", "Modification_Version": "4.19", "Modification_ReleaseDate": "2025-12-11", "Modification_Comment": "updated Weakness_Ordinalities"}, {"Modification_Name": "CWE Content Team", "Modification_Organization": "MITRE", "Modification_Date": "2026-10-28", "Modification_Version": "5.0", "Modification_ReleaseDate": "2026-10-28", "Modification_Comment": "updated Description, Detection_Factors, References"}]}, "entry_type": "Weakness"}