diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b39e655..b19a0fc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,7 +7,7 @@ # # Currently for Java repositories, we support the following hooks: # -# - Git Secrets (https://github.com/awslabs/git-secrets) +# - Detect Secrets (https://nasa-ammos.github.io/slim/docs/guides/software-lifecycle/security/secrets-detection/) # # Future hooks could include: trailing whitespace alerts, executable shebangs, # debug statements left in code, Google code style adherence, etc. @@ -17,22 +17,18 @@ repos: - - # Git Secrets: prevent API keys, passwords, etc. - repo: https://github.com/awslabs/git-secrets.git - rev: b9e96b3212fa06aea65964ff0d5cda84ce935f38 + repo: https://github.com/NASA-AMMOS/slim-detect-secrets + # using commit id for now, will change to tag when official version is released + rev: 91e097ad4559ae6ab785c883dc5ed989202c7fbe hooks: - - - id: git-secrets + - id: detect-secrets + args: + - '--baseline' + - '.secrets.baseline' + - --exclude-files '\.secrets..*' + - --exclude-files '\.git.*' + - --exclude-files 'target' - # Terraform Pre-Commit hooks - - repo: https://github.com/antonbabenko/pre-commit-terraform - rev: v1.81.0 - hooks: - - id: terraform_fmt - - id: terraform_validate - # - id: terraform_tflint - # - id: terrascan - # - id: terraform_tfsec ... # -*- mode: YAML; tab-width: 4 -*- diff --git a/.secrets.baseline b/.secrets.baseline new file mode 100644 index 0000000..fbf508f --- /dev/null +++ b/.secrets.baseline @@ -0,0 +1,147 @@ +{ + "version": "1.4.0", + "plugins_used": [ + { + "name": "AbsolutePathDetectorExperimental" + }, + { + "name": "ArtifactoryDetector" + }, + { + "name": "AWSKeyDetector" + }, + { + "name": "AWSSensitiveInfoDetectorExperimental" + }, + { + "name": "AzureStorageKeyDetector" + }, + { + "name": "Base64HighEntropyString", + "limit": 4.5 + }, + { + "name": "BasicAuthDetector" + }, + { + "name": "CloudantDetector" + }, + { + "name": "DiscordBotTokenDetector" + }, + { + "name": "EmailAddressDetector" + }, + { + "name": "GitHubTokenDetector" + }, + { + "name": "HexHighEntropyString", + "limit": 3.0 + }, + { + "name": "IbmCloudIamDetector" + }, + { + "name": "IbmCosHmacDetector" + }, + { + "name": "IPPublicDetector" + }, + { + "name": "JwtTokenDetector" + }, + { + "name": "KeywordDetector", + "keyword_exclude": "" + }, + { + "name": "MailchimpDetector" + }, + { + "name": "NpmDetector" + }, + { + "name": "PrivateKeyDetector" + }, + { + "name": "SendGridDetector" + }, + { + "name": "SlackDetector" + }, + { + "name": "SoftlayerDetector" + }, + { + "name": "SquareOAuthDetector" + }, + { + "name": "StripeDetector" + }, + { + "name": "TwilioKeyDetector" + } + ], + "filters_used": [ + { + "path": "detect_secrets.filters.allowlist.is_line_allowlisted" + }, + { + "path": "detect_secrets.filters.common.is_baseline_file", + "filename": ".secrets.baseline" + }, + { + "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies", + "min_level": 2 + }, + { + "path": "detect_secrets.filters.heuristic.is_indirect_reference" + }, + { + "path": "detect_secrets.filters.heuristic.is_likely_id_string" + }, + { + "path": "detect_secrets.filters.heuristic.is_lock_file" + }, + { + "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string" + }, + { + "path": "detect_secrets.filters.heuristic.is_potential_uuid" + }, + { + "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign" + }, + { + "path": "detect_secrets.filters.heuristic.is_sequential_string" + }, + { + "path": "detect_secrets.filters.heuristic.is_swagger_file" + }, + { + "path": "detect_secrets.filters.heuristic.is_templated_secret" + }, + { + "path": "detect_secrets.filters.regex.should_exclude_file", + "pattern": [ + "\\.secrets..*", + "\\.git.*", + "target" + ] + } + ], + "results": { + ".pre-commit-config.yaml": [ + { + "type": "Hex High Entropy String", + "filename": ".pre-commit-config.yaml", + "hashed_secret": "63076edad0be7557f5fbd9b60bc1ffa664fce207", + "is_verified": false, + "line_number": 22, + "is_secret": false + } + ] + }, + "generated_at": "2023-11-09T15:47:32Z" +} diff --git a/README.md b/README.md index 0f0b883..0321fe8 100644 --- a/README.md +++ b/README.md @@ -84,23 +84,43 @@ to produce a complete package. This runs all the phases necessary, including com #### ๐Ÿชย Pre-Commit Hooks -This package comes with a configuration for [Pre-Commit](https://pre-commit.com/), a system for automating and standardizing `git` hooks for code linting, security scanning, etc. Here in this Java template repository, we use Pre-Commit with [Git Secrets](https://github.com/awslabs/git-secrets) to prevent the accidental committing or commit messages containing secrets like API keys and passwords. +This package comes with a configuration for [Pre-Commit](https://pre-commit.com/), a system for automating and standardizing `git` hooks for code linting, security scanning, etc. Here in this Java template repository, we use Pre-Commit with [Detect Secrets](https://nasa-ammos.github.io/slim/docs/guides/software-lifecycle/security/secrets-detection/) to prevent the accidental committing or commit messages containing secrets like API keys and passwords. -Pre-Commit is language-neutral, but is itself written in Python. To take advantage of Pre-Commit, you'll need a nearby Python installation. A recommended way to do this is with a virtual Python environment. Using the command line interface, run: +Pre-Commit and `detect-secrets` are language-neutral, but they themselves are written in Python. To take advantage of these features, you'll need a nearby Python installation. A recommended way to do this is with a virtual Python environment. Using the command line interface, run: ```console $ python -m venv .venv $ source .venv/bin/activate # Use source .venv/bin/activate.csh if you're using a C-style shell -$ pip install pre-commit -$ pre-commit install -$ pre-commit install -t pre-push -$ pre-commit install -t prepare-commit-msg -$ pre-commit install -t commit-msg +$ pip install pre-commit https://github.com/NASA-AMMOS/slim-detect-secrets.git@exp ``` +You can then establish a secrets baseline in your Maven-based repository: + + detect-secrets scan . \ + --all-files \ + --disable-plugin AbsolutePathDetectorExperimental \ + --exclude-files '\.secrets..*' \ + --exclude-files '\.git.*' \ + --exclude-files 'target' > .secrets.baseline + +Review the secrets to determine which should be allowed and which are false positives: + + detect-secrets audit .secrets.baseline + +Please remove any secrets that should not be seen by the public. You can then add the baseline file to the commit: + + git add .secrets.baseline + +Finally, install the pre-commit hooks: + + pre-commit install + pre-commit install -t pre-push + pre-commit install -t prepare-commit-msg + pre-commit install -t commit-msg + You can then work normally. Pre-commit will run automatically during `git commit` and `git push` so long as the Python virtual environment is active. -๐Ÿ‘‰ **Note:** For Git Secrets to work, there is a one-time setup required to your personal global Git configuration. See [the wiki entry on Git Secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#git-secrets) to learn how to do this. +๐Ÿ‘‰ **Note:** For Detect Secrets to work, there is a one-time setup required to your personal global Git configuration. See [the wiki entry on Detect Secrets](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#detect-secrets) to learn how to do this. ### ๐Ÿš… Continuous Integration & Deployment diff --git a/secrets-detection.yaml b/secrets-detection.yaml new file mode 100644 index 0000000..66dff04 --- /dev/null +++ b/secrets-detection.yaml @@ -0,0 +1,69 @@ +name: Secret Detection Workflow +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + secret-detection: + runs-on: ubuntu-latest + steps: + - + name: Checkout code + uses: actions/checkout@v2 + - + name: Install necessary packages + run: | + pip install git+https://github.com/NASA-AMMOS/slim-detect-secrets.git@exp + pip install jq + + - + name: Create an initial .secrets.baseline if .secrets.baseline does not exist + run: | + if [ ! -f .secrets.baseline ]; then + # This generated baseline file will only be temporarily available on the GitHub side and will not appear in the user's local files. + # Scanning an empty folder to generate an initial .secrets.baseline without secrets in the results. + echo "โš ๏ธ No existing .secrets.baseline file detected. Creating a new blank baseline file." + mkdir empty-dir + detect-secrets scan empty-dir > .secrets.baseline + echo "โœ… Blank .secrets.baseline file created successfully." + rm -r empty-dir + else + echo "โœ… Existing .secrets.baseline file detected. No new baseline file will be created." + fi + + - + name: Scan repository for secrets + run: | + # scripts to scan repository for new secrets + + # backup the list of known secrets + cp .secrets.baseline .secrets.new + + # find the secrets in the repository + detect-secrets scan --disable-plugin AbsolutePathDetectorExperimental --baseline .secrets.new \ + --exclude-files '\.secrets..*' \ + --exclude-files '\.git.*' \ + --exclude-files 'target' + + # if there is any difference between the known and newly detected secrets, break the build + # Function to compare secrets without listing them + compare_secrets() { diff <(jq -r '.results | keys[] as $key | "\($key),\(.[$key] | .[] | .hashed_secret)"' "$1" | sort) <(jq -r '.results | keys[] as $key | "\($key),\(.[$key] | .[] | .hashed_secret)"' "$2" | sort) >/dev/null; } + + # Check if there's any difference between the known and newly detected secrets + if ! compare_secrets .secrets.baseline .secrets.new; then + echo "โš ๏ธ Attention Required! โš ๏ธ" >&2 + echo "New secrets have been detected in your recent commit. Due to security concerns, we cannot display detailed information here and we cannot proceed until this issue is resolved." >&2 + echo "" >&2 + echo "Please follow the steps below on your local machine to reveal and handle the secrets:" >&2 + echo "" >&2 + echo "1๏ธโƒฃ Run the 'detect-secrets' tool on your local machine. This tool will identify and clean up the secrets. You can find detailed instructions at this link: https://nasa-ammos.github.io/slim/continuous-testing/starter-kits/#detect-secrets" >&2 + echo "" >&2 + echo "2๏ธโƒฃ After cleaning up the secrets, commit your changes and re-push your update to the repository." >&2 + echo "" >&2 + echo "Your efforts to maintain the security of our codebase are greatly appreciated!" >&2 + exit 1 + fi