working jinja template type
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing

This commit is contained in:
Tobias Trabelsi 2022-11-26 21:33:31 +01:00
parent cb793a7490
commit d316c8567e
Signed by: lerentis
GPG Key ID: FF0C2839718CAF2E
13 changed files with 78 additions and 44 deletions

View File

@ -32,12 +32,12 @@ annotations:
url: https://github.com/Lerentis/bitwarden-crd-operator url: https://github.com/Lerentis/bitwarden-crd-operator
artifacthub.io/crds: | artifacthub.io/crds: |
- kind: BitwardenSecret - kind: BitwardenSecret
version: v1beta3 version: v1beta4
name: bitwarden-secret name: bitwarden-secret
displayName: Bitwarden Secret displayName: Bitwarden Secret
description: Management Object to create secrets from bitwarden description: Management Object to create secrets from bitwarden
- kind: RegistryCredential - kind: RegistryCredential
version: v1beta3 version: v1beta4
name: registry-credential name: registry-credential
displayName: Regestry Credentials displayName: Regestry Credentials
description: Management Object to create regestry secrets from bitwarden description: Management Object to create regestry secrets from bitwarden
@ -47,7 +47,7 @@ annotations:
displayName: Bitwarden Template displayName: Bitwarden Template
description: Management Object to create secrets from a jinja template with a bitwarden lookup description: Management Object to create secrets from a jinja template with a bitwarden lookup
artifacthub.io/crdsExamples: | artifacthub.io/crdsExamples: |
- apiVersion: lerentis.uploadfilter24.eu/v1beta3 - apiVersion: lerentis.uploadfilter24.eu/v1beta4
kind: BitwardenSecret kind: BitwardenSecret
metadata: metadata:
name: test name: test
@ -62,7 +62,7 @@ annotations:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
name: "test-secret" name: "test-secret"
namespace: "default" namespace: "default"
- apiVersion: lerentis.uploadfilter24.eu/v1beta3 - apiVersion: lerentis.uploadfilter24.eu/v1beta4
kind: RegistryCredential kind: RegistryCredential
metadata: metadata:
name: test name: test
@ -73,7 +73,7 @@ annotations:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
name: "test-regcred" name: "test-regcred"
namespace: "default" namespace: "default"
- apiVersion: "lerentis.uploadfilter24.eu/v1beta1" - apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
kind: BitwardenTemplate kind: BitwardenTemplate
metadata: metadata:
name: test name: test
@ -85,19 +85,23 @@ annotations:
--- ---
api: api:
enabled: True enabled: True
key: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "key") }} key: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "fields", "key") }}
allowCrossOrigin: false allowCrossOrigin: false
apps: apps:
"some.app.identifier:some_version": "some.app.identifier:some_version":
pubkey: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "public_key") }} pubkey: {{ bitwarden_lookup("466fc4b0-ffca-4444-8d88-b59d4de3d928", "fields", "public_key") }}
enabled: true enabled: true
artifacthub.io/license: MIT artifacthub.io/license: MIT
artifacthub.io/operator: "true" artifacthub.io/operator: "true"
artifacthub.io/changes: | artifacthub.io/changes: |
- kind: added - kind: added
description: "Added Template CRD" description: "Added Template type"
- kind: added - kind: added
description: "Added logo" description: "Added logo"
- kind: changed
description: "BitwardenSecret now requires a 'secretScope' to be defined. Can eigher be 'login' or 'fields'"
- kind: fixed
description: "fixed hardcoded reference to 'login' even tho secrets could also be in 'fields' scope"
artifacthub.io/images: | artifacthub.io/images: |
- name: bitwarden-crd-operator - name: bitwarden-crd-operator
image: lerentis/bitwarden-crd-operator:0.4.0 image: lerentis/bitwarden-crd-operator:0.4.0

View File

@ -13,7 +13,7 @@ spec:
shortNames: shortNames:
- bws - bws
versions: versions:
- name: v1beta3 - name: v1beta4
served: true served: true
storage: true storage: true
schema: schema:
@ -35,6 +35,8 @@ spec:
type: string type: string
secretRef: secretRef:
type: string type: string
secretScope:
type: string
required: required:
- secretName - secretName
id: id:

View File

@ -13,7 +13,7 @@ spec:
shortNames: shortNames:
- bwt - bwt
versions: versions:
- name: v1beta1 - name: v1beta4
served: true served: true
storage: true storage: true
schema: schema:

View File

@ -13,7 +13,7 @@ spec:
shortNames: shortNames:
- rgc - rgc
versions: versions:
- name: v1beta3 - name: v1beta4
served: true served: true
storage: true storage: true
schema: schema:

View File

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

View File

@ -1,5 +1,5 @@
--- ---
apiVersion: "lerentis.uploadfilter24.eu/v1beta3" apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
kind: RegistryCredential kind: RegistryCredential
metadata: metadata:
name: test name: test

View File

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

View File

@ -7,9 +7,14 @@ from utils.utils import command_wrapper, unlock_bw
@kopf.on.startup() @kopf.on.startup()
def bitwarden_signin(logger, **kwargs): def bitwarden_signin(logger, **kwargs):
if 'BW_HOST' in os.environ: if 'BW_HOST' in os.environ:
command_wrapper(logger, f"config server {os.getenv('BW_HOST')}") 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: else:
logger.info(f"BW_HOST not set. Assuming SaaS installation") logger.info(f"BW_HOST not set. Assuming SaaS installation")
command_wrapper(logger, "login --apikey") command_wrapper("login --apikey")
unlock_bw(logger) unlock_bw(logger)

View File

@ -23,7 +23,7 @@ def create_dockerlogin(logger, secret, secret_json, username_ref, password_ref,
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 return secret
@kopf.on.create('registry-credentials.lerentis.uploadfilter24.eu') @kopf.on.create('registry-credential.lerentis.uploadfilter24.eu')
def create_managed_registry_secret(spec, name, namespace, logger, **kwargs): def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
username_ref = spec.get('usernameRef') username_ref = spec.get('usernameRef')
password_ref = spec.get('passwordRef') password_ref = spec.get('passwordRef')
@ -39,7 +39,7 @@ def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
api = kubernetes.client.CoreV1Api() api = kubernetes.client.CoreV1Api()
annotations = { annotations = {
"managed": "registry-credentials.lerentis.uploadfilter24.eu", "managed": "registry-credential.lerentis.uploadfilter24.eu",
"managedObject": f"{namespace}/{name}" "managedObject": f"{namespace}/{name}"
} }
secret = kubernetes.client.V1Secret() secret = kubernetes.client.V1Secret()
@ -52,11 +52,11 @@ def create_managed_registry_secret(spec, name, namespace, logger, **kwargs):
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-credentials.lerentis.uploadfilter24.eu') @kopf.on.update('registry-credential.lerentis.uploadfilter24.eu')
def my_handler(spec, old, new, diff, **_): def my_handler(spec, old, new, diff, **_):
pass pass
@kopf.on.delete('registry-credentials.lerentis.uploadfilter24.eu') @kopf.on.delete('registry-credential.lerentis.uploadfilter24.eu')
def delete_managed_secret(spec, name, namespace, logger, **kwargs): def delete_managed_secret(spec, name, namespace, logger, **kwargs):
secret_name = spec.get('name') secret_name = spec.get('name')
secret_namespace = spec.get('namespace') secret_namespace = spec.get('namespace')

View File

@ -3,7 +3,7 @@ import kubernetes
import base64 import base64
import json import json
from utils.utils import unlock_bw, get_secret_from_bitwarden from utils.utils import unlock_bw, get_secret_from_bitwarden, parse_login_scope, parse_fields_scope
def create_kv(secret, secret_json, content_def): def create_kv(secret, secret_json, content_def):
secret.type = "Opaque" secret.type = "Opaque"
@ -15,10 +15,15 @@ def create_kv(secret, secret_json, content_def):
_secret_key = value _secret_key = value
if key == "secretRef": if key == "secretRef":
_secret_ref = value _secret_ref = value
secret.data[_secret_ref] = str(base64.b64encode(secret_json["login"][_secret_key].encode("utf-8")), "utf-8") 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 return secret
@kopf.on.create('bitwarden-secrets.lerentis.uploadfilter24.eu') @kopf.on.create('bitwarden-secret.lerentis.uploadfilter24.eu')
def create_managed_secret(spec, name, namespace, logger, body, **kwargs): def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
content_def = body['spec']['content'] content_def = body['spec']['content']
@ -33,7 +38,7 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
api = kubernetes.client.CoreV1Api() api = kubernetes.client.CoreV1Api()
annotations = { annotations = {
"managed": "bitwarden-secrets.lerentis.uploadfilter24.eu", "managed": "bitwarden-secret.lerentis.uploadfilter24.eu",
"managedObject": f"{namespace}/{name}" "managedObject": f"{namespace}/{name}"
} }
secret = kubernetes.client.V1Secret() secret = kubernetes.client.V1Secret()
@ -46,11 +51,11 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
logger.info(f"Secret {secret_namespace}/{secret_name} has been created") logger.info(f"Secret {secret_namespace}/{secret_name} has been created")
@kopf.on.update('bitwarden-secrets.lerentis.uploadfilter24.eu') @kopf.on.update('bitwarden-secret.lerentis.uploadfilter24.eu')
def my_handler(spec, old, new, diff, **_): def my_handler(spec, old, new, diff, **_):
pass pass
@kopf.on.delete('bitwarden-secrets.lerentis.uploadfilter24.eu') @kopf.on.delete('bitwarden-secret.lerentis.uploadfilter24.eu')
def delete_managed_secret(spec, name, namespace, logger, **kwargs): def delete_managed_secret(spec, name, namespace, logger, **kwargs):
secret_name = spec.get('name') secret_name = spec.get('name')
secret_namespace = spec.get('namespace') secret_namespace = spec.get('namespace')

View File

@ -1,5 +1,10 @@
from utils.utils import get_secret_from_bitwarden import json
def bitwarden_lookup(id, field): from utils.utils import get_secret_from_bitwarden, parse_fields_scope, parse_login_scope
_secret_json = get_secret_from_bitwarden(id)
return _secret_json["login"][field] 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)

View File

@ -22,7 +22,7 @@ def create_template_secret(secret, filename, template):
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 return secret
@kopf.on.create('bitwarden-templates.lerentis.uploadfilter24.eu') @kopf.on.create('bitwarden-template.lerentis.uploadfilter24.eu')
def create_managed_secret(spec, name, namespace, logger, body, **kwargs): def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
template = spec.get('template') template = spec.get('template')
@ -35,12 +35,12 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
api = kubernetes.client.CoreV1Api() api = kubernetes.client.CoreV1Api()
annotations = { annotations = {
"managed": "bitwarden-templates.lerentis.uploadfilter24.eu", "managed": "bitwarden-template.lerentis.uploadfilter24.eu",
"managedObject": f"{namespace}/{name}" "managedObject": f"{namespace}/{name}"
} }
secret = kubernetes.client.V1Secret() 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_managed_secret(secret, filename, template) secret = create_template_secret(secret, filename, template)
obj = api.create_namespaced_secret( obj = api.create_namespaced_secret(
secret_namespace, secret secret_namespace, secret
@ -48,11 +48,11 @@ def create_managed_secret(spec, name, namespace, logger, body, **kwargs):
logger.info(f"Secret {secret_namespace}/{secret_name} has been created") logger.info(f"Secret {secret_namespace}/{secret_name} has been created")
@kopf.on.update('bitwarden-templates.lerentis.uploadfilter24.eu') @kopf.on.update('bitwarden-template.lerentis.uploadfilter24.eu')
def my_handler(spec, old, new, diff, **_): def my_handler(spec, old, new, diff, **_):
pass pass
@kopf.on.delete('bitwarden-templates.lerentis.uploadfilter24.eu') @kopf.on.delete('bitwarden-template.lerentis.uploadfilter24.eu')
def delete_managed_secret(spec, name, namespace, logger, **kwargs): def delete_managed_secret(spec, name, namespace, logger, **kwargs):
secret_name = spec.get('name') secret_name = spec.get('name')
secret_namespace = spec.get('namespace') secret_namespace = spec.get('namespace')

View File

@ -1,19 +1,30 @@
import os import os
import subprocess import subprocess
class BitwardenCommandException(Exception):
pass
def get_secret_from_bitwarden(id): def get_secret_from_bitwarden(id):
return command_wrapper(logger, f"get item {id}") return command_wrapper(command=f"get item {id}")
def unlock_bw(logger): def unlock_bw(logger):
token_output = command_wrapper(logger, "unlock --passwordenv BW_PASSWORD") token_output = command_wrapper("unlock --passwordenv BW_PASSWORD")
tokens = token_output.split('"')[1::2] tokens = token_output.split('"')[1::2]
os.environ["BW_SESSION"] = tokens[1] os.environ["BW_SESSION"] = tokens[1]
logger.info("Signin successful. Session exported") logger.info("Signin successful. Session exported")
def command_wrapper(logger, command): def command_wrapper(command):
system_env = dict(os.environ) 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() out, err = sp.communicate()
if err: if err:
logger.warn(f"Error during bw cli invokement: {err}") raise BitwardenCommandException(err)
return out.decode(encoding='UTF-8') 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']