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 NoAuthLocations and default it to "/.well-known/acme-challenge" #2243

Merged

Conversation

alvaroaleman
Copy link
Member

What this PR does / why we need it:

Allows to configure locations that should not be authenticated, very usefull e.G. for Let's encrypt/ACME.

Basically the same as #2203 but for authentication instead of TLS upgrading.

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #

Special notes for your reviewer:

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 22, 2018
@alvaroaleman alvaroaleman force-pushed the configurable-locations-to-omit-auth branch 3 times, most recently from 8d3387d to 7840f4e Compare March 22, 2018 21:37
@codecov-io
Copy link

codecov-io commented Mar 22, 2018

Codecov Report

Merging #2243 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2243      +/-   ##
==========================================
+ Coverage    37.3%   37.31%   +0.01%     
==========================================
  Files          71       71              
  Lines        5042     5043       +1     
==========================================
+ Hits         1881     1882       +1     
  Misses       2876     2876              
  Partials      285      285
Impacted Files Coverage Δ
internal/file/bindata.go 53.93% <ø> (ø) ⬆️
internal/ingress/controller/config/config.go 98.18% <100%> (+0.01%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9b4d7f2...d4ac563. Read the comment docs.

@alvaroaleman alvaroaleman force-pushed the configurable-locations-to-omit-auth branch from 7840f4e to 3562119 Compare March 24, 2018 14:09
@aledbf
Copy link
Member

aledbf commented Mar 28, 2018

@alvaroaleman please add e2e tests. Like two ingresses, one with basic authentication in the path / and another with /noauth checking the new settings allows access to /noauth.

@alvaroaleman alvaroaleman force-pushed the configurable-locations-to-omit-auth branch from 3562119 to ca62c1a Compare April 1, 2018 20:46
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 1, 2018
@alvaroaleman alvaroaleman force-pushed the configurable-locations-to-omit-auth branch 2 times, most recently from 0d12c03 to 89ba534 Compare April 1, 2018 21:40
@alvaroaleman
Copy link
Member Author

@aledbf Added e2e tests. Travis currently fails because #2254 introduced a change that redeploys the ingress controller but doesn't properly wait afterwards

@aledbf
Copy link
Member

aledbf commented Apr 1, 2018

@alvaroaleman please rebase and we are ready to merge

@alvaroaleman alvaroaleman force-pushed the configurable-locations-to-omit-auth branch from 564de5c to d4ac563 Compare April 1, 2018 23:41
@aledbf
Copy link
Member

aledbf commented Apr 2, 2018

/approve

@alvaroaleman
Copy link
Member Author

@aledbf Done

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, alvaroaleman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 2, 2018
@aledbf
Copy link
Member

aledbf commented Apr 2, 2018

@alvaroaleman thanks!

@aledbf aledbf merged commit e7aa74b into kubernetes:master Apr 2, 2018
@Justkant
Copy link

Justkant commented Apr 17, 2018

Hi, I'm wondering if there is any security risks with this feature.
I created #2214 earlier about the feature, I like and need it. (Thanks btw)
Could a security warning for people using the ingress with auth be useful because of the defaults ? (If any risks)

@alvaroaleman alvaroaleman deleted the configurable-locations-to-omit-auth branch April 17, 2018 08:52
@Jokero
Copy link

Jokero commented Apr 18, 2018

@alvaroaleman Does it actually work? :) So I'm testing in minikube with last nginx-ingress version (0.13.0):

Ingress:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: ingress
  annotations:
    kubernetes.io/ingress.class: "nginx"
    nginx.ingress.kubernetes.io/auth-type: basic
    nginx.ingress.kubernetes.io/auth-secret: basic-auth
spec:
  rules:
    - host: minikube.local
      http:
        paths:
          - path: /api
            backend:
              serviceName: api
              servicePort: 3000
          - path: /
            backend:
              serviceName: web-client
              servicePort: 8080

And I always get "Authentication required" window, even if I visit /.well-known/acme-challenge page.
nginx-ingress is installed using helm chart (https://github.com/kubernetes/charts/tree/master/stable/nginx-ingress) with overridden controller.image.tag version (set to 0.13.0)

@Jokero
Copy link

Jokero commented Apr 18, 2018

And what's inside nginx-ingress-controller container:

root@nginx-ingress-controller-857dc686c7-pr4rg:/# cat /etc/nginx/template/nginx.tmpl | grep NoAuthLocations --context 3
            }
            {{ end }}

            {{ if not (isLocationInLocationList $location $all.Cfg.NoAuthLocations) }}
            {{ if $authPath }}
            # this location requires authentication
            auth_request        {{ $authPath }};
root@nginx-ingress-controller-857dc686c7-pr4rg:/# cat /etc/nginx/nginx.conf | grep auth_request
root@nginx-ingress-controller-857dc686c7-pr4rg:/# 

@alvaroaleman
Copy link
Member Author

@Jokero This only works if you have a path in your ingress definition that starts with /.well-known/acme-challenge

@Justkant I was thinking about that as well, but IMHO this is not an issue since as @Jokero noticed it will only kick in when you create a path starting with /.well-known/acme-challenge in your ingress - WDYT?

@aledbf
Copy link
Member

aledbf commented Apr 18, 2018

@Jokero please add an ingress with the expected path. If you have / or /api in the nginx.conf you will receive 401

@Jokero
Copy link

Jokero commented Apr 18, 2018

If I am right, it's not possible right now to use this solution with for example grafana and prometheus charts which has an option to create ingress. And this is my case actually.
All options are specified in values.yaml:

ingress:
  enabled: false
  annotations: {}
    # kubernetes.io/ingress.class: nginx
    # kubernetes.io/tls-acme: "true"
  path: /
  hosts:
    - chart-example.local
  tls: []
  #  - secretName: chart-example-tls
  #    hosts:
  #      - chart-example.local

@aledbf
Copy link
Member

aledbf commented Apr 18, 2018

@Jokero if you enable kubernetes.io/tls-acme: "true" and have kube-lego or cert-manager the path /.well-known/acme-challenge will be there (is added by one of the cert controllers)

@Justkant
Copy link

@alvaroaleman Looks good if it only bypass the auth when the path is declared (done by cert-manager w/ ingress-shim)
Thanks for the feature ✌️

@Jokero
Copy link

Jokero commented Apr 18, 2018

@aledbf Uh, I did it. Indeed, it works in GKE. Tried with cert-manager. Not sure only will it work in minikube or not (due to cert-manager), but not a big problem. Thanks a lot!

@ermik
Copy link

ermik commented Apr 28, 2018

@alvaroaleman do I understand correctly, this limited to a single path: /.well-known/acme-challenge? Why?

@alvaroaleman
Copy link
Member Author

@ermik Please do take the time to read the docs that were merged as part of this PR.

@ermik
Copy link

ermik commented Apr 28, 2018

@alvaroaleman sorry, and thanks, couldn't find where to find them. 😃 Do I understand correctly these locations can only be explicitly defined, no regex or wildcard support?

christopherriley pushed a commit to sagansystems/ingress-nginx that referenced this pull request Jun 25, 2018
* Correct typo (kubernetes#2238)

* correct spelling

* correct typo

* fix-link (kubernetes#2239)

* Add missing configuration in kubernetes#2235 (kubernetes#2236)

* to kubernetes (kubernetes#2240)

to kubernetes

* fix: cannot set $service_name if use rewrite (kubernetes#2220)

$path here is the regular expression formatted nginx location not the origin path in ingress rules. Fix kubernetes#2131

* Revert "Get file max from fs/file-max. (kubernetes#2050)" (kubernetes#2241)

This reverts commit d8efd39.

* add http/2

* fix: empty ingress path (kubernetes#2244)

If the origin ingress rule has no field `path`, the default value will be an empty string which will cause issues when rendering template as other place will use `/` as the default value.
Set the default value of path to `/` when retrieve ingress rules from api-server. Thie will fix kubernetes#1980

* Fix grpc json tag name (kubernetes#2246)

* Add EWMA as configurable load balancing algorithm (kubernetes#2229)

* Update go dependencies (kubernetes#2234)

* Add deployment docs for AWS NLB (kubernetes#1785)

* Update annotations.md (kubernetes#2255)

a typo fix

* Update README.md (kubernetes#2267)

It should be "your Ingress targets" in line 7.

* Managing a whitelist for _/nginx_status (kubernetes#2187)

Signed-off-by: Sylvain Rabot <[email protected]>

* Revert deleted assignment in kubernetes#2146 (kubernetes#2270)

* Use SharedIndexInformers in place of Informers (kubernetes#2271)

* clean up tmpl (kubernetes#2263)

The nginx.conf generated now is too messy remove some section only useful when dynamic configure enabled and headers only useful for https.

* Disable opentracing for nginx internal urls (kubernetes#2272)

* Typo fixes in modsecurity.md (kubernetes#2274)

* Update modsecurity.md

Some typo fixes

* Update modsecurity.md

* Update go to 1.10.1 (kubernetes#2273)

* Update README.md (kubernetes#2276)

Small typo fix .

* Fix bug when auth req is enabled(external authentication) (kubernetes#2280)

* set proxy_upstream_name correctly when auth_req module is used

* log a more meaningful message when backend is not found

* Fix nlb instructions (kubernetes#2282)

* e2e tests for dynamic configuration and Lua features and a bug fix (kubernetes#2254)

* e2e tests for dynamic configuration and Lua features

* do not rely on force reload to dynamically configure when reload is needed

* fix misspelling

* skip dynamic configuration in the first template rendering

* dont error on first sync

* Fix flaky e2e tests by always waiting after redeploying the ingress controller (kubernetes#2283)

* Add NoAuthLocations and default it to "/.well-known/acme-challenge" (kubernetes#2243)

* Add NoAuthLocations and default it to "/.well-known/acme-challenge"

* Add e2e tests for no-auth-location

* Improve wording of no-auth-location tests

* Update controller.go (kubernetes#2285)

* Fix custom-error-pages image publication script (kubernetes#2289)

* Update nginx to 1.13.11 (kubernetes#2290)

* Fix HSTS without preload (kubernetes#2294)

* Disable dynamic configuration in s390x and ppc64le (kubernetes#2298)

* Improve indentation of generated nginx.conf (kubernetes#2296)

* Escape variables in add-base-url annotation

* Fix race condition when Ingress does not contains a secret (kubernetes#2300)

* include lua-resty-waf and its dependencies in the base Nginx image (kubernetes#2301)

* install lua-resty-waf

* bump version

* include Kubernetes header

* include the rest of lua-resty-waf dependencies (kubernetes#2303)

* Fix issues building nginx image in different platforms (kubernetes#2305)

* Disable lua waf where luajit is not available (kubernetes#2306)

* Add verification of lua load balancer to health check (kubernetes#2308)

* Configure upload limits for setup of lua load balancer (kubernetes#2309)

* lua-resty-waf controller (kubernetes#2304)

* annotation to ignore given list of WAF rulesets (kubernetes#2314)

* extra waf rules per ingress (kubernetes#2315)

* extra waf rules per ingress

* document annotation nginx.ingress.kubernetes.io/lua-resty-waf-extra-rules

* regenerate internal/file/bindata.go

* run lua-resty-waf in different modes (kubernetes#2317)

* run lua-resty-waf in different modes

* update docs

* Add ingress-nginx survey (kubernetes#2319)

* Fix survey link (kubernetes#2321)

* Update nginx to 1.13.12 (kubernetes#2327)

* Update nginx image (kubernetes#2328)

* Update nginx image

* Update minikube start script

* fix nil pointer when ssl with ca.crt (kubernetes#2331)

* disable lua for arch s390x and ppc64le

LuaJIT is not available for s390x and ppc64le, disable the lua part in nginx.tmpl on these platform.

* Fix buildupstream name to work with dynamic session affinity

* fix make verify-all failures

* Add session affinity to custom load balancing

* Fix nginx template

* Fixed tests

* Sync secrets (SSL certificates) on events

Remove scheduled check for missing secrets.

* Include missing secrets in secretIngressMap

Update secretIngressMap independently from stored annotations, which may
miss some secret references.

* Add test for channel events with referenced secret

* Release nginx ingress controller 0.13.0

* Update owners

* Use same convention, curl + kubectl for GKE

* Correct some returned messages in server_tokens.go

should not exists->should not exist
should exists->should exist

* Typo fix in cli-arguments.md

it's endpoints->its endpoints

* Correct some info in flags.go

Correct some info in flags.go

* Add proxy-add-original-uri-header config flag

This makes it configurable if a location adds an X-Original-Uri header to the backend request. Default is "true", the current behaviour.

* Check ingress rule contains HTTP paths

* Detect if header injected request_id before creating one

* fix: fill missing patch yaml config.

The patch-service yaml missing livenessProbe, readinessProbe and prometheus annotation parts.

* Add vts-sum-key config flag

* Introduce ConfigMap updating helpers into e2e/framework and retain default nginx-configuration state between tests

Group sublogic

* Update nginx image to fix modsecurity crs issues

* Move the resetting logic into framework

Stylistic fixes based on feedback

* Fix leaky test

* fix the default cookie name in doc

* DOCS: Add clarification regarding ssl passthrough

* Remove most of the time.Sleep from the e2e tests

* Accept ns/name Secret reference in annotations

* Document changes to annotations with Secret reference

* Improve speed of e2e tests

* include lua-resty-balancer in nginx image

* Silence unnecessary MissingAnnotations errors

* Ensure dep fix fsnotify

* Update nginx image

* fix flaky dynamic configuration test

* shave off some more seconds

* cleanup redundant code

* Update go dependencies

* Allow tls section without hosts in Ingress rule

* Add test for store helper ListIngresses

* Add tests for controller getEndpoints

* Add busted unit testing framework for lua code

* Add deployment instructions for Docker for Mac (Edge)

* Update nginx-opentracing to 0.3.0

This version includes a new `http.host` header to make searching by
vhost in zipkin or jaeger more trivial.

* Fix golint installation

* add balancer unit tests

* Endpoint Awareness: Read backends data from tmp file as well

Actually read from the file

Logs probably shouldn't assume knowledge of implementation detail

Typos

Added integration test, and dynamic update config refactor

Don't force the 8k default

Minimal test case to make the configuration/backends request body write to temp file

Leverage new safe config updating methods, and use 2 replicas instead of 4

Small refactor

Better integration test, addresses other feedback

Update bindata

* Update nginx image

* automate dev environment build

* Remove unnecessary externalTrafficPolicy on Docker for Mac service

* Apply gometalinter suggestions

* Move all documentation under docs/

* Move miscellaneous tidbits from README to miscellaneous.md and other files

* Fix some document titles

* Move deployment documentation under docs/deploy/

* Remove empty ingress-annotations document; fix up annotations.md's layout slightly

* Configure mkdocs with mkdocs-material and friends

* Move "Customizing NGINX" documentation under "NGINX Configuration"

* Regenerate cli-arguments.md from the actual usage of 0.13

* Remove default-ssl-certificate.md (the content is already in tls.md)

* Move documents related to third-party extensions under third-party-addons

* Add buffer configuration to external auth location config

* make code-generator

* Clean JSON before post request to update configuration

* Add scripts and tasks to publish docs to github pages

* Improve readme file

* Fix broken links in the docs

* Remove data races from tests

* Check ginkgo is installed before running e2e tests

* Update exposing-tcp-udp-services.md

Minor tick missing for syntax highlighting which makes it look ugly on https://kubernetes.github.io/ingress-nginx/user-guide/exposing-tcp-udp-services/

* Update custom-errors.md

Fix grammatical errors

* Update README.md

Fix broken link to `CONTRIBUTING.md`. 

Also update other links to `CONTRIBUTING.md` for consistency.

* Add annotation to enable rewrite logs in a location

* upstream-hash-by annotation support for dynamic configuraton mode

* luacheck ignore subfolders too

* Release nginx ingress controller 0.14.0

* Use local image name for e2e tests

* Bump echoserver version used in e2e test (1.10)

* Refactor e2e framework for TLS tests

* Add tests for global TLS settings

* improve build-dev-env.sh script

* always use x-request-id

* Add basic security context to deployment YAMLs

* Update GitHub pull request template

* Improve documentation format

* Add google analytics [ci skip]

* Add gRPC annotation doc

* Adjust size of tables and only adjust the first column on mobile

* Assert or install go-bindata before incanting

* Add Getting the Code section to Quick Start

* TLS.md: Move the TLS secret misc bit to the TLS document

* TLS.md: Clarify how to set --default-ssl-certificate

* TLS.md: Remove the frankly useless curl output in the default certificate section

* TLS.md: Reformat and grammar check

* TLS.md: Remove useless manual TOC

* multiple-ingress.md: rework page for clarity and less repetition

* Add upgrade documentation

Closes kubernetes#2458

* Reformat log-format.md

* Add note about changing annotation prefixes

* Clean up annotations.md; extract default backend from miscellaneous

* Index all examples and fix their titles

* Example of using nginx-ingress with gRPC

* Exclude grpc-fortune-teller from go list

Deps are managed by bazel so these will fail to
show up in the vendor tree, triggering false positive build fail.

* Fixed broken link in deploy README

* Change TrimLeft for TrimPrefix on the from-to-www redirect

* use roundrobin from lua-resty-balancer library and refactor balancer.lua

* upstream-hash-by should override load-balance annotation

* add resty cookie

* [ci skip] bump nginx baseimage version

* Add some clarification around multiple ingress controller behavior

* Update go version in fortune teller image

* Refactor update of status removing initial check for loadbalancer

* Add KubeCon Europe 2018 Video to documentation

Adds Make Ingress-Nginx Work for you, and the Community Video to the
documentation.

* force backend sync when worker starts

* Remove warning when secret is used only for authentication

* Fix and simplify local dev workflow and execution of e2e tests

* Release nginx ingress controller 0.15.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants