bump chart and app version

Bump mikefarah/yq from 4.40.4 to 4.40.5

.github/workflows/release.yml

@@ -8,11 +8,13 @@ on:
 jobs:
   release:
     permissions:
+      id-token: write
       contents: write
+      packages: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -27,22 +29,43 @@ jobs:
           version: v3.10.0
 
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.4.1
+        uses: helm/chart-releaser-action@v1.6.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.40.5
         id: app_version
         with:
           cmd: yq '.appVersion' charts/bitwarden-crd-operator/Chart.yaml
 
+      - name: "GHCR Login"
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: lerentis
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: "GHCR Build and Push"
+        id: docker_build
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ghcr.io/lerentis/bitwarden-crd-operator:${{ steps.app_version.outputs.result }}
+
       - name: Create SBOM
         uses: anchore/sbom-action@v0
         with:
-          image: lerentis/bitwarden-crd-operator:${{ steps.app_version.outputs.result }}
+          image: ghcr.io/lerentis/bitwarden-crd-operator:${{ steps.app_version.outputs.result }}
         
       - name: Publish SBOM
         uses: anchore/sbom-action/publish-sbom@v0
@@ -54,7 +77,7 @@ jobs:
         uses: WyriHaximus/github-action-get-previous-tag@v1
 
       - name: Download SBOM from github action
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ env.ANCHORE_SBOM_ACTION_PRIOR_ARTIFACT }}
 
@@ -65,4 +88,4 @@ jobs:
           file_glob: true
           file: lerentis-bitwarden-crd-operator_*.spdx.json
           tag:  ${{ steps.previoustag.outputs.tag }}
-          overwrite: false
+          overwrite: true

.github/workflows/test-and-lint.yml

@@ -0,0 +1,55 @@
+name: Lint and Test
+
+on: pull_request
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.11.2
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          check-latest: true
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.6.1
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }})
+          if [[ -n "$changed" ]]; then
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Run chart-testing (lint)
+        if: steps.list-changed.outputs.changed == 'true'
+        run: ct lint --target-branch ${{ github.event.repository.default_branch }}
+
+  pr-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: "GHCR Build"
+        id: docker_build
+        uses: docker/build-push-action@v5
+        with:
+          push: false
+          platforms: linux/amd64,linux/arm64
+          tags: ghcr.io/lerentis/bitwarden-crd-operator:dev
+

.gitignore

@@ -166,3 +166,5 @@ lib
 lib64
 
 myvalues.yaml
+
+.vscode

Dockerfile

@@ -1,34 +1,50 @@
-FROM alpine:latest as builder
+FROM alpine:3.18.4
 
-ARG BW_VERSION=2022.11.0
+LABEL org.opencontainers.image.source=https://github.com/Lerentis/bitwarden-crd-operator
+LABEL org.opencontainers.image.description="Kubernetes Operator to create k8s secrets from bitwarden"
+LABEL org.opencontainers.image.licenses=MIT
 
-RUN apk add wget unzip
+ARG PYTHON_VERSION=3.11.6-r0
+ARG PIP_VERSION=23.1.2-r0
+ARG GCOMPAT_VERSION=1.1.0-r1
+ARG LIBCRYPTO_VERSION=3.1.3-r0
+ARG BW_VERSION=2023.1.0
 
-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
-
-ARG PYTHON_VERSION=3.10.9-r1
-ARG PIP_VERSION=22.3.1-r1
-ARG GCOMPAT_VERSION=1.1.0-r0
-
-COPY --from=builder /tmp/bw /usr/local/bin/bw
-COPY requirements.txt requirements.txt
+COPY requirements.txt /requirements.txt
 
 RUN set -eux; \
+    apk add --virtual build-dependencies wget unzip; \
+    ARCH="$(apk --print-arch)"; \
+    case "${ARCH}" in \
+       aarch64|arm64) \
+          apk add npm; \
+          npm install -g @bitwarden/cli@${BW_VERSION}; \
+         ;; \
+       amd64|x86_64) \
+          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; \
+          mv /tmp/bw /usr/local/bin/bw; \
+          chmod +x /usr/local/bin/bw; \
+         ;; \
+       *) \
+         echo "Unsupported arch: ${ARCH}"; \
+         exit 1; \
+         ;; \
+    esac; \
+    apk del --purge build-dependencies; \
     addgroup -S -g 1000 bw-operator; \
     adduser -S -D -u 1000 -G bw-operator bw-operator; \
     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}; \
-    pip install -r requirements.txt --no-warn-script-location; \
+    apk add gcc musl-dev libstdc++ gcompat=${GCOMPAT_VERSION} python3=${PYTHON_VERSION} py3-pip=${PIP_VERSION} libcrypto3=${LIBCRYPTO_VERSION}; \
+    pip install -r /requirements.txt --no-warn-script-location; \
+    rm /requirements.txt; \
     apk del --purge gcc musl-dev libstdc++;
 
 COPY --chown=bw-operator:bw-operator src /home/bw-operator
 
 USER bw-operator
 
-ENTRYPOINT [ "kopf", "run", "--all-namespaces", "--liveness=http://0.0.0.0:8080/healthz" ]
+ENTRYPOINT [ "kopf", "run", "--log-format=json", "--all-namespaces", "--liveness=http://0.0.0.0:8080/healthz" ]
 CMD [ "/home/bw-operator/bitwardenCrdOperator.py", "/home/bw-operator/kv.py", "/home/bw-operator/dockerlogin.py", "/home/bw-operator/template.py"]

Makefile

@@ -0,0 +1,27 @@
+deployment_name ?= bitwarden-crd-operator
+namespace ?= bitwarden-crd-operator
+label_filter = -l app.kubernetes.io/instance=bitwarden-crd-operator -l app.kubernetes.io/name=bitwarden-crd-operator
+
+create-namespace:
+	kubectl create namespace ${namespace}
+
+dev:
+	skaffold dev -n ${namespace}
+
+run:
+	skaffold run -n ${namespace}
+
+pods:
+	kubectl -n ${namespace} get pods
+
+desc-pods:
+	kubectl -n ${namespace} describe pod ${label_filter}
+
+delete-pods-force:
+	kubectl -n ${namespace} delete pod ${label_filter} --force
+
+exec:
+	kubectl -n ${namespace} exec -it deployment/${deployment_name} -- sh
+
+logs:
+	kubectl -n ${namespace} logs -f --tail 30 deployment/${deployment_name}

README.md

@@ -129,7 +129,7 @@ type: dockerconfigjson
 
 ## BitwardenTemplate
 
-One of the more freely defined types that can be used with this operator you can just pass a whole template:
+One of the more freely defined types that can be used with this operator you can just pass a whole template. Also the lookup function `bitwarden_lookup` is available to reference parts of the secret:
 
 ```yaml
 ---
@@ -145,11 +145,11 @@ spec:
     ---
     api:
       enabled: True
-      key: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "name of a field in bitwarden") }}
+      key: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields or attachment", "name of a field in bitwarden") }}
       allowCrossOrigin: false
       apps:
         "some.app.identifier:some_version":
-          pubkey: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "name of a field in bitwarden") }}
+          pubkey: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields or attachment", "name of a field in bitwarden") }}
           enabled: true
 ```
 
@@ -169,12 +169,18 @@ metadata:
 type: Opaque
 ```
 
-please note that the rendering engine for this template is jinja2, with an addition of a custom `bitwarden_lookup` function, so there are more possibilities to inject here.
+The signature of `bitwarden_lookup` is `(item_id, scope, field)`:
+- `item_id`: The item ID of the secret in Bitwarden
+- `scope`: one of `login`, `fields` or `attachment`
+- `field`:
+  - when `scope` is `login`: either `username` or `password`
+  - when `scope` is `fields`: the name of a custom field
+  - when `scope` is `attachment`: the filename of a file attached to the item
 
-## Short Term Roadmap
+Please note that the rendering engine for this template is jinja2, with an addition of a custom `bitwarden_lookup` function, so there are more possibilities to inject here.
 
-- [ ] support more types
-- [x] offer option to use a existing secret in helm chart
-- [x] host chart on gh pages
-- [x] write release pipeline
-- [x] maybe extend spec to offer modification of keys as well
+## Configurations parameters
+
+The operator uses the bitwarden cli in the background and does not communicate to the api directly. The cli mirrors the credential store locally but doesn't sync it on every get request. Instead it will sync each secret every 15 minutes (900 seconds). You can adjust the interval by setting `BW_SYNC_INTERVAL` in the values. If your secrets update very very frequently, you can force the operator to do a sync before each get by setting `BW_FORCE_SYNC="true"`. You might run into rate limits if you do this too frequent.
+
+Additionally the bitwarden cli session may expire at some time. In order to create a new session, the login command is triggered from time to time. In what interval exactly can be configured with the env `BW_RELOGIN_INTERVAL` which defaults to 3600s.

charts/bitwarden-crd-operator/Chart.yaml

@@ -4,9 +4,9 @@ description: Deploy the Bitwarden CRD Operator
 
 type: application
 
-version: "v0.4.3"
+version: "v0.11.0"
 
-appVersion: "0.4.2"
+appVersion: "0.10.0"
 
 keywords:
   - operator
@@ -20,7 +20,7 @@ home: https://lerentis.github.io/bitwarden-crd-operator/
 sources:
   - https://github.com/Lerentis/bitwarden-crd-operator
 
-kubeVersion: '>= 1.23.0-0'
+kubeVersion: ">= 1.23.0-0"
 
 maintainers:
   - name: lerentis
@@ -32,22 +32,22 @@ annotations:
       url: https://github.com/Lerentis/bitwarden-crd-operator
   artifacthub.io/crds: |
     - kind: BitwardenSecret
-      version: v1beta4
+      version: v1beta5
       name: bitwarden-secret
       displayName: Bitwarden Secret
       description: Management Object to create secrets from bitwarden
     - kind: RegistryCredential
-      version: v1beta4
+      version: v1beta5
       name: registry-credential
       displayName: Regestry Credentials
       description: Management Object to create regestry secrets from bitwarden
     - kind: BitwardenTemplate
-      version: v1beta1
+      version: v1beta5
       name: bitwarden-template
       displayName: Bitwarden Template
       description: Management Object to create secrets from a jinja template with a bitwarden lookup
   artifacthub.io/crdsExamples: |
-    - apiVersion: lerentis.uploadfilter24.eu/v1beta4
+    - apiVersion: lerentis.uploadfilter24.eu/v1beta5
       kind: BitwardenSecret
       metadata:
         name: test
@@ -62,7 +62,9 @@ annotations:
         id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
         name: "test-secret"
         namespace: "default"
-    - apiVersion: lerentis.uploadfilter24.eu/v1beta4
+        labels:
+          key: value
+    - apiVersion: lerentis.uploadfilter24.eu/v1beta5
       kind: RegistryCredential
       metadata:
         name: test
@@ -73,7 +75,9 @@ annotations:
         id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
         name: "test-regcred"
         namespace: "default"
-    - apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+        labels:
+          key: value
+    - apiVersion: "lerentis.uploadfilter24.eu/v1beta5"
       kind: BitwardenTemplate
       metadata:
         name: test
@@ -81,6 +85,8 @@ annotations:
         filename: "config.yaml"
         name: "test-regcred"
         namespace: "default"
+        labels:
+          key: value
         template: |
           ---
           api:
@@ -89,15 +95,14 @@ annotations:
             allowCrossOrigin: false
             apps:
               "some.app.identifier:some_version":
-                pubkey: {{ bitwarden_lookup("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "fields", "public_key") }}
+                pubkey: {{ bitwarden_lookup("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "attachment", "public_key") }}
                 enabled: true
   artifacthub.io/license: MIT
   artifacthub.io/operator: "true"
+  artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/changes: |
-    - kind: fixed
-      description: "Updated Dependencies to fix CVEs"
-    - kind: added
-      description: "Upload SBOM to GitHub Release"
+    - kind: changed
+      description: "Added the possibility to add labels to generated secrets"
   artifacthub.io/images: |
     - name: bitwarden-crd-operator
-      image: lerentis/bitwarden-crd-operator:0.4.2
+      image: ghcr.io/lerentis/bitwarden-crd-operator:0.10.0

charts/bitwarden-crd-operator/crds/bitwarden-secrets.yaml

@@ -14,7 +14,7 @@ spec:
       - bws
   versions:
     - name: v1beta4
-      served: true
+      served: false
       storage: true
       schema:
         openAPIV3Schema:
@@ -49,3 +49,55 @@ spec:
                 - id
                 - namespace
                 - name
+    - name: v1beta5
+      served: true
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                content:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      element:
+                        type: object
+                        properties:
+                          secretName:
+                            type: string
+                          secretRef:
+                            type: string
+                          secretScope:
+                            type: string
+                        required:
+                          - secretName
+                id:
+                  type: string
+                namespace:
+                  type: string
+                name:
+                  type: string
+                labels:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      json:
+                        x-kubernetes-preserve-unknown-fields: true
+                        type: object
+                        properties:
+                          spec:
+                            type: object
+                            properties:
+                              foo:
+                                type: string
+                              bar:
+                                type: string
+              required:
+                - id
+                - namespace
+                - name

charts/bitwarden-crd-operator/crds/bitwarden-templates.yaml

@@ -14,7 +14,7 @@ spec:
       - bwt
   versions:
     - name: v1beta4
-      served: true
+      served: false
       storage: true
       schema:
         openAPIV3Schema:
@@ -36,3 +36,42 @@ spec:
                 - template
                 - namespace
                 - name
+    - name: v1beta5
+      served: true
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                filename:
+                  type: string
+                template:
+                  type: string
+                namespace:
+                  type: string
+                name:
+                  type: string
+                labels:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      json:
+                        x-kubernetes-preserve-unknown-fields: true
+                        type: object
+                        properties:
+                          spec:
+                            type: object
+                            properties:
+                              foo:
+                                type: string
+                              bar:
+                                type: string
+              required:
+                - filename
+                - template
+                - namespace
+                - name

charts/bitwarden-crd-operator/crds/registry-credentials.yaml

@@ -14,7 +14,7 @@ spec:
       - rgc
   versions:
     - name: v1beta4
-      served: true
+      served: false
       storage: true
       schema:
         openAPIV3Schema:
@@ -42,3 +42,48 @@ spec:
                 - usernameRef
                 - passwordRef
                 - registry
+    - name: v1beta5
+      served: true
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                usernameRef:
+                  type: string
+                passwordRef:
+                  type: string
+                registry:
+                  type: string
+                id:
+                  type: string
+                namespace:
+                  type: string
+                name:
+                  type: string
+                labels:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      json:
+                        x-kubernetes-preserve-unknown-fields: true
+                        type: object
+                        properties:
+                          spec:
+                            type: object
+                            properties:
+                              foo:
+                                type: string
+                              bar:
+                                type: string
+              required:
+                - id
+                - namespace
+                - name
+                - usernameRef
+                - passwordRef
+                - registry

charts/bitwarden-crd-operator/templates/deployment.yaml

@@ -50,10 +50,20 @@ spec:
             httpGet:
               path: /healthz
               port: http
+            failureThreshold: {{ .Values.livenessProbe.failureThreshold }}
+            initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
+            periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
+            successThreshold: {{ .Values.livenessProbe.successThreshold }}
+            timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }}
           readinessProbe:
             httpGet:
               path: /healthz
               port: http
+            failureThreshold: {{ .Values.readinessProbe.failureThreshold }}
+            initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
+            periodSeconds: {{ .Values.readinessProbe.periodSeconds }}
+            successThreshold: {{ .Values.readinessProbe.successThreshold }}
+            timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
       {{- with .Values.nodeSelector }}

charts/bitwarden-crd-operator/values.yaml

@@ -5,7 +5,7 @@
 replicaCount: 1
 
 image:
-  repository: lerentis/bitwarden-crd-operator
+  repository: ghcr.io/lerentis/bitwarden-crd-operator
   pullPolicy: IfNotPresent
   # Overrides the image tag whose default is the chart appVersion.
   # tag: "0.1.0"
@@ -14,7 +14,11 @@ imagePullSecrets: []
 nameOverride: ""
 fullnameOverride: ""
 
-#env:
+# env:
+#   - name: BW_FORCE_SYNC
+#     value: "false"
+#   - name: BW_SYNC_INTERVAL
+#     value: "900"
 #   - name: BW_HOST
 #     value: "define_it"
 #   - name: BW_CLIENTID
@@ -23,6 +27,8 @@ fullnameOverride: ""
 #     value: "define_it"
 #   - name: BW_PASSWORD
 #     value: "define_id"
+##  - name: BW_RELOGIN_INTERVAL
+##    value: "3600"
 
 externalConfigSecret:
   enabled: false
@@ -51,6 +57,20 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
+readinessProbe:
+  failureThreshold: 3
+  initialDelaySeconds: 10
+  periodSeconds: 10
+  successThreshold: 1
+  timeoutSeconds: 1
+
+livenessProbe:
+  failureThreshold: 3
+  initialDelaySeconds: 10
+  periodSeconds: 10
+  successThreshold: 1
+  timeoutSeconds: 1
+
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little

example.yaml

@@ -1,5 +1,5 @@
 ---
-apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+apiVersion: "lerentis.uploadfilter24.eu/v1beta5"
 kind: BitwardenSecret
 metadata:
   name: test
@@ -16,3 +16,21 @@ spec:
   id: "88781348-c81c-4367-9801-550360c21295"
   name: "test-secret"
   namespace: "default"
+  labels:
+    - key: value
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta5"
+kind: BitwardenSecret
+metadata:
+  name: test-scope
+spec:
+  content:
+    - element:
+        secretName: public_key
+        secretRef: pubKey 
+        secretScope: fields
+  id: "466fc4b0-ffca-4444-8d88-b59d4de3d928"
+  name: "test-scope"
+  namespace: "default"
+  labels:
+    - key: value

requirements.txt

@@ -1,3 +1,4 @@
-kopf==1.36.0
-kubernetes==25.3.0
+kopf==1.36.2
+kubernetes==26.1.0
 Jinja2==3.1.2
+schedule==1.2.1

skaffold.yaml

@@ -0,0 +1,17 @@
+apiVersion: skaffold/v4beta5
+kind: Config
+metadata:
+  name: bitwarden-crd-operator
+build:
+  artifacts:
+    - image: ghcr.io/lerentis/bitwarden-crd-operator
+      docker:
+        dockerfile: Dockerfile
+deploy:
+  helm:
+    releases:
+      - name: bitwarden-crd-operator
+        chartPath: charts/bitwarden-crd-operator
+        valuesFiles:
+          - env/values.yaml
+        version: v0.7.4

src/bitwardenCrdOperator.py

@@ -1,20 +1,47 @@
 #!/usr/bin/env python3
-import kopf
 import os
+import kopf
+import schedule
+import time
+import threading
 
-from utils.utils import command_wrapper, unlock_bw
+from utils.utils import command_wrapper, unlock_bw, sync_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:
-            logger.warn("Revieved none zero exit code from server config")
+            command_wrapper(logger, f"config server {os.getenv('BW_HOST')}")
+        except BaseException:
+            logger.warn("Received non-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")
-    command_wrapper("login --apikey")
+        logger.info("BW_HOST not set. Assuming SaaS installation")
+    command_wrapper(logger, "login --apikey")
     unlock_bw(logger)
 
+def run_continuously(interval=30):
+    cease_continuous_run = threading.Event()
+
+    class ScheduleThread(threading.Thread):
+        @classmethod
+        def run(cls):
+            while not cease_continuous_run.is_set():
+                schedule.run_pending()
+                time.sleep(interval)
+
+    continuous_thread = ScheduleThread()
+    continuous_thread.start()
+    return cease_continuous_run
+
+@kopf.on.startup()
+def load_schedules(logger, **kwargs):
+    bitwarden_signin(logger)
+    logger.info("Loading schedules")
+    bw_relogin_interval = float(os.environ.get('BW_RELOGIN_INTERVAL', 3600))
+    bw_sync_interval = float(os.environ.get('BW_SYNC_INTERVAL', 900))
+    schedule.every(bw_relogin_interval).seconds.do(bitwarden_signin, logger=logger)
+    logger.info(f"relogin scheduled every {bw_relogin_interval} seconds")
+    schedule.every(bw_sync_interval).seconds.do(sync_bw, logger=logger)
+    logger.info(f"sync scheduled every {bw_relogin_interval} seconds")
+    stop_run_continuously = run_continuously()

src/dockerlogin.py

@@ -3,10 +3,17 @@ import kubernetes
 import base64
 import json
 
-from utils.utils import unlock_bw, get_secret_from_bitwarden
+from utils.utils import unlock_bw, get_secret_from_bitwarden, bw_sync_interval
 
-def create_dockerlogin(logger, secret, secret_json, username_ref, password_ref, registry):
-    secret.type = "dockerconfigjson"
+
+def create_dockerlogin(
+        logger,
+        secret,
+        secret_json,
+        username_ref,
+        password_ref,
+        registry):
+    secret.type = "kubernetes.io/dockerconfigjson"
     secret.data = {}
     auths_dict = {}
     registry_dict = {}
@@ -15,14 +22,20 @@ 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["username"] = _username
+    reg_auth_dict["password"] = _password
     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')
@@ -31,10 +44,87 @@ def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
     id = spec.get('id')
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
+    labels = spec.get('labels')
 
     unlock_bw(logger)
     logger.info(f"Locking up secret with ID: {id}")
-    secret_json_object = json.loads(get_secret_from_bitwarden(id))
+    secret_json_object = get_secret_from_bitwarden(logger, id)
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "registry-credential.lerentis.uploadfilter24.eu",
+        "managedObject": f"{namespace}/{name}"
+    }
+
+    if not labels:
+        labels = {}
+
+    secret = kubernetes.client.V1Secret()
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations, labels=labels)
+    secret = create_dockerlogin(
+        logger,
+        secret,
+        secret_json_object["data"],
+        username_ref,
+        password_ref,
+        registry)
+
+    api.create_namespaced_secret(
+        secret_namespace, secret
+    )
+
+    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=bw_sync_interval)
+def update_managed_registry_secret(
+        spec,
+        status,
+        name,
+        namespace,
+        logger,
+        body,
+        **kwargs):
+
+    username_ref = spec.get('usernameRef')
+    password_ref = spec.get('passwordRef')
+    registry = spec.get('registry')
+    id = spec.get('id')
+    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 = get_secret_from_bitwarden(logger, id)
 
     api = kubernetes.client.CoreV1Api()
 
@@ -43,18 +133,26 @@ 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["data"],
+        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 BaseException:
+        logger.warn(
+            f"Could not update secret {secret_namespace}/{secret_name}!")
 
-    obj = api.create_namespaced_secret(
-        secret_namespace, secret
-    )
-
-    logger.info(f"Registry Secret {secret_namespace}/{secret_name} has been created")
-
-@kopf.on.update('registry-credential.lerentis.uploadfilter24.eu')
-def my_handler(spec, old, new, diff, **_):
-    pass
 
 @kopf.on.delete('registry-credential.lerentis.uploadfilter24.eu')
 def delete_managed_secret(spec, name, namespace, logger, **kwargs):
@@ -64,6 +162,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

@@ -3,14 +3,14 @@ import kubernetes
 import base64
 import json
 
-from utils.utils import unlock_bw, get_secret_from_bitwarden, parse_login_scope, parse_fields_scope
+from utils.utils import unlock_bw, get_secret_from_bitwarden, parse_login_scope, parse_fields_scope, bw_sync_interval
 
 def create_kv(secret, secret_json, content_def):
     secret.type = "Opaque"
     secret.data = {}
     for eleml in content_def:
         for k, elem in eleml.items():
-            for key,value in elem.items():
+            for key, value in elem.items():
                 if key == "secretName":
                     _secret_key = value
                 if key == "secretRef":
@@ -18,11 +18,22 @@ def create_kv(secret, secret_json, content_def):
                 if key == "secretScope":
                     _secret_scope = value
             if _secret_scope == "login":
-                secret.data[_secret_ref] = str(base64.b64encode(parse_login_scope(secret_json, _secret_key).encode("utf-8")), "utf-8")
+                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(
+                    value.encode("utf-8")), "utf-8")
             if _secret_scope == "fields":
-                secret.data[_secret_ref] = str(base64.b64encode(parse_fields_scope(secret_json, _secret_key).encode("utf-8")), "utf-8")
+                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(
+                    value.encode("utf-8")), "utf-8")
     return secret
 
+
 @kopf.on.create('bitwarden-secret.lerentis.uploadfilter24.eu')
 def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
 
@@ -30,10 +41,11 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
     id = spec.get('id')
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
+    labels = spec.get('labels')
 
     unlock_bw(logger)
     logger.info(f"Locking up secret with ID: {id}")
-    secret_json_object = json.loads(get_secret_from_bitwarden(id))
+    secret_json_object = get_secret_from_bitwarden(logger, id)
 
     api = kubernetes.client.CoreV1Api()
 
@@ -41,19 +53,88 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
         "managed": "bitwarden-secret.lerentis.uploadfilter24.eu",
         "managedObject": f"{namespace}/{name}"
     }
+
+    if not labels:
+        labels = {}
+
     secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations, labels=labels)
     secret = create_kv(secret, secret_json_object, content_def)
 
-    obj = api.create_namespaced_secret(
-        secret_namespace, secret
+    api.create_namespaced_secret(
+        namespace="{}".format(secret_namespace),
+        body=secret
     )
 
     logger.info(f"Secret {secret_namespace}/{secret_name} has been created")
 
+
 @kopf.on.update('bitwarden-secret.lerentis.uploadfilter24.eu')
-def my_handler(spec, old, new, diff, **_):
-    pass
+@kopf.timer('bitwarden-secret.lerentis.uploadfilter24.eu', interval=bw_sync_interval)
+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 = get_secret_from_bitwarden(logger, id)
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "bitwarden-secret.lerentis.uploadfilter24.eu",
+        "managedObject": f"{namespace}/{name}"
+    }
+
+    secret = kubernetes.client.V1Secret()
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
+    secret = create_kv(secret, secret_json_object, content_def)
+
+    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 BaseException:
+        logger.warn(
+            f"Could not update secret {secret_namespace}/{secret_name}!")
+
 
 @kopf.on.delete('bitwarden-secret.lerentis.uploadfilter24.eu')
 def delete_managed_secret(spec, name, namespace, logger, **kwargs):
@@ -63,6 +144,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/lookups/bitwarden_lookup.py

@@ -1,9 +1,15 @@
-import json
+from utils.utils import get_secret_from_bitwarden, get_attachment, parse_fields_scope, parse_login_scope
 
-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))
+class BitwardenLookupHandler:
+
+    def __init__(self, logger) -> None:
+        self.logger = logger
+
+    def bitwarden_lookup(self, id, scope, field):
+        if scope == "attachment":
+            return get_attachment(self.logger, id, field)
+        _secret_json = get_secret_from_bitwarden(self.logger, id)
         if scope == "login":
             return parse_login_scope(_secret_json, field)
         if scope == "fields":

src/template.py

@@ -1,27 +1,31 @@
 import kopf
 import base64
 import kubernetes
+import json
 
-from utils.utils import unlock_bw
-from lookups.bitwarden_lookup import bitwarden_lookup
+from utils.utils import unlock_bw, bw_sync_interval
+from lookups.bitwarden_lookup import BitwardenLookupHandler
 from jinja2 import Environment, BaseLoader
 
 
-lookup_func_dict = {
-    "bitwarden_lookup": bitwarden_lookup,
-}
-
-def render_template(template):
+def render_template(logger, template):
     jinja_template = Environment(loader=BaseLoader()).from_string(template)
-    jinja_template.globals.update(lookup_func_dict)
+    jinja_template.globals.update({
+        "bitwarden_lookup": BitwardenLookupHandler(logger).bitwarden_lookup,
+    })
     return jinja_template.render()
 
-def create_template_secret(secret, filename, template):
+
+def create_template_secret(logger, 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(logger, 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):
 
@@ -29,6 +33,72 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
     filename = spec.get('filename')
     secret_name = spec.get('name')
     secret_namespace = spec.get('namespace')
+    labels = spec.get('labels')
+
+    unlock_bw(logger)
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "bitwarden-template.lerentis.uploadfilter24.eu",
+        "managedObject": f"{namespace}/{name}"
+    }
+
+    if not labels:
+        labels = {}
+
+    secret = kubernetes.client.V1Secret()
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations, labels=labels)
+    secret = create_template_secret(logger, secret, filename, template)
+
+    obj = api.create_namespaced_secret(
+        secret_namespace, secret
+    )
+
+    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=bw_sync_interval)
+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)
 
@@ -39,18 +109,21 @@ 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 = create_template_secret(secret, filename, template)
+    secret.metadata = kubernetes.client.V1ObjectMeta(
+        name=secret_name, annotations=annotations)
+    secret = create_template_secret(logger, secret, filename, template)
 
-    obj = api.create_namespaced_secret(
-        secret_namespace, secret
-    )
+    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 BaseException:
+        logger.warn(
+            f"Could not update secret {secret_namespace}/{secret_name}!")
 
-    logger.info(f"Secret {secret_namespace}/{secret_name} has been created")
-
-@kopf.on.update('bitwarden-template.lerentis.uploadfilter24.eu')
-def my_handler(spec, old, new, diff, **_):
-    pass
 
 @kopf.on.delete('bitwarden-template.lerentis.uploadfilter24.eu')
 def delete_managed_secret(spec, name, namespace, logger, **kwargs):
@@ -60,13 +133,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}!")
-
-#if __name__ == '__main__':
-#    tpl = """
-#        Calling the 'bitwarden_lookup' function:
-#        {{ bitwarden_lookup(2, 2) }}
-#    """
-#    print(render_template(tpl))
+        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,91 @@
 import os
+import json
 import subprocess
+import distutils
+
+bw_sync_interval = float(os.environ.get(
+    'BW_SYNC_INTERVAL', 900))
 
 class BitwardenCommandException(Exception):
     pass
 
-def get_secret_from_bitwarden(id):
-    return command_wrapper(command=f"get item {id}")
+
+def get_secret_from_bitwarden(logger, id, force_sync=False):
+    sync_bw(logger, force=force_sync)
+    return command_wrapper(logger, command=f"get item {id}")
+
+
+def sync_bw(logger, force=False):
+
+    def _sync(logger):
+        status_output = command_wrapper(logger, command=f"sync")
+        logger.info(f"Sync successful {status_output}")
+        return
+
+    if force:
+        _sync(logger)
+        return
+
+    global_force_sync = bool(distutils.util.strtobool(
+        os.environ.get('BW_FORCE_SYNC', "false")))
+
+    if global_force_sync:
+        logger.debug("Running forced sync")
+        status_output = _sync(logger)
+        logger.info(f"Sync successful {status_output}")
+    else:
+        logger.debug("Running scheduled sync")
+        status_output = _sync(logger)
+        logger.info(f"Sync successful {status_output}")
+
+
+def get_attachment(logger, id, name):
+    return command_wrapper(logger, command=f"get attachment {name} --itemid {id}", raw=True)
+
 
 def unlock_bw(logger):
-    token_output = command_wrapper("unlock --passwordenv BW_PASSWORD")
-    tokens = token_output.split('"')[1::2]
-    os.environ["BW_SESSION"] = tokens[1]
+    status_output = command_wrapper(logger, "status", False)
+    status = status_output['data']['template']['status']
+    if status == 'unlocked':
+        logger.info("Already unlocked")
+        return
+    token_output = command_wrapper(logger, "unlock --passwordenv BW_PASSWORD")
+    os.environ["BW_SESSION"] = token_output["data"]["raw"]
     logger.info("Signin successful. Session exported")
 
-def command_wrapper(command):
+
+def command_wrapper(logger, command, use_success: bool = True, raw: bool = False):
     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)
+    response_flag = "--raw" if raw else "--response"
+    sp = subprocess.Popen(
+        [f"bw {response_flag} {command}"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        close_fds=True,
+        shell=True,
+        env=system_env)
     out, err = sp.communicate()
     if err:
-        raise BitwardenCommandException(err)
+        logger.warn(err)
+        return None
+    if raw:
         return out.decode(encoding='UTF-8')
+    if "DEBUG" in system_env:
+        logger.info(out.decode(encoding='UTF-8'))
+    resp = json.loads(out.decode(encoding='UTF-8'))
+    if resp["success"] != None and (not use_success or (use_success and resp["success"] == True)):
+        return resp
+    logger.warn(resp)
+    return None
+
 
 def parse_login_scope(secret_json, key):
-    return secret_json["login"][key]
+    return secret_json["data"]["login"][key]
+
 
 def parse_fields_scope(secret_json, key):
-    for entry in secret_json["fields"]:
+    if "fields" not in secret_json["data"]:
+        return None
+    for entry in secret_json["data"]["fields"]:
         if entry['name'] == key:
             return entry['value']