Skip to content

Commit

Permalink
Updated report examples and replaced the full example with an image i…
Browse files Browse the repository at this point in the history
…n the README (#206)

Co-authored-by: Ilya Siamionau <[email protected]>
  • Loading branch information
anna-aleksandrowicz and MarshalX authored Jan 25, 2024
1 parent 0d6cbac commit 9465e88
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 39 deletions.
43 changes: 4 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,56 +329,21 @@ When using this option, the scan results from this scan will appear in the knowl
To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in the Repository scan to Cycode, add the argument `--report` to the scan command.
`cycode scan -t sca --report repository ~/home/git/codebase`
`cycode scan -t secret --report repository ~/home/git/codebase`
or:
`cycode scan --scan-type sca --report repository ~/home/git/codebase`
`cycode scan --scan-type secret --report repository ~/home/git/codebase`
When using this option, the scan results from this scan will appear in the On-Demand Scans section of Cycode. To get to this page, click the link that appears after the printed results:
> :warning: **NOTE**<br/>
> You must be an `owner` or an `admin` in Cycode to view this page.
```bash
Scan Results: (scan_id: e04e06e5-6dd8-474f-b409-33bbee67270b)
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Multiple evaluation of contract address in call in vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Integer bounds error in Vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
⛔ Found issue of type: Security vulnerability in package 'pyyaml' referenced in project '': Improper Input Validation in PyYAML (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
![cli-report](https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/sca_report_url.png)
⛔ Found issue of type: Security vulnerability in package 'cleo' referenced in project '': cleo is vulnerable to Regular Expression Denial of Service (ReDoS) (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
2 | vyper==0.3.1
3 | cleo==1.0.0a5
4 |
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Incorrect Comparison in Vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Buffer Overflow in vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
Report URL: https://app.cycode.com/on-demand-scans/617ecc3d-9ff2-493e-8be8-2c1fecaf6939
```
The report page will look something like below:
Expand Down
Binary file added images/sca_report_url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9465e88

Please sign in to comment.