Skip to content

armgit / fider

Public Imported from GitHub
0

Open platform to collect and prioritize feedback

refactor(webhooks): rename env var to ALLOW_PRIVATE_NETWORK_TARGETS

Matt Roberts480b994b1572
diff --git a/.example.env b/.example.env
index 737c02333..5214e3965 100644
--- a/.example.env
+++ b/.example.env
@@ -3,6 +3,9 @@ GO_ENV=development
DATABASE_URL=postgres://fider:fider_pw@localhost:5555/fider?sslmode=disable
JWT_SECRET=hsjl]W;&ZcHxT&FK;s%bgIQF:#ch=~#Al4:5]N;7V<qPZ3e9lT4'%;go;LIkc%k
# ALLOW_ALLOWED_SCHEMES=false
+# Relaxes the SSRF guard so webhooks and OAuth token/profile URLs may target
+# private/internal network addresses (LAN, loopback, link-local). Self-hosted only.
+# ALLOW_PRIVATE_NETWORK_TARGETS=true
LOG_LEVEL=DEBUG
LOG_CONSOLE=true
diff --git a/app/pkg/env/env.go b/app/pkg/env/env.go
index 889c5d2bb..39b113ed4 100644
--- a/app/pkg/env/env.go
+++ b/app/pkg/env/env.go
@@ -56,7 +56,7 @@ type config struct {
JWTSecret string `env:"JWT_SECRET,required"`
PostCreationWithTagsEnabled bool `env:"POST_CREATION_WITH_TAGS_ENABLED,default=false"`
AllowAllowedSchemes bool `env:"ALLOW_ALLOWED_SCHEMES,default=true"`
- WebhookAllowPrivateIPs bool `env:"WEBHOOK_ALLOW_PRIVATE_IPS,default=false"`
+ AllowPrivateNetworkTargets bool `env:"ALLOW_PRIVATE_NETWORK_TARGETS,default=false"`
Stripe struct {
SecretKey string `env:"STRIPE_SECRET_KEY"`
WebhookSecret string `env:"STRIPE_WEBHOOK_SECRET"`
diff --git a/app/pkg/validate/general.go b/app/pkg/validate/general.go
index 4c456d561..3a4599f08 100644
--- a/app/pkg/validate/general.go
+++ b/app/pkg/validate/general.go
@@ -57,9 +57,10 @@ func URL(ctx context.Context, rawurl string) []string {
}
// WebhookURL validates that a URL is well-formed and, by default, does not target
-// private/internal networks. Self-hosted instances that need to reach internal
-// services (e.g. an integration server on a LAN) can opt out of the network
-// check by setting WEBHOOK_ALLOW_PRIVATE_IPS=true; format validation (valid URL,
+// private/internal networks. This is a shared SSRF guard: besides webhooks it also
+// validates OAuth token/profile URLs. Self-hosted instances that need to reach
+// internal services (e.g. an integration server on a LAN) can relax the network
+// check by setting ALLOW_PRIVATE_NETWORK_TARGETS=true; format validation (valid URL,
// scheme http/https) still applies in that mode.
func WebhookURL(rawurl string) []string {
u, err := url.Parse(rawurl)
@@ -72,7 +73,7 @@ func WebhookURL(rawurl string) []string {
return []string{"Only http and https URLs are allowed."}
}
- if env.Config.WebhookAllowPrivateIPs {
+ if env.Config.AllowPrivateNetworkTargets {
return []string{}
}
diff --git a/app/pkg/validate/general_test.go b/app/pkg/validate/general_test.go
index 357523880..461066a5b 100644
--- a/app/pkg/validate/general_test.go
+++ b/app/pkg/validate/general_test.go
@@ -118,9 +118,9 @@ func TestWebhookURL_AllowedAddresses(t *testing.T) {
func TestWebhookURL_PrivateIPsAllowedWhenOptedIn(t *testing.T) {
RegisterT(t)
- original := env.Config.WebhookAllowPrivateIPs
- env.Config.WebhookAllowPrivateIPs = true
- t.Cleanup(func() { env.Config.WebhookAllowPrivateIPs = original })
+ original := env.Config.AllowPrivateNetworkTargets
+ env.Config.AllowPrivateNetworkTargets = true
+ t.Cleanup(func() { env.Config.AllowPrivateNetworkTargets = original })
for _, rawurl := range []string{
"http://localhost/hook",
@@ -139,9 +139,9 @@ func TestWebhookURL_PrivateIPsAllowedWhenOptedIn(t *testing.T) {
func TestWebhookURL_OptInDoesNotBypassFormatValidation(t *testing.T) {
RegisterT(t)
- original := env.Config.WebhookAllowPrivateIPs
- env.Config.WebhookAllowPrivateIPs = true
- t.Cleanup(func() { env.Config.WebhookAllowPrivateIPs = original })
+ original := env.Config.AllowPrivateNetworkTargets
+ env.Config.AllowPrivateNetworkTargets = true
+ t.Cleanup(func() { env.Config.AllowPrivateNetworkTargets = original })
for _, rawurl := range []string{
"ftp://example.com/hook",