多读书多实践,勤思考善领悟

保护Kubernetes对外暴露的服务

本文于1905天之前发表,文中内容可能已经过时。

有时候我们需要在 Kubernetes 中暴露一些没有任何安全验证机制的服务,比如没有安装 xpack 的 Kibana,没有开启登录认证的 Jenkins 服务之类的,我们也想通过域名来进行访问,比较域名比较方便,更主要的是对于 Kubernetes 里面的服务,通过 Ingress 暴露一个服务太方便了,而且还可以通过 cert-manager 来自动的完成HTTPS化。所以就非常有必要对这些服务进行一些安全验证了。

Basic Auth 认证

我们在前面升级 Dashboard 的文章中就给大家提到过两种方式来为我们的服务添加 Basic Auth 认证:haproxy/nginx 和 traefik/nginx-ingress。 使用 haproxy/nginx 的方式非常简单,就是直接添加 basic auth 认证,然后将请求转发到后面的服务;而 traefik/nginx-ingress 都直接提供了 basic auth 的支持,我们这里使用 nginx-ingress 来为 Jenkins 服务添加一个 basic auth 的认证服务。

首先,我们需要创建用于存储用户名和密码的htpasswd文件:

1
2
$ htpasswd -bc auth admin admin321
Adding password for user admin

然后,创建一个基于上面 htpasswd 文件的 Secret 对象:

1
2
$ kubectl create secret generic jenkins-basic-auth --from-file=auth -n kube-ops
secret "jenkins-basic-auth" created

最后,我们需要在 Ingress 对象中添加auth-type:basicauth-jenkins-basic-auth两个 annotations:(ingress.yaml)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: jenkins
namespace: kube-ops
annotations:
kubernetes.io/ingress.class: nginx
# 认证类型
nginx.ingress.kubernetes.io/auth-type: basic
# 包含 user/password 的 Secret 名称
nginx.ingress.kubernetes.io/auth-secret: jenkins-basic-auth
# 当认证的时候显示一个合适的上下文信息
nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required - admin'
spec:
rules:
- host: jenkins.ljjyy.com
http:
paths:
- backend:
serviceName: jenkins
servicePort: web

然后更新上面的资源对象:

1
2
$ kubectl apply -f ingress.yaml
ingress.extensions "jenkins" configured

更新完成后,现在我们去访问我们的 Jenkins 服务可以看到需要输入用户名和密码的提示信息了:

jenkins basic auth
jenkins basic auth

OAuth 认证

除了上面的 Basic Auth 认证方式以为,我们还可以通过 Github、Google 等提供的 OAuth 服务来进行身份验证。我们可以通过名为OAuth2 Proxy的工具来代理请求,它通过提供一个外部身份验证的反向代理来实现,使用起来也相对简单。

安装

首先我们需要为我们的应用添加自动的 HTTPS,可以参考我们前面的文章使用 Let’s Encrypt 实现 Kubernetes Ingress 自动化 HTTPS

然后登录 Github,在https://github.com/settings/applications/new添加一个新的OAuth应用程序:

register github app
register github app

替换成你自己需要使用的域名,然后在回调 URL 上添加/oauth2/callback,点击注册后,记录下应用详细页面Client IDClient Secret的值。然后还需要生成一个 cookie 密钥,当然如果我们系统中安装了 python 环境可以直接生成,没有的话用 Docker 容器运行当然也行:

1
2
3
$ docker run -ti --rm python:3-alpine \
python -c 'import secrets,base64; print(base64.b64encode(base64.b64encode(secrets.token_bytes(16))));'
b'<GENERATED_COOKIE_SECRET>'

然后部署OAuth2 Proxy应用,这里我们直接使用 Helm 来简化安装:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
$ helm install --name authproxy \
--namespace=kube-system \
--set config.clientID=<YOUR_CLIENT_ID> \
--set config.clientSecret=<YOUR_SECRET> \
--set config.cookieSecret=<GENERATED_COOKIE_SECRET> \
--set extraArgs.provider=github \
--set extraArgs.email-domain="*" \
stable/oauth2-proxy
NAME: authproxy
LAST DEPLOYED: Sun Apr 14 01:11:50 2019
NAMESPACE: kube-system
STATUS: DEPLOYED

RESOURCES:
==> v1/Secret
NAME TYPE DATA AGE
authproxy-oauth2-proxy Opaque 3 0s

==> v1/ConfigMap
NAME DATA AGE
authproxy-oauth2-proxy 1 0s

==> v1/Service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
authproxy-oauth2-proxy ClusterIP 10.109.110.219 <none> 80/TCP 0s

==> v1beta2/Deployment
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
authproxy-oauth2-proxy 1 0 0 0 0s

==> v1/Pod(related)
NAME READY STATUS RESTARTS AGE
authproxy-oauth2-proxy-798cff85fc-pc8x5 0/1 ContainerCreating 0 0s


NOTES:
To verify that oauth2-proxy has started, run:

kubectl --namespace=kube-system get pods -l "app=oauth2-proxy"

$ # 执行下面的命令待编程 Running 状态证明安装成功了。
$ kubectl --namespace=kube-system get pods -l "app=oauth2-proxy"
NAME READY STATUS RESTARTS AGE
authproxy-oauth2-proxy-cdb4f675b-wvdg5 1/1 Running 0 1m

对于 GitHub,我们可以通过github-orggithub-team来限制访问,一般设置email-doamin="*",我们可以通过OAuth2 Proxy示例文档来查看更改 GitHub Provider 的配置。

测试

同样我们这里还是使用一个 Jenkins 服务,大家也可以使用任意的一个服务来验证,当然最好是没有身份验证功能的,比如没有安装 x-pack 的 Kibana。 要实现外部服务来进行认证的关键点在于 nginx-ingress-controller 在 annotations 中为我们提供了auth-urlauth-signin两个注解来允许配置外部身份验证的入口。

上面这两个 annotation 需要 nginx-ingress-controller 在 v0.9.0 版本或以上。

我们在 Jenkins 的核心 Ingress 对象中配置服务认证的 url:https://$host/oauth2/auth,然后通过创建一个同域的 Ingress 对象将oauth2路径代理到OAuth2 proxy应用去处理认证服务:

1
2
nginx.ingress.kubernetes.io/auth-url: "https://$host/oauth2/auth"
nginx.ingress.kubernetes.io/auth-signin: "https://$host/oauth2/start?rd=$escaped_request_uri"

然后按照上面的思路重新创建 Jenkins 的两个 Ingress 对象:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
$ cat <<EOF | kubectl apply -f -
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: jenkins
namespace: kube-ops
annotations:
kubernetes.io/ingress.class: nginx
kubernetes.io/tls-acme: "true"
nginx.ingress.kubernetes.io/auth-url: "https://$host/oauth2/auth"
nginx.ingress.kubernetes.io/auth-signin: "https://$host/oauth2/start?rd=$escaped_request_uri"
spec:
rules:
- host: jenkins.ljjyy.com
http:
paths:
- backend:
serviceName: jenkins
servicePort: web
path: /
tls:
- hosts:
- jenkins.ljjyy.com
secretName: jenkins-tls

---
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: authproxy-oauth2-proxy
namespace: kube-system
annotations:
kubernetes.io/ingress.class: nginx
kubernetes.io/tls-acme: "true"
spec:
rules:
- host: jenkins.ljjyy.com
http:
paths:
- backend:
serviceName: authproxy-oauth2-proxy
servicePort: 80
path: /oauth2
tls:
- hosts:
- jenkins.ljjyy.com
secretName: jenkins-tls
EOF

我们这里通过cert-manager来自动为服务添加 HTTPS ,添加了kubernetes.io/tls-acme=true这个注解,然后我们在浏览器中打开我们的 Jenkins 服务,正常就会跳转到 GitHub 登录页面了:

github oauth
github oauth

然后认证通过后就可以跳转到我们的 Jenkins 服务了:

jenkins
jenkins

当然除了使用 GitHub 之外,还可以使用其他的 OAuth 认证服务,比如 Google,我们可以根据需要自行去添加即可。


参考资料

OAuth2 Proxy
ingress-nginx oauth external auth exmaple