cycode 1.9.1.dev1__tar.gz → 1.9.1.dev3__tar.gz

{cycode-1.9.1.dev1 → cycode-1.9.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cycode
-Version: 1.9.1.dev1
+Version: 1.9.1.dev3
 Summary: Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.
 Home-page: https://github.com/cycodehq/cycode-cli
 License: MIT
@@ -76,6 +76,7 @@ This guide will guide you through both installation and usage.
             2. [IaC Result Example](#iac-result-example)
             3. [SCA Result Example](#sca-result-example)
             4. [SAST Result Example](#sast-result-example)
+        4. [Company’s Custom Remediation Guidelines](#companys-custom-remediation-guidelines) 
     3. [Ignoring Scan Results](#ignoring-scan-results)
         1. [Ignoring a Secret Value](#ignoring-a-secret-value)
         2. [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value)
@@ -106,9 +107,10 @@ To install the Cycode CLI application on your local machine, perform the followi
 
 1. Open your command line or terminal application.
 
-2. Execute the following command:
+2. Execute one of the following commands:
 
-   `pip3 install cycode`
+   - `pip3 install cycode` - to install from PyPI
+   - `brew install cycode` - to install from Homebrew
 
 3. Navigate to the top directory of the local repository you wish to scan.
 
@@ -362,14 +364,13 @@ When using this option, the scan results from this scan will appear in the knowl
 ### Report Option
 
 > [!NOTE]
-> This option is only available to SCA and Secret scans.
+> This option is not available to IaC scans.
 
 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`
@@ -597,6 +598,10 @@ Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0
 4 | print(res.content)
 ```
 
+### Company’s Custom Remediation Guidelines
+
+If your company has set custom remediation guidelines in the relevant policy via the Cycode portal, you'll see a field for “Company Guidelines” that contains the remediation guidelines you added. Note that if you haven't added any company guideline, this field will not appear in the CLI tool.
+
 ## Ignoring Scan Results
 
 Ignore rules can be added to ignore specific secret values, specific SHA512 values, specific paths, and specific Cycode secret and IaC rule IDs. This will cause the scan to not alert these values. The ignore rules are written and saved locally in the `./.cycode/config.yaml` file.

{cycode-1.9.1.dev1 → cycode-1.9.1.dev3}/README.md

@@ -38,6 +38,7 @@ This guide will guide you through both installation and usage.
             2. [IaC Result Example](#iac-result-example)
             3. [SCA Result Example](#sca-result-example)
             4. [SAST Result Example](#sast-result-example)
+        4. [Company’s Custom Remediation Guidelines](#companys-custom-remediation-guidelines) 
     3. [Ignoring Scan Results](#ignoring-scan-results)
         1. [Ignoring a Secret Value](#ignoring-a-secret-value)
         2. [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value)
@@ -68,9 +69,10 @@ To install the Cycode CLI application on your local machine, perform the followi
 
 1. Open your command line or terminal application.
 
-2. Execute the following command:
+2. Execute one of the following commands:
 
-   `pip3 install cycode`
+   - `pip3 install cycode` - to install from PyPI
+   - `brew install cycode` - to install from Homebrew
 
 3. Navigate to the top directory of the local repository you wish to scan.
 
@@ -324,14 +326,13 @@ When using this option, the scan results from this scan will appear in the knowl
 ### Report Option
 
 > [!NOTE]
-> This option is only available to SCA and Secret scans.
+> This option is not available to IaC scans.
 
 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`
@@ -559,6 +560,10 @@ Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0
 4 | print(res.content)
 ```
 
+### Company’s Custom Remediation Guidelines
+
+If your company has set custom remediation guidelines in the relevant policy via the Cycode portal, you'll see a field for “Company Guidelines” that contains the remediation guidelines you added. Note that if you haven't added any company guideline, this field will not appear in the CLI tool.
+
 ## Ignoring Scan Results
 
 Ignore rules can be added to ignore specific secret values, specific SHA512 values, specific paths, and specific Cycode secret and IaC rule IDs. This will cause the scan to not alert these values. The ignore rules are written and saved locally in the `./.cycode/config.yaml` file.

cycode-1.9.1.dev3/cycode/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.9.1.dev3'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag

{cycode-1.9.1.dev1 → cycode-1.9.1.dev3}/cycode/cli/printers/json_printer.py

@@ -25,8 +25,16 @@ class JsonPrinter(PrinterBase):
     def print_scan_results(
         self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
     ) -> None:
+        scan_ids = []
+        report_urls = []
         detections = []
+
         for local_scan_result in local_scan_results:
+            scan_ids.append(local_scan_result.scan_id)
+
+            if local_scan_result.report_url:
+                report_urls.append(local_scan_result.report_url)
+
             for document_detections in local_scan_result.document_detections:
                 detections.extend(document_detections.detections)
 
@@ -37,12 +45,16 @@ class JsonPrinter(PrinterBase):
             # FIXME(MarshalX): we don't care about scan IDs in JSON output due to clumsy JSON root structure
             inlined_errors = [err._asdict() for err in errors.values()]
 
-        click.echo(self._get_json_scan_result(detections_dict, inlined_errors))
+        click.echo(self._get_json_scan_result(scan_ids, detections_dict, report_urls, inlined_errors))
 
-    def _get_json_scan_result(self, detections: dict, errors: List[dict]) -> str:
+    def _get_json_scan_result(
+        self, scan_ids: List[str], detections: dict, report_urls: List[str], errors: List[dict]
+    ) -> str:
         result = {
-            'scan_id': 'DEPRECATED',  # FIXME(MarshalX): we need change JSON struct to support multiple scan results
+            'scan_id': 'DEPRECATED',  # backward compatibility
+            'scan_ids': scan_ids,
             'detections': detections,
+            'report_urls': report_urls,
             'errors': errors,
         }
 

{cycode-1.9.1.dev1 → cycode-1.9.1.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cycode"
-version = "1.9.1.dev1" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
+version = "1.9.1.dev3" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
 description = "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning."
 keywords=["secret-scan", "cycode", "devops", "token", "secret", "security", "cycode", "code"]
 authors = ["Cycode <support@cycode.com>"]

cycode-1.9.1.dev1/cycode/__init__.py

@@ -1 +0,0 @@
-__version__ = '1.9.1.dev1'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag