Give each endpoint its own credential and fix the review findings on the server

Per-PC credentials (replaces the 09-14 client-certificate attempt): - POST /api/endpoints/enroll issues a credential to a PC that matches exactly one computer by hostname and BIOS serial and has none yet. Anything else (unknown or duplicate hostname, serial mismatch, already enrolled) waits as a request an admin approves or rejects. The agent's persisted nonce binds an approved request to the PC that asked. - One auth helper serves every agent route. With X-Endpoint-Credential the asset comes from the credential and a request naming another PC gets 403 ASSET_MISMATCH. The shared key still works for PCs that have not enrolled, is refused (401 SHARED_KEY_REFUSED) for any PC that has, and can be switched off. A revoked credential gets 401 CREDENTIAL_INVALID so the agent re-enrolls. - The core collector accepts the credential for the computers, printers and endpoints collectors through two new plugin hooks exposed on shopdb.api (contract 0.33.0), and refuses the shared key for enrolled PCs. - Admin API: enrollment list, approve, reject, revoke (un-enroll), settings. Migration API: per-PC readiness with blockers, and upgrade waves that package the agent once and queue the existing agent upgrade per PC. - Migration 0023 creates endpointcredentials, endpointenrollrequests and endpointmigrationwaves, drops the certificate columns from assets where test databases have them, and renames app_fingerprint to appfingerprint. 0021 and 0022 keep their ids but no longer alter the core assets table. - Removed: client_cert.py, certificate renewal, the unauthenticated /test/client-cert route, nginx client certificate forwarding and the agent certificate script. The client-cert header could be forged on IIS, the key was readable by users, and the shared key remained a fallback. - GET /settings/server-cert returns the SPKI SHA-256 pin for GE-Enforce. Review fixes: - report_command_result used g without importing it; every result was a 500. - collect_log refuses setup answer files, appsettings, agent directories and key files at enqueue. - Fleet alerts: alerttimeout and alertfleet agree with the migration, the scope is validated and a malformed scope no longer reaches the whole fleet, and the ack race no longer raises NameError. - A refused break-glass override leaves no hold and no audit row. - Agent upgrade checks locks and permissions before repackaging, and writes the package atomically. - Server certificate upload validates the pair before replacing files; generation no longer builds an openssl config from user input; audit rows are actually written. - Health evaluation runs in a savepoint so a caught error cannot lose the check-in. - Required-app policies are found by appid, survive renames, and deleting an app deactivates policies that still name it. The UI and API now say such a policy only takes effect inside a business policy. - Backfill handles duplicate fingerprints and rolls back a failed batch. - Plugin settings routes skip a plugin whose hook raises. - The setup token is no longer printed to the log. - The naming gate checks top-level files again and handles odd file names. - Removed root scratch scripts, one of which carried a token. - Rewrote the fleet alert scheduling and app delta tests on real fixtures.
2026-09-15 12:03:53 -04:00
parent f484be8a33
commit 7480e4fe3a
58 changed files with 4485 additions and 2032 deletions
--- a/plugins/endpoints/models/credential.py
+++ b/plugins/endpoints/models/credential.py
@@ -0,0 +1,148 @@
+"""Per-PC endpoint credentials, enrollment requests and migration waves.
+
+  EndpointCredential
+                 One row per asset. Holds only the sha256 of the secret the
+                 agent was issued, plus a short display prefix. Revoking sets
+                 revokedat; re-issuing after a revoke UPDATES the same row, so
+                 an asset never carries two credentials.
+
+  EndpointEnrollRequest
+                 One row per (hostname, serial number) that asked to enroll. The
+                 agent's enrollment nonce is recorded on first sight and is what
+                 an admin approval is bound to, so a second machine claiming the
+                 same hostname and serial cannot collect the approved credential.
+
+  EndpointMigrationWave
+                 An admin action that pushed the agent upgrade to a set of PCs.
+                 Progress is computed live from credentials and commands; only
+                 the membership is stored.
+"""
+
+from datetime import datetime
+
+from shopdb.api import db
+
+
+def _utciso(value):
+    return value.isoformat() + 'Z' if value else None
+
+
+class EndpointCredential(db.Model):
+    """The credential issued to one endpoint (hash only)."""
+
+    __tablename__ = 'endpointcredentials'
+
+    ENROLLED_AUTO = 'auto'
+    ENROLLED_APPROVED = 'approved'
+
+    credentialid = db.Column(db.Integer, primary_key=True)
+    assetid = db.Column(
+        db.Integer,
+        db.ForeignKey('assets.assetid', ondelete='CASCADE'),
+        nullable=False,
+        unique=True,
+    )
+    credentialhash = db.Column(db.CHAR(64), nullable=False, unique=True)
+    credentialprefix = db.Column(db.String(12), nullable=False)
+    enrolledvia = db.Column(db.String(16), nullable=False)
+    issuedat = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+    lastusedat = db.Column(db.DateTime, nullable=True)
+    revokedat = db.Column(db.DateTime, nullable=True)
+    revokedby = db.Column(db.String(64), nullable=True)
+
+    @property
+    def isactive(self):
+        return self.revokedat is None
+
+    def to_dict(self):
+        return {
+            'credentialid': self.credentialid,
+            'assetid': self.assetid,
+            'credentialprefix': self.credentialprefix,
+            'enrolledvia': self.enrolledvia,
+            'issuedat': _utciso(self.issuedat),
+            'lastusedat': _utciso(self.lastusedat),
+            'revokedat': _utciso(self.revokedat),
+            'revokedby': self.revokedby,
+        }
+
+    def __repr__(self):
+        return f'<EndpointCredential asset={self.assetid} {self.credentialprefix}>'
+
+
+class EndpointEnrollRequest(db.Model):
+    """A PC asking for a credential."""
+
+    __tablename__ = 'endpointenrollrequests'
+
+    STATUS_PENDING = 'pending'
+    STATUS_APPROVED = 'approved'
+    STATUS_REJECTED = 'rejected'
+    STATUS_ISSUED = 'issued'
+
+    requestid = db.Column(db.Integer, primary_key=True)
+    hostname = db.Column(db.String(255), nullable=False)
+    serialnumber = db.Column(db.String(128), nullable=False)
+    deviceid = db.Column(db.String(64), nullable=True)
+    enrollnonce = db.Column(db.String(128), nullable=False)
+    agentversion = db.Column(db.String(32), nullable=True)
+    status = db.Column(db.String(16), nullable=False, default=STATUS_PENDING)
+    reason = db.Column(db.String(64), nullable=True)
+    matchedassetid = db.Column(
+        db.Integer,
+        db.ForeignKey('assets.assetid', ondelete='SET NULL'),
+        nullable=True,
+    )
+    sourceip = db.Column(db.String(45), nullable=True)
+    requestedat = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+    lastseenat = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+    decidedat = db.Column(db.DateTime, nullable=True)
+    decidedby = db.Column(db.String(64), nullable=True)
+
+    # Prefix lengths keep the key under 767 bytes on utf8mb4 (4 bytes a char).
+    __table_args__ = (
+        db.Index('idx_endpointenrollrequests_hostserial', 'hostname',
+                 'serialnumber',
+                 mysql_length={'hostname': 128, 'serialnumber': 63}),
+    )
+
+    def to_dict(self):
+        return {
+            'requestid': self.requestid,
+            'hostname': self.hostname,
+            'serialnumber': self.serialnumber,
+            'deviceid': self.deviceid,
+            'agentversion': self.agentversion,
+            'reason': self.reason,
+            'status': self.status,
+            'matchedassetid': self.matchedassetid,
+            'requestedat': _utciso(self.requestedat),
+            'lastseenat': _utciso(self.lastseenat),
+            'decidedat': _utciso(self.decidedat),
+            'decidedby': self.decidedby,
+            'sourceip': self.sourceip,
+        }
+
+    def __repr__(self):
+        return f'<EndpointEnrollRequest {self.hostname!r} {self.status}>'
+
+
+class EndpointMigrationWave(db.Model):
+    """One batch of agent upgrades pushed to move PCs onto credentials."""
+
+    __tablename__ = 'endpointmigrationwaves'
+
+    waveid = db.Column(db.Integer, primary_key=True)
+    createdat = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
+    createdby = db.Column(db.String(64), nullable=True)
+    # Comma list of asset ids. TEXT, not JSON: MySQL 5.6.
+    assetids = db.Column(db.Text, nullable=False, default='')
+    notes = db.Column(db.String(255), nullable=True)
+
+    @property
+    def assetidlist(self):
+        return [int(part) for part in (self.assetids or '').split(',')
+                if part.strip().isdigit()]
+
+    def __repr__(self):
+        return f'<EndpointMigrationWave {self.waveid}>'