bump chart

Bump mikefarah/yq from 4.32.2 to 4.33.1

.github/workflows/release.yml

@@ -27,14 +27,14 @@ jobs:
           version: v3.10.0
 
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.4.1
+        uses: helm/chart-releaser-action@v1.5.0
         with:
           charts_dir: charts
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
 
       - name: Get app version from chart
-        uses: mikefarah/yq@v4.30.6
+        uses: mikefarah/yq@v4.33.1
         id: app_version
         with:
           cmd: yq '.appVersion' charts/bitwarden-crd-operator/Chart.yaml
@@ -65,4 +65,4 @@ jobs:
           file_glob: true
           file: lerentis-bitwarden-crd-operator_*.spdx.json
           tag:  ${{ steps.previoustag.outputs.tag }}
-          overwrite: false
+          overwrite: true

Dockerfile

@@ -1,15 +1,15 @@
 FROM alpine:latest as builder
 
-ARG BW_VERSION=2022.11.0
+ARG BW_VERSION=2023.1.0
 
 RUN apk add wget unzip
 
 RUN cd /tmp && wget https://github.com/bitwarden/clients/releases/download/cli-v${BW_VERSION}/bw-linux-${BW_VERSION}.zip && \
     unzip /tmp/bw-linux-${BW_VERSION}.zip
 
-FROM alpine:3.17
+FROM alpine:3.17.3
 
-ARG PYTHON_VERSION=3.10.9-r1
+ARG PYTHON_VERSION=3.10.11-r0
 ARG PIP_VERSION=22.3.1-r1
 ARG GCOMPAT_VERSION=1.1.0-r0
 
@@ -22,7 +22,7 @@ RUN set -eux; \
     mkdir -p /home/bw-operator; \
     chown -R bw-operator /home/bw-operator; \
     chmod +x /usr/local/bin/bw; \
-    apk add gcc musl-dev libstdc++ gcompat=${GCOMPAT_VERSION} python3=${PYTHON_VERSION} py-pip=${PIP_VERSION}; \
+    apk add gcc musl-dev libstdc++ gcompat=${GCOMPAT_VERSION} python3=${PYTHON_VERSION} py3-pip=${PIP_VERSION}; \
     pip install -r requirements.txt --no-warn-script-location; \
     apk del --purge gcc musl-dev libstdc++;
 

charts/bitwarden-crd-operator/Chart.yaml

@@ -4,9 +4,9 @@ description: Deploy the Bitwarden CRD Operator
 
 type: application
 
-version: "v0.5.0"
+version: "v0.5.4"
 
-appVersion: "0.5.0"
+appVersion: "0.5.4"
 
 keywords:
   - operator
@@ -94,12 +94,8 @@ annotations:
   artifacthub.io/license: MIT
   artifacthub.io/operator: "true"  
   artifacthub.io/changes: |
-    - kind: added
-      description: "Implemented update handling"
     - kind: changed
-      description: "Changed default logging structure to json logging"
-    - kind: changed
-      description: "Secrets are periodically updated every 15 minutes"
+      description: "Bump Alpine base image from 3.17.2 to 3.17.3"
   artifacthub.io/images: |
     - name: bitwarden-crd-operator
-      image: lerentis/bitwarden-crd-operator:0.5.0
+      image: lerentis/bitwarden-crd-operator:0.5.4

requirements.txt

@@ -1,3 +1,3 @@
 kopf==1.36.0
-kubernetes==25.3.0
+kubernetes==26.1.0
 Jinja2==3.1.2

src/bitwardenCrdOperator.py

@@ -1,20 +1,20 @@
 #!/usr/bin/env python3
-import kopf
 import os
+import kopf
 
 from utils.utils import command_wrapper, unlock_bw
 
+
 @kopf.on.startup()
 def bitwarden_signin(logger, **kwargs):
     if 'BW_HOST' in os.environ:
         try:
             command_wrapper(f"config server {os.getenv('BW_HOST')}")
-        except:
+        except BaseException:
             logger.warn("Revieved none zero exit code from server config")
             logger.warn("This is expected from startup")
             pass
     else:
-        logger.info(f"BW_HOST not set. Assuming SaaS installation")
+        logger.info("BW_HOST not set. Assuming SaaS installation")
     command_wrapper("login --apikey")
     unlock_bw(logger)
-

src/dockerlogin.py

@@ -5,7 +5,14 @@ import json
 
 from utils.utils import unlock_bw, get_secret_from_bitwarden
 
-def create_dockerlogin(logger, secret, secret_json, username_ref, password_ref, registry):
+
+def create_dockerlogin(
+        logger,
+        secret,
+        secret_json,
+        username_ref,
+        password_ref,
+        registry):
     secret.type = "dockerconfigjson"
     secret.data = {}
     auths_dict = {}
@@ -15,14 +22,19 @@ def create_dockerlogin(logger, secret, secret_json, username_ref, password_ref,
     _username = secret_json["login"][username_ref]
     logger.info(f"Creating login with username: {_username}")
     _password = secret_json["login"][password_ref]
-    cred_field = str(base64.b64encode(f"{_username}:{_password}".encode("utf-8")), "utf-8")
+    cred_field = str(
+        base64.b64encode(
+            f"{_username}:{_password}".encode("utf-8")),
+        "utf-8")
 
     reg_auth_dict["auth"] = cred_field
     registry_dict[registry] = reg_auth_dict
     auths_dict["auths"] = registry_dict
-    secret.data[".dockerconfigjson"] = str(base64.b64encode(json.dumps(auths_dict).encode("utf-8")), "utf-8")
+    secret.data[".dockerconfigjson"] = str(base64.b64encode(
+        json.dumps(auths_dict).encode("utf-8")), "utf-8")
     return secret
 
+
 @kopf.on.create('registry-credential.lerentis.uploadfilter24.eu')
 def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
     username_ref = spec.get('usernameRef')
@@ -43,18 +55,34 @@ def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
         "managedObject": f"{namespace}/{name}"
     }
     secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
-    secret = create_dockerlogin(logger, secret, secret_json_object, username_ref, password_ref, registry)   
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
+    secret = create_dockerlogin(
+        logger,
+        secret,
+        secret_json_object,
+        username_ref,
+        password_ref,
+        registry)
 
     obj = api.create_namespaced_secret(
         secret_namespace, secret
     )
 
-    logger.info(f"Registry Secret {secret_namespace}/{secret_name} has been created")
+    logger.info(
+        f"Registry Secret {secret_namespace}/{secret_name} has been created")
+
 
 @kopf.on.update('registry-credential.lerentis.uploadfilter24.eu')
 @kopf.timer('registry-credential.lerentis.uploadfilter24.eu', interval=900)
-def update_managed_registry_secret(spec, status, name, namespace, logger, body, **kwargs):
+def update_managed_registry_secret(
+        spec,
+        status,
+        name,
+        namespace,
+        logger,
+        body,
+        **kwargs):
 
     username_ref = spec.get('usernameRef')
     password_ref = spec.get('passwordRef')
@@ -63,6 +91,31 @@ def update_managed_registry_secret(spec, status, name, namespace, logger, body,
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
 
+    old_config = None
+    old_secret_name = None
+    old_secret_namespace = None
+    if 'kopf.zalando.org/last-handled-configuration' in body.metadata.annotations:
+        old_config = json.loads(
+            body.metadata.annotations['kopf.zalando.org/last-handled-configuration'])
+        old_secret_name = old_config['spec'].get('name')
+        old_secret_namespace = old_config['spec'].get('namespace')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    if old_config is not None and (
+            old_secret_name != secret_name or old_secret_namespace != secret_namespace):
+        # If the name of the secret or the namespace of the secret is different
+        # We have to delete the secret an recreate it
+        logger.info("Secret name or namespace changed, let's recreate it")
+        delete_managed_secret(
+            old_config['spec'],
+            name,
+            namespace,
+            logger,
+            **kwargs)
+        create_managed_registry_secret(spec, name, namespace, logger, **kwargs)
+        return
+
     unlock_bw(logger)
     logger.info(f"Locking up secret with ID: {id}")
     secret_json_object = json.loads(get_secret_from_bitwarden(id))
@@ -74,15 +127,23 @@ def update_managed_registry_secret(spec, status, name, namespace, logger, body,
         "managedObject": f"{namespace}/{name}"
     }
     secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
-    secret = create_dockerlogin(logger, secret, secret_json_object, username_ref, password_ref, registry)
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
+    secret = create_dockerlogin(
+        logger,
+        secret,
+        secret_json_object,
+        username_ref,
+        password_ref,
+        registry)
     try:
         obj = api.replace_namespaced_secret(
             name=secret_name,
             body=secret,
             namespace="{}".format(secret_namespace))
-        logger.info(f"Secret {secret_namespace}/{secret_name} has been updated")
-    except:
+        logger.info(
+            f"Secret {secret_namespace}/{secret_name} has been updated")
+    except BaseException:
         logger.warn(
             f"Could not update secret {secret_namespace}/{secret_name}!")
 
@@ -95,6 +156,8 @@ def delete_managed_secret(spec, name, namespace, logger, **kwargs):
 
     try:
         api.delete_namespaced_secret(secret_name, secret_namespace)
-        logger.info(f"Secret {secret_namespace}/{secret_name} has been deleted")
-    except:
-        logger.warn(f"Could not delete secret {secret_namespace}/{secret_name}!")
+        logger.info(
+            f"Secret {secret_namespace}/{secret_name} has been deleted")
+    except BaseException:
+        logger.warn(
+            f"Could not delete secret {secret_namespace}/{secret_name}!")

src/kv.py

@@ -19,11 +19,19 @@ def create_kv(secret, secret_json, content_def):
                 if key == "secretScope":
                     _secret_scope = value
             if _secret_scope == "login":
+                value = parse_login_scope(secret_json, _secret_key)
+                if value is None:
+                    raise Exception(
+                        f"Field {_secret_key} has no value in bitwarden secret")
                 secret.data[_secret_ref] = str(base64.b64encode(
-                    parse_login_scope(secret_json, _secret_key).encode("utf-8")), "utf-8")
+                    value.encode("utf-8")), "utf-8")
             if _secret_scope == "fields":
+                value = parse_fields_scope(secret_json, _secret_key)
+                if value is None:
+                    raise Exception(
+                        f"Field {_secret_key} has no value in bitwarden secret")
                 secret.data[_secret_ref] = str(base64.b64encode(
-                    parse_fields_scope(secret_json, _secret_key).encode("utf-8")), "utf-8")
+                    value.encode("utf-8")), "utf-8")
     return secret
 
 
@@ -60,13 +68,42 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
 
 @kopf.on.update('bitwarden-secret.lerentis.uploadfilter24.eu')
 @kopf.timer('bitwarden-secret.lerentis.uploadfilter24.eu', interval=900)
-def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs):
+def update_managed_secret(
+        spec,
+        status,
+        name,
+        namespace,
+        logger,
+        body,
+        **kwargs):
 
     content_def = body['spec']['content']
     id = spec.get('id')
+    old_config = None
+    old_secret_name = None
+    old_secret_namespace = None
+    if 'kopf.zalando.org/last-handled-configuration' in body.metadata.annotations:
+        old_config = json.loads(
+            body.metadata.annotations['kopf.zalando.org/last-handled-configuration'])
+        old_secret_name = old_config['spec'].get('name')
+        old_secret_namespace = old_config['spec'].get('namespace')
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
 
+    if old_config is not None and (
+            old_secret_name != secret_name or old_secret_namespace != secret_namespace):
+        # If the name of the secret or the namespace of the secret is different
+        # We have to delete the secret an recreate it
+        logger.info("Secret name or namespace changed, let's recreate it")
+        delete_managed_secret(
+            old_config['spec'],
+            name,
+            namespace,
+            logger,
+            **kwargs)
+        create_managed_secret(spec, name, namespace, logger, body, **kwargs)
+        return
+
     unlock_bw(logger)
     logger.info(f"Locking up secret with ID: {id}")
     secret_json_object = json.loads(get_secret_from_bitwarden(id))
@@ -88,8 +125,9 @@ def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs)
             name=secret_name,
             body=secret,
             namespace="{}".format(secret_namespace))
-        logger.info(f"Secret {secret_namespace}/{secret_name} has been updated")
-    except:
+        logger.info(
+            f"Secret {secret_namespace}/{secret_name} has been updated")
+    except BaseException:
         logger.warn(
             f"Could not update secret {secret_namespace}/{secret_name}!")
 
@@ -104,6 +142,6 @@ def delete_managed_secret(spec, name, namespace, logger, **kwargs):
         api.delete_namespaced_secret(secret_name, secret_namespace)
         logger.info(
             f"Secret {secret_namespace}/{secret_name} has been deleted")
-    except:
+    except BaseException:
         logger.warn(
             f"Could not delete secret {secret_namespace}/{secret_name}!")

src/lookups/bitwarden_lookup.py

@@ -2,9 +2,10 @@ import json
 
 from utils.utils import get_secret_from_bitwarden, parse_fields_scope, parse_login_scope
 
+
 def bitwarden_lookup(id, scope, field):
     _secret_json = json.loads(get_secret_from_bitwarden(id))
     if scope == "login":
         return parse_login_scope(_secret_json, field)
     if scope == "fields":
-        return parse_fields_scope(_secret_json, field)
+        return parse_fields_scope(_secret_json, field)

src/template.py

@@ -1,6 +1,7 @@
 import kopf
 import base64
 import kubernetes
+import json
 
 from utils.utils import unlock_bw
 from lookups.bitwarden_lookup import bitwarden_lookup
@@ -11,17 +12,23 @@ lookup_func_dict = {
     "bitwarden_lookup": bitwarden_lookup,
 }
 
+
 def render_template(template):
     jinja_template = Environment(loader=BaseLoader()).from_string(template)
     jinja_template.globals.update(lookup_func_dict)
     return jinja_template.render()
 
+
 def create_template_secret(secret, filename, template):
     secret.type = "Opaque"
     secret.data = {}
-    secret.data[filename] = str(base64.b64encode(render_template(template).encode("utf-8")), "utf-8")
+    secret.data[filename] = str(
+        base64.b64encode(
+            render_template(template).encode("utf-8")),
+        "utf-8")
     return secret
 
+
 @kopf.on.create('bitwarden-template.lerentis.uploadfilter24.eu')
 def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
 
@@ -39,7 +46,8 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
         "managedObject": f"{namespace}/{name}"
     }
     secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
     secret = create_template_secret(secret, filename, template)
 
     obj = api.create_namespaced_secret(
@@ -48,15 +56,48 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
 
     logger.info(f"Secret {secret_namespace}/{secret_name} has been created")
 
+
 @kopf.on.update('bitwarden-template.lerentis.uploadfilter24.eu')
 @kopf.timer('bitwarden-template.lerentis.uploadfilter24.eu', interval=900)
-def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs):
+def update_managed_secret(
+        spec,
+        status,
+        name,
+        namespace,
+        logger,
+        body,
+        **kwargs):
 
     template = spec.get('template')
     filename = spec.get('filename')
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
 
+    old_config = None
+    old_secret_name = None
+    old_secret_namespace = None
+    if 'kopf.zalando.org/last-handled-configuration' in body.metadata.annotations:
+        old_config = json.loads(
+            body.metadata.annotations['kopf.zalando.org/last-handled-configuration'])
+        old_secret_name = old_config['spec'].get('name')
+        old_secret_namespace = old_config['spec'].get('namespace')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    if old_config is not None and (
+            old_secret_name != secret_name or old_secret_namespace != secret_namespace):
+        # If the name of the secret or the namespace of the secret is different
+        # We have to delete the secret an recreate it
+        logger.info("Secret name or namespace changed, let's recreate it")
+        delete_managed_secret(
+            old_config['spec'],
+            name,
+            namespace,
+            logger,
+            **kwargs)
+        create_managed_secret(spec, name, namespace, logger, body, **kwargs)
+        return
+
     unlock_bw(logger)
 
     api = kubernetes.client.CoreV1Api()
@@ -66,7 +107,8 @@ def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs)
         "managedObject": f"{namespace}/{name}"
     }
     secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
     secret = create_template_secret(secret, filename, template)
 
     try:
@@ -74,11 +116,13 @@ def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs)
             name=secret_name,
             body=secret,
             namespace="{}".format(secret_namespace))
-        logger.info(f"Secret {secret_namespace}/{secret_name} has been updated")
-    except:
+        logger.info(
+            f"Secret {secret_namespace}/{secret_name} has been updated")
+    except BaseException:
         logger.warn(
             f"Could not update secret {secret_namespace}/{secret_name}!")
 
+
 @kopf.on.delete('bitwarden-template.lerentis.uploadfilter24.eu')
 def delete_managed_secret(spec, name, namespace, logger, **kwargs):
     secret_name = spec.get('name')
@@ -87,6 +131,8 @@ def delete_managed_secret(spec, name, namespace, logger, **kwargs):
 
     try:
         api.delete_namespaced_secret(secret_name, secret_namespace)
-        logger.info(f"Secret {secret_namespace}/{secret_name} has been deleted")
-    except:
-        logger.warn(f"Could not delete secret {secret_namespace}/{secret_name}!")
+        logger.info(
+            f"Secret {secret_namespace}/{secret_name} has been deleted")
+    except BaseException:
+        logger.warn(
+            f"Could not delete secret {secret_namespace}/{secret_name}!")

src/utils/utils.py

@@ -1,30 +1,50 @@
 import os
+import json
 import subprocess
 
+
 class BitwardenCommandException(Exception):
     pass
 
+
 def get_secret_from_bitwarden(id):
     return command_wrapper(command=f"get item {id}")
 
+
 def unlock_bw(logger):
+    status_output = command_wrapper("status")
+    status = json.loads(status_output)['status']
+    if status == 'unlocked':
+        logger.info("Already unlocked")
+        return
     token_output = command_wrapper("unlock --passwordenv BW_PASSWORD")
     tokens = token_output.split('"')[1::2]
     os.environ["BW_SESSION"] = tokens[1]
     logger.info("Signin successful. Session exported")
 
+
 def command_wrapper(command):
     system_env = dict(os.environ)
-    sp = subprocess.Popen([f"bw {command}"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True, shell=True, env=system_env)
+    sp = subprocess.Popen(
+        [f"bw {command}"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        close_fds=True,
+        shell=True,
+        env=system_env)
     out, err = sp.communicate()
     if err:
         raise BitwardenCommandException(err)
     return out.decode(encoding='UTF-8')
 
+
 def parse_login_scope(secret_json, key):
     return secret_json["login"][key]
 
+
 def parse_fields_scope(secret_json, key):
+    if "fields" not in secret_json:
+        return None
     for entry in secret_json["fields"]:
         if entry['name'] == key:
             return entry['value']