Add example

aledbf · aledbf · commit 64f4cfe44da0 · 2016-06-13T14:22:03.000-04:00
diff --git a/ingress/controllers/nginx/controller.go b/ingress/controllers/nginx/controller.go
@@ -698,7 +698,7 @@ func (lbc *loadBalancerController) getUpstreamServers(ngxCfg config.Configuratio
 				glog.V(3).Infof("error parsing rewrite annotations for Ingress rule %v/%v: %v", ing.GetNamespace(), ing.GetName(), err)
 			}
 
-			wl, err := ipwhitelist.ParseAnnotations(ngxCfg.WhiteList, ing)
+			wl, err := ipwhitelist.ParseAnnotations(ngxCfg.WhitelistSourceRange, ing)
 			glog.V(3).Infof("nginx white list %v", wl)
 			if err != nil {
 				glog.V(3).Infof("error reading white list annotation in Ingress %v/%v: %v", ing.GetNamespace(), ing.GetName(), err)
diff --git a/ingress/controllers/nginx/examples/whitelist/README.md b/ingress/controllers/nginx/examples/whitelist/README.md
@@ -0,0 +1,122 @@
+
+This example shows how is possible to restrict access
+
+echo "
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: whitelist
+  annotations:
+    ingress.kubernetes.io/whitelist-source-range: "1.1.1.1/24"
+spec:
+  rules:
+  - host: foo.bar.com
+    http:
+      paths:
+      - path: /
+        backend:
+          serviceName: echoheaders
+          servicePort: 80
+" | kubectl create -f -
+
+
+Check the annotation is present in the Ingress rule:
+```
+$ kubectl get ingress whitelist -o yaml
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  annotations:
+    ingress.kubernetes.io/whitelist-source-range: 1.1.1.1/24
+  creationTimestamp: 2016-06-09T21:39:06Z
+  generation: 2
+  name: whitelist
+  namespace: default
+  resourceVersion: "419363"
+  selfLink: /apis/extensions/v1beta1/namespaces/default/ingresses/whitelist
+  uid: 97b74737-2e8a-11e6-90db-080027d2dc94
+spec:
+  rules:
+  - host: whitelist.bar.com
+    http:
+      paths:
+      - backend:
+          serviceName: echoheaders
+          servicePort: 80
+        path: /
+status:
+  loadBalancer:
+    ingress:
+    - ip: 172.17.4.99
+``
+
+Finally test is not possible to access the URL
+
+```
+$ curl -v http://172.17.4.99/ -H 'Host: whitelist.bar.com'
+*   Trying 172.17.4.99...
+* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0)
+> GET / HTTP/1.1
+> Host: whitelist.bar.com
+> User-Agent: curl/7.43.0
+> Accept: */*
+>
+< HTTP/1.1 403 Forbidden
+< Server: nginx/1.11.1
+< Date: Thu, 09 Jun 2016 21:56:17 GMT
+< Content-Type: text/html
+< Content-Length: 169
+< Connection: keep-alive
+<
+<html>
+<head><title>403 Forbidden</title></head>
+<body bgcolor="white">
+<center><h1>403 Forbidden</h1></center>
+<hr><center>nginx/1.11.1</center>
+</body>
+</html>
+* Connection #0 to host 172.17.4.99 left intact
+```
+
+Removing the annotation removes the restriction
+
+```
+*   Trying 172.17.4.99...
+* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0)
+> GET / HTTP/1.1
+> Host: whitelist.bar.com
+> User-Agent: curl/7.43.0
+> Accept: */*
+>
+< HTTP/1.1 200 OK
+< Server: nginx/1.11.1
+< Date: Thu, 09 Jun 2016 21:57:44 GMT
+< Content-Type: text/plain
+< Transfer-Encoding: chunked
+< Connection: keep-alive
+<
+CLIENT VALUES:
+client_address=10.2.89.7
+command=GET
+real path=/
+query=nil
+request_version=1.1
+request_uri=http://whitelist.bar.com:8080/
+
+SERVER VALUES:
+server_version=nginx: 1.9.11 - lua: 10001
+
+HEADERS RECEIVED:
+accept=*/*
+connection=close
+host=whitelist.bar.com
+user-agent=curl/7.43.0
+x-forwarded-for=10.2.89.1
+x-forwarded-host=whitelist.bar.com
+x-forwarded-port=80
+x-forwarded-proto=http
+x-real-ip=10.2.89.1
+BODY:
+* Connection #0 to host 172.17.4.99 left intact
+```
+
diff --git a/ingress/controllers/nginx/nginx/config/config.go b/ingress/controllers/nginx/nginx/config/config.go
@@ -233,9 +233,9 @@ type Configuration struct {
 	// Responses with the “text/html” type are always compressed if UseGzip is enabled
 	GzipTypes string `structs:"gzip-types,omitempty"`
 
-	// WhiteList allows limiting access to certain client addresses.
+	// WhitelistSourceRange allows limiting access to certain client addresses
 	// http://nginx.org/en/docs/http/ngx_http_access_module.html
-	WhiteList []string `structs:"whitelist,omitempty"`
+	WhitelistSourceRange []string `structs:"whitelist-source-range,omitempty"`
 
 	// Defines the number of worker processes. By default auto means number of available CPU cores
 	// http://nginx.org/en/docs/ngx_core_module.html#worker_processes
@@ -274,7 +274,7 @@ func NewDefault() Configuration {
 		VtsStatusZoneSize:        "10m",
 		UseHTTP2:                 true,
 		CustomHTTPErrors:         make([]int, 0),
-		WhiteList:                make([]string, 0),
+		WhitelistSourceRange:     make([]string, 0),
 	}
 
 	if glog.V(5) {
diff --git a/ingress/controllers/nginx/nginx/ipwhitelist/main.go b/ingress/controllers/nginx/nginx/ipwhitelist/main.go
@@ -18,13 +18,14 @@ package ipwhitelist
 
 import (
 	"errors"
+	"strings"
 
 	"k8s.io/kubernetes/pkg/apis/extensions"
 	"k8s.io/kubernetes/pkg/util/net/sets"
 )
 
 const (
-	whitelist = "ingress.kubernetes.io/whitelist"
+	whitelist = "ingress.kubernetes.io/whitelist-source-range"
 )
 
 var (
@@ -37,8 +38,8 @@ var (
 	ErrInvalidCIDR = errors.New("the annotation does not contains a valid IP address or network")
 )
 
-// Whitelist returns the CIDR
-type Whitelist struct {
+// SourceRange returns the CIDR
+type SourceRange struct {
 	CIDR []string
 }
 
@@ -50,30 +51,33 @@ func (a ingAnnotations) whitelist() ([]string, error) {
 		return nil, ErrMissingWhitelist
 	}
 
-	ipnet, err := sets.ParseIPNets(val)
+	values := strings.Split(val, ",")
+	ipnets, err := sets.ParseIPNets(values...)
 	if err != nil {
 		return nil, ErrInvalidCIDR
 	}
 
-	nets := make([]string, 0)
-	for k := range ipnet {
-		nets = append(nets, k)
+	cidrs := make([]string, 0)
+	for k := range ipnets {
+		cidrs = append(cidrs, k)
 	}
 
-	return nets, nil
+	return cidrs, nil
 }
 
 // ParseAnnotations parses the annotations contained in the ingress
-// rule used to configure upstream check parameters
-func ParseAnnotations(whiteList []string, ing *extensions.Ingress) (*Whitelist, error) {
+// 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 ParseAnnotations(whiteList []string, ing *extensions.Ingress) (*SourceRange, error) {
 	if ing.GetAnnotations() == nil {
-		return &Whitelist{whiteList}, ErrMissingWhitelist
+		return &SourceRange{whiteList}, ErrMissingWhitelist
 	}
 
 	wl, err := ingAnnotations(ing.GetAnnotations()).whitelist()
 	if err != nil {
 		wl = whiteList
 	}
 
-	return &Whitelist{wl}, err
+	return &SourceRange{wl}, err
 }
diff --git a/ingress/controllers/nginx/nginx/ipwhitelist/main_test.go b/ingress/controllers/nginx/nginx/ipwhitelist/main_test.go
@@ -83,4 +83,16 @@ func TestAnnotations(t *testing.T) {
 	if !reflect.DeepEqual(wl, enet) {
 		t.Errorf("Expected %v but returned %s", enet, wl)
 	}
+
+	data[whitelist] = "10.0.0.0/24,10.0.1.0/25"
+	ing.SetAnnotations(data)
+
+	wl, err = ingAnnotations(ing.GetAnnotations()).whitelist()
+	if err != nil {
+		t.Errorf("Unexpected error: %v", err)
+	}
+
+	if len(wl) != 2 {
+		t.Errorf("Expected 2 netwotks but %v was returned", len(wl))
+	}
 }
diff --git a/ingress/controllers/nginx/nginx/nginx.go b/ingress/controllers/nginx/nginx/nginx.go
@@ -100,7 +100,7 @@ type Location struct {
 	RateLimit      ratelimit.RateLimit
 	Redirect       rewrite.Redirect
 	SecureUpstream bool
-	Whitelist      ipwhitelist.Whitelist
+	Whitelist      ipwhitelist.SourceRange
 }
 
 // LocationByPath sorts location by path

Original file line number	Diff line number	Diff line change
`@@ -698,7 +698,7 @@ func (lbc *loadBalancerController) getUpstreamServers(ngxCfg config.Configuratio`
`698`	`698`	`glog.V(3).Infof("error parsing rewrite annotations for Ingress rule %v/%v: %v", ing.GetNamespace(), ing.GetName(), err)`
`699`	`699`	`}`
`700`	`700`
`701`		`- wl, err := ipwhitelist.ParseAnnotations(ngxCfg.WhiteList, ing)`
	`701`	`+ wl, err := ipwhitelist.ParseAnnotations(ngxCfg.WhitelistSourceRange, ing)`
`702`	`702`	`glog.V(3).Infof("nginx white list %v", wl)`
`703`	`703`	`if err != nil {`
`704`	`704`	`glog.V(3).Infof("error reading white list annotation in Ingress %v/%v: %v", ing.GetNamespace(), ing.GetName(), err)`
Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,14 @@ package ipwhitelist`
`18`	`18`
`19`	`19`	`import (`
`20`	`20`	`"errors"`
	`21`	`+ "strings"`
`21`	`22`
`22`	`23`	`"k8s.io/kubernetes/pkg/apis/extensions"`
`23`	`24`	`"k8s.io/kubernetes/pkg/util/net/sets"`
`24`	`25`	`)`
`25`	`26`
`26`	`27`	`const (`
`27`		`- whitelist = "ingress.kubernetes.io/whitelist"`
	`28`	`+ whitelist = "ingress.kubernetes.io/whitelist-source-range"`
`28`	`29`	`)`
`29`	`30`
`30`	`31`	`var (`
`@@ -37,8 +38,8 @@ var (`
`37`	`38`	`ErrInvalidCIDR = errors.New("the annotation does not contains a valid IP address or network")`
`38`	`39`	`)`
`39`	`40`
`40`		`-// Whitelist returns the CIDR`
`41`		`-type Whitelist struct {`
	`41`	`+// SourceRange returns the CIDR`
	`42`	`+type SourceRange struct {`
`42`	`43`	`CIDR []string`
`43`	`44`	`}`
`44`	`45`
`@@ -50,30 +51,33 @@ func (a ingAnnotations) whitelist() ([]string, error) {`
`50`	`51`	`return nil, ErrMissingWhitelist`
`51`	`52`	`}`
`52`	`53`
`53`		`- ipnet, err := sets.ParseIPNets(val)`
	`54`	`+ values := strings.Split(val, ",")`
	`55`	`+ ipnets, err := sets.ParseIPNets(values...)`
`54`	`56`	`if err != nil {`
`55`	`57`	`return nil, ErrInvalidCIDR`
`56`	`58`	`}`
`57`	`59`
`58`		`- nets := make([]string, 0)`
`59`		`- for k := range ipnet {`
`60`		`- nets = append(nets, k)`
	`60`	`+ cidrs := make([]string, 0)`
	`61`	`+ for k := range ipnets {`
	`62`	`+ cidrs = append(cidrs, k)`
`61`	`63`	`}`
`62`	`64`
`63`		`- return nets, nil`
	`65`	`+ return cidrs, nil`
`64`	`66`	`}`
`65`	`67`
`66`	`68`	`// ParseAnnotations parses the annotations contained in the ingress`
`67`		`-// rule used to configure upstream check parameters`
`68`		`-func ParseAnnotations(whiteList []string, ing extensions.Ingress) (Whitelist, error) {`
	`69`	`+// rule used to limit access to certain client addresses or networks.`
	`70`	`+// Multiple ranges can specified using commas as separator`
	`71`	+// e.g. `18.0.0.0/8,56.0.0.0/8`
	`72`	`+func ParseAnnotations(whiteList []string, ing extensions.Ingress) (SourceRange, error) {`
`69`	`73`	`if ing.GetAnnotations() == nil {`
`70`		`- return &Whitelist{whiteList}, ErrMissingWhitelist`
	`74`	`+ return &SourceRange{whiteList}, ErrMissingWhitelist`
`71`	`75`	`}`
`72`	`76`
`73`	`77`	`wl, err := ingAnnotations(ing.GetAnnotations()).whitelist()`
`74`	`78`	`if err != nil {`
`75`	`79`	`wl = whiteList`
`76`	`80`	`}`
`77`	`81`
`78`		`- return &Whitelist{wl}, err`
	`82`	`+ return &SourceRange{wl}, err`
`79`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ type Location struct {`
`100`	`100`	`RateLimit ratelimit.RateLimit`
`101`	`101`	`Redirect rewrite.Redirect`
`102`	`102`	`SecureUpstream bool`
`103`		`- Whitelist ipwhitelist.Whitelist`
	`103`	`+ Whitelist ipwhitelist.SourceRange`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`// LocationByPath sorts location by path`