1614027cd4
* clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to4f2cb51ef8/ingress/controllers/nginx/examples/ingress.yamland the deployments referenced in4f2cb51ef8/ingress/controllers/nginx/examples/README.mdThey are not relevant to the current instructions. * add whitespace around parens * grammar setup would be a proper noun, but it is not the intended concept, which is a state * grammar * is-only * via * Use bullets for choices * ingress-controller nginx is a distinct brand. generally this repo talks about ingress-controller, although it is quite inconsistent about how... * drop stray paren * OAuth is a brand and needs an article here also GitHub is a brand * Indent text under numbered lists * use e.g. * Document that customer header config maps changes do not trigger updates This should be removed if https://github.com/kubernetes/ingress-nginx/issues/5238 is fixed. * article * period * infinitive verb + period * clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application * avoid using ; and reword * whitespace * brand: gRPC * only-does is the right form `for` adds nothing here * spelling: GitHub * punctuation `;` is generally not the right punctuation... * drop stray `to` * sentence * backticks * fix link * Improve readability of compare/vs * Renumber list * punctuation * Favor Ingress-NGINX and Ingress NGINX * Simplify custom header restart text * Undo typo damage Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
144 lines
3.4 KiB
Markdown
144 lines
3.4 KiB
Markdown
# Basic Authentication
|
|
|
|
This example shows how to add authentication in a Ingress rule using a secret that contains a file generated with `htpasswd`.
|
|
It's important the file generated is named `auth` (actually - that the secret has a key `data.auth`), otherwise the ingress-controller returns a 503.
|
|
|
|
## Create htpasswd file
|
|
|
|
```console
|
|
$ htpasswd -c auth foo
|
|
New password: <bar>
|
|
New password:
|
|
Re-type new password:
|
|
Adding password for user foo
|
|
```
|
|
|
|
## Convert htpasswd into a secret
|
|
|
|
```console
|
|
$ kubectl create secret generic basic-auth --from-file=auth
|
|
secret "basic-auth" created
|
|
```
|
|
|
|
## Examine secret
|
|
|
|
```console
|
|
$ kubectl get secret basic-auth -o yaml
|
|
apiVersion: v1
|
|
data:
|
|
auth: Zm9vOiRhcHIxJE9GRzNYeWJwJGNrTDBGSERBa29YWUlsSDkuY3lzVDAK
|
|
kind: Secret
|
|
metadata:
|
|
name: basic-auth
|
|
namespace: default
|
|
type: Opaque
|
|
```
|
|
|
|
## Using kubectl, create an ingress tied to the basic-auth secret
|
|
|
|
```console
|
|
$ echo "
|
|
apiVersion: networking.k8s.io/v1
|
|
kind: Ingress
|
|
metadata:
|
|
name: ingress-with-auth
|
|
annotations:
|
|
# type of authentication
|
|
nginx.ingress.kubernetes.io/auth-type: basic
|
|
# name of the secret that contains the user/password definitions
|
|
nginx.ingress.kubernetes.io/auth-secret: basic-auth
|
|
# message to display with an appropriate context why the authentication is required
|
|
nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required - foo'
|
|
spec:
|
|
ingressClassName: nginx
|
|
rules:
|
|
- host: foo.bar.com
|
|
http:
|
|
paths:
|
|
- path: /
|
|
pathType: Prefix
|
|
backend:
|
|
service:
|
|
name: http-svc
|
|
port:
|
|
number: 80
|
|
" | kubectl create -f -
|
|
```
|
|
|
|
## Use curl to confirm authorization is required by the ingress
|
|
|
|
```
|
|
$ curl -v http://10.2.29.4/ -H 'Host: foo.bar.com'
|
|
* Trying 10.2.29.4...
|
|
* Connected to 10.2.29.4 (10.2.29.4) port 80 (#0)
|
|
> GET / HTTP/1.1
|
|
> Host: foo.bar.com
|
|
> User-Agent: curl/7.43.0
|
|
> Accept: */*
|
|
>
|
|
< HTTP/1.1 401 Unauthorized
|
|
< Server: nginx/1.10.0
|
|
< Date: Wed, 11 May 2016 05:27:23 GMT
|
|
< Content-Type: text/html
|
|
< Content-Length: 195
|
|
< Connection: keep-alive
|
|
< WWW-Authenticate: Basic realm="Authentication Required - foo"
|
|
<
|
|
<html>
|
|
<head><title>401 Authorization Required</title></head>
|
|
<body bgcolor="white">
|
|
<center><h1>401 Authorization Required</h1></center>
|
|
<hr><center>nginx/1.10.0</center>
|
|
</body>
|
|
</html>
|
|
* Connection #0 to host 10.2.29.4 left intact
|
|
```
|
|
|
|
## Use curl with the correct credentials to connect to the ingress
|
|
|
|
```
|
|
$ curl -v http://10.2.29.4/ -H 'Host: foo.bar.com' -u 'foo:bar'
|
|
* Trying 10.2.29.4...
|
|
* Connected to 10.2.29.4 (10.2.29.4) port 80 (#0)
|
|
* Server auth using Basic with user 'foo'
|
|
> GET / HTTP/1.1
|
|
> Host: foo.bar.com
|
|
> Authorization: Basic Zm9vOmJhcg==
|
|
> User-Agent: curl/7.43.0
|
|
> Accept: */*
|
|
>
|
|
< HTTP/1.1 200 OK
|
|
< Server: nginx/1.10.0
|
|
< Date: Wed, 11 May 2016 06:05:26 GMT
|
|
< Content-Type: text/plain
|
|
< Transfer-Encoding: chunked
|
|
< Connection: keep-alive
|
|
< Vary: Accept-Encoding
|
|
<
|
|
CLIENT VALUES:
|
|
client_address=10.2.29.4
|
|
command=GET
|
|
real path=/
|
|
query=nil
|
|
request_version=1.1
|
|
request_uri=http://foo.bar.com:8080/
|
|
|
|
SERVER VALUES:
|
|
server_version=nginx: 1.9.11 - lua: 10001
|
|
|
|
HEADERS RECEIVED:
|
|
accept=*/*
|
|
connection=close
|
|
host=foo.bar.com
|
|
user-agent=curl/7.43.0
|
|
x-request-id=e426c7829ef9f3b18d40730857c3eddb
|
|
x-forwarded-for=10.2.29.1
|
|
x-forwarded-host=foo.bar.com
|
|
x-forwarded-port=80
|
|
x-forwarded-proto=http
|
|
x-real-ip=10.2.29.1
|
|
x-scheme=http
|
|
BODY:
|
|
* Connection #0 to host 10.2.29.4 left intact
|
|
-no body in request-
|
|
```
|