From 3bd581b2aebc56f993be331e16da3de23d1ad257 Mon Sep 17 00:00:00 2001 From: Bradley Reynolds Date: Fri, 9 Aug 2024 23:06:13 +0530 Subject: [PATCH] feat(rbac): add script to create users Also, added `ClusterRoles` for use with this script. Signed-off-by: Bradley Reynolds Signed-off-by: Siddhesh Mhadnak --- .gitignore | 4 +- .../_/rbac/cluster-roles/vipyrsec-admins.yaml | 18 ++ .../cluster-roles/vipyrsec-core-devs.yaml | 52 ++++ .../_/rbac/cluster-roles/vipyrsec.yaml | 39 +++ kubernetes/rbac/README.md | 65 +++++ kubernetes/rbac/create_user.py | 255 ++++++++++++++++++ 6 files changed, 431 insertions(+), 2 deletions(-) create mode 100644 kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-admins.yaml create mode 100644 kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-core-devs.yaml create mode 100644 kubernetes/manifests/_/rbac/cluster-roles/vipyrsec.yaml create mode 100644 kubernetes/rbac/README.md create mode 100755 kubernetes/rbac/create_user.py diff --git a/.gitignore b/.gitignore index 599913b..36b0192 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,5 @@ secrets.yaml # Helm kubernetes/chart/charts/*.tgz -# Pre-commit > Prettier -.prettier-cache +# Generated kube configs +*.config diff --git a/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-admins.yaml b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-admins.yaml new file mode 100644 index 0000000..1f829da --- /dev/null +++ b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-admins.yaml @@ -0,0 +1,18 @@ +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole + +metadata: + name: vipyrsec-admins + +rules: + - apiGroups: + - '*' + resources: + - '*' + verbs: + - '*' + - nonResourceURLs: + - '*' + verbs: + - '*' diff --git a/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-core-devs.yaml b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-core-devs.yaml new file mode 100644 index 0000000..eba4f5c --- /dev/null +++ b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec-core-devs.yaml @@ -0,0 +1,52 @@ +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole + +metadata: + name: vipyrsec-core-devs + +rules: + - apiGroups: + - '' + resources: + - pods + - services + - configmaps + - secrets + verbs: + - list + - get + - patch + - update + + - apiGroups: + - apps + resources: + - daemonsets + - replicasets + - deployments + verbs: + - list + - get + - patch + - update + + - apiGroups: + - batch + resources: + - jobs + verbs: + - list + - get + - patch + - update + + - apiGroups: + - networking.k8s.io + resources: + - ingresses + verbs: + - list + - get + - patch + - update diff --git a/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec.yaml b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec.yaml new file mode 100644 index 0000000..0b956fe --- /dev/null +++ b/kubernetes/manifests/_/rbac/cluster-roles/vipyrsec.yaml @@ -0,0 +1,39 @@ +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole + +metadata: + name: vipyrsec + +rules: + - apiGroups: + - '' + resources: + - pods + - services + - configmaps + verbs: + - list + + - apiGroups: + - apps + resources: + - daemonsets + - replicasets + - deployments + verbs: + - list + + - apiGroups: + - batch + resources: + - jobs + verbs: + - list + + - apiGroups: + - networking.k8s.io + resources: + - ingresses + verbs: + - list diff --git a/kubernetes/rbac/README.md b/kubernetes/rbac/README.md new file mode 100644 index 0000000..83a64c6 --- /dev/null +++ b/kubernetes/rbac/README.md @@ -0,0 +1,65 @@ +# Kubernetes RBAC + +## Create a user + +> [!IMPORTANT] +> Make sure to set the `kubectl` context to the cluster to which you want to add the user! + +```bash +./create_user.py -g +``` + +This will, + +1. Create a private key for the user +2. Provision a client certificate for the user using the private key +3. Grant the permissions for the requested groups to the user +4. Generate a kubeconfig using the private key, and the client certificate for use with `kubectl` + +### Examples + +1. Create a user `foo` with group `vipyrsec` + +```bash +./create_user.py foo -g vipyrsec +``` + +2. Create a user `bar` with groups `vipyrsec`, and `vipyrsec-core-devs` with a day's validity + +```bash +./create_user.py bar -g vipyrsec -g vipyrsec-core-devs --expiry-seconds 86400 +``` + +## Revoke a user's access granted by a specific role + +> [!IMPORTANT] +> Make sure to set the `kubectl` context to the cluster from which you want to revoke the user's access! + +```bash +kubectl delete clusterrolebinding @ +``` + +### Example + +Revoke user `foo`'s access granted by `vipyrsec-core-devs` + +```bash +kubectl delete clusterrolebinding foo@vipyrsec-core-devs +``` + +## Revoke all permissions granted to a user (AKA, delete the user) + +> [!IMPORTANT] +> Make sure to set the `kubectl` context to the cluster from which you want to revoke the user's access! + +```bash +kubectl delete clusterrolebinding -luser= +``` + +### Example + +Revoke all permissions granted to user `foo` + +```bash +kubectl delete clusterrolebinding -luser=foo +``` diff --git a/kubernetes/rbac/create_user.py b/kubernetes/rbac/create_user.py new file mode 100755 index 0000000..fc673eb --- /dev/null +++ b/kubernetes/rbac/create_user.py @@ -0,0 +1,255 @@ +#!/usr/bin/env python3 + +import argparse +import string +import base64 +import logging +import subprocess +import tempfile +from pathlib import Path +from typing import Literal + + +LogLevel = Literal["debug", "info", "warn", "error"] + +logging.basicConfig(format="[%(asctime)s] [%(levelname)-8s] %(message)s", level=logging.INFO) +log = logging.getLogger() + +CSR_TEMPLATE = string.Template("""\ +apiVersion: certificates.k8s.io/v1 +kind: CertificateSigningRequest + +metadata: + name: $user + +spec: + request: $request + signerName: kubernetes.io/kube-apiserver-client + $expiration + usages: + - client auth +""") +CRB_TEMPLATE = string.Template("""\ +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding + +metadata: + name: $user@$group + labels: + user: $user + +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: $group + +subjects: +- apiGroup: rbac.authorization.k8s.io + kind: User + name: $user +""") + + +def run_command(command: str, input: str | None = None) -> str: + """Run a command in a shell. + + Args: + command: The command to run. + input: The input for the command, if any. + + Returns: + The output of the command. + """ + log.debug("Running command %r", command) + try: + proc = subprocess.run(command, shell=True, capture_output=True, check=True, input=input, text=True) + return proc.stdout + except subprocess.CalledProcessError as cpe: + log.exception("Failed to run command %r (%d): %s", cpe.cmd, cpe.returncode, cpe.stderr) + raise + + +def generate_key() -> str: + """Generate a private key. + + Returns: + The private key. + """ + return run_command("openssl genrsa 4096") + + +def create_csr(user: str, groups: list[str], key: str) -> str: + """Create a certificate signing request (CSR). + + Args: + user: The user for which to create the CSR. + groups: The groups to which the user belongs. + key: The private key of the user. + + Returns: + The CSR. + """ + return run_command( + # We don't use the groups in the subject here, because we cannot revoke membership later + # https://kubernetes.io/docs/concepts/security/hardening-guide/authentication-mechanisms/#x509-client-certificate-authentication + f"openssl req -new -key /dev/stdin -subj /CN={user}", + input=key, + ) + + +def approve_csr(csr: str, user: str, expiry_seconds: int = 31536000) -> str: + """Approve the certificate signing request (CSR). + + Args: + csr: The CSR to approve. + user: The user associated to the CSR. + expiry_seconds: The duration for which the approved certificate will be valid. Default: 31536000 (1 year). + + Returns: + The approved certificate. + """ + expiration = "" + if expiry_seconds is not None: + expiration = f"expirationSeconds: {expiry_seconds}" + + csr_manifest = CSR_TEMPLATE.substitute(user=user, request=csr, expiration=expiration) + run_command("kubectl apply -f -", input=csr_manifest) + run_command(f"kubectl certificate approve {user}") + cert = run_command(f"kubectl get csr {user} -ojsonpath='{{.status.certificate}}'") + run_command(f"kubectl delete csr {user}") + return base64.b64decode(cert).decode() + + +def grant_permissions(user: str, group: str) -> None: + """Grant permissions to the user. + + Args: + user: The user to which to grant permissions. + group: The group for which to grant the user permission. + """ + crb_manifest = CRB_TEMPLATE.substitute(user=user, group=group) + run_command("kubectl apply -f -", input=crb_manifest) + + +def generate_kube_config(user: str, key: str, cert: str) -> None: + """Generate a kube config for the user. + + Args: + user: The user for which to generate the kube config. + key: The private key of the user. + cert: The approved certificate of the user. + + Returns: + The kube config. + """ + config_path = Path(f"{user}.config") + config = run_command("kubectl config view --flatten --minify") + config_path.write_text(config) + kubectl = f"kubectl --kubeconfig={config_path}" + + clusters = run_command(f"{kubectl} config get-clusters") + cluster = clusters.splitlines()[-1] + + current_context = run_command(f"{kubectl} config current-context") + run_command(f"{kubectl} config delete-context {current_context.strip('\n')}") + + users = run_command(f"{kubectl} config get-users") + current_user = users.splitlines()[-1] + run_command(f"{kubectl} config delete-user {current_user}") + + with ( + tempfile.NamedTemporaryFile("w", suffix=f"{user}.key") as key_file, + tempfile.NamedTemporaryFile("w", suffix=f"{user}.crt") as cert_file, + ): + key_file.write(key) + key_file.flush() + cert_file.write(cert) + cert_file.flush() + + run_command( + f"{kubectl} config set-credentials {user}" + f" --client-key={key_file.name}" + f" --client-certificate={cert_file.name} --embed-certs" + ) + + context = f"{user}@{cluster}" + run_command(f"{kubectl} config set-context {context} --cluster={cluster} --user={user}") + run_command(f"{kubectl} config use-context {context}") + + return config_path + + +if __name__ == "__main__": + parser = argparse.ArgumentParser( + description="Configure a user to access a Kubernetes cluster.", + epilog="Make sure to set the `kubectl` context to the cluster to which you want to add the user!", + allow_abbrev=False, + ) + + parser.add_argument("user", help="The user to create.") + parser.add_argument( + "-g", + "--group", + action="append", + help="The group(s) to which to the user belongs.", + choices=["vipyrsec", "vipyrsec-core-devs", "vipyrsec-admins"], + required=True, + ) + + parser.add_argument( + "--expiry-seconds", + help=( + "The duration for which the user config will be valid." + " Minimum: 600 (10 minutes)," + " Maximum: 31536000 (1 year)," + " Default: 31536000 (1 year)" + ), + type=int, + default=31536000, + ) + + misc_options = parser.add_argument_group("misc. options") + misc_options.add_argument( + "--log-level", + help="Log verbosity. Default: info", + choices=["debug", "info", "warn", "error"], + default="info", + ) + + args = parser.parse_args() + log.debug("Args: %s", args) + + user: str = args.user + groups: list[str] = args.group + + expiry_seconds: int = args.expiry_seconds + if not (600 <= expiry_seconds <= 31536000): + msg = "expiry seconds must be between 600, and 31536000" + raise ValueError(msg) + + log_level: LogLevel = args.log_level + log.setLevel(log_level.upper()) + + log.debug("Generating private key") + key = generate_key() + log.info("Generated private key") + + log.debug("Creating CSR for user %r with groups %r", user, groups) + csr = create_csr(user, groups, key) + log.info("Created CSR for user %r with groups %r", user, groups) + + log.debug("Approving CSR for user %r", user) + encoded_csr = base64.b64encode(csr.encode()).decode().replace("\n", "") + cert = approve_csr(encoded_csr, user, expiry_seconds) + log.info("Approved CSR for user %r", user) + + for group in groups: + log.debug("Granting permissions to user %r for group %r", user, group) + grant_permissions(user, group) + log.info("Granted permissions to user %r for group %r", user, group) + + log.debug("Generating kubeconfig for user %r", user) + config_path = generate_kube_config(user, key, cert) + log.debug("Generated kubeconfig for user %r", user) + + log.info(f"Config written to {config_path.resolve()}.")