- Checkmarx Documentation
- Checkmarx One
- Checkmarx One User Guide
- Configuring Account Settings
- Settings
Settings
Settings tab allow the user to configure parameters in the tenant level. These parameters will apply on all the Applications, Projects, including all the scans in those projects.
The tenant level can be the lowest/highest level of configuration, depends on the parameters.
Open Account Settings
To open the tenant settings, perform the following steps:
Click on the Account Settings icon
Click on Settings tab
General Settings
General Settings screen contains the Global SSH Key parameter.
In case configured, this key will be used for authentication with 3rd party vendors.
Scanners Settings
Scanners settings include SAST, IaC Security and SCA scanners.
Important
Each scanner has a different set of parameters.
It isn’t possible to configure the same parameter twice.
Clicking the
icon will clear the configuration field.
Checking the
checkbox will allow overriding the same parameter in a higher level of configuration.
For more information see Configuring Project Rules
"Allow override" is selected by default for all the Parameters in the Tenant settings.
SAST Scanner Parameters
All the Parameters that will be defined for the SAST scanner will be applied for all the Projects that will run SAST scans.
The table below presents all the optional Parameters, and their optional values.
Parameter | Values | Notes |
---|---|---|
presetName | All the available SAST Presets that exist in the system |
|
Folder/file filter | Allow users to select specific folders or files that they want to include or exclude from the code scanning process |
|
languageMode | primary / multi | For more information see: Specifying a Code Language for Scanning Supported Code Languages and Frameworks:
NoteBy default, the languageMode is Multi. |
engineVerbose | true / false |
|
incremental | true / false |
ASA Premium Preset
ASA Premium Preset is a part of the SAST collection of presets.
This Preset is available only for Checkmarx One. Its usage is described in the table below.
Preset | Usage | Includes vulnerability queries for.... |
---|---|---|
ASA Premium | The ASA Premium preset contains a subset of vulnerabilities that Checkmarx AppSec Accelerator team considers to be the starting point of the Checkmarx AppSec program. The preset might change in future versions. The AppSec Accelerator team will remove old/deprecated queries or include new and improved queries in a continuously manner. | Apex, ASP, CPP, CSharp, Go, Groovy, Java, JavaScript, Kotlin (non-mobile only), Perl, PHP, PLSQL, Python, Ruby, Scala, VB6, VbNet, Cobol, RPG and VbScript coding languages. |
ASA Premium Mobile | The ASA Premium Mobile preset is a dedicated preset designed for mobile apps. The ASA Premium Mobile preset contains a subset of vulnerabilities that Checkmarx AppSec Accelerator team considers to be the starting point of the Checkmarx AppSec program. The preset might change in future versions. The AppSec Accelerator team will remove old/deprecated queries or include new and improved queries in a continuously manner. | Apex, ASP, CPP, CSharp, Go, Groovy, Java, JavaScript, Kotlin (non-mobile only), Perl, PHP, PLSQL, Python, Ruby, Scala, VB6, VbNet, Cobol, RPG and VbScript coding languages. |
IaC Security Scanner Parameters
All the Parameters that will be defined for the IaC Security scanner will be applied for all the Projects that will run IaC Security scans.
The table below presents all the optional Parameters, and their optional values.
Parameter | Values | Notes |
---|---|---|
filter | Any file type |
|
platforms | Ansible / CloudFormation / Dockerfile / Kubernetes / Terraform | NoticeConfigure one/more platforms, separated with a comma. The parameter means that you only want to run scans (queries) for those platforms. For example: Ansible,CloudFormation,Dockerfile WarningAny mistake in the the platform characters will cause an error |
SCA Scanner Parameters
All the Parameters that will be defined for the SCA scanner will be applied for all the Projects that will run SCA scans.
The table below presents all the optional Parameters, and their optional values.
Parameter | Values | Notes |
---|---|---|
filter | Any file type |
|
Exploitable Path | Toggle On/Off | When Exploitable Path is activated, scans that use the SCA scanner will identify whether or not there is an exploitable path from your source code to the vulnerable 3rd party package. Learn more about Exploitable Path. |
Exploitable Path Configuration | Radio button selection | The Exploitable Path feature uses queries in the SAST scan of your project to identify exploitable paths to vulnerable 3rd party packages. Therefore, it is always necessary to run a SAST scan on the project in order to get results for Exploitable Path. Whenever you run a Checkmarx One scan with both the SAST and SCA scanners selected, Exploitable Path uses the results of the current SAST scan for analysis. When you run a Checkmarx One scan with only the SCA scanner selected, Checkmarx One can either use results from a previous SAST scan or it can initiate a new SAST scan (using default settings) that runs the Exploitable Path queries. Select one of the following configurations:
|
Filtering Options
Filtering the scanners parameters is based on Glob.
For more information see Glob Tool
For instance:
Exclude all java files: !**/*.java
Exclude all files inside a folder Test: !**/Test/**
Exclude all files under root folder Test: !Test/**
Exclude just the files inside a folder leaving all subfolders content: !**/Test/*
Exclude all JavaScript minified files: !**/*.min.js
Note
The rules follow the same logic at tenant & project level.
Removing Parameters
Scanners parameters configuration work in hierarchy.
During parameters configuration, the system considers the Tenant level as the highest configuration level followed by Project level, Config as Code and Scan level.
Parameters are inherited from one level to the other, starting from Tenant level.
Removing parameters from a lower configuration level can be performed only by deleting the parameter configuration from the higher configuration level. In this case the parameter won't be presented in the lower configuration level.
In case users edit a parameter in a lower configuration level, a icon will appear at the right. Deleting the parameter can't be performed, as the parameter is inherited from the higher configuration level. This behavior is designed to emphasize that the configuration exist at the Tenant level and it is set with "X" value.
In case using the icon, it might appear that the parameter is deleted, but it is not. In case exiting the page and returning, the parameter will be presented again.
Note
When running a scan, the system considers the Scan level as the highest configuration level, followed by Config as Code, Project level and Tenant level.
SCM Organization Settings
SCM Organization Settings screen contains all the SCM organizations that were successfully imported to Checkmarx One, and support the Monitor New Repositories feature.
In this screen users can enable/disable the Monitor New Repositories feature for any existing organization.
For additional information about the feature see Monitor New Repositories
Plugins Settings
The following IDE plugin features need to be activated on a tenant wide level in order for individual developers to be able to use them in their IDEs. Activation can be done by a Checkmarx One admin user via the Account Settings > Settings > Plugins tab.
Configuring Plugin Settings
To change the Plugin settings:
Log in to Checkmarx One as an admin user.
Click on the Account Settings icon
.
Click on the Settings tab and then on the Plugins sub-tab.
Enable/disable IDE features as needed.
The setting is applied to all IDEs using this tenant account.
Click Save at the bottom of the page.
IDE Scans
When this feature is activated Checkmarx IDE plugins enable users to run a new Checkmarx One scan on the project that is open in their workspace.
In order to run IDE scans, you must first create a Checkmarx project and run the initial scan using some other method, e.g., web portal, API, CLI etc. and load the scan results in the Visual Studio console. Then, you are able to run subsequent scans on that project from the IDE.
Warning
Before enabling this feature, you should consider the ramifications; since there is a limitation to the number of concurrent scans that you can run based on your license, enabling IDE scans may cause scans triggered by CI/CD pipelines and SCM integrations to be added to the scan queue, causing major delays for those scans.
AI Guided Remediation
When this feature is activated, developers can access AI Guided Remediation in their IDE editor (currently supported for VS Code).
AI Guided Remediation harnesses the power of AI to help you to understand the vulnerabilities in your code, and resolve them quickly and easily. When you initiate an AI chat, we automatically provide the context to GPT so that you can start a conversation about the precise vulnerability instance that you are assessing.
Notice
When sending your IaC files to GPT, we protect your sensitive data by anonymizing all passwords and secrets before the content is sent. The query used for identifying sensitive data can be seen here.