JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.
If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.
If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.
| CodeSonar® 9.2p0 | CONFIDENTIAL | CodeSecure Inc |
A warning processor is a script or executable that can be invoked on warnings as they are submitted to the hub or as requested by a user.
CodeSonar ships with several sample warning processors. Users can also write and install their own custom processors.
Warning processors are securable resources.
A warning processor is a script or executable that is installed on the hub and can then be invoked on warnings: either interactively by a user, or automatically whenever a warning is issued by an analysis.
Common uses include:
Warning processors are installed and uninstalled from the Manage Warning Processors page. See Install Processors and Uninstall Processors for full instructions.
The CodeSonar Web GUI supports warning processor management and invocation.
| Manage Warning Processors | Lists the currently-installed warning processors, allows processors to be installed and uninstalled. |
|---|---|
| Warning Report | The Change Warning form provides access to those warning processors whose display scripts permit it. |
| Change Multiple Warnings | All installed warning processors are always available. |
The following sections contain information about warning processors.
| How Warning Processors Work | Describes the components and behavior of a warning processor. |
|---|---|
| Warning Processors Shipped With CodeSonar | Describes the example warning processors and explains how to customize and install them. |
| Warning Processor Input and Output | Describes the formats and semantics of warning processor inputs and outputs. |
| Authoring Warning Processors | Outlines the requirements for creating a CodeSonar warning processor. |
| Authoring Python Warning Processors | Explains how to use the csonar_utils Python package to create custom warning processors. |
| csonar_utils API documentation | Describes the key components of the csonar_utils Python package. |
CodeSonar permissions apply to warning processors as follows.
| Install |
Global G_ADD_WPROCESSOR permission is required
to install a warning processor.
When a user installs a new warning processor W, the user's default role is assigned all WPROCESSOR_* permissions for W. |
|---|---|
| Uninstall | Uninstalling a warning processor requires WPROCESSOR_DELETE permission for that warning processor. |
| Apply | A user can only execute a warning processor if they have both WPROCESSOR_EXISTS permission and WPROCESSOR_EXECUTE permission for that processor. The processor can only modify warnings from analyses for which the user has ANALYSIS_ANNOTATE, ANALYSIS_WARNING_EXISTS, and ANALYSIS_WARNING_READ permissions. Additionally, a warning processor can only change a warning Owner to a user that has ANALYSIS_OWN_WARNINGS permission the analysis containing that warning. |
| View/Edit Resource Role-Permissions |
To view or edit role-permissions for a given warning processor,
a user must have at least one of the following permissions.
|
To report problems with this documentation, please visit https://support.codesecure.com/.