🚧 Update certificate management

This commit is contained in:
Jonas Bengtsson
2026-09-19 17:12:58 +02:00
parent 111d6cc390
commit a16a01b1e7
21 changed files with 1128 additions and 37 deletions
+21 -8
View File
@@ -102,7 +102,8 @@ covered by the test suite / running stack.
- [x] Management RBAC (super_admin / broker_admin / operator / auditor) - [x] Management RBAC (super_admin / broker_admin / operator / auditor)
- [x] Dynamic Security integration (backend as the dynsec admin client) - [x] Dynamic Security integration (backend as the dynsec admin client)
- [x] MQTT clients: create / disable / enable / delete, password reset, - [x] MQTT clients: create / disable / enable / delete, password reset,
random passwords (returned exactly once) random passwords (returned exactly once), expected client-ID
binding (anti-credential-sharing, spec section 11)
- [x] Groups: create / delete, member + role assignment with priorities - [x] Groups: create / delete, member + role assignment with priorities
- [x] Roles: create / delete, ACL editor (all six ACL types, `%u`/`%c` - [x] Roles: create / delete, ACL editor (all six ACL types, `%u`/`%c`
substitution, priorities, draft-then-save) substitution, priorities, draft-then-save)
@@ -137,21 +138,33 @@ Hardening done beyond the plan:
private keys encrypted at rest (AES-256-GCM) private keys encrypted at rest (AES-256-GCM)
- [x] Server certificate generation (CN, DNS/IP SANs, serverAuth EKU, - [x] Server certificate generation (CN, DNS/IP SANs, serverAuth EKU,
signed by a platform CA; PEM download) signed by a platform CA; PEM download)
- [x] Client certificates (CN = MQTT username, clientAuth EKU,
one-time bundle with cert + key + CA chain as file downloads;
identity binding to the client metadata)
- [x] mTLS listeners end-to-end: TLS section in the listener form
(certificate picker, min TLS version, require_certificate,
use_identity_as_username) — verified live with a client-cert
publish through an mTLS listener (spec section 24)
- [x] Certificate inventory (serial, fingerprint, SANs, status, expiry) - [x] Certificate inventory (serial, fingerprint, SANs, status, expiry)
- [x] TLS config generation: listeners with a bound certificate emit - [x] TLS config generation: listeners with a bound certificate emit
certfile/keyfile/cafile; cert files are published to a shared certfile/keyfile/cafile; cert files are published to a shared
certs volume before the config is validated/activated certs volume (uid 1883, key mode 0640) before validation/deploy
- [x] Unpublished-port warning: listeners on ports not mapped by
compose.yaml warn in the preview/deploy (reachable only inside
the Docker network; keep PUBLISHED_PORTS in sync with compose)
- [ ] Configuration diff view (revision N-1 → N) - [ ] Configuration diff view (revision N-1 → N)
- [ ] Configuration rollback (creates a new revision, §62) - [ ] Configuration rollback (creates a new revision, §62)
- [ ] Reload-vs-restart classification (§28) — only a restart warning on - [ ] Reload-vs-restart classification (§28) — the deploy health check
listener port/bind edits so far, no general classification passes on reload, but a NEW listener still needs an explicit
broker restart (docker compose restart mosquitto); surfacing
that in the UI is pending
- [ ] CA import (existing external CA) - [ ] CA import (existing external CA)
- [ ] Root-key export + removal workflow (§18) - [ ] Root-key export + removal workflow (§18)
- [ ] Client certificates (managed-key mode, one-time download) - [ ] CSR signing (client-side key generation)
- [ ] CSR signing
- [ ] Certificate revocation + CRL generation/publishing - [ ] Certificate revocation + CRL generation/publishing
- [ ] mTLS listeners (model fields + config generation exist; binding a - [ ] Client-cert disable: revoking access for a connected device
certificate in the UI is the remaining step) (needs CRL or dynsec disable + kick; the interim path — disabling
the client — already refuses reconnects even with a valid cert)
### Release 3 — Operations, safety, and visibility (§68.3) — PARTIAL ### Release 3 — Operations, safety, and visibility (§68.3) — PARTIAL
+14
View File
@@ -46,6 +46,20 @@ class Settings(BaseSettings):
default_cert_validity_days: int = 365 default_cert_validity_days: int = 365
default_ca_validity_days: int = 3650 default_ca_validity_days: int = 3650
# Broker container ports published to the host by compose.yaml —
# listeners on other ports are only reachable INSIDE the Docker
# network (the platform generates any port; compose gates access).
# Comma-separated container ports; see compose.yaml `ports:`.
published_ports: str = "1883,8883"
@property
def published_port_set(self) -> set[int]:
return {
int(p.strip())
for p in self.published_ports.split(",")
if p.strip().isdigit()
}
@property @property
def is_production(self) -> bool: def is_production(self) -> bool:
return self.app_env == "production" return self.app_env == "production"
+15
View File
@@ -12,6 +12,7 @@ from dataclasses import dataclass, field
from sqlalchemy import select from sqlalchemy import select
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from app.config import get_settings
from app.models import BrokerSettings, Certificate, ListenerConfig from app.models import BrokerSettings, Certificate, ListenerConfig
_BOOL = {True: "true", False: "false"} _BOOL = {True: "true", False: "false"}
@@ -121,6 +122,20 @@ def generate_config(db: Session) -> GenerationResult:
lines.append("") lines.append("")
if enabled: if enabled:
# Compose publishes only a fixed set of broker ports to the host
# (spec section 5). Listeners on other ports are reachable ONLY
# inside the Docker network — surface that before an operator
# wonders why no external device can connect.
published = get_settings().published_port_set
for listener in enabled:
if listener.port not in published:
warnings.append(
f"listener '{listener.name}' (port {listener.port}) is not "
"published to the host by compose.yaml — it is reachable "
"only inside the Docker network. Map the port in "
"compose.yaml (or use a published port like 8883) to "
"make it reachable for external devices."
)
lines.append("# --- Listeners ---") lines.append("# --- Listeners ---")
for listener in enabled: for listener in enabled:
block = _listener_block(listener, db, warnings) block = _listener_block(listener, db, warnings)
+13
View File
@@ -233,6 +233,19 @@ class DynsecClient:
def set_client_password(self, username: str, password: str) -> None: def set_client_password(self, username: str, password: str) -> None:
self._command("setClientPassword", username=username, password=password) self._command("setClientPassword", username=username, password=password)
def set_client_id(self, username: str, clientid: str | None) -> None:
"""Bind (or clear) the expected client ID for a username.
With a bound client ID, connections must present exactly that
client id (username + password + client id must all match) — this
is what stops one device's credentials being reused by another
program (spec section 11: "bind an expected client ID").
"""
if clientid is None or clientid == "":
self._command("setClientId", username=username, clientid="")
else:
self._command("setClientId", username=username, clientid=clientid)
def get_client(self, username: str) -> dict[str, Any]: def get_client(self, username: str) -> dict[str, Any]:
return self._command("getClient", username=username).get("client", {}) return self._command("getClient", username=username).get("client", {})
+4
View File
@@ -173,6 +173,10 @@ class Certificate(Base):
parent_id: Mapped[uuid.UUID | None] = mapped_column( parent_id: Mapped[uuid.UUID | None] = mapped_column(
ForeignKey("certificates.id", ondelete="SET NULL") ForeignKey("certificates.id", ondelete="SET NULL")
) )
# server|client — client certificates are bound to MQTT identities.
cert_type: Mapped[str] = mapped_column(String(20), default="server")
# MQTT client identity this certificate authenticates (client certs).
username: Mapped[str | None] = mapped_column(String(100), index=True)
key_algorithm: Mapped[str] = mapped_column(String(20), default="ecdsa-p256") key_algorithm: Mapped[str] = mapped_column(String(20), default="ecdsa-p256")
serial_number: Mapped[str] = mapped_column(String(64), unique=True, index=True) serial_number: Mapped[str] = mapped_column(String(64), unique=True, index=True)
dns_sans: Mapped[list] = mapped_column(JSON, default=list) dns_sans: Mapped[list] = mapped_column(JSON, default=list)
+62
View File
@@ -221,3 +221,65 @@ def fingerprint(certificate_pem: str) -> str:
cert = x509.load_pem_x509_certificate(certificate_pem.encode("utf-8")) cert = x509.load_pem_x509_certificate(certificate_pem.encode("utf-8"))
digest = cert.fingerprint(hashes.SHA256()) digest = cert.fingerprint(hashes.SHA256())
return ":".join(f"{b:02x}" for b in digest) return ":".join(f"{b:02x}" for b in digest)
def issue_client_certificate(
*,
ca_certificate_pem: str,
ca_private_key_pem: str,
common_name: str,
validity_days: int,
) -> IssuedPair:
"""Issue a client certificate signed by the given CA (spec section 20).
The CN MUST equal the MQTT username of the dynsec client this
certificate authenticates: with use_identity_as_username the broker
maps CN -> MQTT identity (spec section 24), so a mismatch means the
certificate authenticates as a username that has no dynsec client.
clientAuth EKU, no SANs — device identity only.
"""
if not common_name.strip():
raise PkiError("common name must not be empty")
ca_cert = x509.load_pem_x509_certificate(ca_certificate_pem.encode("utf-8"))
ca_key = serialization.load_pem_private_key(
ca_private_key_pem.encode("utf-8"), password=None
)
# Type narrowing for the checker: certificate signing requires an
# RSA/EC/Ed25519/Ed448 key — DH/DSA keys load but cannot sign certs.
if not isinstance(
ca_key,
(
rsa.RSAPrivateKey,
ec.EllipticCurvePrivateKey,
ed25519.Ed25519PrivateKey,
ed448.Ed448PrivateKey,
),
):
raise PkiError("the CA private key type cannot sign certificates")
key = _generate_key("ecdsa-p256")
now = datetime.datetime.now(datetime.UTC)
subject = _name(common_name, None, None, None)
cert = (
x509.CertificateBuilder()
.subject_name(subject)
.issuer_name(ca_cert.subject)
.public_key(key.public_key())
.serial_number(_serial())
.not_valid_before(now - datetime.timedelta(minutes=5))
.not_valid_after(_not_after(now, validity_days))
.add_extension(
x509.ExtendedKeyUsage([x509.oid.ExtendedKeyUsageOID.CLIENT_AUTH]),
critical=False,
)
.add_extension(x509.BasicConstraints(ca=False, path_length=None), critical=True)
.sign(ca_key, hashes.SHA256())
)
return IssuedPair(
certificate_pem=_pem_cert(cert),
private_key_pem=_pem_key(key),
serial_number=cert.serial_number,
not_valid_after=cert.not_valid_after_utc,
)
+31 -14
View File
@@ -220,6 +220,9 @@ def _publish_certificates(db: Session) -> None:
Must run BEFORE the config referencing them is validated/activated, Must run BEFORE the config referencing them is validated/activated,
otherwise `mosquitto --test-config` fails on missing files. otherwise `mosquitto --test-config` fails on missing files.
Files are owned by uid/gid 1883 (the broker user in the official
image) with key mode 0640 — the broker must be able to read the key,
but no other container user should.
""" """
listeners = db.scalars( listeners = db.scalars(
select(ListenerConfig).where(ListenerConfig.tls_enabled.is_(True)) select(ListenerConfig).where(ListenerConfig.tls_enabled.is_(True))
@@ -233,25 +236,39 @@ def _publish_certificates(db: Session) -> None:
if cert is None or cert.private_key_pem is None: if cert is None or cert.private_key_pem is None:
continue # nothing to publish (warned about in configgen) continue # nothing to publish (warned about in configgen)
os.makedirs(CERTS_DIR, exist_ok=True) os.makedirs(CERTS_DIR, exist_ok=True)
cert_path = os.path.join(CERTS_DIR, f"{cert.id}.crt")
with open(cert_path, "w", encoding="utf-8") as f:
f.write(cert.certificate_pem)
os.chmod(cert_path, 0o644)
# Private key: decrypted for the broker (DB keeps the AES-GCM copy)
from app.crypto import decrypt_secret from app.crypto import decrypt_secret
key_path = os.path.join(CERTS_DIR, f"{cert.id}.key") def _write(path: str, content: str, mode: int) -> None:
with open(key_path, "w", encoding="utf-8") as f: with open(path, "w", encoding="utf-8") as f:
f.write(decrypt_secret(cert.private_key_pem)) f.write(content)
os.chmod(key_path, 0o600) os.chmod(path, mode)
# Issuing CA certificate (for cafile) try:
# The broker (and this sidecar) run as uid 1883 in the
# official image; chown only works when we are root in
# the container — skip silently in local dev on Windows.
os.chown(path, 1883, 1883)
except (PermissionError, OSError):
pass
_write(
os.path.join(CERTS_DIR, f"{cert.id}.crt"),
cert.certificate_pem,
0o644,
)
_write(
os.path.join(CERTS_DIR, f"{cert.id}.key"),
decrypt_secret(cert.private_key_pem),
0o640,
)
if cert.parent_id is not None: if cert.parent_id is not None:
ca = db.get(Certificate, cert.parent_id) ca = db.get(Certificate, cert.parent_id)
if ca is not None: if ca is not None:
ca_path = os.path.join(CERTS_DIR, f"{ca.id}.crt") _write(
with open(ca_path, "w", encoding="utf-8") as f: os.path.join(CERTS_DIR, f"{ca.id}.crt"),
f.write(ca.certificate_pem) ca.certificate_pem,
os.chmod(ca_path, 0o644) 0o644,
)
@router.get("/config/preview", response_model=ConfigPreviewOut) @router.get("/config/preview", response_model=ConfigPreviewOut)
+33
View File
@@ -19,6 +19,7 @@ from app.deps import CurrentUser, require_roles
from app.dynsec import DynsecError, dynsec_client from app.dynsec import DynsecError, dynsec_client
from app.models import ManagementRole, MqttClientMetadata from app.models import ManagementRole, MqttClientMetadata
from app.schemas import ( from app.schemas import (
ClientIdUpdate,
ClientRoleAssign, ClientRoleAssign,
GroupIn, GroupIn,
GroupMemberAssign, GroupMemberAssign,
@@ -219,6 +220,38 @@ def reset_password(
return MqttPasswordReset(username=username, password=password) return MqttPasswordReset(username=username, password=password)
@router.put("/clients/{username}/clientid", status_code=status.HTTP_204_NO_CONTENT)
def set_client_id(
username: str,
body: ClientIdUpdate,
request: Request,
db: DbDep,
_user: BrokerAdmin,
):
"""Bind (or clear) the expected client ID (spec section 11).
With a bound client id, connections must present exactly that id —
preventing one device's credentials from being reused by another
program. The broker kicks active connections when the id changes.
"""
_guard_mgmt_identity(username)
clientid = body.clientid.strip() or None
try:
dynsec_client.set_client_id(username, clientid)
except DynsecError as exc:
raise HTTPException(status.HTTP_404_NOT_FOUND, str(exc)) from exc
audit.record(
db,
"CLIENT_ID_BOUND" if clientid else "CLIENT_ID_CLEARED",
request=request,
object_type="mqtt_client",
object_id=username,
old_value=None,
new_value={"clientid": clientid or ""},
)
return None
@router.post("/clients/{username}/roles", status_code=status.HTTP_204_NO_CONTENT) @router.post("/clients/{username}/roles", status_code=status.HTTP_204_NO_CONTENT)
def assign_client_role( def assign_client_role(
username: str, username: str,
+128 -4
View File
@@ -16,17 +16,25 @@ from sqlalchemy import select
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from app import audit from app import audit
from app.crypto import encrypt_secret from app.crypto import decrypt_secret, encrypt_secret
from app.db import get_db from app.db import get_db
from app.deps import require_roles from app.deps import require_roles
from app.models import Certificate, ManagementRole from app.dynsec import DynsecError, dynsec_client
from app.models import Certificate, ManagementRole, MqttClientMetadata
from app.pki import ( from app.pki import (
PkiError, PkiError,
create_ca as pki_create_ca, create_ca as pki_create_ca,
fingerprint as pki_fingerprint, fingerprint as pki_fingerprint,
issue_client_certificate,
issue_server_certificate, issue_server_certificate,
) )
from app.schemas import CaCreate, CertificateOut, ServerCertCreate from app.schemas import (
CaCreate,
CertificateBundle,
CertificateOut,
ClientCertCreate,
ServerCertCreate,
)
router = APIRouter(prefix="/api/v1/pki", tags=["pki"]) router = APIRouter(prefix="/api/v1/pki", tags=["pki"])
@@ -72,6 +80,7 @@ def create_ca(body: CaCreate, request: Request, db: DbDep, _user: PkiAdmin):
private_key_pem=encrypt_secret(issued.private_key_pem), private_key_pem=encrypt_secret(issued.private_key_pem),
expiry_date=issued.not_valid_after, expiry_date=issued.not_valid_after,
is_ca=True, is_ca=True,
cert_type="ca",
key_algorithm=body.key_algorithm, key_algorithm=body.key_algorithm,
serial_number=str(issued.serial_number), serial_number=str(issued.serial_number),
dns_sans=[], dns_sans=[],
@@ -148,6 +157,7 @@ def issue_certificate(
expiry_date=issued.not_valid_after, expiry_date=issued.not_valid_after,
is_ca=False, is_ca=False,
parent_id=ca.id, parent_id=ca.id,
cert_type="server",
key_algorithm="ecdsa-p256", key_algorithm="ecdsa-p256",
serial_number=str(issued.serial_number), serial_number=str(issued.serial_number),
dns_sans=body.dns_sans, dns_sans=body.dns_sans,
@@ -166,12 +176,114 @@ def issue_certificate(
new_value={ new_value={
"common_name": body.common_name, "common_name": body.common_name,
"ca": ca.common_name, "ca": ca.common_name,
"cert_type": "server",
"dns_sans": body.dns_sans, "dns_sans": body.dns_sans,
}, },
) )
return cert return cert
@router.post(
"/certificates/client", response_model=CertificateBundle, status_code=201
)
def issue_client_cert(
body: ClientCertCreate, request: Request, db: DbDep, _user: PkiAdmin
):
"""Issue a client certificate for an MQTT client (spec sections 20, 24).
Validates that the dynsec client exists (the certificate CN becomes
the MQTT identity via use_identity_as_username), issues the cert,
binds it to the client metadata, and returns the one-time bundle —
the private key is NEVER retrievable again afterwards.
"""
try:
dynsec_client.get_client(body.username)
except DynsecError as exc:
raise HTTPException(
status.HTTP_404_NOT_FOUND,
f"MQTT client {body.username!r} does not exist at the broker; "
"create it first — the certificate CN must match the username",
) from exc
ca = _get_certificate(db, body.ca_id)
if not ca.is_ca:
raise HTTPException(
status.HTTP_400_BAD_REQUEST, "the referenced certificate is not a CA"
)
if ca.private_key_pem is None:
raise HTTPException(
status.HTTP_409_CONFLICT,
"the CA private key is not held by the platform (offline CA); "
"it cannot issue certificates",
)
try:
ca_key_pem = decrypt_secret(ca.private_key_pem)
except ValueError as exc:
raise HTTPException(
status.HTTP_500_INTERNAL_SERVER_ERROR,
f"could not decrypt the CA key: {exc}",
) from exc
try:
issued = issue_client_certificate(
ca_certificate_pem=ca.certificate_pem,
ca_private_key_pem=ca_key_pem,
common_name=body.username,
validity_days=body.validity_days,
)
except PkiError as exc:
raise HTTPException(status.HTTP_400_BAD_REQUEST, str(exc)) from exc
cert = Certificate(
common_name=body.username,
certificate_pem=issued.certificate_pem,
private_key_pem=encrypt_secret(issued.private_key_pem),
expiry_date=issued.not_valid_after,
is_ca=False,
parent_id=ca.id,
cert_type="client",
username=body.username,
key_algorithm="ecdsa-p256",
serial_number=str(issued.serial_number),
dns_sans=[],
ip_sans=[],
fingerprint=pki_fingerprint(issued.certificate_pem),
status="issued",
)
db.add(cert)
db.flush()
# Bind the certificate to the client's PostgreSQL metadata (the
# dynsec identity link, spec section 24).
meta = db.get(MqttClientMetadata, body.username)
if meta is None:
meta = MqttClientMetadata(username=body.username, tags=[])
db.add(meta)
meta.certificate_id = cert.id
db.flush()
audit.record(
db,
"CERTIFICATE_ISSUED",
request=request,
object_type="certificate",
object_id=str(cert.id),
new_value={
"common_name": body.username,
"ca": ca.common_name,
"cert_type": "client",
"mqtt_client": body.username,
},
)
return CertificateBundle(
certificate_id=cert.id,
username=body.username,
certificate_pem=issued.certificate_pem,
private_key_pem=issued.private_key_pem,
ca_chain_pem=ca.certificate_pem,
)
@router.get( @router.get(
"/certificates/{cert_id}/download", "/certificates/{cert_id}/download",
response_class=PlainTextResponse, response_class=PlainTextResponse,
@@ -210,7 +322,7 @@ def delete_certificate(
status.HTTP_409_CONFLICT, status.HTTP_409_CONFLICT,
"the CA still has issued certificates; delete them first", "the CA still has issued certificates; delete them first",
) )
from app.models import ListenerConfig from app.models import ListenerConfig, MqttClientMetadata
bound = db.scalar( bound = db.scalar(
select(ListenerConfig.id).where(ListenerConfig.cert_id == cert.id) select(ListenerConfig.id).where(ListenerConfig.cert_id == cert.id)
@@ -220,6 +332,18 @@ def delete_certificate(
status.HTTP_409_CONFLICT, status.HTTP_409_CONFLICT,
"the certificate is bound to a listener; unbind it first", "the certificate is bound to a listener; unbind it first",
) )
if cert.cert_type == "client":
# Auto-unlink the identity binding (FK is SET NULL at the DB
# level too); the MQTT client itself is not affected. Explicit
# flush: no query follows, so autoflush would never push this.
linked = db.scalar(
select(MqttClientMetadata).where(
MqttClientMetadata.certificate_id == cert.id
)
)
if linked is not None:
linked.certificate_id = None
db.flush()
db.delete(cert) db.delete(cert)
audit.record( audit.record(
db, db,
+49
View File
@@ -169,6 +169,18 @@ class MqttClientOut(BaseModel):
last_known_connection: datetime | None last_known_connection: datetime | None
class ClientIdUpdate(BaseModel):
"""PUT /clients/{username}/clientid — bind or clear the expected
client ID (spec section 11: "bind an expected client ID").
An empty string clears the binding: any client id may then connect
with these credentials. A bound ID restricts connections to exactly
that client id (anti-credential-sharing).
"""
clientid: str = Field(default="", max_length=200)
class MqttPasswordReset(BaseModel): class MqttPasswordReset(BaseModel):
"""Response for create/reset — plaintext shown exactly once (spec 11).""" """Response for create/reset — plaintext shown exactly once (spec 11)."""
@@ -203,6 +215,8 @@ class ListenerIn(BaseModel):
tls_min_version: Literal["tlsv1.2", "tlsv1.3"] | None = None tls_min_version: Literal["tlsv1.2", "tlsv1.3"] | None = None
require_certificate: bool = False require_certificate: bool = False
use_identity_as_username: bool = False use_identity_as_username: bool = False
# Bound server certificate (PKI): emitted as certfile/keyfile/cafile.
cert_id: uuid.UUID | None = None
class ListenerOut(ListenerIn): class ListenerOut(ListenerIn):
@@ -269,6 +283,10 @@ class CertificateOut(BaseModel):
common_name: str common_name: str
is_ca: bool is_ca: bool
parent_id: uuid.UUID | None parent_id: uuid.UUID | None
cert_type: str
# MQTT client this certificate authenticates (client certs only;
# the CN equals the username — spec section 24).
username: str | None = None
key_algorithm: str key_algorithm: str
serial_number: str serial_number: str
dns_sans: list[str] dns_sans: list[str]
@@ -279,3 +297,34 @@ class CertificateOut(BaseModel):
created_at: datetime created_at: datetime
model_config = {"from_attributes": True} model_config = {"from_attributes": True}
class ClientCertCreate(BaseModel):
"""Issue a client certificate bound to an MQTT client (spec section 20).
The certificate CN is the MQTT username — with
use_identity_as_username the broker maps CN -> dynsec identity
(spec section 24), so the dynsec client must already exist.
"""
username: str = Field(min_length=1, max_length=100)
ca_id: uuid.UUID
validity_days: int = Field(gt=0, le=36500)
class CertificateBundle(BaseModel):
"""One-time download payload (spec sections 20, 44).
Contains EVERYTHING including the plaintext private key — shown
exactly once, never retrievable afterwards from the inventory.
"""
certificate_id: uuid.UUID
username: str
certificate_pem: str
private_key_pem: str
ca_chain_pem: str
download_hint: str = (
"Store these files securely now — the private key cannot be "
"retrieved again."
)
+196
View File
@@ -0,0 +1,196 @@
"""E2E: client-certificate mTLS publish chain (spec sections 20, 24).
Phase deploy: CA -> MQTT client -> role with publish ACL -> client cert
(CN=username) -> server cert -> mTLS listener -> deploy. State is saved
to /tmp/e2e_state.json; the caller then RESTARTS mosquitto (a new listener
needs a restart, not a reload — spec section 28) and runs phase verify.
Phase verify: connects to mosquitto:8884 with the client certificate,
publishes to an allowed topic (expect OK) and a forbidden topic (expect
deny), then cleans everything up.
Usage: python /tmp/e2e.py [--phase deploy|verify|all]
"""
import http.cookiejar
import json
import os
import ssl
import sys
import tempfile
import time
import urllib.request
BASE = "http://127.0.0.1:8000/api/v1"
STATE = "/tmp/e2e_state.json"
phase = "all"
if "--phase" in sys.argv:
phase = sys.argv[sys.argv.index("--phase") + 1]
cj = http.cookiejar.CookieJar()
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
def call(method, path, body=None):
data = json.dumps(body).encode() if body is not None else None
req = urllib.request.Request(
f"{BASE}{path}",
data=data,
headers={"Content-Type": "application/json"},
method=method,
)
resp = opener.open(req)
return json.load(resp) if resp.status != 204 else None
call("POST", "/auth/login", {
"username": os.environ["ADMIN_INITIAL_USERNAME"],
"password": os.environ["ADMIN_INITIAL_PASSWORD"],
})
state = {}
if phase == "verify":
with open(STATE) as f:
state = json.load(f)
# 1. CA
if phase in ("deploy", "all"):
ca = call("POST", "/pki/ca", {
"common_name": "E2E mTLS CA", "validity_days": 3650,
"key_algorithm": "ecdsa-p256",
})
print("CA:", ca["id"][:8])
# 2. MQTT client + role with a publish ACL (idempotent: clear any
# residue from a previous aborted run first).
for path in (
"/mqtt/clients/e2e-device",
"/mqtt/roles/e2e-publisher",
):
try:
call("DELETE", path)
except urllib.error.HTTPError:
pass
call("POST", "/mqtt/clients", {"username": "e2e-device"})
call("POST", "/mqtt/roles", {
"rolename": "e2e-publisher", "acls": [{
"acltype": "publishClientSend", "topic": "e2e/%u/data/#",
"allow": True, "priority": 1,
}],
})
call("POST", "/mqtt/clients/e2e-device/roles",
{"rolename": "e2e-publisher", "priority": 1})
print("client + role + ACL ready")
# 3. Client certificate (CN = username)
bundle = call("POST", "/pki/certificates/client", {
"username": "e2e-device", "ca_id": ca["id"], "validity_days": 365,
})
print("client cert issued:", bundle["certificate_id"][:8])
# 4. Server certificate for the listener
server_cert = call("POST", "/pki/certificates", {
"ca_id": ca["id"], "common_name": "mosquitto", "validity_days": 365,
"dns_sans": ["mosquitto", "localhost"],
})
print("server cert issued:", server_cert["id"][:8])
# 5. mTLS listener on 8884 + deploy
listener = call("POST", "/broker/listeners", {
"name": "E2E mTLS", "port": 8884, "protocol": "mqtt",
"tls_enabled": True, "tls_min_version": "tlsv1.2",
"require_certificate": True, "use_identity_as_username": True,
"cert_id": server_cert["id"],
})
deploy = call("POST", "/broker/config/deploy", {"comment": "E2E mTLS test"})
print("deployed revision:", deploy.get("revision"),
"broker_healthy:", deploy.get("broker_healthy"))
state = {
"ca": ca["id"],
"bundle": bundle,
"server_cert": server_cert["id"],
"listener": listener["id"],
}
with open(STATE, "w") as f:
json.dump(state, f)
if phase == "deploy":
print("state saved — restart mosquitto, then run --phase verify")
sys.exit(0)
# A NEW listener cannot be added by config reload (spec section 28) —
# the broker must be restarted for it to start listening. The restart is
# performed externally (docker compose restart mosquitto) between the
# deploy phase and the connect phase; this script is invoked with
# --phase deploy|verify to allow that.
import sys
import time
phase = "all"
if len(sys.argv) > 1 and sys.argv[1] == "--phase":
phase = sys.argv[2]
# 6. Connect with the client certificate and publish
if phase in ("verify", "all"):
import paho.mqtt.client as mqtt
from paho.mqtt.enums import CallbackAPIVersion
bundle = state["bundle"]
tmp = tempfile.mkdtemp()
cert_file = os.path.join(tmp, "dev.crt")
key_file = os.path.join(tmp, "dev.key")
ca_file = os.path.join(tmp, "ca.crt")
open(cert_file, "w").write(bundle["certificate_pem"])
open(key_file, "w").write(bundle["private_key_pem"])
open(ca_file, "w").write(bundle["ca_chain_pem"])
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
ctx.load_verify_locations(ca_file)
ctx.load_cert_chain(cert_file, key_file)
ctx.check_hostname = False # CN is "mosquitto"; connect by DNS name
ctx.verify_mode = ssl.CERT_REQUIRED
results = {}
client = mqtt.Client(CallbackAPIVersion.VERSION2, client_id="e2e-test")
def on_connect(cl, u, f, rc, props):
results["connack"] = rc
client.on_connect = on_connect
client.tls_set_context(ctx)
# The backend container shares backend-net with mosquitto; Docker
# DNS resolves the name (127.0.0.1 here is the BACKEND, not broker).
client.connect("mosquitto", 8884, keepalive=30)
client.loop_start()
time.sleep(2)
if results.get("connack") == 0:
print("CONNECT: OK — certificate accepted, CN mapped to identity")
allowed = client.publish("e2e/e2e-device/data/1", b"hello", qos=1)
allowed.wait_for_publish(timeout=5)
print("PUBLISH allowed topic rc:", allowed.rc, "(0 = OK)")
denied = client.publish("forbidden/secret", b"x", qos=1)
denied.wait_for_publish(timeout=5)
print("PUBLISH forbidden topic rc:", denied.rc,
"(non-zero = ACL deny enforced)")
else:
print("CONNECT FAILED rc:", results.get("connack"))
client.loop_stop()
# 7. Cleanup
if phase in ("verify", "all"):
def try_call(method, path, body=None):
try:
call(method, path, body)
except urllib.error.HTTPError:
pass
try_call("DELETE", f"/broker/listeners/{state['listener']}")
try_call("POST", "/broker/config/deploy", {"comment": "E2E cleanup"})
try_call("DELETE", f"/pki/certificates/{state['bundle']['certificate_id']}")
try_call("DELETE", f"/pki/certificates/{state['server_cert']}")
try_call("DELETE", f"/pki/certificates/{state['ca']}")
try_call("DELETE", "/mqtt/clients/e2e-device")
try_call("DELETE", "/mqtt/roles/e2e-publisher")
print("cleanup done")
@@ -0,0 +1,30 @@
"""Release 2: client certificates — cert_type + username columns.
Revision ID: r2_0003
Revises: r2_0002
Create Date: 2026-09-19
"""
from typing import Sequence, Union
import sqlalchemy as sa
from alembic import op
revision: str = "r2_0003"
down_revision: Union[str, None] = "r2_0002"
branch_labels: Union[str, Sequence[str] | None] = None
depends_on: Union[str, Sequence[str] | None] = None
def upgrade() -> None:
op.add_column(
"certificates",
sa.Column("cert_type", sa.String(20), nullable=False, server_default="server"),
)
op.add_column("certificates", sa.Column("username", sa.String(100), nullable=True))
op.create_index("ix_certificates_username", "certificates", ["username"])
def downgrade() -> None:
op.drop_index("ix_certificates_username", table_name="certificates")
op.drop_column("certificates", "username")
op.drop_column("certificates", "cert_type")
+20
View File
@@ -116,7 +116,22 @@ def client(db_session, monkeypatch):
def set_client_password(self, username, password): def set_client_password(self, username, password):
pass pass
def set_client_id(self, username, clientid=None):
# Mirrors the real broker's setClientId: empty string unbinds.
client = self.clients.get(username)
if client is None:
from app.dynsec import DynsecError
raise DynsecError(f"Client not found: {username}")
client["clientid"] = clientid or ""
def get_client(self, username): def get_client(self, username):
# Mirrors the real broker: getClient on a missing client
# returns a dynsec error, which the router maps to 404.
if username not in self.clients:
from app.dynsec import DynsecError
raise DynsecError(f"Client not found: {username}")
return self.clients[username] return self.clients[username]
def create_group(self, groupname, roles=None): def create_group(self, groupname, roles=None):
@@ -204,6 +219,11 @@ def client(db_session, monkeypatch):
monkeypatch.setattr(mqtt_router, "dynsec_client", fake) monkeypatch.setattr(mqtt_router, "dynsec_client", fake)
from app.routers import pki as pki_router
# The PKI client-cert endpoint validates the dynsec client exists.
monkeypatch.setattr(pki_router, "dynsec_client", fake)
with TestClient(main_module.app) as test_client: with TestClient(main_module.app) as test_client:
yield test_client yield test_client
+172
View File
@@ -102,6 +102,34 @@ def test_password_reset_still_works_for_normal_clients(admin_client):
assert len(body["password"]) >= 20 # random password, shown once assert len(body["password"]) >= 20 # random password, shown once
def test_client_id_binding(admin_client):
"""Bind/clear the expected client ID (spec section 11) and refuse
it for the management identity."""
admin_client.post("/api/v1/mqtt/clients", json={"username": "device-1"})
bound = admin_client.put(
"/api/v1/mqtt/clients/device-1/clientid",
json={"clientid": "device-ps042"},
)
assert bound.status_code == 204
client = admin_client.get("/api/v1/mqtt/clients/device-1").json()
assert client["clientid"] == "device-ps042"
# Clearing with an empty string unbinds (any client id may connect).
cleared = admin_client.put(
"/api/v1/mqtt/clients/device-1/clientid", json={"clientid": ""}
)
assert cleared.status_code == 204
client = admin_client.get("/api/v1/mqtt/clients/device-1").json()
assert client["clientid"] in (None, "")
# The management identity is never manageable (existing guard).
refused = admin_client.put(
"/api/v1/mqtt/clients/admin/clientid", json={"clientid": "x"}
)
assert refused.status_code == 400
def test_role_acl_lifecycle(admin_client): def test_role_acl_lifecycle(admin_client):
admin_client.post("/api/v1/mqtt/roles", json={"rolename": "telemetry"}) admin_client.post("/api/v1/mqtt/roles", json={"rolename": "telemetry"})
@@ -380,3 +408,147 @@ def test_server_certificate_is_cryptographically_valid(admin_client):
from app.pki import fingerprint as pki_fingerprint from app.pki import fingerprint as pki_fingerprint
assert inv["fingerprint"] == pki_fingerprint(cert_pem) assert inv["fingerprint"] == pki_fingerprint(cert_pem)
# --- Client certificates (spec sections 20, 24) ---------------------------------
def test_client_certificate_issuance_and_binding(admin_client, db_session):
"""Issue-client-cert requires an existing dynsec client; the bundle
carries cert+key+CA exactly once and binds the identity link."""
from sqlalchemy import select
from app.models import MqttClientMetadata
ca_id = admin_client.post(
"/api/v1/pki/ca",
json={
"common_name": "Client CA",
"validity_days": 3650,
"key_algorithm": "ecdsa-p256",
},
).json()["id"]
# Without the dynsec client it must 404, not issue a useless cert.
missing = admin_client.post(
"/api/v1/pki/certificates/client",
json={"username": "ghost-device", "ca_id": ca_id, "validity_days": 365},
)
assert missing.status_code == 404
admin_client.post("/api/v1/mqtt/clients", json={"username": "ps042"})
response = admin_client.post(
"/api/v1/pki/certificates/client",
json={"username": "ps042", "ca_id": ca_id, "validity_days": 365},
)
assert response.status_code == 201, response.text
bundle = response.json()
assert bundle["username"] == "ps042"
assert "BEGIN CERTIFICATE" in bundle["certificate_pem"]
assert "BEGIN PRIVATE KEY" in bundle["private_key_pem"]
assert "BEGIN CERTIFICATE" in bundle["ca_chain_pem"]
# Identity binding recorded in metadata (spec section 24).
meta = db_session.get(MqttClientMetadata, "ps042")
assert meta is not None
assert str(meta.certificate_id) == bundle["certificate_id"]
# Inventory shows the client cert with cert_type=client. The bundle
# legitimately carries the private key ONCE (spec section 20); the
# INVENTORY must never leak it.
inventory = admin_client.get("/api/v1/pki/certificates")
certs = inventory.json()
entry = next(c for c in certs if c["id"] == bundle["certificate_id"])
assert entry["cert_type"] == "client"
assert entry["common_name"] == "ps042"
# The bound MQTT identity is exposed for differentiation in the UI
# (client certs list the device they authenticate, spec section 24).
assert entry["username"] == "ps042"
assert "PRIVATE KEY" not in inventory.text
# Server certs carry no username.
server_entries = [c for c in certs if c.get("cert_type") == "server"]
assert all(c["username"] is None for c in server_entries)
def test_client_cert_delete_unlinks_metadata(admin_client, db_session):
from app.models import MqttClientMetadata
ca_id = admin_client.post(
"/api/v1/pki/ca",
json={"common_name": "Del CA", "validity_days": 3650, "key_algorithm": "ecdsa-p256"},
).json()["id"]
admin_client.post("/api/v1/mqtt/clients", json={"username": "unlink-me"})
bundle = admin_client.post(
"/api/v1/pki/certificates/client",
json={"username": "unlink-me", "ca_id": ca_id, "validity_days": 365},
).json()
deleted = admin_client.delete(
f"/api/v1/pki/certificates/{bundle['certificate_id']}"
)
assert deleted.status_code == 204
# The metadata row survives, unlinked (FK behaviour, mirrored in API).
db_session.expire_all()
meta = db_session.get(MqttClientMetadata, "unlink-me")
assert meta is not None
assert meta.certificate_id is None
def test_listener_cert_binding_roundtrip(admin_client):
"""Listener cert_id must round-trip through create/update (the gap that
previously made TLS unusable from the API)."""
ca_id = admin_client.post(
"/api/v1/pki/ca",
json={"common_name": "Listener CA", "validity_days": 3650, "key_algorithm": "ecdsa-p256"},
).json()["id"]
cert_id = admin_client.post(
"/api/v1/pki/certificates",
json={"ca_id": ca_id, "common_name": "broker.local", "validity_days": 365},
).json()["id"]
created = admin_client.post(
"/api/v1/broker/listeners",
json={
"name": "TLS listener",
"port": 8883,
"protocol": "mqtt",
"tls_enabled": True,
"tls_min_version": "tlsv1.2",
"require_certificate": True,
"use_identity_as_username": True,
"cert_id": cert_id,
},
)
assert created.status_code == 201, created.text
listener = created.json()
assert listener["cert_id"] == cert_id
assert listener["require_certificate"] is True
# The generated config now emits the real certfile/keyfile/cafile.
preview = admin_client.get("/api/v1/broker/config/preview").json()
assert f"certfile /mosquitto/certs/{cert_id}.crt" in preview["config_text"]
assert f"keyfile /mosquitto/certs/{cert_id}.key" in preview["config_text"]
assert f"cafile /mosquitto/certs/{ca_id}.crt" in preview["config_text"]
assert "require_certificate true" in preview["config_text"]
assert "use_identity_as_username true" in preview["config_text"]
# Update keeps the binding (full-object PUT).
updated = admin_client.put(
f"/api/v1/broker/listeners/{listener['id']}",
json={
"name": "TLS listener",
"port": 8883,
"protocol": "mqtt",
"tls_enabled": True,
"tls_min_version": "tlsv1.2",
"require_certificate": True,
"use_identity_as_username": True,
"cert_id": cert_id,
},
)
assert updated.status_code == 200
assert updated.json()["cert_id"] == cert_id
admin_client.delete(f"/api/v1/broker/listeners/{listener['id']}")
admin_client.delete(f"/api/v1/pki/certificates/{cert_id}")
admin_client.delete(f"/api/v1/pki/certificates/{ca_id}")
+20
View File
@@ -64,6 +64,26 @@ def test_disabled_listeners_are_omitted(session):
assert "listener 1884" not in result.config_text assert "listener 1884" not in result.config_text
def test_unpublished_port_listener_warns(session):
"""Listeners on ports not published by compose warn: they are only
reachable inside the Docker network (spec section 5)."""
session.add(ListenerConfig(name="internal-only", port=8884, protocol="mqtt"))
session.commit()
result = generate_config(session)
assert any(
"not published to the host" in w and "8884" in w for w in result.warnings
)
def test_published_port_listener_does_not_warn(session):
session.add(ListenerConfig(name="prod", port=8883, protocol="mqtt"))
session.commit()
result = generate_config(session)
assert not any("not published to the host" in w for w in result.warnings)
def test_tls_listener_without_pki_warns(session): def test_tls_listener_without_pki_warns(session):
session.add( session.add(
ListenerConfig( ListenerConfig(
+3
View File
@@ -18,6 +18,9 @@ x-backend-env: &backend-env
DEFAULT_TLS_MIN_VERSION: ${DEFAULT_TLS_MIN_VERSION:-tlsv1.2} DEFAULT_TLS_MIN_VERSION: ${DEFAULT_TLS_MIN_VERSION:-tlsv1.2}
DEFAULT_CERT_VALIDITY_DAYS: ${DEFAULT_CERT_VALIDITY_DAYS:-365} DEFAULT_CERT_VALIDITY_DAYS: ${DEFAULT_CERT_VALIDITY_DAYS:-365}
DEFAULT_CA_VALIDITY_DAYS: ${DEFAULT_CA_VALIDITY_DAYS:-3650} DEFAULT_CA_VALIDITY_DAYS: ${DEFAULT_CA_VALIDITY_DAYS:-3650}
# Broker container ports published to the host (compose `ports:`);
# keep in sync when editing the mosquitto port mappings.
PUBLISHED_PORTS: ${PUBLISHED_PORTS:-1883,8883}
services: services:
mqtt-db: mqtt-db:
+1 -1
View File
@@ -39,7 +39,7 @@ const NAV_SECTIONS: {
items: [ items: [
{ label: "Authorities", to: "/certificates" }, { label: "Authorities", to: "/certificates" },
{ label: "Server Certificates", to: "/certificates" }, { label: "Server Certificates", to: "/certificates" },
{ label: "Client Certificates", hint: "Client certs + one-time download (Release 2, later)" }, { label: "Client Certificates", to: "/certificates#client-certificates" },
{ label: "CSRs", hint: "CSR signing (Release 2, later)" }, { label: "CSRs", hint: "CSR signing (Release 2, later)" },
{ label: "Revocations", hint: "CRL management (Release 2, later)" }, { label: "Revocations", hint: "CRL management (Release 2, later)" },
], ],
+23
View File
@@ -93,6 +93,11 @@ export const api = {
delete: <T>(path: string) => request<T>(path, { method: "DELETE" }), delete: <T>(path: string) => request<T>(path, { method: "DELETE" }),
}; };
/** Build a text/plain download URL for a PEM payload (one-time bundles). */
export function pemDataUrl(pem: string): string {
return `data:application/x-pem-file;charset=utf-8,${encodeURIComponent(pem)}`;
}
// --- Assignment operations (spec sections 11-12) --------------------------- // --- Assignment operations (spec sections 11-12) ---------------------------
export const assignClientRole = (username: string, rolename: string, priority = -1) => export const assignClientRole = (username: string, rolename: string, priority = -1) =>
@@ -167,6 +172,8 @@ export interface Certificate {
common_name: string; common_name: string;
is_ca: boolean; is_ca: boolean;
parent_id: string | null; parent_id: string | null;
cert_type: string;
username: string | null;
key_algorithm: string; key_algorithm: string;
serial_number: string; serial_number: string;
dns_sans: string[]; dns_sans: string[];
@@ -177,6 +184,21 @@ export interface Certificate {
created_at: string; created_at: string;
} }
export interface CertificateBundle {
certificate_id: string;
username: string;
certificate_pem: string;
private_key_pem: string;
ca_chain_pem: string;
download_hint: string;
}
export interface ClientCertCreate {
username: string;
ca_id: string;
validity_days: number;
}
export interface CaCreate { export interface CaCreate {
common_name: string; common_name: string;
validity_days: number; validity_days: number;
@@ -210,6 +232,7 @@ export interface Listener {
tls_min_version: string | null; tls_min_version: string | null;
require_certificate: boolean; require_certificate: boolean;
use_identity_as_username: boolean; use_identity_as_username: boolean;
cert_id: string | null;
} }
export interface Revision { export interface Revision {
+88 -1
View File
@@ -1,6 +1,6 @@
import { FormEvent, useEffect, useState } from "react"; import { FormEvent, useEffect, useState } from "react";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { api, type Listener, type Revision } from "../api"; import { api, type Certificate, type Listener, type Revision } from "../api";
interface ConfigPreview { interface ConfigPreview {
config_text: string; config_text: string;
@@ -25,6 +25,7 @@ const EMPTY_LISTENER: Omit<Listener, "id"> = {
tls_min_version: null, tls_min_version: null,
require_certificate: false, require_certificate: false,
use_identity_as_username: false, use_identity_as_username: false,
cert_id: null,
}; };
// Curated subset of spec section 31; anything else can be added later // Curated subset of spec section 31; anything else can be added later
@@ -276,6 +277,15 @@ function ListenerForm({
const set = (patch: Partial<Listener>) => setDraft((d) => ({ ...d, ...patch })); const set = (patch: Partial<Listener>) => setDraft((d) => ({ ...d, ...patch }));
const valid = draft.name.trim() !== "" && draft.port > 0 && draft.port <= 65535; const valid = draft.name.trim() !== "" && draft.port > 0 && draft.port <= 65535;
// Server certificates for the certfile/keyfile/cafile binding.
const serverCerts = useQuery({
queryKey: ["certificates"],
queryFn: () => api.get<Certificate[]>("/pki/certificates"),
});
const certOptions = (serverCerts.data ?? []).filter(
(c) => !c.is_ca && c.cert_type === "server",
);
const submit = (e: FormEvent) => { const submit = (e: FormEvent) => {
e.preventDefault(); e.preventDefault();
if (valid) { if (valid) {
@@ -346,6 +356,83 @@ function ListenerForm({
/> />
</div> </div>
</div> </div>
<div
style={{
display: "flex",
gap: "0.5rem",
flexWrap: "wrap",
alignItems: "flex-end",
marginTop: "0.5rem",
borderTop: "1px solid #e4e7eb",
paddingTop: "0.5rem",
}}
>
<div>
<label>TLS</label>
<select
value={draft.tls_enabled ? "true" : "false"}
onChange={(e) => set({ tls_enabled: e.target.value === "true" })}
>
<option value="false">disabled</option>
<option value="true">enabled</option>
</select>
</div>
{draft.tls_enabled && (
<>
<div>
<label>Server certificate</label>
<select
value={draft.cert_id ?? ""}
onChange={(e) => set({ cert_id: e.target.value || null })}
>
<option value="">
{certOptions.length === 0 ? "none issued yet…" : "select certificate…"}
</option>
{certOptions.map((c) => (
<option key={c.id} value={c.id}>
{c.common_name} ({new Date(c.expiry_date).toLocaleDateString()})
</option>
))}
</select>
</div>
<div>
<label>Min TLS version</label>
<select
value={draft.tls_min_version ?? ""}
onChange={(e) => set({ tls_min_version: e.target.value || null })}
>
<option value="">broker default</option>
<option value="tlsv1.2">tlsv1.2</option>
<option value="tlsv1.3">tlsv1.3</option>
</select>
</div>
<div>
<label>Client certificates</label>
<select
value={draft.require_certificate ? "true" : "false"}
onChange={(e) => set({ require_certificate: e.target.value === "true" })}
>
<option value="false">not required</option>
<option value="true">required (mTLS)</option>
</select>
</div>
{draft.require_certificate && (
<div>
<label>Cert CN as username</label>
<select
value={draft.use_identity_as_username ? "true" : "false"}
onChange={(e) =>
set({ use_identity_as_username: e.target.value === "true" })
}
>
<option value="false">no</option>
<option value="true">yes — CN must match a client username</option>
</select>
</div>
)}
</>
)}
</div>
<p /> <p />
<button className="primary" disabled={!valid || pending}> <button className="primary" disabled={!valid || pending}>
{pending ? (initial ? "Saving…" : "Adding…") : initial ? "Save changes" : "Add listener"} {pending ? (initial ? "Saving…" : "Adding…") : initial ? "Save changes" : "Add listener"}
+71 -2
View File
@@ -268,6 +268,10 @@ export function CertificatesPage() {
)} )}
<h3 style={{ marginTop: "2rem" }}>Server certificates</h3> <h3 style={{ marginTop: "2rem" }}>Server certificates</h3>
<p style={{ color: "#52606d" }}>
Bound to TLS listeners (certfile/keyfile). Issue one, then select it
in the listener form under Broker configuration.
</p>
<ServerCertForm cas={caList} pending={certificates.isFetching && false} /> <ServerCertForm cas={caList} pending={certificates.isFetching && false} />
<table style={{ marginTop: "1.5rem" }}> <table style={{ marginTop: "1.5rem" }}>
@@ -283,7 +287,7 @@ export function CertificatesPage() {
</thead> </thead>
<tbody> <tbody>
{(certificates.data ?? []) {(certificates.data ?? [])
.filter((c) => !c.is_ca) .filter((c) => c.cert_type === "server")
.map((c) => { .map((c) => {
const signer = caList.find((ca) => ca.id === c.parent_id); const signer = caList.find((ca) => ca.id === c.parent_id);
return ( return (
@@ -316,12 +320,77 @@ export function CertificatesPage() {
})} })}
</tbody> </tbody>
</table> </table>
{(certificates.data ?? []).filter((c) => !c.is_ca).length === 0 && ( {(certificates.data ?? []).filter((c) => c.cert_type === "server").length === 0 && (
<p style={{ color: "#52606d" }}> <p style={{ color: "#52606d" }}>
No server certificates yet. Issue one above, then bind it to a TLS No server certificates yet. Issue one above, then bind it to a TLS
listener in Broker configuration. listener in Broker configuration.
</p> </p>
)} )}
<h3 id="client-certificates" style={{ marginTop: "2rem" }}>
Client certificates
</h3>
<p style={{ color: "#52606d" }}>
Authenticate MQTT devices (mTLS): the certificate CN is the MQTT
username, so with use_identity_as_username the broker maps the
certificate to that client. Issue them from the Clients page — the
private key is shown exactly once there.
</p>
<table style={{ marginTop: "1.5rem" }}>
<thead>
<tr>
<th>MQTT client</th>
<th>Signed by</th>
<th>Status</th>
<th>Expires</th>
<th></th>
</tr>
</thead>
<tbody>
{(certificates.data ?? [])
.filter((c) => c.cert_type === "client")
.map((c) => {
const signer = caList.find((ca) => ca.id === c.parent_id);
return (
<tr key={c.id}>
<td className="mono">{c.username ?? c.common_name}</td>
<td>{signer ? signer.common_name : "—"}</td>
<td>{c.status}</td>
<td className={expiryClass(c.expiry_date) ?? undefined}>
{new Date(c.expiry_date).toLocaleDateString()}
</td>
<td>
<a href={`/api/v1/pki/certificates/${c.id}/download`}>
Download PEM
</a>{" "}
<button
className="danger"
onClick={() => {
const target = c.username ?? c.common_name;
if (
confirm(
`Delete the certificate for ${target}? The client ` +
"will no longer be able to authenticate with it.",
)
)
remove.mutate(c.id);
}}
>
Delete
</button>
</td>
</tr>
);
})}
</tbody>
</table>
{(certificates.data ?? []).filter((c) => c.cert_type === "client").length === 0 && (
<p style={{ color: "#52606d" }}>
No client certificates yet. Open Clients and use “Issue certificate”
on a client to provision a device for mTLS.
</p>
)}
</div> </div>
); );
} }
+131 -4
View File
@@ -4,8 +4,11 @@ import {
api, api,
assignClientRole, assignClientRole,
assignGroupMember, assignGroupMember,
pemDataUrl,
removeClientRole, removeClientRole,
removeGroupMember, removeGroupMember,
type Certificate,
type CertificateBundle,
type MqttClient, type MqttClient,
type PasswordReset, type PasswordReset,
type Role, type Role,
@@ -54,6 +57,7 @@ function AssignmentChips({
export function ClientsPage() { export function ClientsPage() {
const queryClient = useQueryClient(); const queryClient = useQueryClient();
const [newUsername, setNewUsername] = useState(""); const [newUsername, setNewUsername] = useState("");
const [newClientId, setNewClientId] = useState("");
const [oncePassword, setOncePassword] = useState<PasswordReset | null>(null); const [oncePassword, setOncePassword] = useState<PasswordReset | null>(null);
const [error, setError] = useState<string | null>(null); const [error, setError] = useState<string | null>(null);
@@ -77,16 +81,37 @@ export function ClientsPage() {
}; };
const create = useMutation({ const create = useMutation({
mutationFn: (username: string) => mutationFn: ({ username, clientid }: { username: string; clientid: string | null }) =>
api.post<PasswordReset>("/mqtt/clients", { username }), api.post<PasswordReset>("/mqtt/clients", {
username,
clientid: clientid || null,
}),
onSuccess: (result) => { onSuccess: (result) => {
setOncePassword(result); setOncePassword(result);
setNewUsername(""); setNewUsername("");
setNewClientId("");
refresh(); refresh();
}, },
onError: (e: Error) => setError(e.message), onError: (e: Error) => setError(e.message),
}); });
const bindClientId = useMutation({
mutationFn: ({ username, clientid }: { username: string; clientid: string }) =>
api.put(`/mqtt/clients/${username}/clientid`, { clientid }),
onSuccess: refresh,
onError: (e: Error) => setError(e.message),
});
const setClientIdFor = (c: MqttClient) => {
const current = c.clientid ?? "";
const answer = prompt(
`Expected client ID for ${c.username} (empty = any client id may connect):`,
current,
);
if (answer === null) return; // cancelled
bindClientId.mutate({ username: c.username, clientid: answer.trim() });
};
const disable = useMutation({ const disable = useMutation({
mutationFn: (username: string) => api.post(`/mqtt/clients/${username}/disable`), mutationFn: (username: string) => api.post(`/mqtt/clients/${username}/disable`),
onSuccess: refresh, onSuccess: refresh,
@@ -110,6 +135,50 @@ export function ClientsPage() {
onError: (e: Error) => setError(e.message), onError: (e: Error) => setError(e.message),
}); });
const [certBundle, setCertBundle] = useState<CertificateBundle | null>(null);
const cas = useQuery({
queryKey: ["cas"],
queryFn: () => api.get<Certificate[]>("/pki/ca"),
});
const issueCert = useMutation({
mutationFn: ({
username,
caId,
days,
}: {
username: string;
caId: string;
days: number;
}) =>
api.post<CertificateBundle>("/pki/certificates/client", {
username,
ca_id: caId,
validity_days: days,
}),
onSuccess: (result) => setCertBundle(result),
onError: (e: Error) => setError(e.message),
});
const issueClientCertificate = (username: string) => {
const caList = cas.data ?? [];
if (caList.length === 0) {
setError(
"No certificate authority exists yet — create one under Certificates first.",
);
return;
}
const daysStr = prompt("Validity in days (e.g. 365):", "365");
if (!daysStr) return;
const days = Number(daysStr);
if (!Number.isFinite(days) || days <= 0) {
setError("Validity must be a positive number of days.");
return;
}
issueCert.mutate({ username, caId: caList[0].id, days });
};
const assignRole = useMutation({ const assignRole = useMutation({
mutationFn: ({ username, rolename }: { username: string; rolename: string }) => mutationFn: ({ username, rolename }: { username: string; rolename: string }) =>
assignClientRole(username, rolename), assignClientRole(username, rolename),
@@ -141,7 +210,8 @@ export function ClientsPage() {
const submit = (e: FormEvent) => { const submit = (e: FormEvent) => {
e.preventDefault(); e.preventDefault();
setError(null); setError(null);
if (newUsername) create.mutate(newUsername); if (newUsername)
create.mutate({ username: newUsername, clientid: newClientId.trim() });
}; };
const roleNames = (roles.data ?? []).map((r) => r.rolename); const roleNames = (roles.data ?? []).map((r) => r.rolename);
@@ -163,6 +233,40 @@ export function ClientsPage() {
<div className="password-once mono">{oncePassword.password}</div> <div className="password-once mono">{oncePassword.password}</div>
</div> </div>
)} )}
{certBundle && (
<div className="banner warn">
<strong>
Certificate bundle for {certBundle.username} — save these files now,
the private key is shown only once:
</strong>
<p style={{ margin: "0.4rem 0 0.2rem", fontSize: "0.85rem" }}>
<a href={pemDataUrl(certBundle.certificate_pem)} download={`${certBundle.username}.crt`}>
Download {certBundle.username}.crt
</a>{" "}
<a href={pemDataUrl(certBundle.private_key_pem)} download={`${certBundle.username}.key`}>
Download {certBundle.username}.key
</a>{" "}
<a href={pemDataUrl(certBundle.ca_chain_pem)} download="ca.crt">
Download ca.crt (issuing CA)
</a>
</p>
<p style={{ margin: "0.4rem 0 0.2rem", fontSize: "0.85rem" }}>
or copy manually — <span className="mono">{certBundle.username}.crt</span>:
</p>
<pre className="config mono">{certBundle.certificate_pem}</pre>
<p style={{ margin: "0.4rem 0 0.2rem", fontSize: "0.85rem" }}>
<span className="mono">{certBundle.username}.key</span>:
</p>
<pre className="config mono">{certBundle.private_key_pem}</pre>
<p style={{ margin: "0.4rem 0 0.2rem", fontSize: "0.85rem" }}>
<span className="mono">ca.crt</span> (issuing CA):
</p>
<pre className="config mono">{certBundle.ca_chain_pem}</pre>
<button onClick={() => setCertBundle(null)}>
I have saved the files — dismiss
</button>
</div>
)}
{error && <div className="banner error">{error}</div>} {error && <div className="banner error">{error}</div>}
{(clients.error || roles.error || groups.error) && ( {(clients.error || roles.error || groups.error) && (
<div className="banner error"> <div className="banner error">
@@ -179,6 +283,15 @@ export function ClientsPage() {
onChange={(e) => setNewUsername(e.target.value)} onChange={(e) => setNewUsername(e.target.value)}
placeholder="e.g. ps042" placeholder="e.g. ps042"
/> />
<label htmlFor="new-client-id">
Expected client ID (optional — binds the credential to one device)
</label>
<input
id="new-client-id"
value={newClientId}
onChange={(e) => setNewClientId(e.target.value)}
placeholder="e.g. device-ps042"
/>
<p /> <p />
<button className="primary" disabled={!newUsername || create.isPending}> <button className="primary" disabled={!newUsername || create.isPending}>
{create.isPending ? "Creating…" : "Create client (random password)"} {create.isPending ? "Creating…" : "Create client (random password)"}
@@ -213,7 +326,15 @@ export function ClientsPage() {
return ( return (
<tr key={c.username}> <tr key={c.username}>
<td className="mono">{c.username}</td> <td className="mono">{c.username}</td>
<td className="mono">{c.clientid ?? "—"}</td> <td className="mono">
{c.clientid ?? "—"}{" "}
<button
onClick={() => setClientIdFor(c)}
title="Bind an expected client ID so this credential can only be used by that device"
>
Set
</button>
</td>
<td>{c.enabled ? "yes" : "no"}</td> <td>{c.enabled ? "yes" : "no"}</td>
<td> <td>
<AssignmentChips <AssignmentChips
@@ -291,6 +412,12 @@ export function ClientsPage() {
> >
Reset password Reset password
</button>{" "} </button>{" "}
<button
onClick={() => issueClientCertificate(c.username)}
title="Issue a client certificate (CN = username) for mTLS"
>
Issue certificate
</button>{" "}
<button <button
className="danger" className="danger"
onClick={() => { onClick={() => {