Skip to content

fix(query): resolve false positive on API Gateway access logging #7996

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.

Sign up for GitHub

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

Open
cx-prathmesh-borle wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix(query): resolve false positive on API Gateway access logging #7996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72af7d5
fix(query): resolve false positive on API Gateway access logging #7466
cx-prathmesh-borle Mar 12, 2026
91fd0e6
Merge branch 'Checkmarx:master' into hotfix/7466-api-gateway-access-l…
cx-prathmesh-borle Apr 4, 2026
59fc99c
fix(query): normalize API Gateway access logging MethodSettings sampl…
cx-prathmesh-borle Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/query.rego
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,18 +114,18 @@ CxPolicy[result] {
resource.Type == "AWS::ApiGateway::Stage"

properties := resource.Properties
methodSettings := properties.MethodSettings
not common_lib.valid_key(methodSettings, "LoggingLevel")
methodSetting := properties.MethodSettings[j]
not common_lib.valid_key(methodSetting, "LoggingLevel")

result := {
"documentId": input.document[i].id,
"resourceType": resource.Type,
"resourceName": cf_lib.get_resource_name(resource, name),
"searchKey": sprintf("Resources.%s.Properties.MethodSettings", [name]),
"issueType": "MissingAttribute",
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel should be defined and not null", [name]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel are undefined or null", [name]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings"], []),
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel should be defined and not null", [name, j]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel is undefined or null", [name, j]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings", j], []),
}
}

Expand All @@ -135,18 +135,18 @@ CxPolicy[result] {
resource.Type == "AWS::ApiGateway::Stage"

properties := resource.Properties
loggingLevel := properties.MethodSettings.LoggingLevel
loggingLevel := properties.MethodSettings[j].LoggingLevel
loggingLevel == ""

result := {
"documentId": input.document[i].id,
"resourceType": resource.Type,
"resourceName": cf_lib.get_resource_name(resource, name),
"searchKey": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel", [name]),
"searchKey": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel", [name, j]),
"issueType": "IncorrectValue",
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel should be not be empty", [name]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel is empty", [name]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings", "LoggingLevel"], []),
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel should not be empty", [name, j]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel is empty", [name, j]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings", j, "LoggingLevel"], []),
}
}

Expand All @@ -156,18 +156,18 @@ CxPolicy[result] {
resource.Type == "AWS::ApiGateway::Stage"

properties := resource.Properties
loggingLevel := properties.MethodSettings.LoggingLevel
loggingLevel := properties.MethodSettings[j].LoggingLevel
loggingLevel == "OFF"

result := {
"documentId": input.document[i].id,
"resourceType": resource.Type,
"resourceName": cf_lib.get_resource_name(resource, name),
"searchKey": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel", [name]),
"searchKey": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel", [name, j]),
"issueType": "IncorrectValue",
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel should not be set to OFF", [name]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings.LoggingLevel is OFF", [name]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings", "LoggingLevel"], []),
"keyExpectedValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel should not be set to OFF", [name, j]),
"keyActualValue": sprintf("Resources.%s.Properties.MethodSettings[%d].LoggingLevel is OFF", [name, j]),
"searchLine": common_lib.build_search_line(["Resources", name, "Properties", "MethodSettings", j, "LoggingLevel"], []),
}
}

Expand Down
23 changes: 16 additions & 7 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/negative3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,22 @@
"DeploymentId": {
"Ref": "MyDeployment"
},
"MethodSettings": {
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
"MethodSettings": [
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "ERROR",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
],
"RestApiId": {
"Ref": "CFNWebSocket"
}
Expand Down
5 changes: 4 additions & 1 deletion assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/negative4.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ Resources:
DeploymentId: !Ref TestDeployment
DocumentationVersion: ""
MethodSettings:
LoggingLevel: "ON"
- LoggingLevel: "INFO"
DataTraceEnabled: False
- DataTraceEnabled: False
LoggingLevel: "ERROR"
AccessLogSetting:
DestinationArn: "dest"
Format: "format"
4 changes: 3 additions & 1 deletion assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ Resources:
HttpMethod: GET
MetricsEnabled: false
DataTraceEnabled: false
- ResourcePath: /stack
- LoggingLevel: "OFF"
ResourcePath: /stack
HttpMethod: POST
MetricsEnabled: false
DataTraceEnabled: false
- ResourcePath: /stack
HttpMethod: GET
MetricsEnabled: true
DataTraceEnabled: false
LoggingLevel: "INFO"
12 changes: 10 additions & 2 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,16 @@
"RestApiId": {
"Ref": "CFNWebSocket"
},
"MethodSettings": {
}
"MethodSettings": [
{},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
]
}
}
}
Expand Down
30 changes: 23 additions & 7 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive12.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,29 @@
"RestApiId": {
"Ref": "CFNWebSocket"
},
"MethodSettings": {
"DetailedMetricsEnabled": true,
"LoggingLevel": "OFF",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
"MethodSettings": [
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "OFF",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
]
}
}
}
Expand Down
5 changes: 4 additions & 1 deletion assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive14.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ Resources:
DeploymentId: !Ref TestDeployment
DocumentationVersion: ""
MethodSettings:
LoggingLevel: "OFF"
- LoggingLevel: "OFF"
DataTraceEnabled: False
- DataTraceEnabled: False
LoggingLevel: "INFO"
5 changes: 4 additions & 1 deletion assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive16.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ Resources:
DeploymentId: !Ref TestDeployment
DocumentationVersion: ""
MethodSettings:
LoggingLevel: "ON"
- LoggingLevel: "INFO"
DataTraceEnabled: False
- DataTraceEnabled: False
LoggingLevel: "ERROR"
44 changes: 44 additions & 0 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive18.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"MyStage": {
"Type": "AWS::ApiGateway::Stage",
"Properties": {
"StageName": "Prod",
"Description": "Prod Stage",
"AccessLogSetting": {
"DestinationArn": "dest",
"Format": "format"
},
"DeploymentId": {
"Ref": "MyDeployment"
},
"RestApiId": {
"Ref": "CFNWebSocket"
},
"MethodSettings": [
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "OFF",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
]
}
}
}
}
19 changes: 19 additions & 0 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive19.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Resources:
Prod:
Type: AWS::ApiGateway::Stage
Properties:
StageName: Prod
Description: Prod Stage
AccessLogSetting:
DestinationArn: "dest"
Format: "format"
RestApiId: !Ref MyRestApi
DeploymentId: !Ref TestDeployment
DocumentationVersion: ""
MethodSettings:
- DataTraceEnabled: False
LoggingLevel: "OFF"
- DataTraceEnabled: False
LoggingLevel: ""
- LoggingLevel: "INFO"
DataTraceEnabled: False
23 changes: 16 additions & 7 deletions assets/queries/cloudFormation/aws/api_gateway_access_logging_disabled/test/positive6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,22 @@
"DeploymentId": {
"Ref": "MyDeployment"
},
"MethodSettings": {
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
"MethodSettings": [
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "INFO",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
},
{
"DetailedMetricsEnabled": true,
"LoggingLevel": "ERROR",
"DataTraceEnabled": false,
"ThrottlingBurstLimit": 10,
"ThrottlingRateLimit": 10
}
],
"RestApiId": {
"Ref": "CFNWebSocket"
}
Expand Down
40 changes: 35 additions & 5 deletions ...cloudFormation/aws/api_gateway_access_logging_disabled/test/positive_expected_result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 16,
"line": 17,
"fileName": "positive1.yaml"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 21,
"fileName": "positive1.yaml"
},
{
Expand Down Expand Up @@ -56,7 +62,7 @@
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 19,
"line": 22,
"fileName": "positive10.json"
},
{
Expand All @@ -68,13 +74,13 @@
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 13,
"fileName": "positive11.yaml"
"line": 22,
"fileName": "positive12.json"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 21,
"line": 29,
"fileName": "positive12.json"
},
{
Expand Down Expand Up @@ -112,5 +118,29 @@
"severity": "MEDIUM",
"line": 4,
"fileName": "positive17.yaml"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 22,
"fileName": "positive18.json"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 35,
"fileName": "positive18.json"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 15,
"fileName": "positive19.yaml"
},
{
"queryName": "API Gateway V2 Stage Access Logging Settings Not Defined",
"severity": "MEDIUM",
"line": 17,
"fileName": "positive19.yaml"
}
]
Loading
Loading