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

Add checks for azure databases #946

Merged
merged 2 commits into from
Jul 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions cmd/tfsec-docs/webpage.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ func formatProviderName(providerName string) string {
switch providerName {
case "aws":
return strings.ToUpper(providerName)
case "openstack":
return "OpenStack"
default:
return strings.Title(strings.ToLower(providerName))
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
package database

import (
"fmt"

"github.com/aquasecurity/tfsec/pkg/result"
"github.com/aquasecurity/tfsec/pkg/severity"

"github.com/aquasecurity/tfsec/pkg/provider"

"github.com/aquasecurity/tfsec/internal/app/tfsec/hclcontext"

"github.com/aquasecurity/tfsec/internal/app/tfsec/block"

"github.com/aquasecurity/tfsec/pkg/rule"

"github.com/aquasecurity/tfsec/internal/app/tfsec/scanner"
)

func init() {
scanner.RegisterCheckRule(rule.Rule{
Service: "database",
ShortCode: "enable-ssl-enforcement",
Documentation: rule.RuleDocumentation{
Summary: "SSL should be enforced on database connections where applicable",
Explanation: `SSL connections should be enforced were available to ensure secure transfer and reduce the risk of compromising data in flight.`,
Impact: "Insecure connections could lead to data loss and other vulnerabilities",
Resolution: "Enable SSL enforcement",
BadExample: `
resource "azurerm_postgresql_server" "bad_example" {
name = "bad_example"

public_network_access_enabled = false
ssl_enforcement_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
GoodExample: `
resource "azurerm_postgresql_server" "good_example" {
name = "good_example"

public_network_access_enabled = false
ssl_enforcement_enabled = true
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
Links: []string{
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/postgresql_server#ssl_enforcement_enabled",
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mysql_server#ssl_enforcement_enabled",
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mariadb_server#ssl_enforcement_enabled",
},
},
Provider: provider.AzureProvider,
RequiredTypes: []string{"resource"},
RequiredLabels: []string{"azurerm_mariadb_server", "azurerm_mysql_server", "azurerm_postgresql_server"},
DefaultSeverity: severity.Medium,
CheckFunc: func(set result.Set, resourceBlock block.Block, _ *hclcontext.Context) {

if resourceBlock.MissingChild("ssl_enforcement_enabled") {
set.Add(
result.New(resourceBlock).
WithDescription(fmt.Sprintf("Resource '%s' is missing the required ssl_enforcement_enabled attribute", resourceBlock.FullName())),
)
return
}

sslEnforceAttr := resourceBlock.GetAttribute("ssl_enforcement_enabled")
if sslEnforceAttr.IsFalse() {
set.Add(
result.New(resourceBlock).
WithDescription(fmt.Sprintf("Resource '%s' has ssl_enforcement_enabled disabled", resourceBlock.FullName())).
WithRange(sslEnforceAttr.Range()).
WithAttributeAnnotation(sslEnforceAttr),
)
}
},
})
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package database

import (
"testing"

"github.com/aquasecurity/tfsec/internal/app/tfsec/testutil"
)

func Test_AzureEnableSslEnforcement(t *testing.T) {
expectedCode := "azure-database-enable-ssl-enforcement"

var tests = []struct {
name string
source string
mustIncludeResultCode string
mustExcludeResultCode string
}{
{
name: "server with ssl enforcement disabled fails check",
source: `
resource "azurerm_postgresql_server" "bad_example" {
name = "bad_example"

public_network_access_enabled = false
ssl_enforcement_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}`,
mustIncludeResultCode: expectedCode,
},
{
name: "server with ssl enforcement not set fails check",
source: `
resource "azurerm_mariadb_server" "bad_example" {
name = "bad_example"

public_network_access_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}`,
mustIncludeResultCode: expectedCode,
},
{
name: "server ssl enforcement enabled passes check",
source: `
resource "azurerm_mysql_server" "goodl_example" {
name = "goodl_example"

public_network_access_enabled = true
ssl_enforcement_enabled = true
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
mustExcludeResultCode: expectedCode,
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {

results := testutil.ScanHCL(test.source, t)
testutil.AssertCheckCode(t, test.mustIncludeResultCode, test.mustExcludeResultCode, results)
})
}
}
78 changes: 78 additions & 0 deletions internal/app/tfsec/rules/azure/database/no_public_access_rule.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
package database

import (
"fmt"

"github.com/aquasecurity/tfsec/pkg/result"
"github.com/aquasecurity/tfsec/pkg/severity"

"github.com/aquasecurity/tfsec/pkg/provider"

"github.com/aquasecurity/tfsec/internal/app/tfsec/hclcontext"

"github.com/aquasecurity/tfsec/internal/app/tfsec/block"

"github.com/aquasecurity/tfsec/pkg/rule"

"github.com/aquasecurity/tfsec/internal/app/tfsec/scanner"
)

func init() {
scanner.RegisterCheckRule(rule.Rule{
Service: "database",
ShortCode: "no-public-access",
Documentation: rule.RuleDocumentation{
Summary: "Ensure databases are not publicly accessible",
Explanation: `Database resources should not publicly available. You should limit all access to the minimum that is required for your application to function.`,
Impact: "Publicly accessible database could lead to compromised data",
Resolution: "Disable public access to database when not required",
BadExample: `
resource "azurerm_postgresql_server" "bad_example" {
name = "bad_example"

public_network_access_enabled = true
ssl_enforcement_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
GoodExample: `
resource "azurerm_postgresql_server" "good_example" {
name = "bad_example"

public_network_access_enabled = false
ssl_enforcement_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
Links: []string{
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/postgresql_server#public_network_access_enabled",
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mysql_server#public_network_access_enabled",
"https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mariadb_server#public_network_access_enabled",
},
},
Provider: provider.AzureProvider,
RequiredTypes: []string{"resource"},
RequiredLabels: []string{"azurerm_mariadb_server", "azurerm_mssql_server", "azurerm_mysql_server", "azurerm_postgresql_server"},
DefaultSeverity: severity.Medium,
CheckFunc: func(set result.Set, resourceBlock block.Block, _ *hclcontext.Context) {

if resourceBlock.MissingChild("public_network_access_enabled") {
set.Add(
result.New(resourceBlock).
WithDescription(fmt.Sprintf("Resource '%s' has default public network access of enabled", resourceBlock.FullName())),
)
return
}

publicAccessAttr := resourceBlock.GetAttribute("public_network_access_enabled")
if publicAccessAttr.IsTrue() {
set.Add(
result.New(resourceBlock).
WithDescription(fmt.Sprintf("Resource '%s' has public access explicitly enabled", resourceBlock.FullName())).
WithRange(publicAccessAttr.Range()).
WithAttributeAnnotation(publicAccessAttr),
)
}
},
})
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package database

import (
"testing"

"github.com/aquasecurity/tfsec/internal/app/tfsec/testutil"
)

func Test_AzureNoPublicAccess(t *testing.T) {
expectedCode := "azure-database-no-public-access"

var tests = []struct {
name string
source string
mustIncludeResultCode string
mustExcludeResultCode string
}{
{
name: "server with public access enabled fails check",
source: `
resource "azurerm_postgresql_server" "bad_example" {
name = "bad_example"

public_network_access_enabled = true
ssl_enforcement_enabled = false
ssl_minimal_tls_version_enforced = "TLS1_2"
}`,
mustIncludeResultCode: expectedCode,
},
{
name: "server with public access not set fails check",
source: `
resource "azurerm_mariadb_server" "bad_example" {
name = "bad_example"


ssl_minimal_tls_version_enforced = "TLS1_2"
}`,
mustIncludeResultCode: expectedCode,
},
{
name: "server public access disabled passes check",
source: `
resource "azurerm_mysql_server" "goodl_example" {
name = "goodl_example"

public_network_access_enabled = false
ssl_enforcement_enabled = true
ssl_minimal_tls_version_enforced = "TLS1_2"
}
`,
mustExcludeResultCode: expectedCode,
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {

results := testutil.ScanHCL(test.source, t)
testutil.AssertCheckCode(t, test.mustIncludeResultCode, test.mustExcludeResultCode, results)
})
}
}