forked from kubernetes/ingress-nginx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding ipdenylist annotation (kubernetes#8795)
* feat: Add support for IP Deny List * fixed gomod * Update package * go mod tidy * Revert "go mod tidy" This reverts commit e6a837e. * update ginko version * Updates e2e tests * fix test typo
- Loading branch information
1 parent
bbf7c79
commit 8ed3a27
Showing
15 changed files
with
3,568 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| Copyright 2023 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package ipdenylist | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| networking "k8s.io/api/networking/v1" | ||
| "k8s.io/ingress-nginx/internal/net" | ||
|
|
||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| ing_errors "k8s.io/ingress-nginx/internal/ingress/errors" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| "k8s.io/ingress-nginx/pkg/util/sets" | ||
| ) | ||
|
|
||
| // SourceRange returns the CIDR | ||
| type SourceRange struct { | ||
| CIDR []string `json:"cidr,omitempty"` | ||
| } | ||
|
|
||
| // Equal tests for equality between two SourceRange types | ||
| func (sr1 *SourceRange) Equal(sr2 *SourceRange) bool { | ||
| if sr1 == sr2 { | ||
| return true | ||
| } | ||
| if sr1 == nil || sr2 == nil { | ||
| return false | ||
| } | ||
|
|
||
| return sets.StringElementsMatch(sr1.CIDR, sr2.CIDR) | ||
| } | ||
|
|
||
| type ipdenylist struct { | ||
| r resolver.Resolver | ||
| } | ||
|
|
||
| // NewParser creates a new denylist annotation parser | ||
| func NewParser(r resolver.Resolver) parser.IngressAnnotation { | ||
| return ipdenylist{r} | ||
| } | ||
|
|
||
| // ParseAnnotations parses the annotations contained in the ingress | ||
| // rule used to limit access to certain client addresses or networks. | ||
| // Multiple ranges can specified using commas as separator | ||
| // e.g. `18.0.0.0/8,56.0.0.0/8` | ||
| func (a ipdenylist) Parse(ing *networking.Ingress) (interface{}, error) { | ||
| defBackend := a.r.GetDefaultBackend() | ||
|
|
||
| defaultDenylistSourceRange := make([]string, len(defBackend.DenylistSourceRange)) | ||
| copy(defaultDenylistSourceRange, defBackend.DenylistSourceRange) | ||
| sort.Strings(defaultDenylistSourceRange) | ||
|
|
||
| val, err := parser.GetStringAnnotation("denylist-source-range", ing) | ||
| // A missing annotation is not a problem, just use the default | ||
| if err == ing_errors.ErrMissingAnnotations { | ||
| return &SourceRange{CIDR: defaultDenylistSourceRange}, nil | ||
| } | ||
|
|
||
| values := strings.Split(val, ",") | ||
| ipnets, ips, err := net.ParseIPNets(values...) | ||
| if err != nil && len(ips) == 0 { | ||
| return &SourceRange{CIDR: defaultDenylistSourceRange}, ing_errors.LocationDenied{ | ||
| Reason: fmt.Errorf("the annotation does not contain a valid IP address or network: %w", err), | ||
| } | ||
| } | ||
|
|
||
| cidrs := []string{} | ||
| for k := range ipnets { | ||
| cidrs = append(cidrs, k) | ||
| } | ||
| for k := range ips { | ||
| cidrs = append(cidrs, k) | ||
| } | ||
|
|
||
| sort.Strings(cidrs) | ||
|
|
||
| return &SourceRange{cidrs}, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| /* | ||
| Copyright 2023 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package ipdenylist | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| api "k8s.io/api/core/v1" | ||
| networking "k8s.io/api/networking/v1" | ||
| meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| "k8s.io/ingress-nginx/internal/ingress/defaults" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| ) | ||
|
|
||
| func buildIngress() *networking.Ingress { | ||
| defaultBackend := networking.IngressBackend{ | ||
| Service: &networking.IngressServiceBackend{ | ||
| Name: "default-backend", | ||
| Port: networking.ServiceBackendPort{ | ||
| Number: 80, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| return &networking.Ingress{ | ||
| ObjectMeta: meta_v1.ObjectMeta{ | ||
| Name: "foo", | ||
| Namespace: api.NamespaceDefault, | ||
| }, | ||
| Spec: networking.IngressSpec{ | ||
| DefaultBackend: &networking.IngressBackend{ | ||
| Service: &networking.IngressServiceBackend{ | ||
| Name: "default-backend", | ||
| Port: networking.ServiceBackendPort{ | ||
| Number: 80, | ||
| }, | ||
| }, | ||
| }, | ||
| Rules: []networking.IngressRule{ | ||
| { | ||
| Host: "foo.bar.com", | ||
| IngressRuleValue: networking.IngressRuleValue{ | ||
| HTTP: &networking.HTTPIngressRuleValue{ | ||
| Paths: []networking.HTTPIngressPath{ | ||
| { | ||
| Path: "/foo", | ||
| Backend: defaultBackend, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func TestParseAnnotations(t *testing.T) { | ||
| ing := buildIngress() | ||
| tests := map[string]struct { | ||
| net string | ||
| expectCidr []string | ||
| expectErr bool | ||
| errOut string | ||
| }{ | ||
| "test parse a valid net": { | ||
| net: "10.0.0.0/24", | ||
| expectCidr: []string{"10.0.0.0/24"}, | ||
| expectErr: false, | ||
| }, | ||
| "test parse a invalid net": { | ||
| net: "ww", | ||
| expectErr: true, | ||
| errOut: "the annotation does not contain a valid IP address or network: invalid CIDR address: ww", | ||
| }, | ||
| "test parse a empty net": { | ||
| net: "", | ||
| expectErr: true, | ||
| errOut: "the annotation does not contain a valid IP address or network: invalid CIDR address: ", | ||
| }, | ||
| "test parse a malicious escaped string": { | ||
| net: `10.0.0.0/8"rm /tmp",11.0.0.0/8`, | ||
| expectErr: true, | ||
| errOut: `the annotation does not contain a valid IP address or network: invalid CIDR address: 10.0.0.0/8"rm /tmp"`, | ||
| }, | ||
| "test parse multiple valid cidr": { | ||
| net: "2.2.2.2/32,1.1.1.1/32,3.3.3.0/24", | ||
| expectCidr: []string{"1.1.1.1/32", "2.2.2.2/32", "3.3.3.0/24"}, | ||
| expectErr: false, | ||
| }, | ||
| } | ||
|
|
||
| for testName, test := range tests { | ||
| data := map[string]string{} | ||
| data[parser.GetAnnotationWithPrefix("denylist-source-range")] = test.net | ||
| ing.SetAnnotations(data) | ||
| p := NewParser(&resolver.Mock{}) | ||
| i, err := p.Parse(ing) | ||
| if err != nil && !test.expectErr { | ||
| t.Errorf("%v:unexpected error: %v", testName, err) | ||
| } | ||
| if test.expectErr { | ||
| if err.Error() != test.errOut { | ||
| t.Errorf("%v:expected error: %v but %v return", testName, test.errOut, err.Error()) | ||
| } | ||
| } | ||
| if !test.expectErr { | ||
| sr, ok := i.(*SourceRange) | ||
| if !ok { | ||
| t.Errorf("%v:expected a SourceRange type", testName) | ||
| } | ||
| if !strsEquals(sr.CIDR, test.expectCidr) { | ||
| t.Errorf("%v:expected %v CIDR but %v returned", testName, test.expectCidr, sr.CIDR) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| type mockBackend struct { | ||
| resolver.Mock | ||
| } | ||
|
|
||
| // GetDefaultBackend returns the backend that must be used as default | ||
| func (m mockBackend) GetDefaultBackend() defaults.Backend { | ||
| return defaults.Backend{ | ||
| DenylistSourceRange: []string{"4.4.4.0/24", "1.2.3.4/32"}, | ||
| } | ||
| } | ||
|
|
||
| // Test that when we have a denylist set on the Backend that is used when we | ||
| // don't have the annotation | ||
| func TestParseAnnotationsWithDefaultConfig(t *testing.T) { | ||
| ing := buildIngress() | ||
|
|
||
| mockBackend := mockBackend{} | ||
|
|
||
| tests := map[string]struct { | ||
| net string | ||
| expectCidr []string | ||
| expectErr bool | ||
| errOut string | ||
| }{ | ||
| "test parse a valid net": { | ||
| net: "10.0.0.0/24", | ||
| expectCidr: []string{"10.0.0.0/24"}, | ||
| expectErr: false, | ||
| }, | ||
| "test parse a invalid net": { | ||
| net: "ww", | ||
| expectErr: true, | ||
| errOut: "the annotation does not contain a valid IP address or network: invalid CIDR address: ww", | ||
| }, | ||
| "test parse a empty net": { | ||
| net: "", | ||
| expectErr: true, | ||
| errOut: "the annotation does not contain a valid IP address or network: invalid CIDR address: ", | ||
| }, | ||
| "test parse multiple valid cidr": { | ||
| net: "2.2.2.2/32,1.1.1.1/32,3.3.3.0/24", | ||
| expectCidr: []string{"1.1.1.1/32", "2.2.2.2/32", "3.3.3.0/24"}, | ||
| expectErr: false, | ||
| }, | ||
| } | ||
|
|
||
| for testName, test := range tests { | ||
| data := map[string]string{} | ||
| data[parser.GetAnnotationWithPrefix("denylist-source-range")] = test.net | ||
| ing.SetAnnotations(data) | ||
| p := NewParser(mockBackend) | ||
| i, err := p.Parse(ing) | ||
| if err != nil && !test.expectErr { | ||
| t.Errorf("%v:unexpected error: %v", testName, err) | ||
| } | ||
| if test.expectErr { | ||
| if err.Error() != test.errOut { | ||
| t.Errorf("%v:expected error: %v but %v return", testName, test.errOut, err.Error()) | ||
| } | ||
| } | ||
| if !test.expectErr { | ||
| sr, ok := i.(*SourceRange) | ||
| if !ok { | ||
| t.Errorf("%v:expected a SourceRange type", testName) | ||
| } | ||
| if !strsEquals(sr.CIDR, test.expectCidr) { | ||
| t.Errorf("%v:expected %v CIDR but %v returned", testName, test.expectCidr, sr.CIDR) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func strsEquals(a, b []string) bool { | ||
| if len(a) != len(b) { | ||
| return false | ||
| } | ||
| for i, v := range a { | ||
| if v != b[i] { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.