Common Weakness Enumeration

CWE Glossary Definition

Name of Your Organization:

Programming Research Ltd

Web Site:

www.prqa.com/

Compatible Capability:

QA∙C analysis component with CWE C compliance module

Capability home page:

http://www.prqa.com/content/literature/PRQA-QAC.pdf

Product Accessibility <CR_2.4>

Provide a short description of how and where your capability is made available to your customers and the public (required):

Programming Research tools including QA∙C v. 9.1.0 with CWE C v.1.0.0 are available to licensed customer via the products ftp site. Please contact support@programmingresearch.com for access.

Map Currency Indication <CR_6.1>

Describe how and where your capability indicates the most recent CWE content used to create or update its mappings (required):

The full description of the CWE content used to create the CWE C compliance module is reported in the compliance module manual, available in PDF format as part of the compliance module installation.

Map Currency Update Approach <CR_6.2>

Indicate how often you plan on updating the mappings to reflect the current CWE content and describe your approach to keeping reasonably current with the CWE content when mapping them to your repository (recommended):

The full description of the CWE content used to create the CWE C compliance module is reported in the compliance module manual, available in PDF format as part of the compliance module installation.

MAP CURRENCY UPDATE TIME <CR_6.3>

Describe how and where you explain to your customers the timeframe they should expect an update of your capability’s mappings to reflect newly available CWE content (required):

Programming Research releases product updates every 6 months and informs customers of the changes including updates to CWE capability mappings.

CWE AND COMPATIBILITY DOCUMENTATION <CR_5.1>

Provide a copy, or directions to its location, of where your documentation describes CWE and CWE compatibility for your customers (required):

The full description of the CWE C compliance module is reported in the compliance module manual, available in PDF and HTML format as part of the compliance module installation.
This can be found specifically within the folder:
<PRQA ROOT INSTALLATION>\components\cweccm-1.0.0\doc-<language culture>\component_manual\

DOCUMENTATION OF FINDING ELEMENTS USING CWE IDENTIFIERS <CR_5.2>

Provide a copy, or directions to its location, of where your documentation describes the specific details of how your customers can use CWE identifiers to find the individual security elements within your capability’s repository (required):

The mapping between CWE identifier and individual security elements can be accessed in two distinct locations:
1 – as part of the documentation, which can be found on the location described on §6
2 – from the Rule Configuration Dialog in the Project Properties:

Figure 1- Mapping of CWE-121 against QAC 9.1.0 checks

DOCUMENTATION OF FINDING CWE IDENTIFIERS USING ELEMENTS <CR_5.3>

Provide a copy, or directions to its location, of where your documentation describes the process a user would follow to find the CWE identifiers associated with individual security elements within your capability’s repository (required):

The CWE ID(s) referring to the weakness associated with a specific violation is automatically indicated in the diagnostic provided by the tool. In the GUI, this happens in the Analysis/Results Diagnostics Pane, where for each occurrence of a check there is the corresponding ID (or IDs in case of multiple violations) of the CWE violated:

Figure 2 - Message qac-9.1.0-0184 mapped to multiple CWE IDs

DOCUMENTATION INDEXING OF CWE-RELATED MATERIAL <CR_5.4>

If your documentation includes an index, provide a copy of the items and resources that you have listed under "CWE" in your index. Alternately, provide directions to where these "CWE" items are posted on your web site (recommended):

There's a comprehensive list of the CWE items in the Section 5 "Rule Cross Reference" of the documentation which is included as part of the CWE C compliance module.

Type-Specific Capability Questions

FINDING TASKS USING CWE IDENTIFIERS <CR_A.2.1>

Give detailed examples and explanations of how a user can locate tasks in the tool by looking for their associated CWE identifier (required):

The GUI allows to filter the analysis results by rule or rule group; since the CWE C compliance module considers CWE Weaknesses as "rules" from the organizational point of view, this allows to isolate all the occurrences of the diagnostics which are referring to the violation of the specific CWE instance:

Figure 3 Filtering on CWE-134

FINDING CWE IDENTIFIERS USING ELEMENTS IN REPORTS <CR_A.2.2>

Give detailed examples and explanations of how, for reports that identify individual security elements, the tool allows the user to determine the associated CWE identifier for the individual security elements in the report (required):

As part of the report production process, the tool generates a results data file in portable format (XML) from which it's possible to extract single occurrences of the analysis checks grouped by CWE element.

GETTING A LIST OF CLAIMED CWE IDENTIFIER COVERAGE <CR_A.2.3>

Give detailed examples and explanations of how a user can obtain a listing of all of the CWE identifiers that the owner claims the tool is effective at locating in software (required):

The list of CWE identifiers and individual security elements mapped to them can be accessed in two distinct locations:
1 – as part of the documentation, which can be found on the location described on §6
2 – from the Rule Configuration Dialog in the Project Properties:

Figure 4- Mapping of CWE-121 against QAC 9.1.0 checks

The table of CWE Coverage information is also available on the PRQA website
http://www.prqa.com/wp-content/uploads/2016/09/CWE_mapping_2QAC.pdf

GETTING A LIST OF CWE IDENTIFIERS ASSOCIATED WITH TASKS <CR_A.2.6>

Give detailed examples and explanations of how a user can obtain a listing of all of the CWE identifiers that are associated with the tool’s tasks (recommended):

A complete list of the CWE IDs covered by the tool's capabilities are available on the documentation provided with the CWE compliance module, more specifically on sections "5 – Rule Cross Reference" and "6 – Rule Enforcement" of the component manual.

SELECTING TASKS WITH A LIST OF CWE IDENTIFIERS <CR_A.2.7>

Describe the steps and format that a user would use to select a set of tasks by providing a file with a list of CWE identifiers (recommended):

The correspondence between security check and CWE ID impacted is provided by means of configuration files (in the specific case Rule Configuration Files – RCF). Consequently, there's no operation of mapping required to the user to be performed.

SELECTING TASKS USING INDIVIDUAL CWE IDENTIFIERS <CR_A.2.8>

Describe the steps that a user would follow to browse, select, and deselect a set of tasks for the tool by using individual CWE identifiers (recommended):

As described before, there's a predefined set of checks assigned to each CWE IDs covered by the tool. For each CWE IDs there's the possibility to browse, select and deselect checks from the "Project Properties" dialog (accessible from GUI and CLI):

1 – In the "Rule Configuration" tab, select the CWE ID to be modified (e..g CWE-14). The corresponding current mapping will be shown:

2 – Right click and click on "Messages". A "Rule Enforcement Messages" dialog will pop up:

3 – Expanding the "Messages" menu for the the chosen component it's possible to select/unselect single messages. Optional customized messages are available under the "User Messages" menu:

FINDING TASKS USING CWE IDENTIFIERS <CR_A.3.1>

Give detailed examples and explanations of how a user can locate tasks in the tool by looking for their associated CWE identifier (required):

From the Project Properties dialog, in the "Rule Configuration" tab, all the CWE IDs' mappings are available:

The same mapping is accessible from the help section (GUI/Help/Rules/CWECCM):

For each one of the messages mapped, it's possible to consult a dedicated help file section, rich in explanations and examples (GUI/Help/<component>/Component Help/ Messages):

FINDING CWE IDENTIFIERS USING ELEMENTS IN REPORTS <CR_A.3.2>

Give detailed examples and explanations of how, for reports that identify individual security elements, the tool allows the user to determine the associated CWE identifier for the individual security elements in the report (required):

As part of the report production process, the tool generates a results data file in portable format (XML) from which it's possible to extract single occurrences of the analysis checks grouped by CWE element.

GETTING A LIST OF CLAIMED CWE IDENTIFIER COVERAGE <CR_A.3.3>

Give detailed examples and explanations of how a user can obtain a listing of all of the CWE identifiers that the owner claims the tool is effective at locating in software (required):

A complete list of the CWE IDs covered by the tool's capabilities are available on the documentation provided with the CWE compliance module, more specifically on sections "5 – Rule Cross Reference" and "6 – Rule Enforcement" of the component manual.

ELECTRONIC DOCUMENT FORMAT INFO <B.3.1>

Provide details about the different electronic document formats that you provide and describe how they can be searched for specific CWE-related text (required):

The documentation is distributed in HTML and PDF format; as such, along with hypertextual indexes a full search capability is intrinsic in the format (e.g. classical CTRL+F for PDF search in PDF readers).

ELECTRONIC DOCUMENT LISTING OF CWE IDENTIFIERS <CR_B.3.2>

If one of the capability’s standard electronic documents only lists security elements by their short names or titles provide example documents that demonstrate how the associated CWE identifiers are listed for each individual security element (required):

For each one of the messages mapped, it's possible to consult a dedicated help file section, rich in explanations and examples (GUI/Help/<component>/Component Help/ Messages):

ELECTRONIC DOCUMENT ELEMENT TO CWE IDENTIFIER <CR_B.3.3>

Provide example documents that demonstrate the mapping from the capability’s individual elements to the respective CWE identifier(s) (recommended):

For each one of the messages mapped, it's possible to consult a dedicated help file section, rich in explanations and examples (GUI/Help/<component>/Component Help/ Messages):

FINDING ELEMENTS USING CWE IDENTIFIERS THROUGH THE GUI <CR_B.4.1>

Give detailed examples and explanations of how the GUI provides a "find" or "search" function for the user to identify your capability’s elements by looking for their associated CWE identifier(s) (required):

The information about the mapping between capability elements and CWE IDs is distributed in HTML and PDF format; as such, along with hypertextual indexes a full search capability is intrinsic in the format (e.g. classical CTRL+F for PDF search in PDF readers).

GUI ELEMENT TO CWE IDENTIFIER MAPPING <CR_B.4.2>

Briefly describe how the associated CWE identifiers are listed for the individual security elements or discuss how the user can use the mapping between CWE identifiers and the capability’s elements, also describe the format of the mapping (required):

The listing of the CWE IDs associated with a single security element (message) are reported on the help. For each one of the messages mapped, it's possible to consult a dedicated help file section, rich in explanations and examples (GUI/Help/<component>/Component Help/ Messages):

The mapping information format is portable (XML) and as such the user can operate directly to it with usual instruments (XML parsers, customized scripts etc).

GUI EXPORT ELECTRONIC DOCUMENT FORMAT INFO <CR_B.4.3>

Provide details about the different electronic document formats that you provide for exporting or accessing CWE-related data and describe how they can be searched for specific CWE-related text (recommended):

It's possible to export CWE-related data in two major modes:
1 – Reports: completely customizable, can output by default in HTML and text mode, but other formats are possible depending on the report generation operations performed by the user.
2 – Annotated source: This modality is possible only on dedicated licensing basis and only for command line (CLI) operations. The output format is HTML

STATEMENT OF COMPATIBILITY <CR_2.11>

Have an authorized individual sign and date the following Compatibility Statement (required):

"As an authorized representative of my organization I agree that we will abide by all of the mandatory CWE Compatibility Requirements as well as all of the additional mandatory CWE Compatibility Requirements that are appropriate for our specific type of capability."

Name: Jill Britton

Title: CSG Manager

STATEMENT OF ACCURACY <CR_3.4>

Have an authorized individual sign and date the following accuracy Statement (recommended):

"As an authorized representative of my organization I agree that we will abide by all of the mandatory CWE Compatibility Requirements as well as all of the additional mandatory CWE Compatibility Requirements that are appropriate for our specific type of capability."

Name: Jill Britton

Title: CSG Manager

STATEMENT ON FALSE-POSITIVES AND FALSE-NEGATIVES <CR_B.2.10> and/or <CR_B.3.7>

FOR TOOLS AND SERVICES ONLY — Have an authorized individual sign and date the following statement about your tools efficiency in identification of security elements (required):

"As an authorized representative of my organization I agree that we will abide by all of the mandatory CWE Compatibility Requirements as well as all of the additional mandatory CWE Compatibility Requirements that are appropriate for our specific type of capability."

Name: Jill Britton

Title: CSG Manager