From d89b1584291a8b5226e6d794103608d225e1e3e0 Mon Sep 17 00:00:00 2001 From: StepSecurity Bot Date: Sat, 7 Dec 2024 07:07:52 +0000 Subject: [PATCH] [StepSecurity] Apply security best practices Signed-off-by: StepSecurity Bot --- .github/dependabot.yml | 146 ++++++++++++++++++++++++ .github/workflows/ci.yaml | 18 ++- .github/workflows/codeql.yml | 78 +++++++++++++ .github/workflows/dependency-review.yml | 27 +++++ .github/workflows/publish-site.yaml | 16 ++- .github/workflows/push_gem.yaml | 4 +- .github/workflows/scorecards.yml | 81 +++++++++++++ .pre-commit-config.yaml | 23 ++++ 8 files changed, 383 insertions(+), 10 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/codeql.yml create mode 100644 .github/workflows/dependency-review.yml create mode 100644 .github/workflows/scorecards.yml create mode 100644 .pre-commit-config.yaml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..30171c02 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,146 @@ +version: 2 +updates: + - package-ecosystem: bundler + directory: / + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /config/release + schedule: + interval: daily + + - package-ecosystem: npm + directory: /config/site + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-admin + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-admin_lambda + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-apollo + schedule: + interval: daily + + - package-ecosystem: docker + directory: /elasticgraph-apollo/apollo_tests_implementation + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-apollo/apollo_tests_implementation + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-datastore_core + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-elasticsearch + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-graphql + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-graphql_lambda + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-health_check + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-indexer + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-indexer_autoscaler_lambda + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-indexer_lambda + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-json_schema + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-lambda_support + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-local + schedule: + interval: daily + + - package-ecosystem: docker + directory: /elasticgraph-local/lib/elastic_graph/local/elasticsearch + schedule: + interval: daily + + - package-ecosystem: docker + directory: /elasticgraph-local/lib/elastic_graph/local/opensearch + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-opensearch + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-query_interceptor + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-query_registry + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-rack + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-schema_artifacts + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-schema_definition + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph-support + schedule: + interval: daily + + - package-ecosystem: bundler + directory: /elasticgraph + schedule: + interval: daily diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 1b6acd0a..f4320442 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -47,18 +47,23 @@ jobs: datastore: "elasticsearch:8.15.3" steps: - - uses: actions/checkout@v4 + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - - uses: ruby/setup-ruby@v1 + - uses: ruby/setup-ruby@2a18b06812b0e15bb916e1df298d3e740422c47e # v1.203.0 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true # runs 'bundle install' and caches installed gems automatically - - uses: actions/setup-node@v4 + - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 with: node-version: "23.x" - - uses: KengoTODA/actions-setup-docker-compose@main + - uses: KengoTODA/actions-setup-docker-compose@2eec4b884e8cfa0d7310a4037b0ca789e5db12b2 # main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -78,6 +83,11 @@ jobs: name: All CI Checks Passed needs: [ci-check] steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + - run: | result="${{ needs.ci-check.result }}" if [[ $result == "success" || $result == "skipped" ]]; then diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 00000000..bf7d1a5a --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,78 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: ["main"] + pull_request: + # The branches below must be a subset of the branches above + branches: ["main"] + schedule: + - cron: "0 0 * * 1" + +permissions: + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: ["java", "javascript", "ruby"] + # CodeQL supports [ $supported-codeql-languages ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + + - name: Checkout repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 00000000..21a469b1 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,27 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, +# surfacing known-vulnerable versions of the packages declared or updated in the PR. +# Once installed, if the workflow run is marked as required, +# PRs introducing known-vulnerable packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + + - name: 'Checkout Repository' + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - name: 'Dependency Review' + uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0 diff --git a/.github/workflows/publish-site.yaml b/.github/workflows/publish-site.yaml index 47a9c425..c2c0f7d3 100644 --- a/.github/workflows/publish-site.yaml +++ b/.github/workflows/publish-site.yaml @@ -5,6 +5,9 @@ on: branches: - main +permissions: + contents: read + jobs: publish-docs: runs-on: ubuntu-latest @@ -17,17 +20,22 @@ jobs: group: ${{ github.workflow }}-${{ github.ref }} steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + - name: Checkout the repository - uses: actions/checkout@v4 + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Set up Ruby - uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@2a18b06812b0e15bb916e1df298d3e740422c47e # v1.203.0 with: ruby-version: "3.3" bundler-cache: true # runs 'bundle install' and caches installed gems automatically - name: Set up Node - uses: actions/setup-node@v3 + uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3.8.2 with: node-version: "23.x" @@ -36,7 +44,7 @@ jobs: - name: Deploy to GitHub Pages if: github.event_name == 'push' && github.ref == 'refs/heads/main' - uses: peaceiris/actions-gh-pages@v4 + uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 with: # The GitHub Actions runner automatically creates this `GITHUB_TOKEN` secret github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/push_gem.yaml b/.github/workflows/push_gem.yaml index 0924b72f..0f19a56f 100644 --- a/.github/workflows/push_gem.yaml +++ b/.github/workflows/push_gem.yaml @@ -79,7 +79,7 @@ jobs: # Note: this must come after we release the gem because it resets git back to the same SHA we started on # (before bumping the version), but the RubyGems release depends on the version having been bumped. - name: Create pull request for the version bump - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0 with: branch: release-v${{ inputs.version }} title: "Release v${{ inputs.version }}" @@ -89,7 +89,7 @@ jobs: - [ ] Review and edit the [GitHub Draft Release](https://github.com/${{ github.repository }}/releases) (can be done after this PR is merged) - name: Create GitHub Release - uses: ncipollo/release-action@v1 + uses: ncipollo/release-action@2c591bcc8ecdcd2db72b97d6147f871fcd833ba5 # v1.14.0 with: draft: true generateReleaseNotes: true diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml new file mode 100644 index 00000000..e29081bd --- /dev/null +++ b/.github/workflows/scorecards.yml @@ -0,0 +1,81 @@ +# This workflow uses actions that are not certified by GitHub. They are provided +# by a third-party and are governed by separate terms of service, privacy +# policy, and support documentation. + +name: Scorecard supply-chain security +on: + # For Branch-Protection check. Only the default branch is supported. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection + branch_protection_rule: + # To guarantee Maintained check is occasionally updated. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained + schedule: + - cron: '20 7 * * 2' + push: + branches: ["main"] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-latest + permissions: + # Needed to upload the results to code-scanning dashboard. + security-events: write + # Needed to publish results and get a badge (see publish_results below). + id-token: write + contents: read + actions: read + # To allow GraphQL ListCommits to work + issues: read + pull-requests: read + # To detect SAST tools + checks: read + + steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + + - name: "Checkout code" + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@dc50aa9510b46c811795eb24b2f1ba02a914e534 # v2.3.3 + with: + results_file: results.sarif + results_format: sarif + # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: + # - you want to enable the Branch-Protection check on a *public* repository, or + # - you are installing Scorecards on a *private* repository + # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat. + # repo_token: ${{ secrets.SCORECARD_TOKEN }} + + # Public repositories: + # - Publish results to OpenSSF REST API for easy access by consumers + # - Allows the repository to include the Scorecard badge. + # - See https://github.com/ossf/scorecard-action#publishing-results. + # For private repositories: + # - `publish_results` will always be set to `false`, regardless + # of the value entered here. + publish_results: true + + # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF + # format to the repository Actions tab. + - name: "Upload artifact" + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + # Upload the results to GitHub's code scanning dashboard. + - name: "Upload to code-scanning" + uses: github/codeql-action/upload-sarif@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6 + with: + sarif_file: results.sarif diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..431282f3 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +repos: +- repo: https://github.com/gherynos/pre-commit-java + rev: v0.2.4 + hooks: + - id: Checkstyle +- repo: https://github.com/gitleaks/gitleaks + rev: v8.16.3 + hooks: + - id: gitleaks +- repo: https://github.com/jumanjihouse/pre-commit-hooks + rev: 3.0.0 + hooks: + - id: RuboCop + - id: shellcheck +- repo: https://github.com/pre-commit/mirrors-eslint + rev: v8.38.0 + hooks: + - id: eslint +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace