Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(queries): implementation of regal for linting rego files #7295

Draft
wants to merge 38 commits into
base: master
Choose a base branch
from

Conversation

ArturRibeiro-CX
Copy link
Contributor

@ArturRibeiro-CX ArturRibeiro-CX commented Nov 8, 2024

This PR integrates the Regal linter for Rego files in KICS to support query maintanance, reusability and best practices. As KICS uses Rego extensively to build queries, adding a linter helps ensuring consistency and quality across our codebase.

Thanks to the contributors who initiated the discussions and provided input for this addition. 🥳 🙌

Closes #6774
Closes #505

Reason for Proposed Changes

  • Improve code quality, maintainability and consistency by applying the Regal linter to Rego files;
  • Implement linter rules that follow best practices while leaving flexibility to refine rules over time (through rego_config.yaml);

Proposed Changes

  • Add Regal Linter (v1.0.0) for Rego files;
  • Create a configuration file ( rego_config.yaml) to specify which linter rules to enforce or ignore;
  • Update Rego queries to to address linting issues.

Documentation Links:

I submit this contribution under the Apache-2.0 license.

@github-actions github-actions bot added feature New feature query New query feature labels Nov 8, 2024
Copy link
Contributor

github-actions bot commented Nov 8, 2024

kics-logo

KICS version: v2.1.3

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 1
Files parsed placeholder 1
Files failed to scan placeholder 0
Total executed queries placeholder 48
Queries failed to execute placeholder 0
Execution time placeholder 0

@ArturRibeiro-CX ArturRibeiro-CX self-assigned this Nov 8, 2024
@ArturRibeiro-CX ArturRibeiro-CX added the community Community contribution label Nov 8, 2024
Copy link

gitguardian bot commented Nov 10, 2024

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
14477467 Triggered Generic Password 8fa67a6 assets/libraries/common.rego View secret
14477466 Triggered Generic Password 8fa67a6 assets/libraries/common.rego View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution feature New feature query New query feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add shared_host_ipc_namespace query for Kubernetes
1 participant