update and retry handler

Bump kopf from 1.35.6 to 1.36.0

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -32,3 +32,37 @@ jobs:
           charts_dir: charts
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Get app version from chart
+        uses: mikefarah/yq@v4.30.6
+        id: app_version
+        with:
+          cmd: yq '.appVersion' charts/bitwarden-crd-operator/Chart.yaml
+
+      - name: Create SBOM
+        uses: anchore/sbom-action@v0
+        with:
+          image: lerentis/bitwarden-crd-operator:${{ steps.app_version.outputs.result }}
+        
+      - name: Publish SBOM
+        uses: anchore/sbom-action/publish-sbom@v0
+        with:
+          sbom-artifact-match: ".*\\.spdx\\.json"
+
+      - name: Get Latest Tag
+        id: previoustag
+        uses: WyriHaximus/github-action-get-previous-tag@v1
+
+      - name: Download SBOM from github action
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ env.ANCHORE_SBOM_ACTION_PRIOR_ARTIFACT }}
+
+      - name: Add SBOM to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file_glob: true
+          file: lerentis-bitwarden-crd-operator_*.spdx.json
+          tag:  ${{ steps.previoustag.outputs.tag }}
+          overwrite: false

Dockerfile

@@ -1,33 +1,34 @@
 FROM alpine:latest as builder
 
-ARG BW_VERSION=2022.8.0
+ARG BW_VERSION=2022.11.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 ubuntu:jammy
+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
 
 RUN set -eux; \
-    groupadd -r bw-operator ; \
-    useradd -r -g bw-operator -s /sbin/nologin bw-operator; \
+    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; \
-    apt-get update; \
-    apt-get install -y --no-install-recommends python3 python3-pip; \
-    apt-get clean;
+    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 del --purge gcc musl-dev libstdc++;
 
-COPY --chown=bw-operator:bw-operator bitwarden-crd-operator.py /home/bw-operator/bitwarden-crd-operator.py
+COPY --chown=bw-operator:bw-operator src /home/bw-operator
 
 USER bw-operator
 
-RUN set -eux; \
-    pip install -r requirements.txt --no-warn-script-location
-
-ENTRYPOINT [ "/home/bw-operator/.local/bin/kopf", "run", "--all-namespaces", "--liveness=http://0.0.0.0:8080/healthz" ]
-CMD [ "/home/bw-operator/bitwarden-crd-operator.py" ]
+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"]

README.md

@@ -1,15 +1,18 @@
 # Bitwarden CRD Operator
 
-[![Build Status](https://drone.uploadfilter24.eu/api/badges/lerentis/bitwarden-crd-operator/status.svg?ref=refs/heads/main)](https://drone.uploadfilter24.eu/lerentis/bitwarden-crd-operator)
+[![Build Status](https://drone.uploadfilter24.eu/api/badges/lerentis/bitwarden-crd-operator/status.svg?ref=refs/heads/main)](https://drone.uploadfilter24.eu/lerentis/bitwarden-crd-operator) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/lerentis)](https://artifacthub.io/packages/search?repo=lerentis)
 
 Bitwarden CRD Operator is a kubernetes Operator based on [kopf](https://github.com/nolar/kopf/). The goal is to create kubernetes native secret objects from bitwarden.
 
+<p align="center">
+  <img src="logo.png" alt="Bitwarden CRD Operator Logo" width="200"/>
+</p>
+
 > DISCLAIMER:  
 > This project is still very work in progress :)
 
-## Getting started
 
-For now a few secrets need to be passed to helm. I will change this in the future to give the option to also use a kubernetes secret for this.
+## Getting started
 
 You will need a `ClientID` and `ClientSecret` ([where to get these](https://bitwarden.com/help/personal-api-key/)) as well as your password.
 Expose these to the operator as described in this example:
@@ -26,6 +29,16 @@ env:
     value: "YourSuperSecurePassword"
 ```
 
+you can also create a secret manually with these information and reference the existing secret like this in the `values.yaml`:
+
+```yaml
+externalConfigSecret:
+  enabled: true
+  name: "my-existing-secret"
+```
+
+the helm template will use all environment variables from this secret, so make sure to prepare this secret with the key value pairs as described above.
+
 `BW_HOST` can be omitted if you are using the Bitwarden SaaS offering.
 
 After that it is a basic helm deployment:
@@ -37,11 +50,13 @@ kubectl create namespace bw-operator
 helm upgrade --install --namespace bw-operator -f values.yaml bw-operator bitwarden-operator/bitwarden-crd-operator
 ```
 
+## BitwardenSecret
+
 And you are set to create your first secret using this operator. For that you need to add a CRD Object like this to your cluster:
 
 ```yaml
 ---
-apiVersion: "lerentis.uploadfilter24.eu/v1beta2"
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
 kind: BitwardenSecret
 metadata:
   name: name-of-your-management-object
@@ -50,9 +65,11 @@ spec:
     - element:
         secretName: nameOfTheFieldInBitwarden # for example username
         secretRef: nameOfTheKeyInTheSecretToBeCreated 
+        secretScope: login # for custom entries on bitwarden use 'fields' 
     - element:
         secretName: nameOfAnotherFieldInBitwarden # for example password
         secretRef: nameOfAnotherKeyInTheSecretToBeCreated 
+        secretScope: login # for custom entries on bitwarden use 'fields' 
   id: "A Secret ID from bitwarden"
   name: "Name of the secret to be created"
   namespace: "Namespace of the secret to be created"
@@ -75,10 +92,89 @@ metadata:
 type: Opaque
 ```
 
+## RegistryCredential
+
+For managing registry credentials, or pull secrets, you can create another kind of object to let the operator create these as well for you:
+
+```yaml
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: RegistryCredential
+metadata:
+  name: name-of-your-management-object
+spec:
+  usernameRef: nameOfTheFieldInBitwarden # for example username
+  passwordRef: nameOfTheFieldInBitwarden # for example password
+  registry: "docker.io"
+  id: "A Secret ID from bitwarden"
+  name: "Name of the secret to be created"
+  namespace: "Namespace of the secret to be created"
+```
+
+The resulting secret looks something like this:
+
+```yaml
+apiVersion: v1
+data:
+  .dockerconfigjson: "base64 encoded json auth string for your registry"
+kind: Secret
+metadata:
+  annotations:
+    managed: bitwarden-secrets.lerentis.uploadfilter24.eu
+    managedObject: bw-operator/test
+  name: name-of-your-management-object
+  namespace: default
+type: dockerconfigjson
+```
+
+## BitwardenTemplate
+
+One of the more freely defined types that can be used with this operator you can just pass a whole template:
+
+```yaml
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: BitwardenTemplate
+metadata:
+  name: name-of-your-management-object
+spec:
+  filename: "Key of the secret to be created"
+  name: "Name of the secret to be created"
+  namespace: "Namespace of the secret to be created"
+  template: |
+    ---
+    api:
+      enabled: True
+      key: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "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") }}
+          enabled: true
+```
+
+This will result in something like the following object:
+
+```yaml
+apiVersion: v1
+data:
+  Key of the secret to be created: "base64 encoded and rendered template with secrets injected directly from bitwarden"
+kind: Secret
+metadata:
+  annotations:
+    managed: bitwarden-template.lerentis.uploadfilter24.eu
+    managedObject: namespace/name-of-your-management-object
+  name: Name of the secret to be created
+  namespace: Namespace of the secret to be created
+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.
+
 ## Short Term Roadmap
 
 - [ ] support more types
-- [ ] offer option to use a existing secret in helm chart
+- [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

bitwarden-crd-operator.py

@@ -1,90 +0,0 @@
-#!/usr/bin/env python3
-import kopf
-import kubernetes
-import base64
-import os
-import subprocess
-import json
-
-from pprint import pprint
-
-def get_secret_from_bitwarden(logger, id):
-    return command_wrapper(logger, f"get item {id}")
-
-def unlock_bw(logger):
-    token_output = command_wrapper(logger, "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(logger, 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)
-    out, err = sp.communicate()
-    if err:
-        logger.warn(f"Error during bw cli invokement: {err}")
-    return out.decode(encoding='UTF-8')
-
-@kopf.on.startup()
-def bitwarden_signin(logger, **kwargs):
-    if 'BW_HOST' in os.environ:
-        command_wrapper(logger, f"config server {os.getenv('BW_HOST')}")
-    else:
-        logger.info(f"BW_HOST not set. Assuming SaaS installation")
-    command_wrapper(logger, "login --apikey")
-    unlock_bw(logger)
-
-@kopf.on.create('bitwarden-secrets.lerentis.uploadfilter24.eu')
-def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
-
-    content_def = body['spec']['content']
-    id = spec.get('id')
-    secret_name = spec.get('name')
-    secret_namespace = spec.get('namespace')
-
-    unlock_bw(logger)
-    
-    secret_json_object = json.loads(get_secret_from_bitwarden(logger, id))
-
-    api = kubernetes.client.CoreV1Api()
-
-    annotations = {
-        "managed": "bitwarden-secrets.lerentis.uploadfilter24.eu",
-        "managedObject": f"{namespace}/{name}"
-    }
-    secret = kubernetes.client.V1Secret()
-    secret.metadata = kubernetes.client.V1ObjectMeta(name=secret_name, annotations=annotations)
-    secret.type = "Opaque"
-    secret.data = {}
-    for eleml in content_def:
-        for k, elem in eleml.items():
-            for key,value in elem.items():
-                if key == "secretName":
-                    _secret_key = value
-                if key == "secretRef":
-                    _secret_ref = value
-            
-            secret.data[_secret_ref] = str(base64.b64encode(secret_json_object["login"][_secret_key].encode("utf-8")), "utf-8")
-
-    obj = api.create_namespaced_secret(
-        secret_namespace, secret
-    )
-
-    logger.info(f"Secret {secret_namespace}/{secret_name} is created")
-
-
-@kopf.on.update('bitwarden-secrets.lerentis.uploadfilter24.eu')
-def my_handler(spec, old, new, diff, **_):
-    pass
-
-@kopf.on.delete('bitwarden-secrets.lerentis.uploadfilter24.eu')
-def delete_managed_secret(spec, name, namespace, logger, **kwargs):
-    secret_name = spec.get('name')
-    secret_namespace = spec.get('namespace')
-    api = kubernetes.client.CoreV1Api()
-
-    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}!")

charts/bitwarden-crd-operator/Chart.yaml

@@ -4,6 +4,102 @@ description: Deploy the Bitwarden CRD Operator
 
 type: application
 
-version: "v0.1.2"
+version: "v0.5.0"
 
-appVersion: "0.1.2"
+appVersion: "0.5.0"
+
+keywords:
+  - operator
+  - bitwarden
+  - vaultwarden
+
+icon: https://lerentis.github.io/bitwarden-crd-operator/logo.png
+
+home: https://lerentis.github.io/bitwarden-crd-operator/
+
+sources:
+  - https://github.com/Lerentis/bitwarden-crd-operator
+
+kubeVersion: '>= 1.23.0-0'
+
+maintainers:
+  - name: lerentis
+    email: lerentis+helm@uploadfilter24.eu
+
+annotations:
+  artifacthub.io/links: |
+    - name: Chart Source
+      url: https://github.com/Lerentis/bitwarden-crd-operator
+  artifacthub.io/crds: |
+    - kind: BitwardenSecret
+      version: v1beta4
+      name: bitwarden-secret
+      displayName: Bitwarden Secret
+      description: Management Object to create secrets from bitwarden
+    - kind: RegistryCredential
+      version: v1beta4
+      name: registry-credential
+      displayName: Regestry Credentials
+      description: Management Object to create regestry secrets from bitwarden
+    - kind: BitwardenTemplate
+      version: v1beta1
+      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
+      kind: BitwardenSecret
+      metadata:
+        name: test
+      spec:
+        content:
+          - element:
+              secretName: username
+              secretRef: nameofUser 
+          - element:
+              secretName: password
+              secretRef: passwordOfUser 
+        id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
+        name: "test-secret"
+        namespace: "default"
+    - apiVersion: lerentis.uploadfilter24.eu/v1beta4
+      kind: RegistryCredential
+      metadata:
+        name: test
+      spec:
+        usernameRef: "username"
+        passwordRef: "password"
+        registry: "docker.io"
+        id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
+        name: "test-regcred"
+        namespace: "default"
+    - apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+      kind: BitwardenTemplate
+      metadata:
+        name: test
+      spec:
+        filename: "config.yaml"
+        name: "test-regcred"
+        namespace: "default"
+        template: |
+          ---
+          api:
+            enabled: True
+            key: {{ bitwarden_lookup("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "fields", "key") }}
+            allowCrossOrigin: false
+            apps:
+              "some.app.identifier:some_version":
+                pubkey: {{ bitwarden_lookup("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "fields", "public_key") }}
+                enabled: true  
+  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"
+  artifacthub.io/images: |
+    - name: bitwarden-crd-operator
+      image: lerentis/bitwarden-crd-operator:0.5.0

charts/bitwarden-crd-operator/README.md

@@ -0,0 +1,172 @@
+# Bitwarden CRD Operator
+
+[![Build Status](https://drone.uploadfilter24.eu/api/badges/lerentis/bitwarden-crd-operator/status.svg?ref=refs/heads/main)](https://drone.uploadfilter24.eu/lerentis/bitwarden-crd-operator) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/lerentis)](https://artifacthub.io/packages/search?repo=lerentis)
+
+Bitwarden CRD Operator is a kubernetes Operator based on [kopf](https://github.com/nolar/kopf/). The goal is to create kubernetes native secret objects from bitwarden.
+
+<p align="center">
+  <img src="https://github.com/Lerentis/bitwarden-crd-operator/blob/main/logo.png?raw=true" alt="Bitwarden CRD Operator Logo" width="200"/>
+</p>
+
+> DISCLAIMER:  
+> This project is still very work in progress :)
+
+
+## Getting started
+
+You will need a `ClientID` and `ClientSecret` ([where to get these](https://bitwarden.com/help/personal-api-key/)) as well as your password.
+Expose these to the operator as described in this example:
+
+```yaml
+env:
+  - name: BW_HOST
+    value: "https://bitwarden.your.tld.org"
+  - name: BW_CLIENTID
+    value: "user.your-client-id"
+  - name: BW_CLIENTSECRET
+    value: "YoUrCliEntSecRet"
+  - name: BW_PASSWORD
+    value: "YourSuperSecurePassword"
+```
+
+you can also create a secret manually with these information and reference the existing secret like this in the `values.yaml`:
+
+```yaml
+externalConfigSecret:
+  enabled: true
+  name: "my-existing-secret"
+```
+
+the helm template will use all environment variables from this secret, so make sure to prepare this secret with the key value pairs as described above.
+
+`BW_HOST` can be omitted if you are using the Bitwarden SaaS offering.
+
+After that it is a basic helm deployment:
+
+```bash
+helm repo add bitwarden-operator https://lerentis.github.io/bitwarden-crd-operator
+helm repo update 
+kubectl create namespace bw-operator
+helm upgrade --install --namespace bw-operator -f values.yaml bw-operator bitwarden-operator/bitwarden-crd-operator
+```
+
+## BitwardenSecret
+
+And you are set to create your first secret using this operator. For that you need to add a CRD Object like this to your cluster:
+
+```yaml
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: BitwardenSecret
+metadata:
+  name: name-of-your-management-object
+spec:
+  content:
+    - element:
+        secretName: nameOfTheFieldInBitwarden # for example username
+        secretRef: nameOfTheKeyInTheSecretToBeCreated 
+        secretScope: login # for custom entries on bitwarden use 'fields' 
+    - element:
+        secretName: nameOfAnotherFieldInBitwarden # for example password
+        secretRef: nameOfAnotherKeyInTheSecretToBeCreated 
+        secretScope: login # for custom entries on bitwarden use 'fields' 
+  id: "A Secret ID from bitwarden"
+  name: "Name of the secret to be created"
+  namespace: "Namespace of the secret to be created"
+```
+
+The ID can be extracted from the browser when you open a item the ID is in the URL. The resulting secret looks something like this:
+
+```yaml
+apiVersion: v1
+data:
+  nameOfTheKeyInTheSecretToBeCreated: "base64 encoded value of TheFieldInBitwarden"
+  nameOfAnotherKeyInTheSecretToBeCreated: "base64 encoded value of AnotherFieldInBitwarden"
+kind: Secret
+metadata:
+  annotations:
+    managed: bitwarden-secrets.lerentis.uploadfilter24.eu
+    managedObject: bw-operator/test
+  name: name-of-your-management-object
+  namespace: default
+type: Opaque
+```
+
+## RegistryCredential
+
+For managing registry credentials, or pull secrets, you can create another kind of object to let the operator create these as well for you:
+
+```yaml
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: RegistryCredential
+metadata:
+  name: name-of-your-management-object
+spec:
+  usernameRef: nameOfTheFieldInBitwarden # for example username
+  passwordRef: nameOfTheFieldInBitwarden # for example password
+  registry: "docker.io"
+  id: "A Secret ID from bitwarden"
+  name: "Name of the secret to be created"
+  namespace: "Namespace of the secret to be created"
+```
+
+The resulting secret looks something like this:
+
+```yaml
+apiVersion: v1
+data:
+  .dockerconfigjson: "base64 encoded json auth string for your registry"
+kind: Secret
+metadata:
+  annotations:
+    managed: bitwarden-secrets.lerentis.uploadfilter24.eu
+    managedObject: bw-operator/test
+  name: name-of-your-management-object
+  namespace: default
+type: dockerconfigjson
+```
+
+## BitwardenTemplate
+
+One of the more freely defined types that can be used with this operator you can just pass a whole template:
+
+```yaml
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: BitwardenTemplate
+metadata:
+  name: name-of-your-management-object
+spec:
+  filename: "Key of the secret to be created"
+  name: "Name of the secret to be created"
+  namespace: "Namespace of the secret to be created"
+  template: |
+    ---
+    api:
+      enabled: True
+      key: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "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") }}
+          enabled: true
+```
+
+This will result in something like the following object:
+
+```yaml
+apiVersion: v1
+data:
+  Key of the secret to be created: "base64 encoded and rendered template with secrets injected directly from bitwarden"
+kind: Secret
+metadata:
+  annotations:
+    managed: bitwarden-template.lerentis.uploadfilter24.eu
+    managedObject: namespace/name-of-your-management-object
+  name: Name of the secret to be created
+  namespace: Namespace of the secret to be created
+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.

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

@@ -1,3 +1,4 @@
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -12,7 +13,7 @@ spec:
     shortNames:
       - bws
   versions:
-    - name: v1beta2
+    - name: v1beta4
       served: true
       storage: true
       schema:
@@ -34,6 +35,8 @@ spec:
                             type: string
                           secretRef:
                             type: string
+                          secretScope:
+                            type: string
                         required:
                           - secretName
                 id:

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

@@ -0,0 +1,38 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: bitwarden-templates.lerentis.uploadfilter24.eu
+spec:
+  scope: Namespaced
+  group: lerentis.uploadfilter24.eu
+  names:
+    kind: BitwardenTemplate
+    plural: bitwarden-templates
+    singular: bitwarden-template
+    shortNames:
+      - bwt
+  versions:
+    - name: v1beta4
+      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
+              required:
+                - filename
+                - template
+                - namespace
+                - name

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

@@ -0,0 +1,44 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: registry-credentials.lerentis.uploadfilter24.eu
+spec:
+  scope: Namespaced
+  group: lerentis.uploadfilter24.eu
+  names:
+    kind: RegistryCredential
+    plural: registry-credentials
+    singular: registry-credential
+    shortNames:
+      - rgc
+  versions:
+    - name: v1beta4
+      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
+              required:
+                - id
+                - namespace
+                - name
+                - usernameRef
+                - passwordRef
+                - registry

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

@@ -4,7 +4,7 @@ metadata:
   name: {{ include "bitwarden-crd-operator.serviceAccountName" . }}-role
 rules:
 - apiGroups: ["lerentis.uploadfilter24.eu"]
-  resources: ["bitwarden-secrets"]
+  resources: ["bitwarden-secrets", "registry-credentials", "bitwarden-templates"]
   verbs: ["get", "watch", "list", "create", "delete", "patch", "update"]
 - apiGroups: [""]
   resources: ["secrets"]

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

@@ -33,10 +33,15 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
-          {{- with .Values.env }}
           env:
+          {{- with .Values.env }}
             {{- . | toYaml | trim | nindent 12 }}
           {{- end }}
+          {{- if .Values.externalConfigSecret.enabled }}
+          envFrom:
+            - secretRef:
+                name: {{ .Values.externalConfigSecret.name }}
+          {{- end }}
           ports:
             - name: http
               containerPort: 8080

charts/bitwarden-crd-operator/values.yaml

@@ -24,6 +24,11 @@ fullnameOverride: ""
 #  - name: BW_PASSWORD
 #    value: "define_id"
 
+externalConfigSecret:
+  enabled: false
+
+  name: ""
+
 serviceAccount:
   # Specifies whether a service account should be created
   create: true

example.yaml

@@ -1,5 +1,5 @@
 ---
-apiVersion: "lerentis.uploadfilter24.eu/v1beta2"
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
 kind: BitwardenSecret
 metadata:
   name: test
@@ -8,9 +8,11 @@ spec:
     - element:
         secretName: username
         secretRef: nameofUser 
+        secretScope: login
     - element:
         secretName: password
         secretRef: passwordOfUser 
+        secretScope: login
   id: "88781348-c81c-4367-9801-550360c21295"
   name: "test-secret"
   namespace: "default"

example_dockerlogin.yaml

@@ -0,0 +1,12 @@
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: RegistryCredential
+metadata:
+  name: test
+spec:
+  usernameRef: "username"
+  passwordRef: "password"
+  registry: "docker.io"
+  id: "3b249ec7-9ce7-440a-9558-f34f3ab10680"
+  name: "test-regcred"
+  namespace: "default"

example_template.yaml

@@ -0,0 +1,19 @@
+---
+apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
+kind: BitwardenTemplate
+metadata:
+  name: test
+spec:
+  filename: "config.yaml"
+  name: "test-template"
+  namespace: "default"
+  template: |
+    ---
+    api:
+      enabled: True
+      key: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "fields", "key") }}
+      allowCrossOrigin: false
+      apps:
+        "some.app.identifier:some_version":
+          pubkey: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "fields", "public_key") }}
+          enabled: true

requirements.txt

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

src/bitwardenCrdOperator.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+import kopf
+import os
+
+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:
+            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")
+    command_wrapper("login --apikey")
+    unlock_bw(logger)
+

src/dockerlogin.py

@@ -0,0 +1,100 @@
+import kopf
+import kubernetes
+import base64
+import json
+
+from utils.utils import unlock_bw, get_secret_from_bitwarden
+
+def create_dockerlogin(logger, secret, secret_json, username_ref, password_ref, registry):
+    secret.type = "dockerconfigjson"
+    secret.data = {}
+    auths_dict = {}
+    registry_dict = {}
+    reg_auth_dict = {}
+
+    _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")
+
+    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")
+    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')
+    password_ref = spec.get('passwordRef')
+    registry = spec.get('registry')
+    id = spec.get('id')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    unlock_bw(logger)
+    logger.info(f"Locking up secret with ID: {id}")
+    secret_json_object = json.loads(get_secret_from_bitwarden(id))
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "registry-credential.lerentis.uploadfilter24.eu",
+        "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)   
+
+    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')
+@kopf.timer('registry-credential.lerentis.uploadfilter24.eu', interval=900)
+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')
+
+    unlock_bw(logger)
+    logger.info(f"Locking up secret with ID: {id}")
+    secret_json_object = json.loads(get_secret_from_bitwarden(id))
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "registry-credential.lerentis.uploadfilter24.eu",
+        "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)
+    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.warn(
+            f"Could not update secret {secret_namespace}/{secret_name}!")
+
+
+@kopf.on.delete('registry-credential.lerentis.uploadfilter24.eu')
+def delete_managed_secret(spec, name, namespace, logger, **kwargs):
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+    api = kubernetes.client.CoreV1Api()
+
+    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}!")

src/kv.py

@@ -0,0 +1,109 @@
+import kopf
+import kubernetes
+import base64
+import json
+
+from utils.utils import unlock_bw, get_secret_from_bitwarden, parse_login_scope, parse_fields_scope
+
+
+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():
+                if key == "secretName":
+                    _secret_key = value
+                if key == "secretRef":
+                    _secret_ref = value
+                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")
+            if _secret_scope == "fields":
+                secret.data[_secret_ref] = str(base64.b64encode(
+                    parse_fields_scope(secret_json, _secret_key).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):
+
+    content_def = body['spec']['content']
+    id = spec.get('id')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    unlock_bw(logger)
+    logger.info(f"Locking up secret with ID: {id}")
+    secret_json_object = json.loads(get_secret_from_bitwarden(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)
+
+    obj = 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')
+@kopf.timer('bitwarden-secret.lerentis.uploadfilter24.eu', interval=900)
+def update_managed_secret(spec, status, name, namespace, logger, body, **kwargs):
+
+    content_def = body['spec']['content']
+    id = spec.get('id')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    unlock_bw(logger)
+    logger.info(f"Locking up secret with ID: {id}")
+    secret_json_object = json.loads(get_secret_from_bitwarden(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:
+        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):
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+    api = kubernetes.client.CoreV1Api()
+
+    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}!")

src/lookups/bitwarden_lookup.py

@@ -0,0 +1,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)

src/template.py

@@ -0,0 +1,92 @@
+import kopf
+import base64
+import kubernetes
+
+from utils.utils import unlock_bw
+from lookups.bitwarden_lookup import bitwarden_lookup
+from jinja2 import Environment, BaseLoader
+
+
+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")
+    return secret
+
+@kopf.on.create('bitwarden-template.lerentis.uploadfilter24.eu')
+def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
+
+    template = spec.get('template')
+    filename = spec.get('filename')
+    secret_name = spec.get('name')
+    secret_namespace = spec.get('namespace')
+
+    unlock_bw(logger)
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "bitwarden-template.lerentis.uploadfilter24.eu",
+        "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)
+
+    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=900)
+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')
+
+    unlock_bw(logger)
+
+    api = kubernetes.client.CoreV1Api()
+
+    annotations = {
+        "managed": "bitwarden-template.lerentis.uploadfilter24.eu",
+        "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)
+
+    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.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')
+    secret_namespace = spec.get('namespace')
+    api = kubernetes.client.CoreV1Api()
+
+    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}!")

src/utils/utils.py

@@ -0,0 +1,30 @@
+import os
+import subprocess
+
+class BitwardenCommandException(Exception):
+    pass
+
+def get_secret_from_bitwarden(id):
+    return command_wrapper(command=f"get item {id}")
+
+def unlock_bw(logger):
+    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)
+    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):
+    for entry in secret_json["fields"]:
+        if entry['name'] == key:
+            return entry['value']