Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions elements/oci/k0s-sysext.bst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ config:
mkdir -p sysext/usr/share/k0s/kubeflex
cp -a kubeflex-src/. sysext/usr/share/k0s/kubeflex/
chmod 0755 sysext/usr/share/k0s/kubeflex/generate-postgres-secret.sh
chmod 0755 sysext/usr/share/k0s/kubeflex/generate-console-secret.sh

# Generate self-signed TLS certificate for local kiosk proxy
openssl req -x509 -nodes -days 3650 -newkey rsa:2048 \
Expand Down
40 changes: 40 additions & 0 deletions files/k0s/kubeflex/generate-console-secret.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash
# First-boot generator for the KubeStellar console session-signing secret.
#
# The console Deployment (40-kubestellar-console.yaml) reads JWT_SECRET from
# the kubestellar-console-github-oauth Secret via secretKeyRef. This script
# creates that Secret once, with a random jwt-secret, so no usable signing key
# is committed to git (see projectbluefin/server#72). The GitHub OAuth keys
# are created empty: the console consumes them with `optional: true`, and an
# operator enabling OAuth edits the generated file with real credentials.
#
# Idempotent: the secret is generated only if the file does not already exist,
# so operator-supplied OAuth credentials and issued sessions survive re-boots.
# Run once per boot by k0s-first-boot.service, before k0s applies the
# manifests (its 02- name sorts before 40-kubestellar-console.yaml).
set -euo pipefail

manifest_dir="${KUBESTELLAR_MANIFEST_DIR:-/var/lib/k0s/manifests/kubestellar}"
secret_file="$manifest_dir/02-kubestellar-console-secret.yaml"

if [ -e "$secret_file" ]; then
exit 0
fi

mkdir -p "$manifest_dir"
jwt_secret="$(od -An -tx1 -N32 /dev/urandom | tr -d ' \n')"

cat > "$secret_file" <<YAML
apiVersion: v1
kind: Secret
metadata:
name: kubestellar-console-github-oauth
namespace: kubestellar-console
type: Opaque
stringData:
client-id: ""
client-secret: ""
jwt-secret: "$jwt_secret"
YAML

chmod 0600 "$secret_file"
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# The kubestellar-console-github-oauth Secret is NOT committed here (#72): its
# jwt-secret signs console session tokens, and a value published in git would
# let anyone forge valid sessions on every default install. The Secret is
# generated at first boot with a random jwt-secret by
# /usr/share/k0s/kubeflex/generate-console-secret.sh (written as
# 02-kubestellar-console-secret.yaml, which sorts before the console
# Deployment in 40-kubestellar-console.yaml). Operators supply real GitHub
# OAuth credentials by editing that generated Secret; the console consumes
# client-id/client-secret with `optional: true`, so empty values are fine.
apiVersion: v1
kind: Namespace
metadata:
name: kubestellar-console
---
apiVersion: v1
kind: Secret
metadata:
name: kubestellar-console-github-oauth
namespace: kubestellar-console
type: Opaque
stringData:
client-id: ""
client-secret: ""
jwt-secret: default-jwt-secret-123456789012345678901234
1 change: 1 addition & 0 deletions files/os/systemd/system/k0s-first-boot.service
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ ExecStart=/usr/bin/install -D -m 0644 /var/lib/k0s/k0s.raw /run/extensions/k0s.r
ExecStart=/usr/bin/systemd-sysext merge
ExecStart=/usr/bin/systemd-tmpfiles --create /usr/lib/tmpfiles.d/k0s-manifests.conf
ExecStart=/usr/share/k0s/kubeflex/generate-postgres-secret.sh
ExecStart=/usr/share/k0s/kubeflex/generate-console-secret.sh
ExecStart=/usr/bin/systemctl daemon-reload
ExecStart=/usr/bin/systemctl enable --now k0scontroller.service
[Install]
Expand Down
50 changes: 50 additions & 0 deletions tests/unit/test_k0s_manifests.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,53 @@ def test_generate_postgres_secret_is_idempotent(tmp_path):
first = secret_file.read_text()
run()
assert secret_file.read_text() == first, "password changed on re-run; DB would lose access"


def test_console_jwt_secret_not_hardcoded():
# #72: the console JWT signing secret must not be committed to git. The
# 01- manifest only creates the namespace; the Secret itself is generated
# at first boot with a random jwt-secret.
manifest = ROOT / "files" / "k0s" / "manifests" / "kubestellar" / "01-kubestellar-console-github-oauth.yaml"
text = manifest.read_text()
assert "kind: Secret" not in text
assert "jwt-secret" not in yaml_values(text)
docs = [d for d in yaml.safe_load_all(text) if d]
assert [d["kind"] for d in docs] == ["Namespace"]


def yaml_values(text):
# Collapse to non-comment lines so doc comments may still mention keys.
return "\n".join(l for l in text.splitlines() if not l.lstrip().startswith("#"))


def test_k0s_first_boot_generates_console_secret_before_k0s():
unit = ROOT / "files" / "os" / "systemd" / "system" / "k0s-first-boot.service"
lines = [l for l in unit.read_text().splitlines() if l.startswith("ExecStart")]
gen = next((i for i, l in enumerate(lines) if "generate-console-secret.sh" in l), None)
k0s = next((i for i, l in enumerate(lines) if "k0scontroller.service" in l), None)
assert gen is not None, "first-boot service never runs the console secret generator"
assert k0s is not None
assert gen < k0s, "console secret generator must run before k0s applies manifests"


def test_generate_console_secret_is_idempotent(tmp_path):
# Re-running must not rotate the jwt-secret (sessions would break) and
# must not clobber operator-supplied OAuth credentials.
script = ROOT / "files" / "k0s" / "kubeflex" / "generate-console-secret.sh"
env = dict(os.environ, KUBESTELLAR_MANIFEST_DIR=str(tmp_path))
run = lambda: subprocess.run(["/bin/bash", str(script)], env=env, check=True, capture_output=True, text=True)
run()
secret_file = tmp_path / "02-kubestellar-console-secret.yaml"
assert secret_file.is_file()
assert (secret_file.stat().st_mode & 0o777) == 0o600
secret = yaml.safe_load(secret_file.read_text())
assert secret["kind"] == "Secret"
assert secret["metadata"]["name"] == "kubestellar-console-github-oauth"
assert secret["metadata"]["namespace"] == "kubestellar-console"
jwt = secret["stringData"]["jwt-secret"]
assert len(jwt) == 64 and all(c in "0123456789abcdef" for c in jwt)
assert secret["stringData"]["client-id"] == ""
assert secret["stringData"]["client-secret"] == ""
first = secret_file.read_text()
run()
assert secret_file.read_text() == first, "jwt-secret changed on re-run"
Loading