cycode 1.11.1.dev5__tar.gz → 1.11.1.dev8__tar.gz

cycode-1.11.1.dev8/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Cycode Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{cycode-1.11.1.dev5 → cycode-1.11.1.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cycode
-Version: 1.11.1.dev5
+Version: 1.11.1.dev8
 Summary: Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.
 Home-page: https://github.com/cycodehq/cycode-cli
 License: MIT
@@ -19,8 +19,8 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: arrow (>=1.0.0,<1.4.0)
 Requires-Dist: binaryornot (>=0.4.4,<0.5.0)
@@ -239,33 +239,59 @@ export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
 
 Cycode’s pre-commit hook can be set up within your local repository so that the Cycode CLI application will identify any issues with your code automatically before you commit it to your codebase.
 
+> [!NOTE]
+> pre-commit hook is only available to Secrets and SCA scans.
+
 Perform the following steps to install the pre-commit hook:
 
-1. Install the pre-commit framework:
+1. Install the pre-commit framework (Python 3.8 or higher must be installed):
 
    `pip3 install pre-commit`
 
-2. Navigate to the top directory of the local repository you wish to scan.
+2. Navigate to the top directory of the local Git repository you wish to configure.
 
 3. Create a new YAML file named `.pre-commit-config.yaml` (include the beginning `.`) in the repository’s top directory that contains the following:
 
     ```yaml
     repos:
       - repo: https://github.com/cycodehq/cycode-cli
-        rev: v1.4.0
+        rev: v1.11.0
+        hooks:
+          - id: cycode
+            stages:
+              - commit
+    ```
+
+4. Modify the created file for your specific needs. Use hook ID `cycode` to enable scan for Secrets. Use hook ID `cycode-sca` to enable SCA scan. If you want to enable both, use this configuration:
+
+    ```yaml
+    repos:
+      - repo: https://github.com/cycodehq/cycode-cli
+        rev: v1.11.0
         hooks:
           - id: cycode
             stages:
               - commit
+          - id: cycode-sca
+            stages:
+              - commit
     ```
 
-4. Install Cycode’s hook:
+5. Install Cycode’s hook:
 
    `pre-commit install`
 
+   A successful hook installation will result in the message: `Pre-commit installed at .git/hooks/pre-commit`.
+
+6. Keep the pre-commit hook up to date:
+
+   `pre-commit autoupdate`
+
+   It will automatically bump "rev" in ".pre-commit-config.yaml" to the latest available version of Cycode CLI.
+
 > [!NOTE]
-> A successful hook installation will result in the message:<br/>
-`Pre-commit installed at .git/hooks/pre-commit`
+> Trigger happens on `git commit` command.
+> Hook triggers only on the files that are staged for commit.
 
 # Cycode CLI Commands
 

{cycode-1.11.1.dev5 → cycode-1.11.1.dev8}/README.md

@@ -199,33 +199,59 @@ export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
 
 Cycode’s pre-commit hook can be set up within your local repository so that the Cycode CLI application will identify any issues with your code automatically before you commit it to your codebase.
 
+> [!NOTE]
+> pre-commit hook is only available to Secrets and SCA scans.
+
 Perform the following steps to install the pre-commit hook:
 
-1. Install the pre-commit framework:
+1. Install the pre-commit framework (Python 3.8 or higher must be installed):
 
    `pip3 install pre-commit`
 
-2. Navigate to the top directory of the local repository you wish to scan.
+2. Navigate to the top directory of the local Git repository you wish to configure.
 
 3. Create a new YAML file named `.pre-commit-config.yaml` (include the beginning `.`) in the repository’s top directory that contains the following:
 
     ```yaml
     repos:
       - repo: https://github.com/cycodehq/cycode-cli
-        rev: v1.4.0
+        rev: v1.11.0
+        hooks:
+          - id: cycode
+            stages:
+              - commit
+    ```
+
+4. Modify the created file for your specific needs. Use hook ID `cycode` to enable scan for Secrets. Use hook ID `cycode-sca` to enable SCA scan. If you want to enable both, use this configuration:
+
+    ```yaml
+    repos:
+      - repo: https://github.com/cycodehq/cycode-cli
+        rev: v1.11.0
         hooks:
           - id: cycode
             stages:
               - commit
+          - id: cycode-sca
+            stages:
+              - commit
     ```
 
-4. Install Cycode’s hook:
+5. Install Cycode’s hook:
 
    `pre-commit install`
 
+   A successful hook installation will result in the message: `Pre-commit installed at .git/hooks/pre-commit`.
+
+6. Keep the pre-commit hook up to date:
+
+   `pre-commit autoupdate`
+
+   It will automatically bump "rev" in ".pre-commit-config.yaml" to the latest available version of Cycode CLI.
+
 > [!NOTE]
-> A successful hook installation will result in the message:<br/>
-`Pre-commit installed at .git/hooks/pre-commit`
+> Trigger happens on `git commit` command.
+> Hook triggers only on the files that are staged for commit.
 
 # Cycode CLI Commands
 

cycode-1.11.1.dev8/cycode/__init__.py

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

cycode-1.11.1.dev8/cycode/cli/files_collector/sca/go/restore_go_dependencies.py

@@ -0,0 +1,31 @@
+import os
+from typing import List
+
+import click
+
+from cycode.cli.files_collector.sca.base_restore_dependencies import BaseRestoreDependencies
+from cycode.cli.models import Document
+
+GO_PROJECT_FILE_EXTENSIONS = ['.mod']
+GO_RESTORE_FILE_NAME = 'go.sum'
+BUILD_GO_FILE_NAME = 'go.mod'
+
+
+class RestoreGoDependencies(BaseRestoreDependencies):
+    def __init__(self, context: click.Context, is_git_diff: bool, command_timeout: int) -> None:
+        super().__init__(context, is_git_diff, command_timeout, create_output_file_manually=True)
+
+    def is_project(self, document: Document) -> bool:
+        return any(document.path.endswith(ext) for ext in GO_PROJECT_FILE_EXTENSIONS)
+
+    def get_command(self, manifest_file_path: str) -> List[str]:
+        return ['cd', self.prepare_tree_file_path_for_command(manifest_file_path), '&&', 'go', 'list', '-m', '-json']
+
+    def get_lock_file_name(self) -> str:
+        return GO_RESTORE_FILE_NAME
+
+    def verify_restore_file_already_exist(self, restore_file_path: str) -> bool:
+        return os.path.isfile(restore_file_path)
+
+    def prepare_tree_file_path_for_command(self, manifest_file_path: str) -> str:
+        return manifest_file_path.replace(os.sep + BUILD_GO_FILE_NAME, '')

{cycode-1.11.1.dev5 → cycode-1.11.1.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cycode"
-version = "1.11.1.dev5" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
+version = "1.11.1.dev8" # 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.11.1.dev5/cycode/__init__.py

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