Replace localhost with private IP ranges fetcher

JasonLovesDoggo · Jan 28, 2025 · f910338 · f910338
1 parent d979603
commit f910338
Show file tree

Hide file tree

Showing 12 changed files with 66 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ defender <responder> {
   - `garbage`: Returns garbage data to pollute AI training.
   - `custom`: Returns a custom message (requires `responder_args`).
   - `ratelimit`: Marks requests for rate limiting (requires [Caddy-Ratelimit](https://github.com/mholt/caddy-ratelimit) to be installed as well ).
-- `<ip_ranges...>`: A list of CIDR ranges or predefined range keys (e.g., `openai`, `localhost`) to match against the client's IP.
+- `<ip_ranges...>`: A list of CIDR ranges or predefined range keys (e.g., `openai`, `private`) to match against the client's IP.
 - `<custom message>`: A custom message to return when using the `custom` responder.
 ---
 
@@ -96,16 +96,16 @@ defender <responder> {
 
 The plugin includes predefined IP ranges for popular AI services. These ranges are embedded in the binary and can be used without additional configuration.
 
-| Service               | Key                                         | IP Ranges                                          |
-|-----------------------|---------------------------------------------|----------------------------------------------------|
-| AWS                   | aws                                         | [aws.go](ranges/fetchers/aws/aws.go)               |
-| AWS Region            | aws-us-east-1, aws-us-west-1, aws-eu-west-1 | [aws_region.go](ranges/fetchers/aws/aws_region.go) |
-| DeepSeek              | deepseek                                    | [deepseek.go](ranges/fetchers/deepseek.go)         |
-| GitHub Copilot        | githubcopilot                               | [github.go](ranges/fetchers/github.go)             |
-| Google Cloud Platform | gcloud                                      | [gcloud.go](ranges/fetchers/gcloud.go)             |
-| Microsoft Azure       | azurepubliccloud                            | [azure.go](ranges/fetchers/azure.go)               |
-| OpenAI                | openai                                      | [openai.go](ranges/fetchers/openai.go)             |
-| Localhost (testing)   | localhost                                   | [localhost.go](ranges/fetchers/localhost.go)       |
+| Service                                                              | Key                                         | IP Ranges                                          |
+|----------------------------------------------------------------------|---------------------------------------------|----------------------------------------------------|
+| AWS                                                                  | aws                                         | [aws.go](ranges/fetchers/aws/aws.go)               |
+| AWS Region                                                           | aws-us-east-1, aws-us-west-1, aws-eu-west-1 | [aws_region.go](ranges/fetchers/aws/aws_region.go) |
+| DeepSeek                                                             | deepseek                                    | [deepseek.go](ranges/fetchers/deepseek.go)         |
+| GitHub Copilot                                                       | githubcopilot                               | [github.go](ranges/fetchers/github.go)             |
+| Google Cloud Platform                                                | gcloud                                      | [gcloud.go](ranges/fetchers/gcloud.go)             |
+| Microsoft Azure                                                      | azurepubliccloud                            | [azure.go](ranges/fetchers/azure.go)               |
+| OpenAI                                                               | openai                                      | [openai.go](ranges/fetchers/openai.go)             |
+| [Private](https://caddyserver.com/docs/caddyfile/matchers#remote-ip) | private                                     | [private.go](ranges/fetchers/private.go)           |
 
 More are welcome! for a precompiled list, see the [embedded results](ranges/data/generated.go)
 

diff --git a/config_test.go b/config_test.go
@@ -208,7 +208,7 @@ func TestDefenderValidation(t *testing.T) {
                 {
                   "handler": "defender",
                   "ranges": [
-                    "localhost"
+                    "private"
                   ],
                   "raw_responder": "pineapple"
                 },

diff --git a/docs/examples.md b/docs/examples.md
@@ -82,7 +82,7 @@ Integrate with [caddy-ratelimit](https://github.com/mholt/caddy-ratelimit):
 
 :80 {
 	defender ratelimit {
-		ranges localhost
+		ranges private
 	}
     
 	rate_limit {

diff --git a/examples/block/Caddyfile b/examples/block/Caddyfile
@@ -8,7 +8,7 @@
 	bind 127.0.0.1 ::1
 
 	defender block {
-		ranges localhost
+		ranges private
 	}
 	respond "This is what a human sees"
 }

diff --git a/examples/custom/Caddyfile b/examples/custom/Caddyfile
@@ -8,7 +8,7 @@
 	bind 127.0.0.1 ::1
 
 	defender custom {
-		ranges localhost
+		ranges private
 		message "You are not welcome here"
 	}
 	respond "This is what a human sees"

diff --git a/examples/garbage/Caddyfile b/examples/garbage/Caddyfile
@@ -8,7 +8,7 @@
 	bind 127.0.0.1 ::1
 
 	defender garbage {
-		ranges localhost
+		ranges private
 	}
 	respond "This is what a human sees"
 }

diff --git a/examples/ratelimit/Caddyfile b/examples/ratelimit/Caddyfile
@@ -4,7 +4,7 @@
 
 :80 {
 	defender ratelimit {
-		ranges localhost
+		ranges private
 	}
 
 	rate_limit {

diff --git a/ranges/README.md b/ranges/README.md
@@ -17,14 +17,14 @@ The **Fetchers Module** is a Go package designed to fetch IP ranges for various
 
 ## Supported Fetchers
 
-| Fetcher Name           | Description                                                         |
-|------------------------|---------------------------------------------------------------------|
-| `AWSFetcher`           | Fetches global IP ranges for AWS services.                          |
-| `AWSRegionFetcher`     | Fetches IP ranges for a specific AWS region (e.g., `us-east-1`).    |
-| `GCloudFetcher`        | Fetches IP ranges for Google Cloud Platform (GCP) services.         |
-| `OpenAIFetcher`        | Fetches IP ranges for OpenAI services (e.g., ChatGPT, GPTBot).      |
-| `GithubCopilotFetcher` | Fetches IP ranges for GitHub Copilot services.                      |
-| `LocalhostFetcher`     | Fetches IP ranges for localhost (used for development and testing). |
+| Fetcher Name           | Description                                                      |
+|------------------------|------------------------------------------------------------------|
+| `AWSFetcher`           | Fetches global IP ranges for AWS services.                       |
+| `AWSRegionFetcher`     | Fetches IP ranges for a specific AWS region (e.g., `us-east-1`). |
+| `GCloudFetcher`        | Fetches IP ranges for Google Cloud Platform (GCP) services.      |
+| `OpenAIFetcher`        | Fetches IP ranges for OpenAI services (e.g., ChatGPT, GPTBot).   |
+| `GithubCopilotFetcher` | Fetches IP ranges for GitHub Copilot services.                   |
+| `PrivateFetcher`       | Fetches IP ranges for private network ranges (used for testing). |
 
 ---
 
@@ -63,16 +63,16 @@ func main() {
 
 The `IPRanges` map in the `data` package contains the following keys:
 
-| Key               | Description                                                                 |
-|-------------------|-----------------------------------------------------------------------------|
-| `aws`             | Global IP ranges for AWS services.                                          |
-| `aws-us-east-1`   | IP ranges for the AWS `us-east-1` region.                                   |
-| `aws-us-west-1`   | IP ranges for the AWS `us-west-1` region.                                   |
-| `aws-eu-west-1`   | IP ranges for the AWS `eu-west-1` region.                                   |
-| `gcloud`          | IP ranges for Google Cloud Platform (GCP) services.                         |
-| `openai`          | IP ranges for OpenAI services (e.g., ChatGPT, GPTBot).                      |
-| `githubcopilot`   | IP ranges for GitHub Copilot services.                                      |
-| `localhost`       | IP ranges for localhost (used for development and testing).                 |
+| Key             | Description                                            |
+|-----------------|--------------------------------------------------------|
+| `aws`           | Global IP ranges for AWS services.                     |
+| `aws-us-east-1` | IP ranges for the AWS `us-east-1` region.              |
+| `aws-us-west-1` | IP ranges for the AWS `us-west-1` region.              |
+| `aws-eu-west-1` | IP ranges for the AWS `eu-west-1` region.              |
+| `gcloud`        | IP ranges for Google Cloud Platform (GCP) services.    |
+| `openai`        | IP ranges for OpenAI services (e.g., ChatGPT, GPTBot). |
+| `githubcopilot` | IP ranges for GitHub Copilot services.                 |
+| `private`       | IP ranges for private networks (used for testing).     |
 
 ### Regenerating Pregenerated Results
 

diff --git a/ranges/data/generated.go b/ranges/data/generated.go
diff --git a/ranges/fetchers/localhost.go b/ranges/fetchers/localhost.go
diff --git a/ranges/fetchers/private.go b/ranges/fetchers/private.go
@@ -0,0 +1,22 @@
+package fetchers
+
+// PrivateFetcher implements the IPRangeFetcher interface for private network ranges.
+type PrivateFetcher struct{}
+
+func (f PrivateFetcher) Name() string {
+	return "Private"
+}
+func (f PrivateFetcher) Description() string {
+	return "Hardcoded IP ranges for private network ranges. Used in testing."
+}
+func (f PrivateFetcher) FetchIPRanges() ([]string, error) {
+
+	return []string{
+		"127.0.0.0/8",
+		"::1/128",
+		"10.0.0.0/8",
+		"172.16.0.0/12",
+		"192.168.0.0/16",
+		"fd00::/8",
+	}, nil
+}
diff --git a/ranges/main.go b/ranges/main.go
@@ -36,7 +36,7 @@ func main() {
 		aws.AWSRegionFetcher{Region: "us-east-1"}, // us-east-1 region
 		aws.AWSRegionFetcher{Region: "us-west-1"}, // us-west-1 region
 		aws.AWSRegionFetcher{Region: "eu-west-1"}, // eu-west-1 region
-		fetchers.LocalhostFetcher{},
+		fetchers.PrivateFetcher{},
 	}
 
 	// Load the existing IP ranges from the data package