From 7fd81f347006ca6ebaf6f0cf149a4d8c1f8086b0 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Sun, 25 Dec 2022 19:52:28 +0100 Subject: WIP new secretmgr --- secretmgr/secretmgr | 382 ---------------------------------------------------- 1 file changed, 382 deletions(-) delete mode 100755 secretmgr/secretmgr (limited to 'secretmgr') diff --git a/secretmgr/secretmgr b/secretmgr/secretmgr deleted file mode 100755 index 0595f81..0000000 --- a/secretmgr/secretmgr +++ /dev/null @@ -1,382 +0,0 @@ -#!/usr/bin/env nix-shell -#!nix-shell -i python3 -p "python3.withPackages(ps: [ ps.pip ps.consul ps.ldap ps.passlib ps.requests ps.six ])" - -# DEPENDENCY: python-consul -import consul - -# DEPENDENCY: python-ldap -import ldap - -# DEPENDENCY: passlib -from passlib.hash import ldap_salted_sha1 - -import os -import sys -import glob -import subprocess -import getpass -import base64 -from secrets import token_bytes - - -""" -TODO: this will be a utility to handle secrets in the Consul database -for the various components of the Deuxfleurs infrastructure - -Functionnalities: -- check that secrets are correctly configured -- help user fill in secrets -- create LDAP service users and fill in corresponding secrets -- maybe one day: manage SSL certificates and keys - -It uses files placed in /secrets/* to know what secrets -it should handle. These secret files contain directives for what to do -about these secrets. - -Example directives: - -USER -(a secret that must be filled in by the user) - -USER_LONG -(the same, indicates that the secret fits on several lines) - -CMD -(a secret that is generated by running this command) - -CMD_ONCE -(same, but value is not changed when doing a regen) - -CONST -(the secret has a constant value set here) - -CONST_LONG - -(same) - -SERVICE_DN -(the LDAP DN of a service user) - -SERVICE_PASSWORD -(the LDAP password for the corresponding service user) - -SSL_CERT -(a SSL domain for the given domains) - -SSL_KEY -(the SSL key going with corresponding certificate) - -RSA_PUBLIC_KEY -(a public RSA key) - -RSA_PRIVATE_KEY -(the corresponding private RSA key) -""" - - -# Parameters -LDAP_URL = "ldap://localhost:1389" -SERVICE_DN_SUFFIX = "ou=services,ou=users,dc=deuxfleurs,dc=fr" -consul_server = consul.Consul() - - -# ---- - -USER = "USER" -USER_LONG = "USER_LONG" -CMD = "CMD" -CMD_ONCE = "CMD_ONCE" -CONST = "CONST" -CONST_LONG = "CONST_LONG" -SERVICE_DN = "SERVICE_DN" -SERVICE_PASSWORD = "SERVICE_PASSWORD" -SSL_CERT = "SSL_CERT" -SSL_KEY = "SSL_KEY" -RSA_PUBLIC_KEY = "RSA_PUBLIC_KEY" -RSA_PRIVATE_KEY = "RSA_PRIVATE_KEY" - -class bcolors: - HEADER = '\033[95m' - OKBLUE = '\033[94m' - OKCYAN = '\033[96m' - OKGREEN = '\033[92m' - WARNING = '\033[93m' - FAIL = '\033[91m' - ENDC = '\033[0m' - BOLD = '\033[1m' - UNDERLINE = '\033[4m' - -def read_secret(key, file_path): - lines = [l.strip() for l in open(file_path, "r")] - if len(lines) == 0: - print(bcolors.FAIL, "ERROR:", bcolors.ENDC, "Empty file in", file_path) - sys.exit(-1) - l0 = lines[0].split(" ") - stype = l0[0] - secret = {"type": stype, "key": key} - if stype in [USER, USER_LONG]: - secret["desc"] = " ".join(l0[1:]) - elif stype in [CMD, CMD_ONCE]: - secret["cmd"] = " ".join(l0[1:]) - elif stype == CONST: - secret["value"] = " ".join(l0[1:]) - elif stype == CONST_LONG: - secret["value"] = "\n".join(lines[1:]) - elif stype in [SERVICE_DN, SERVICE_PASSWORD]: - secret["service"] = l0[1] - if stype == SERVICE_DN: - secret["service_desc"] = " ".join(l0[2:]) - elif stype in [SSL_CERT, SSL_KEY]: - secret["cert_name"] = l0[1] - if stype == SSL_CERT: - secret["cert_domains"] = l0[2:] - elif stype in [RSA_PUBLIC_KEY, RSA_PRIVATE_KEY]: - secret["key_name"] = l0[1] - if stype == RSA_PUBLIC_KEY: - secret["key_desc"] = " ".join(l0[2:]) - else: - print(bcolors.FAIL, "ERROR:", bcolors.ENDC, "Invalid secret type", stype, "in", file_path) - sys.exit(-1) - - return secret - -def read_secrets(module_list): - secrets = {} - for mod in module_list: - for file_path in glob.glob(mod.strip('/') + "/secrets/**", recursive=True): - if os.path.isfile(file_path): - key = '/'.join(file_path.split("/")[1:]) - secrets[key] = read_secret(key, file_path) - return secrets - -def get_secrets_services(secrets): - services = {} - for key, secret in secrets.items(): - if secret["type"] not in [SERVICE_DN, SERVICE_PASSWORD]: - continue - svc = secret["service"] - print(svc, "@", key, bcolors.OKCYAN, "...", bcolors.ENDC) - if svc not in services: - services[svc] = { - "dn": "cn=%s,%s"%(svc, SERVICE_DN_SUFFIX), - "desc": "(not provided)", - "pass": None, - "dn_at": [], - "pass_at": [], - } - if secret["type"] == SERVICE_DN: - services[svc]["dn_at"].append(key) - services[svc]["desc"] = secret["service_desc"] - - if secret["type"] == SERVICE_PASSWORD: - services[svc]["pass_at"].append(key) - _, data = consul_server.kv.get(key) - if data is not None: - if services[svc]["pass"] is None: - services[svc]["pass"] = data["Value"].decode('ascii').strip() - - return services - -ldap_admin_conn = None -def get_ldap_admin_conn(): - global ldap_admin_conn - if ldap_admin_conn is None: - ldap_admin_conn = ldap.initialize(LDAP_URL) - ldap_user = input("LDAP admin user (full DN, please!): ") - ldap_pass = getpass.getpass("LDAP admin password: ") - ldap_admin_conn.simple_bind_s(ldap_user, ldap_pass) - return ldap_admin_conn - -# ---- CHECK COMMAND ---- - -def check_secrets(module_list): - secrets = read_secrets(module_list) - print("Found", len(secrets), "secrets to check") - print() - - check_secrets_presence(secrets) - check_secrets_services(secrets) - -def check_secrets_presence(secrets): - print("Checking secrets presence...") - for key in secrets.keys(): - _, data = consul_server.kv.get(key) - if data is None: - print(key, bcolors.FAIL, "x", bcolors.ENDC) - else: - print(key, bcolors.OKGREEN, "✓", bcolors.ENDC) - print() - -def check_secrets_services(secrets): - print("Checking secrets for LDAP service users...") - services = get_secrets_services(secrets) - - for svc_name, svc in services.items(): - for dn_key in svc["dn_at"]: - _, data = consul_server.kv.get(dn_key) - if data is not None: - got_val = data["Value"].decode('ascii').strip() - if got_val != svc["dn"]: - print(svc_name, "wrong DN at", dn_key, bcolors.FAIL, "x", bcolors.ENDC) - print("got:", got_val, "instead of:", svc["dn"]) - - if svc["pass"] is None: - print(svc_name, bcolors.FAIL, "no password stored", bcolors.ENDC) - else: - for pass_key in svc["pass_at"]: - _, data = consul_server.kv.get(pass_key) - if data is not None: - got_val = data["Value"].decode('ascii').strip() - if got_val != svc["pass"]: - print(svc_name, "wrong pass at", dn_key, bcolors.FAIL, "x", bcolors.ENDC) - - l = ldap.initialize(LDAP_URL) - try: - l.simple_bind_s(svc["dn"], svc["pass"]) - print(svc_name, bcolors.OKGREEN, "✓", bcolors.ENDC) - except Exception as e: - print(svc_name, bcolors.FAIL, e, bcolors.ENDC) - print() - - -# ---- GEN COMMAND ---- - -def gen_secrets(module_list, regen): - secrets = read_secrets(module_list) - print("Found", len(secrets), "secrets to check and maybe generate") - print() - - gen_secrets_base(secrets, regen) - gen_secrets_services(secrets, regen) - - check_secrets_presence(secrets) - check_secrets_services(secrets) - -def gen_secrets_base(secrets, regen): - print("Filling in user secrets and cmd secrets...") - - for key, secret in secrets.items(): - _, data = consul_server.kv.get(key) - if data is not None and not regen: - continue - - if secret["type"] == USER: - print("----") - print(key) - print("Description:", secret["desc"]) - print("Enter value for secret, or ^C to skip:") - try: - val = input().strip() - consul_server.kv.put(key, val) - print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) - except KeyboardInterrupt: - print(bcolors.WARNING, "Skipped.", bcolors.ENDC) - - if secret["type"] == USER_LONG: - print("----") - print(key) - print("Description:", secret["desc"]) - print("Enter value for secret, or ^C to skip:") - print("THIS IS A LONG VALUE, ENTER SEVERAL LINES AND FINISH WITH A LINE CONTAINING A SINGLE .") - try: - lines = [] - while True: - line = input().strip() - if line == ".": - break - lines.append(line) - val = "\n".join(lines) - consul_server.kv.put(key, val) - print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) - except KeyboardInterrupt: - print(bcolors.WARNING, "Skipped.", bcolors.ENDC) - - if secret["type"] in [CONST, CONST_LONG]: - print("----") - print(key) - print("Resetting to constant value.") - consul_server.kv.put(key, secret["value"]) - print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) - - if secret["type"] == CMD or (secret["type"] == CMD_ONCE and data is None): - print("----") - print(key) - print("Executing command:", secret["cmd"]) - val = subprocess.check_output(["sh", "-c", secret["cmd"]]) - consul_server.kv.put(key, val) - print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) - - print() - -def gen_secrets_services(secrets, regen): - print("Generating LDAP service accounts...") - services = get_secrets_services(secrets) - - for svc_name, svc in services.items(): - print("----") - print("Service:", svc_name) - print("Description:", svc["desc"]) - - for dn_key in svc["dn_at"]: - _, data = consul_server.kv.get(dn_key) - if data is None or data["Value"].decode('ascii').strip() != svc["dn"]: - print(bcolors.OKCYAN, "Setting DN", bcolors.ENDC, "at", dn_key) - consul_server.kv.put(dn_key, svc["dn"]) - - if svc["pass"] is None or regen: - print(bcolors.OKCYAN, "Generating new password", bcolors.ENDC) - svc["pass"] = base64.urlsafe_b64encode(token_bytes(12)).decode('ascii') - - l = ldap.initialize(LDAP_URL) - try: - l.simple_bind_s(svc["dn"], svc["pass"]) - except: - fix_service_user(svc) - - for pass_key in svc["pass_at"]: - _, data = consul_server.kv.get(pass_key) - if data is None or data["Value"].decode('ascii').strip() != svc["pass"]: - print(bcolors.OKCYAN, "Setting password", bcolors.ENDC, "at", pass_key) - consul_server.kv.put(pass_key, svc["pass"]) - - print() - -def fix_service_user(svc): - print("Fixing service user", svc["dn"], "...") - l = get_ldap_admin_conn() - res = l.search_s(svc["dn"], ldap.SCOPE_BASE, "objectclass=*") - pass_crypt = ldap_salted_sha1.hash(svc["pass"]) - if res is None or len(res) == 0: - print(bcolors.OKCYAN, "Creating entity...", bcolors.ENDC) - l.add_s(svc["dn"], - [ - ("objectclass", [b"person", b"top"]), - ("displayname", [svc["desc"].encode('ascii')]), - ("userpassword", [pass_crypt.encode('ascii')]), - ]) - else: - print(bcolors.OKCYAN, "Resetting entity password", bcolors.ENDC) - l.modify_s(svc["dn"], - [ - (ldap.MOD_REPLACE, "userpassword", [pass_crypt.encode('ascii')]) - ]) - -# ---- MAIN ---- - -if __name__ == "__main__": - for i, val in enumerate(sys.argv): - if val == "check": - check_secrets(sys.argv[i+1:]) - break - elif val == "gen": - gen_secrets(sys.argv[i+1:], False) - break - elif val == "regen": - gen_secrets(sys.argv[i+1:], True) - break - else: - print("Usage:") - print(" secretmgr.py [check|gen|regen] ...") - - -# vim: set sts=4 ts=4 sw=4 tw=0 ft=python et : -- cgit v1.2.3 From 8d0a7a806da952adccca51b0a806a4c28732ea90 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Sun, 25 Dec 2022 21:03:16 +0100 Subject: New secretmgr --- secretmgr | 444 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 444 insertions(+) create mode 100755 secretmgr (limited to 'secretmgr') diff --git a/secretmgr b/secretmgr new file mode 100755 index 0000000..0b4aa3f --- /dev/null +++ b/secretmgr @@ -0,0 +1,444 @@ +#!/usr/bin/env nix-shell +#!nix-shell -i python3 -p "python3.withPackages(ps: [ ps.pip ps.consul ps.ldap ps.passlib ps.requests ps.six ps.toml ])" + +# DEPENDENCY: python-consul +import consul + +# DEPENDENCY: python-ldap +import ldap + +# DEPENDENCY: passlib +from passlib.hash import ldap_salted_sha1 + +# DEPENDENCY: toml +import toml + +import os +import sys +import glob +import subprocess +import getpass +import base64 +from secrets import token_bytes + +""" +This is a utility to handle secrets in the Consul database +for the various components of the Deuxfleurs infrastructure + +Functionnalities: +- check that secrets are correctly configured +- help user fill in secrets +- create LDAP service users and fill in corresponding secrets +- TODO: manage Garage buckets and access keys +- maybe one day: manage SSL certificates and keys +""" + +# ---- UTIL ---- + +consul_server = consul.Consul() + +class bcolors: + HEADER = '\033[95m' + OKBLUE = '\033[94m' + OKCYAN = '\033[96m' + OKGREEN = '\033[92m' + WARNING = '\033[93m' + FAIL = '\033[91m' + ENDC = '\033[0m' + BOLD = '\033[1m' + UNDERLINE = '\033[4m' + + +# ---- SECRETS ---- + +class Secret: + def __init__(self, key, config, description=None): + self.config = config + self.key = key + self.consul_key = "secrets/" + key + if description != None: + self.description = description + else: + self.description = None + + def check(self, value): + return True + + def generate(self): + pass + + def rotate(self): + return None + + def print_info(self): + print("Secret: {}".format(self.consul_key)) + print("Type: {}".format(self.__class__.__name__)) + if self.description != None: + print("Description: {}".format(self.description)) + +class UserSecret(Secret): + def __init__(self, example=None, multiline=False, **kwargs): + Secret.__init__(self, **kwargs) + self.example = example + self.multiline = multiline + + def generate(self): + if self.key in self.config.constants: + print("Using constant value from cluster's secretmgr.toml") + return self.config.constants[self.key] + + print("Enter value for secret, or ^C to skip:") + if self.multiline: + print("THIS IS A LONG VALUE, ENTER SEVERAL LINES AND FINISH WITH A LINE CONTAINING A SINGLE .") + try: + lines = [] + while True: + line = input().strip() + if line == ".": + break + lines.append(line) + return "\n".join(lines) + except KeyboardInterrupt: + return None + else: + try: + while True: + line = input().strip() + if line != "": + return line + else: + print("Please enter a non-empty value, or ^C to skip:") + except KeyboardInterrupt: + return None + +class CommandSecret(Secret): + def __init__(self, command, rotate=False, **kwargs): + Secret.__init__(self, **kwargs) + self.command = command + self.rotate_value = rotate + + def generate(self): + print("Executing command:", self.command) + return subprocess.check_output(["sh", "-c", self.command]) + + def rotate(self): + if self.rotate_value: + return self.generate() + else: + return None + +class ConstantSecret(Secret): + def __init__(self, value, **kwargs): + Secret.__init__(self, **kwargs) + self.value = value + + def check(self, value): + return value == self.value + + def generate(self): + return self.value + + +# ---- SERVICE USERS ---- + +class ServiceUserPasswordSecret(Secret): + def __init__(self, service_user, **kwargs): + Secret.__init__(self, **kwargs) + self.service_user = service_user + + def check(self, value): + l = ldap.initialize(self.config.ldap_server) + try: + l.simple_bind_s(self.service_user.dn, value) + return True + except Exception as e: + return False + + def generate(self): + return self.service_user.password + + def rotate(self): + return self.service_user.password + +class ServiceUser: + def __init__(self, username, password_secret, config, description=None, dn_secret=None, username_secret=None, rotate_password=False): + self.config = config + self.username = username + self.description = description + self.password = None + self.dn = "cn={},{}".format(self.username, self.config.ldap_service_dn_suffix) + self.rotate_password = rotate_password + + self.password_secret = ServiceUserPasswordSecret( + config=config, + service_user=self, + key=password_secret, + description="LDAP password for service user {}".format(username), + ) + + self.username_secret = None + if username_secret != None: + self.username_secret = ConstantSecret( + config=config, + key=username_secret, + value=username, + description="LDAP username for service user {}".format(username), + ) + + self.dn_secret = None + if dn_secret != None: + self.dn_secret = ConstantSecret( + config=config, + key=dn_secret, + value=self.dn, + description="LDAP DN for service user {}".format(username), + ) + + def secrets(self): + secrets = {} + secrets[self.password_secret.key] = self.password_secret + if self.dn_secret != None: + secrets[self.dn_secret.key] = self.dn_secret + if self.username_secret != None: + secrets[self.username_secret.key] = self.username_secret + return secrets + + def configure(self, rotate): + _, data = consul_server.kv.get(self.password_secret.consul_key) + if data is None: + good = False + else: + l = ldap.initialize(self.config.ldap_server) + try: + self.password = data["Value"].decode('ascii') + l.simple_bind_s(self.dn, self.password) + good = True + except: + good = False + + if not good or (rotate and self.rotate_password): + # Reset passsword + self.password = base64.urlsafe_b64encode(token_bytes(12)).decode('ascii') + pass_crypt = ldap_salted_sha1.hash(self.password).encode('ascii') + + l = self.config.get_ldap_admin_conn() + res = l.search_s(self.dn, ldap.SCOPE_BASE, "objectclass=*") + if res is None or len(res) == 0: + print(bcolors.OKCYAN, "Creating entity", self.dn, bcolors.ENDC) + l.add_s(self.dn, + [ + ("objectclass", [b"person", b"top"]), + ("displayname", [self.description.encode('ascii')]), + ("userpassword", [pass_crypt]), + ]) + else: + print(bcolors.OKCYAN, "Resetting password for entity", self.dn, bcolors.ENDC) + l.modify_s(self.dn, + [ + (ldap.MOD_REPLACE, "userpassword", [pass_crypt]) + ]) + else: + print(bcolors.OKGREEN, "Entity is good: ", self.dn, bcolors.ENDC) + + +# ---- MAIN CONFIG CLASS ---- + +class Config: + def __init__(self, cluster_name): + self.cluster_name = cluster_name + self.app_path = os.path.join(".", "cluster", cluster_name, "app") + + self.service_users = {} + self.secrets = {} + self.modules = [] + + # Load config from secretmgr.toml in cluster directory + secretmgr_toml_path = os.path.join(".", "cluster", cluster_name, "secretmgr.toml") + if os.path.exists(secretmgr_toml_path): + with open(secretmgr_toml_path) as f: + secretmgr_toml = toml.load(f) + else: + secretmgr_toml = {} + + if "constants" in secretmgr_toml: + self.constants = secretmgr_toml["constants"] + else: + self.constants = {} + + self.ldap_server = None + self.ldap_service_dn_suffix = None + self.ldap_admin_dn = None + self.ldap_admin_password_secret = None + self.ldap_admin_conn = None + if "ldap" in secretmgr_toml: + if "server" in secretmgr_toml["ldap"]: + self.ldap_server = secretmgr_toml["ldap"]["server"] + if "service_dn_suffix" in secretmgr_toml["ldap"]: + self.ldap_service_dn_suffix = secretmgr_toml["ldap"]["service_dn_suffix"] + if "admin_dn" in secretmgr_toml["ldap"]: + self.ldap_admin_dn = secretmgr_toml["ldap"]["admin_dn"] + if "admin_password_secret" in secretmgr_toml["ldap"]: + self.ldap_admin_password_secret = secretmgr_toml["ldap"]["admin_password_secret"] + + def load_module(self, module_name): + secrets_toml_path = os.path.join(self.app_path, module_name, "secrets.toml") + + with open(secrets_toml_path) as f: + secrets_toml = toml.load(f) + + self.modules.append(module_name) + + # Service users, and their associated secrets + if "service_users" in secrets_toml: + for (uname, uargs) in secrets_toml["service_users"].items(): + service_user = ServiceUser(uname, config=self, **uargs) + for (skey, secret) in service_user.secrets().items(): + if skey in self.secrets: + raise Exception("Duplicate secret: {}".format(skey)) + self.secrets[skey] = secret + self.service_users[uname] = service_user + + # Other secrets + if "secrets" in secrets_toml: + for (skey, sargs) in secrets_toml["secrets"].items(): + ty = sargs["type"] + del sargs["type"] + if ty == "user": + secret = UserSecret(config=self, key=skey, **sargs) + elif ty == "command": + secret = CommandSecret(config=self, key=skey, **sargs) + elif ty == "constant": + secret = ConstantSecret(config=self, key=skey, **sargs) + else: + raise Exception("Invalid secret type: {}".format(ty)) + if skey in self.secrets: + raise Exception("Duplicate secret: {}".format(skey)) + self.secrets[skey] = secret + + def add_constant_secrets(self): + for (skey, value) in self.constants.items(): + self.secrets[skey] = ConstantSecret( + config=self, + key=skey, + value=value, + description="Constant value for secret {}".format(skey)) + + def get_ldap_admin_conn(self): + if self.ldap_admin_conn is None: + if self.ldap_admin_password_secret != None: + pass_key = "secrets/" + self.ldap_admin_password_secret + _, data = consul_server.kv.get(pass_key) + if data is None: + raise Exception("LDAP admin password could not be read at: {}".format(pass_key)) + ldap_pass = data["Value"].decode('ascii').strip() + else: + ldap_pass = getpass.getpass("LDAP admin password: ") + + self.ldap_admin_conn = ldap.initialize(self.ldap_server) + self.ldap_admin_conn.simple_bind_s(self.ldap_admin_dn, ldap_pass) + return self.ldap_admin_conn + + def check_secrets(self): + print(":: Checking secrets...") + must_gen = False + for (_, secret) in self.secrets.items(): + _, data = consul_server.kv.get(secret.consul_key) + if data is None: + print(secret.consul_key, bcolors.FAIL, "x missing", bcolors.ENDC) + must_gen = True + elif not secret.check(data["Value"].decode('ascii').strip()): + print(secret.consul_key, bcolors.WARNING, "x bad value", bcolors.ENDC) + must_gen = True + else: + print(secret.consul_key, bcolors.OKGREEN, "✓", bcolors.ENDC) + print() + if must_gen: + print("To fix missing or invalid secrets, use `secretmgr gen ...`") + print() + + def gen_secrets(self): + if len(self.service_users) > 0: + print(":: Configuring service users...") + for (_, su) in self.service_users.items(): + su.configure(False) + print() + + print(":: Generating missing/invalid secrets...") + for (_, secret) in self.secrets.items(): + _, data = consul_server.kv.get(secret.consul_key) + if data is None or not secret.check(data["Value"].decode('ascii').strip()): + print() + secret.print_info() + value = secret.generate() + if value != None: + consul_server.kv.put(secret.consul_key, value) + print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) + else: + print(bcolors.WARNING, "Skipped.", bcolors.ENDC) + + print() + self.check_secrets() + + def rotate_secrets(self): + if len(self.service_users) > 0: + print(":: Regenerating service user passwords...") + for (_, su) in self.service_users.items(): + su.configure(True) + print() + + print(":: Rotating secrets...") + for (_, secret) in self.secrets.items(): + print() + secret.print_info() + + _, data = consul_server.kv.get(secret.consul_key) + if data is None: + old_value = None + else: + old_value = data["Value"].decode('ascii').strip() + new_value = secret.rotate() + + if new_value != None and new_value != old_value: + consul_server.kv.put(secret.consul_key, new_value) + print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) + else: + print(bcolors.OKGREEN, "Nothing to do.", bcolors.ENDC) + + print() + self.check_secrets() + + +# ---- MAIN ---- + +def load_config(cluster_name, modules): + cfg = Config(cluster_name) + if len(modules) > 0: + for mod in modules: + cfg.load_module(mod) + else: + cfg.add_constant_secrets() + return cfg + +if __name__ == "__main__": + verb = None + + for i, val in enumerate(sys.argv): + if val == "check": + verb = lambda cfg: cfg.check_secrets() + break + elif val == "gen": + verb = lambda cfg: cfg.gen_secrets() + break + elif val == "rotate": + verb = lambda cfg: cfg.rotate_secrets() + break + + if verb is None: + print("Usage:") + print(" secretmgr.py [check|gen|rotate] ...") + else: + cfg = load_config(sys.argv[i+1], sys.argv[i+2:]) + verb(cfg) + + +# vim: set sts=4 ts=4 sw=4 tw=0 ft=python et : -- cgit v1.2.3 From 6d6e48c8fa7f4f38a5b812389d269c025a977790 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Sun, 25 Dec 2022 22:12:38 +0100 Subject: Improve secretmgr more, update secrets for staging --- secretmgr | 250 +++++++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 191 insertions(+), 59 deletions(-) (limited to 'secretmgr') diff --git a/secretmgr b/secretmgr index 0b4aa3f..1507008 100755 --- a/secretmgr +++ b/secretmgr @@ -55,7 +55,6 @@ class Secret: def __init__(self, key, config, description=None): self.config = config self.key = key - self.consul_key = "secrets/" + key if description != None: self.description = description else: @@ -71,21 +70,30 @@ class Secret: return None def print_info(self): - print("Secret: {}".format(self.consul_key)) - print("Type: {}".format(self.__class__.__name__)) + print("Secret: {}".format(self.key)) + print("Type: {}".format(self.__class__.TYPE)) if self.description != None: print("Description: {}".format(self.description)) class UserSecret(Secret): + TYPE = "user-entered secret" + def __init__(self, example=None, multiline=False, **kwargs): Secret.__init__(self, **kwargs) self.example = example self.multiline = multiline + def print_info(self): + Secret.print_info(self) + if self.key in self.config.user_values: + print("Cluster value: {}".format(self.config.user_values[self.key])) + elif self.example != None: + print("Example: {}".format(self.example)) + def generate(self): - if self.key in self.config.constants: + if self.key in self.config.user_values: print("Using constant value from cluster's secretmgr.toml") - return self.config.constants[self.key] + return self.config.user_values[self.key] print("Enter value for secret, or ^C to skip:") if self.multiline: @@ -112,11 +120,19 @@ class UserSecret(Secret): return None class CommandSecret(Secret): + TYPE = "command" + def __init__(self, command, rotate=False, **kwargs): Secret.__init__(self, **kwargs) self.command = command self.rotate_value = rotate + def print_info(self): + Secret.print_info(self) + print("Command: {}".format(self.command)) + if self.rotate_value: + print("Rotate: True") + def generate(self): print("Executing command:", self.command) return subprocess.check_output(["sh", "-c", self.command]) @@ -128,10 +144,16 @@ class CommandSecret(Secret): return None class ConstantSecret(Secret): + TYPE = "constant value" + def __init__(self, value, **kwargs): Secret.__init__(self, **kwargs) self.value = value + def print_info(self): + Secret.print_info(self) + print("Value: {}".format(self.value)) + def check(self, value): return value == self.value @@ -142,10 +164,16 @@ class ConstantSecret(Secret): # ---- SERVICE USERS ---- class ServiceUserPasswordSecret(Secret): + TYPE = "service user's password" + def __init__(self, service_user, **kwargs): Secret.__init__(self, **kwargs) self.service_user = service_user + def print_info(self): + Secret.print_info(self) + print("Service user: {}".format(self.service_user.username)) + def check(self, value): l = ldap.initialize(self.config.ldap_server) try: @@ -160,6 +188,41 @@ class ServiceUserPasswordSecret(Secret): def rotate(self): return self.service_user.password +class ServiceUserNameSecret(Secret): + TYPE = "service user's username (constant value)" + + def __init__(self, service_user, **kwargs): + Secret.__init__(self, **kwargs) + self.service_user = service_user + + def print_info(self): + Secret.print_info(self) + print("Value: {}".format(self.service_user.username)) + + def check(self, value): + return value == self.service_user.username + + def generate(self): + return self.service_user.username + +class ServiceUserDNSecret(Secret): + TYPE = "service user's DN (constant value)" + + def __init__(self, service_user, **kwargs): + Secret.__init__(self, **kwargs) + self.service_user = service_user + + def print_info(self): + Secret.print_info(self) + print("Service user: {}".format(self.service_user.username)) + print("Value: {}".format(self.service_user.dn)) + + def check(self, value): + return value == self.service_user.dn + + def generate(self): + return self.service_user.dn + class ServiceUser: def __init__(self, username, password_secret, config, description=None, dn_secret=None, username_secret=None, rotate_password=False): self.config = config @@ -169,30 +232,15 @@ class ServiceUser: self.dn = "cn={},{}".format(self.username, self.config.ldap_service_dn_suffix) self.rotate_password = rotate_password - self.password_secret = ServiceUserPasswordSecret( - config=config, - service_user=self, - key=password_secret, - description="LDAP password for service user {}".format(username), - ) + self.password_secret = ServiceUserPasswordSecret(config=config, service_user=self, key=password_secret) self.username_secret = None if username_secret != None: - self.username_secret = ConstantSecret( - config=config, - key=username_secret, - value=username, - description="LDAP username for service user {}".format(username), - ) + self.username_secret = ServiceUserNameSecret(config=config, service_user=self, key=username_secret) self.dn_secret = None if dn_secret != None: - self.dn_secret = ConstantSecret( - config=config, - key=dn_secret, - value=self.dn, - description="LDAP DN for service user {}".format(username), - ) + self.dn_secret = ServiceUserDNSecret(config=config, service_user=self, key=dn_secret) def secrets(self): secrets = {} @@ -204,13 +252,12 @@ class ServiceUser: return secrets def configure(self, rotate): - _, data = consul_server.kv.get(self.password_secret.consul_key) - if data is None: + self.password = self.config.get_secret(self.password_secret.key) + if self.password is None: good = False else: l = ldap.initialize(self.config.ldap_server) try: - self.password = data["Value"].decode('ascii') l.simple_bind_s(self.dn, self.password) good = True except: @@ -225,6 +272,9 @@ class ServiceUser: res = l.search_s(self.dn, ldap.SCOPE_BASE, "objectclass=*") if res is None or len(res) == 0: print(bcolors.OKCYAN, "Creating entity", self.dn, bcolors.ENDC) + if self.config.dry_run: + print(bcolors.OKBLUE, "Dry run, skipping. Add --do to actually do something.", bcolors.ENDC) + return l.add_s(self.dn, [ ("objectclass", [b"person", b"top"]), @@ -233,6 +283,9 @@ class ServiceUser: ]) else: print(bcolors.OKCYAN, "Resetting password for entity", self.dn, bcolors.ENDC) + if self.config.dry_run: + print(bcolors.OKBLUE, "Dry run, skipping. Add --do to actually do something.", bcolors.ENDC) + return l.modify_s(self.dn, [ (ldap.MOD_REPLACE, "userpassword", [pass_crypt]) @@ -244,13 +297,14 @@ class ServiceUser: # ---- MAIN CONFIG CLASS ---- class Config: - def __init__(self, cluster_name): + def __init__(self, cluster_name, dry_run): self.cluster_name = cluster_name self.app_path = os.path.join(".", "cluster", cluster_name, "app") self.service_users = {} self.secrets = {} self.modules = [] + self.dry_run = dry_run # Load config from secretmgr.toml in cluster directory secretmgr_toml_path = os.path.join(".", "cluster", cluster_name, "secretmgr.toml") @@ -260,10 +314,10 @@ class Config: else: secretmgr_toml = {} - if "constants" in secretmgr_toml: - self.constants = secretmgr_toml["constants"] + if "user_values" in secretmgr_toml: + self.user_values = secretmgr_toml["user_values"] else: - self.constants = {} + self.user_values = {} self.ldap_server = None self.ldap_service_dn_suffix = None @@ -309,28 +363,66 @@ class Config: secret = CommandSecret(config=self, key=skey, **sargs) elif ty == "constant": secret = ConstantSecret(config=self, key=skey, **sargs) + elif ty == "service_password": + service = sargs["service"] + del sargs["service"] + secret = ServiceUserPasswordSecret( + config=self, + key=skey, + service_user=self.service_users[service], + **sargs) + elif ty == "service_username": + service = sargs["service"] + del sargs["service"] + secret = ServiceUserNameSecret( + config=self, + key=skey, + service_user=self.service_users[service], + **sargs) + elif ty == "service_dn": + service = sargs["service"] + del sargs["service"] + secret = ServiceUserDNSecret( + config=self, + key=skey, + service_user=self.service_users[service], + **sargs) else: - raise Exception("Invalid secret type: {}".format(ty)) + description = "{}, {}".format(ty, + ", ".join([k + ": " + v for k, v in sargs.items()])) + secret = UserSecret( + config=self, + key=skey, + multiline=True, + description=description) if skey in self.secrets: raise Exception("Duplicate secret: {}".format(skey)) self.secrets[skey] = secret - def add_constant_secrets(self): - for (skey, value) in self.constants.items(): + def add_user_values_secrets(self): + for (skey, value) in self.user_values.items(): self.secrets[skey] = ConstantSecret( config=self, key=skey, value=value, - description="Constant value for secret {}".format(skey)) + description="Cluster-defined user value") + + # -- consul and ldap helpers -- + + def check_consul_cluster(self): + # Check cluster name we are connected to + consul_node = consul_server.agent.self() + if consul_node["Config"]["Datacenter"] != self.cluster_name: + print("You are not connected to the correct Consul cluster.") + print("You are connected to cluster '{}' instead of '{}'.".format(consul_node["Config"]["Datacenter"], self.cluster_name)) + sys.exit(1) def get_ldap_admin_conn(self): if self.ldap_admin_conn is None: if self.ldap_admin_password_secret != None: - pass_key = "secrets/" + self.ldap_admin_password_secret - _, data = consul_server.kv.get(pass_key) - if data is None: + ldap_pass = self.get_secret(self.ldap_admin_password_secret) + if ldap_pass is None: raise Exception("LDAP admin password could not be read at: {}".format(pass_key)) - ldap_pass = data["Value"].decode('ascii').strip() else: ldap_pass = getpass.getpass("LDAP admin password: ") @@ -338,25 +430,57 @@ class Config: self.ldap_admin_conn.simple_bind_s(self.ldap_admin_dn, ldap_pass) return self.ldap_admin_conn + def get_secret(self, key): + _, data = consul_server.kv.get("secrets/" + key) + if data is None: + return None + else: + return data["Value"].decode('ascii').strip() + + def put_secret(self, key, value): + if self.dry_run: + print(bcolors.OKBLUE, "Dry run, not updating secrets/{}. Add --do to actually do something.".format(key), bcolors.ENDC) + return + consul_server.kv.put("secrets/" + key, value) + + # -- user actions -- + + def print_info(self): + print("== LIST OF SERVICE USERS ==") + print() + for (_, su) in self.service_users.items(): + print("Username: {}".format(su.username)) + print("DN: {}".format(su.dn)) + print("Pass. secret: {}".format(su.password_secret.key)) + print() + + print("== LIST OF SECRETS ==") + print() + for (_, secret) in self.secrets.items(): + secret.print_info() + print() + def check_secrets(self): + self.check_consul_cluster() print(":: Checking secrets...") must_gen = False for (_, secret) in self.secrets.items(): - _, data = consul_server.kv.get(secret.consul_key) - if data is None: - print(secret.consul_key, bcolors.FAIL, "x missing", bcolors.ENDC) + value = self.get_secret(secret.key) + if value is None: + print(secret.key, bcolors.FAIL, "x missing", bcolors.ENDC) must_gen = True - elif not secret.check(data["Value"].decode('ascii').strip()): - print(secret.consul_key, bcolors.WARNING, "x bad value", bcolors.ENDC) + elif not secret.check(value): + print(secret.key, bcolors.WARNING, "x bad value", bcolors.ENDC) must_gen = True else: - print(secret.consul_key, bcolors.OKGREEN, "✓", bcolors.ENDC) + print(secret.key, bcolors.OKGREEN, "✓", bcolors.ENDC) print() if must_gen: print("To fix missing or invalid secrets, use `secretmgr gen ...`") print() def gen_secrets(self): + self.check_consul_cluster() if len(self.service_users) > 0: print(":: Configuring service users...") for (_, su) in self.service_users.items(): @@ -365,13 +489,13 @@ class Config: print(":: Generating missing/invalid secrets...") for (_, secret) in self.secrets.items(): - _, data = consul_server.kv.get(secret.consul_key) - if data is None or not secret.check(data["Value"].decode('ascii').strip()): + old_value = self.get_secret(secret.key) + if old_value is None or not secret.check(old_value): print() secret.print_info() value = secret.generate() if value != None: - consul_server.kv.put(secret.consul_key, value) + self.put_secret(secret.key, value) print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) else: print(bcolors.WARNING, "Skipped.", bcolors.ENDC) @@ -380,6 +504,7 @@ class Config: self.check_secrets() def rotate_secrets(self): + self.check_consul_cluster() if len(self.service_users) > 0: print(":: Regenerating service user passwords...") for (_, su) in self.service_users.items(): @@ -391,15 +516,11 @@ class Config: print() secret.print_info() - _, data = consul_server.kv.get(secret.consul_key) - if data is None: - old_value = None - else: - old_value = data["Value"].decode('ascii').strip() + old_value = self.get_secret(secret.key) new_value = secret.rotate() if new_value != None and new_value != old_value: - consul_server.kv.put(secret.consul_key, new_value) + self.put_secret(secret.key, new_value) print(bcolors.OKCYAN, "Value set.", bcolors.ENDC) else: print(bcolors.OKGREEN, "Nothing to do.", bcolors.ENDC) @@ -410,20 +531,28 @@ class Config: # ---- MAIN ---- -def load_config(cluster_name, modules): - cfg = Config(cluster_name) +def load_config(cluster_name, modules, **kwargs): + # Load config + cfg = Config(cluster_name, **kwargs) if len(modules) > 0: for mod in modules: cfg.load_module(mod) else: - cfg.add_constant_secrets() + cfg.add_user_values_secrets() + return cfg if __name__ == "__main__": verb = None + dry_run = True for i, val in enumerate(sys.argv): - if val == "check": + if val == "--do": + dry_run = False + elif val == "info": + verb = lambda cfg: cfg.print_info() + break + elif val == "check": verb = lambda cfg: cfg.check_secrets() break elif val == "gen": @@ -435,9 +564,12 @@ if __name__ == "__main__": if verb is None: print("Usage:") - print(" secretmgr.py [check|gen|rotate] ...") + print(" secretmgr [--do] info|check|gen|rotate [...]") else: - cfg = load_config(sys.argv[i+1], sys.argv[i+2:]) + cfg = load_config( + cluster_name=sys.argv[i+1], + modules=sys.argv[i+2:], + dry_run=dry_run) verb(cfg) -- cgit v1.2.3