k8s-dashboard-impersonation-proxy

README

k8s-dashboard-impersonation-proxy

This is a tool that injects authorization and remaps impersonation headers to the Kubernetes Dashboard format.

References:

• https://kubernetes.io/docs/reference/access-authn-authz/authentication/#user-impersonation
• https://github.com/kubernetes/dashboard/blob/master/docs/user/README.md#user-impersonation

Usage with nginx and oauth2-proxy

oauth2-proxy reference: https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview/

oauth2-proxy with the --set-xauthrequest flag will set the following headers:

• X-Auth-Request-Preferred-Username holding the username
• X-Auth-Request-Groups holding the groups (comma separated)

This tool will remap these headers to the Kubernetes Dashboard impersonation headers:

• Impersonate-User holding the username
• Impersonate-Group holding the groups (one header per group)

Additionally, it will inject the Authorization header with the Bearer token sourced from a Kubernetes service account.

⚠️ Caution: This proxy works well with kubernetes-dashboard set to 1 replicas. ⚠️

Local development

$ go build
$ ./k8s-dashboard-impersonation-proxy
2023/04/12 16:31:24 Starting Server

$ curl http://localhost:8080
# should send request to target url

Setup

Automatically built Docker image can be found at ghcr.io/aslafy-z/k8s-dashboard-impersonation-proxy:latest. Latest being the latest release, you can replace it with any Git tag.

Demo

$ kind create cluster
$ kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.7.0/aio/deploy/recommended.yaml
$ kubectl apply -f https://raw.githubusercontent.com/aslafy-z/k8s-dashboard-impersonation-proxy/main/deploy/sample.yaml
$ kubectl wait deployment -n kubernetes-dashboard kubernetes-dashboard --for condition=Available=True
$ kubectl wait deployment -n kubernetes-dashboard k8s-dashboard-impersonation-proxy --for condition=Available=True
$ kubectl port-forward -n kubernetes-dashboard service/k8s-dashboard-impersonation-proxy 8080:80
$ curl http://localhost:8080/api/v1/service/default -H 'Impersonate-User: restricted-user'
# User 'restricted-user' CAN list services in default namespace
$ curl http://localhost:8080/api/v1/service/kube-system -H 'Impersonate-User: restricted-user'
# User 'restricted-user' CAN NOT list services in kube-system namespace
$ curl -vv http://localhost:8080/api/v1/service/kube-system -H 'Impersonate-User: admin' -H 'Impersonate-Group: system:masters'
# Group 'system:masters' CAN list services in default namespace

TBD - Sample Kubernetes setup with oauth2-proxy.

Contributing

Simply create an issue or a pull request.