Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): fix results documentation #7005

Merged
merged 4 commits into from
Apr 16, 2024
Merged

fix(docs): fix results documentation #7005

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
167a879
fix(docs): fix results documentation
ArturRibeiro-CX Apr 15, 2024
fb96b2f
Merge branch 'master' into docs_result_update
cx-andrep Apr 16, 2024
eb58766
Merge branch 'master' into docs_result_update
cx-andrep Apr 16, 2024
b3bbf45
Merge branch 'master' into docs_result_update
cx-andrep Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions docs/results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,26 +598,25 @@ JUnit reports follow [JUnit XML specification by junit-team](https://github.com/
</testsuite>
```


**Overview of key-value pairs:**
**<?xml?>**: This is the XML declaration indicating the version of XML being used and the character encoding.
**<testsuites>**: This is the opening tag for the <testsuites> element, which represents a collection of test suites. Here are the key-value pairs:
**<?xml?\>**: This is the XML declaration indicating the version of XML being used and the character encoding.
**<testsuites\>**: This is the opening tag for the <testsuites\> element, which represents a collection of test suites. Here are the key-value pairs:
**name**: The name of the test suite.
**time**: The total time taken for executing all the tests in the test suite.
**failures**: The total number of test failures encountered in the test suite.
**<testsuite>**: This is the opening tag for a specific test suite within the overall collection. Here are the key-value pairs:
**<testsuite\>**: This is the opening tag for a specific test suite within the overall collection. Here are the key-value pairs:
**name**: The name of the test suite.
**failures**: The total number of test failures encountered in this specific test suite.
**tests**: The total number of tests executed in this specific test suite.
**<testcase>**: This is the opening tag for a specific test case within the test suite. Here are the key-value pairs:
**<testcase\>**: This is the opening tag for a specific test case within the test suite. Here are the key-value pairs:
**name**: The name of the test case, which describes the scenario being tested.
**classname**: The name of the class to which this test case belongs.
**<failure>**: This is the <failure> tag indicating that the test case has failed. Here are the key-value pairs:
**<failure\>**: This is the <failure\> tag indicating that the test case has failed. Here are the key-value pairs:
**type**: The type of failure or error encountered.
**message**: A descriptive message explaining the failure or error in detail.
**</testcase>**: This is the closing tag for the <testcase> element, marking the end of the specific test case.
**</testsuite>**: This is the closing tag for the <testsuite> element, marking the end of the specific test suite.
**</testsuites>**: This is the closing tag for the <testsuites> element, marking the end of the overall collection of test suites.
**message**: A descriptive message explaining the failure or error in detail.
**</testcase\>**: This is the closing tag for the <testcase\> element, marking the end of the specific test case.
**</testsuite\>**: This is the closing tag for the <testsuite\> element, marking the end of the specific test suite.
**</testsuites\>**: This is the closing tag for the <testsuites\> element, marking the end of the overall collection of test suites.

Also, you can check our [Jenkins integration section](integrations_jenkins.md) to check how to integrate this report with Jenkins JUnit plugin.

Expand Down Expand Up @@ -679,7 +678,7 @@ HTML reports are sorted by severity (from high to info), the results will have q
You can export a pdf report by using `--report-formats "pdf"`.
PDF reports are sorted by severity (from high to info), the results will have query information and a list of files alongside the line where the result was found.

<img src="https://raw.githubusercontent.com/Checkmarx/kics/514878ea3fbf98042def0b12cca475062321d36d/docs/img/pdf_report.png" width="850">
<img src="https://raw.githubusercontent.com/Checkmarx/kics/master/docs/img/pdf_report.png" width="850">

## CycloneDX

Expand Down Expand Up @@ -890,16 +889,15 @@ You can export CSV report by using `--report-formats "csv"`.

CSV reports follow the [CSV structure](https://www.loc.gov/preservation/digital/formats/fdd/fdd000323.shtml#:~:text=CSV%20is%20a%20simple%20format,characters%20indicating%20a%20line%20break.).

```
| query_name | query_id | query_uri | severity | platform | cwe | cloud_provider | category | description_id | description | cis_description_id | cis_description_title | cis_description_text | file_name | similarity_id | line | issue_type | search_key | search_line | search_value | expected_value | actual_value |
| -------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------- | -------- | --- | --------------- | --------------------- | -------------- | ------------------------------------------------------------------------- | ------------------ | --------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---- | ----------------- | ------------------------------------------------- | ----------- | ------------ | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| ALB Listening on HTTP | f81d63d2-c5d7-43a4-a5b5-66717a41c895 | https://docs.ansible.com/ansible/latest/collections/community/aws/elb_application_lb_module.html | HIGH | Ansible | 22 | AWS | Networking and Firewall | 3a7576e5 | AWS Application Load Balancer (alb) should not listen on HTTP | | | | assets\queries\ansible\aws\alb_listening_on_http\test\positive.yaml | a00c90f900058bb60c8eeeaf5236416079e5085fe0465b69aa51b5aa5b7442fe | 11 | IncorrectValue | name={{my_elb_application}}.{{community.aws.elb_application_lb}}.listeners.Protocol=HTTP | -1 | | 'aws_elb_application_lb' Protocol should be 'HTTP' | 'aws_elb_application_lb' Protocol it's not 'HTTP' |
| ALB Listening on HTTP | f81d63d2-c5d7-43a4-a5b5-66717a41c895 | https://docs.ansible.com/ansible/latest/collections/community/aws/elb_application_lb_module.html | HIGH | Ansible | 22 | AWS | Networking and Firewall | 3a7576e5 | AWS Application Load Balancer (alb) should not listen on HTTP | | | | assets\queries\ansible\aws\alb_listening_on_http\test\positive.yaml | 02e577bf2456c31f64f2855f8345fa051c0fe2159e1f116bd392e02af5f4a4f9 | 29 | MissingAttribute | name={{my_elb_application2}}.{{community.aws.elb_application_lb}}.listeners | -1 | | 'aws_elb_application_lb' Protocol should be 'HTTP' | 'aws_elb_application_lb' Protocol is missing |
```
| query_name | query_id | query_uri | severity | platform | cwe | cloud_provider | category | description_id | description | cis_description_id | cis_description_title | cis_description_text | file_name | similarity_id | line | issue_type | search_key | search_line | search_value | expected_value | actual_value |
|----------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------|----------|----------|-----|-----------------|-----------------------|-----------------|------------------------------------------------------------------|---------------------|-----------------------|----------------------|-------------------------------------------------------------------------------------------------------|----------------------------------------------------------|------|-----------------|----------------------------------------------------------------------------------------------|-------------|--------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| ALB Listening on HTTP | f81d63d2-c5d7-43a4-a5b5-66717a41c895 | https://docs.ansible.com/ansible/latest/collections/community/aws/elb_application_lb_module.html | HIGH | Ansible | 22 | AWS | Networking and Firewall | 3a7576e5 | AWS Application Load Balancer (alb) should not listen on HTTP | | | | assets\queries\ansible\aws\alb_listening_on_http\test\positive.yaml | a00c90f900058bb60c8eeeaf5236416079e5085fe0465b69aa51b5aa5b7442fe | 11 | IncorrectValue | name={{my_elb_application}}.{{community.aws.elb_application_lb}}.listeners.Protocol=HTTP | -1 | | 'aws_elb_application_lb' Protocol should be 'HTTP' | 'aws_elb_application_lb' Protocol it's not 'HTTP' |
| ALB Listening on HTTP | f81d63d2-c5d7-43a4-a5b5-66717a41c895 | https://docs.ansible.com/ansible/latest/collections/community/aws/elb_application_lb_module.html | HIGH | Ansible | 22 | AWS | Networking and Firewall | 3a7576e5 | AWS Application Load Balancer (alb) should not listen on HTTP | | | | assets\queries\ansible\aws\alb_listening_on_http\test\positive.yaml | 02e577bf2456c31f64f2855f8345fa051c0fe2159e1f116bd392e02af5f4a4f9 | 29 | MissingAttribute | name={{my_elb_application2}}.{{community.aws.elb_application_lb}}.listeners | -1 | | 'aws_elb_application_lb' Protocol should be 'HTTP' | 'aws_elb_application_lb' Protocol is missing |


**Brief Explanation of CSV Columns:**
**query_name**: Specifies the name of the query.
**query_id**: Unique identifier for the query.
**query_id**: Unique identifier for the query.
**query_uri**: URI link to documentation or reference material related to the query.
**severity**: Indicates the severity level of the vulnerability.
**platform**: Specifies the platform or technology stack targeted by the query.
Expand All @@ -919,7 +917,7 @@ CSV reports follow the [CSV structure](https://www.loc.gov/preservation/digital/
**search_line**: Line number where the search was conducted.
**search_value**: Value searched for in the file.
**expected_value**: Expected value for the vulnerability.
**actual_value**: Actual value found in the file.
**actual_value**: Actual value found in the file.

## Code Climate

Expand Down
Loading