Skip to content

Checkov #108

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

Closed
wants to merge 2 commits into from
Closed

Checkov #108

wants to merge 2 commits into from

Conversation

alexcoderabbitai
Copy link
Owner

@alexcoderabbitai alexcoderabbitai commented Apr 17, 2025

Summary by CodeRabbit

  • New Features
    • Added a sample Terraform configuration file defining AWS resources, including security groups and a publicly accessible S3 bucket, for testing and demonstration purposes.

@alexcrtestapp
Copy link

alexcrtestapp bot commented Apr 17, 2025

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 5fbf32a and 5d7beff.

📒 Files selected for processing (1)
  • sampleTerraformFile.tf (1 hunks)
 _______________________________________
< r/CodeReview: Where I'm the top post. >
 ---------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Walkthrough

A new Terraform configuration file has been added, defining several AWS resources with intentional security vulnerabilities for testing. The file sets up local variables, configures the AWS provider with hardcoded credentials, and specifies required Terraform and AWS provider versions. It declares two security groups—one with minimal restrictions and another with overly permissive rules—and an S3 bucket that is publicly accessible. The configuration includes comments and instructions for running security scans using Checkov.

Changes

File(s) Change Summary
sampleTerraformFile.tf Added a Terraform configuration defining local variables, AWS provider, two security groups (one secure, one insecure), a public S3 bucket, and required version blocks. Includes comments and Checkov scan instructions.

Poem

In the land of Terraform, a file appears—
With buckets and groups, and a few open fears.
Security wide open, for testing delight,
Checkov will scan it, exposing the blight.
So hop along, devs, with a cautious cheer,
For every new config, a rabbit is near! 🐇


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @alexcrtestapp in a new review comment at the desired location with your query. Examples:
    • @alexcrtestapp generate unit testing code for this file.
    • @alexcrtestapp modularize this function.
  • PR comments: Tag @alexcrtestapp in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @alexcrtestapp gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @alexcrtestapp read src/utils.ts and generate unit testing code.
    • @alexcrtestapp read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @alexcrtestapp help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @alexcrtestapp pause to pause the reviews on a PR.
  • @alexcrtestapp resume to resume the paused reviews.
  • @alexcrtestapp review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @alexcrtestapp full review to do a full review from scratch and review all the files again.
  • @alexcrtestapp summary to regenerate the summary of the PR.
  • @alexcrtestapp generate docstrings to generate docstrings for this PR.
  • @alexcrtestapp resolve resolve all the CodeRabbit review comments.
  • @alexcrtestapp configuration to show the current CodeRabbit configuration for the repository.
  • @alexcrtestapp help to get help.

Other keywords and placeholders

  • Add @alexcrtestapp ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @alexcrtestapp summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @alexcrtestapp or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@alexcrtestapp alexcrtestapp bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (2)
sampleTerraformFile.tf (2)

1-8: Refactor documentation comments to README
Consider moving the Checkov invocation examples and reference URL out of the Terraform file and into a dedicated README or CI configuration. This keeps the Terraform code focused and avoids cluttering resource files with procedural docs.


30-49: Refine egress rules and clean up description

  1. The default egress allows all outbound traffic, which may be broader than necessary.
  2. The description has an extra trailing space.

You might tighten the egress to required ports and remove the trailing space:

 resource "aws_security_group" "this" {
   name        = local.sg_name
-  description = "Security group "
+  description = "Security group"
   vpc_id      = local.aws_vpc_id
   ...
   egress {
-    from_port   = 0
-    to_port     = 0
-    protocol    = "-1"
+    from_port   = 443
+    to_port     = 443
+    protocol    = "tcp"
     cidr_blocks = ["0.0.0.0/0"]
   }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5fbf32a and 5d7beff.

📒 Files selected for processing (1)
  • sampleTerraformFile.tf (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Security Checks
sampleTerraformFile.tf

[error] 24-24: A hard-coded credential was detected. It is not recommended to store credentials in source-code, as this risks secrets being leaked and used by malicious adversaries. Use environment variables or secure vaults to provide credentials. (terraform.aws.security.aws-provider-static-credentials.aws-provider-static-credentials)

🪛 CircleCI: semgrep
sampleTerraformFile.tf

[error] 24-24: terraform.aws.security.aws-provider-static-credentials.aws-provider-static-credentials: A hard-coded credential was detected. Storing credentials in source code risks secrets being leaked. Use environment variables or secure vaults to provide credentials.

🔇 Additional comments (1)
sampleTerraformFile.tf (1)

97-105: Terraform block versions look good
The required_version and provider version constraints are appropriately set.

Comment on lines +9 to +15
locals {
sg_name = "checkov-test"
aws_vpc_id = "vpc-#####" #enter vpc id here
cidr_block = ["0.0.0.0/0"]
from_port = "80"
to_port = "80"
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enforce correct types for port variables
Terraform expects numeric values for from_port and to_port. Defining them as strings will cause type mismatches or implicit conversions. Convert these to numbers for clarity and safety.

Apply this diff:

 locals {
   sg_name    = "checkov-test"
   aws_vpc_id = "vpc-#####" #enter vpc id here
   cidr_block = ["0.0.0.0/0"]
-  from_port  = "80"
-  to_port    = "80"
+  from_port  = 80
+  to_port    = 80
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
locals {
sg_name = "checkov-test"
aws_vpc_id = "vpc-#####" #enter vpc id here
cidr_block = ["0.0.0.0/0"]
from_port = "80"
to_port = "80"
}
locals {
sg_name = "checkov-test"
aws_vpc_id = "vpc-#####" #enter vpc id here
cidr_block = ["0.0.0.0/0"]
from_port = 80
to_port = 80
}

Comment on lines +21 to +25
provider "aws" {
region = "us-east-1"
access_key = "AKIA123456789EXAMPLE"
secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid hard-coded AWS credentials
Embedding access_key and secret_key in code poses a critical security risk. Use environment variables, shared credentials files, or Terraform variables with sensitive inputs instead.

Consider this approach:

 provider "aws" {
-  region     = "us-east-1"
-  access_key = "AKIA123456789EXAMPLE"
-  secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
+  region = var.aws_region
+  # Credentials picked up from environment or shared credentials file
 }
 
 variable "aws_region" {
   type    = string
   default = "us-east-1"
 }

Also define aws_access_key and aws_secret_key as sensitive variables or rely on AWS provider defaults.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
provider "aws" {
region = "us-east-1"
access_key = "AKIA123456789EXAMPLE"
secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}
provider "aws" {
region = var.aws_region
# Credentials picked up from environment or shared credentials file
}
variable "aws_region" {
type = string
default = "us-east-1"
}
🧰 Tools
🪛 GitHub Actions: Security Checks

[error] 24-24: A hard-coded credential was detected. It is not recommended to store credentials in source-code, as this risks secrets being leaked and used by malicious adversaries. Use environment variables or secure vaults to provide credentials. (terraform.aws.security.aws-provider-static-credentials.aws-provider-static-credentials)

🪛 CircleCI: semgrep

[error] 24-24: terraform.aws.security.aws-provider-static-credentials.aws-provider-static-credentials: A hard-coded credential was detected. Storing credentials in source code risks secrets being leaked. Use environment variables or secure vaults to provide credentials.

Comment on lines +55 to +75
resource "aws_security_group" "insecure" {
name = "insecure-sg"
description = "Insecure SG exposing all TCP ports to the world"
vpc_id = local.aws_vpc_id

ingress {
description = "Allow all TCP traffic"
from_port = 0
to_port = 65535
protocol = "tcp"
cidr_blocks = ["0.0.0.0/0"]
}

egress {
description = "Allow all outbound traffic"
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Dangerous: Insecure security group exposing all TCP ports
This resource opens every TCP port to the internet, constituting a major security vulnerability. If this is only for testing, guard it behind a toggle or isolate it in a dedicated test workspace.

Example toggle using a variable:

+variable "enable_insecure_sg" {
+  type    = bool
+  default = false
+}
 resource "aws_security_group" "insecure" {
+  count       = var.enable_insecure_sg ? 1 : 0
   name        = "insecure-sg"
   description = "Insecure SG exposing all TCP ports to the world"
   vpc_id      = local.aws_vpc_id
   ...
 }

Comment on lines +80 to +92
resource "aws_s3_bucket" "public" {
bucket = "checkov-public-bucket-demo-12345"
acl = "public-read" # Vulnerability: Bucket is publicly readable

versioning {
enabled = false
}

# Intentionally not configuring block public access to expose potential risk
website {
index_document = "index.html"
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Secure public S3 bucket configuration
A public-read ACL without block public access settings leaves this bucket exposed. Recommend removing the ACL, enabling block public access, and using a bucket policy for controlled access.

Apply this diff:

 resource "aws_s3_bucket" "public" {
   bucket = "checkov-public-bucket-demo-12345"
-  acl    = "public-read"
+  # acl    = "public-read"  # tightened for security
+
+  block_public_acls       = true
+  block_public_policy     = true
+  ignore_public_acls      = true
+  restrict_public_buckets = true

   versioning {
     enabled = false
   }
   website {
     index_document = "index.html"
   }
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
resource "aws_s3_bucket" "public" {
bucket = "checkov-public-bucket-demo-12345"
acl = "public-read" # Vulnerability: Bucket is publicly readable
versioning {
enabled = false
}
# Intentionally not configuring block public access to expose potential risk
website {
index_document = "index.html"
}
}
resource "aws_s3_bucket" "public" {
bucket = "checkov-public-bucket-demo-12345"
# acl = "public-read" # tightened for security
block_public_acls = true
block_public_policy = true
ignore_public_acls = true
restrict_public_buckets = true
versioning {
enabled = false
}
website {
index_document = "index.html"
}
}

@alexcoderabbitai
Copy link
Owner Author

@alexcrtestapp full review

2 similar comments
@alexcoderabbitai
Copy link
Owner Author

@alexcrtestapp full review

@alexcoderabbitai
Copy link
Owner Author

@alexcrtestapp full review

@alexcrtestapp
Copy link

alexcrtestapp bot commented Apr 17, 2025

✅ Actions performed

Full review triggered.

@alexcoderabbitai
Copy link
Owner Author

@alexcrtestapp full review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant