Compare commits

...
2 Commits
Author SHA1 Message Date
Madzone a6a3e72659 TEST 2026-09-08 17:05:36 +02:00
Madzone d4ea6e5417 feat(stagging): version unattended preparation as 0.1.0 2026-09-08 12:30:46 +02:00
28 changed files with 1364 additions and 0 deletions
+11
View File
@@ -0,0 +1,11 @@
group_vars/all.yml
group_vars/vault.yml
files/*.crt
*.retry
.venv/
# Lokale macOS-Dateien und Vault-Passwortdateien
.DS_Store
.vault-pass*
.vault_pass*
vault-password*
+14
View File
@@ -0,0 +1,14 @@
# Änderungsprotokoll
## [1.0.0] – 2026-09-08
Erste Version des Ansible-Setups für PVE 9 und Keycloak OIDC.
- Inventory für ts01 und die Keycloak-VM sowie konfigurierbare Realm- und Client-Werte.
- HEIMLAN_RootCA im Betriebssystem-, Java- und Keycloak-Truststore.
- OIDC-Realm, Rollengruppen, Gruppenmapper und variable Session-Zeiten.
- Idempotentes ACL-Mapping ausschließlich für existierende PVE-Gruppen.
- Secrets über Vault/Variablen; lokale Konfiguration und Zertifikate von Git ausgeschlossen.
- README und Dokumentation der lokalen Syntax- und ACL-Prüfungen.
Ein Integrationstest auf den Zielhosts steht aus.
+145
View File
@@ -0,0 +1,145 @@
# PVE 9 + Keycloak OIDC für HEIMLAN
Version: **1.0.0** · [Änderungsprotokoll](CHANGELOG.md) · [Versionsdatei](VERSION)
Dieses Ansible-Setup konfiguriert den bestehenden PVE-Host **ts01** und eine bestehende **Keycloak-VM**. Es installiert die private Root-CA auf beiden Betriebssystemen sowie im Java- und Keycloak-Truststore, richtet Realm, Client, Gruppen, Mapper und Sessions ein und ergänzt PVE-ACLs ausschließlich für bereits vorhandene Gruppen. Alle Module gehören zu `ansible.builtin`.
## Voraussetzungen und Umfang
- Ansible-Core 2.18/2.19 auf einem Controller mit passender Python-Version (für 2.19 Python ≥3.11); Python 3 auf beiden Zielhosts, SSH und root/sudo-Zugriff.
- PVE 9 ist installiert. Die Keycloak-VM läuft auf Debian/Ubuntu, mit einer bestehenden modernen Keycloak-Distribution (26.x, Quarkus), JVM und einem systemd-Dienst `keycloak`. Datenbank, VM-Erstellung, Keycloak-Binärinstallation und initialer Admin-Bootstrap sind Voraussetzung.
- Keycloak bietet **direkt HTTPS auf Port 8443**, ohne Reverse Proxy. Serverzertifikat mit SAN `keycloak.service.heim.lan`, privater Serverschlüssel und vollständige Intermediate-Kette müssen bereits konfiguriert sein. Der Import einer Root-CA stellt kein Serverzertifikat aus.
- DNS, Zeitabgleich und Erreichbarkeit müssen auf PVE, Keycloak und im Browser stimmen. Auch der Browser muss HEIMLAN_RootCA vertrauen.
- Bestehender Keycloak-Admin im `master`-Realm, der Realms anlegen und Zielrealm, Clients und Gruppen verwalten darf. Die Anmeldung erfolgt über `admin-cli` mit Password Grant. Für einen Admin mit vorgeschriebenem interaktivem MFA ist dieses Verfahren ungeeignet; dafür einen passenden Automationszugang bereitstellen.
- JVM-Pfad und Truststore müssen zur **tatsächlich gestarteten JVM** passen. Ein Container oder ein über `javax.net.ssl.trustStore` abweichend konfigurierter Dienst braucht entsprechend angepasste Pfade; das Beispiel steuert eine native systemd-Installation.
## Dateien
```text
ansible.cfg
inventory/hosts.yml
group_vars/all.yml.example
files/README.md
playbook/site.yml # vollständige Konfiguration
playbook/acl.yml # spätere ACL-Zuordnung nach Login
tasks/{preflight,ca,java,keycloak,keycloak_group,keycloak_mapper,pve,acl}.yml
```
## Einrichtung und Start
Alle Befehle im entpackten Verzeichnis ausführen:
```bash
python3 -m venv .venv
. .venv/bin/activate
pip install 'ansible-core>=2.18,<2.20'
cp group_vars/all.yml.example group_vars/all.yml
ansible-vault create group_vars/vault.yml
```
Im Vault-Editor die folgenden Variablen mit echten Werten anlegen. Die leeren Werte hier sind ausschließlich eine Vorlage; das Playbook lehnt sie ab:
```yaml
vault_keycloak_admin_username: ""
vault_keycloak_admin_password: ""
vault_keycloak_client_secret: ""
vault_java_cacerts_password: ""
```
Für das Client-Secret einen zufälligen Wert mit mindestens 16, maximal 256 Zeichen ohne führende/abschließende Leerzeichen oder Zeilenumbrüche verwenden. Das Java-Passwort muss das bestehende Truststore-Passwort sein; es wird nicht geändert. Keine Zugangsdaten im Inventory oder in der Kommandozeile eintragen.
1. `inventory/hosts.yml` anpassen: `ts01`, Keycloak-Adresse, SSH-Benutzer.
2. Öffentliche PEM-Root-CA als `files/HEIMLAN_RootCA.crt` ablegen, genau ein Zertifikat und **kein privater CA-Schlüssel**. Optional `heimlan_ca_sha256` auf einen unabhängig geprüften SHA-256-Fingerprint setzen, nur den Hexwert mit Doppelpunkten.
3. `group_vars/all.yml` prüfen: URL, Java-/Keycloak-Pfade, Servicebenutzer und tatsächliche Browser-URLs unter `pve_redirect_uris`. Beispiel: `https://ts01.heim.lan:8006/`. Für `https://ts01:8006/` einen eigenen Eintrag ergänzen. Keine Wildcards.
4. Bei abweichendem Issuer `keycloak_base_url`, `keycloak_realm` und ggf. `pve_oidc_issuer` konsistent ändern. Die Discovery-Antwort muss den Issuer exakt bestätigen. `pve_realm` bestimmt PVE-Benutzersuffix und PVE-Gruppensuffix.
5. SSH-Hostschlüssel vorab prüfen und in `known_hosts` aufnehmen.
```bash
ansible-playbook playbook/site.yml --syntax-check --ask-vault-pass
ansible-playbook playbook/site.yml --ask-vault-pass
```
Bei sudo-Passwort zusätzlich `--ask-become-pass`. Den vollständigen Lauf nicht mit `--limit pve` oder `--limit keycloak` zerlegen: CA-Fakten und Java-Prüfungen bauen aufeinander auf. `--check` wird für `site.yml` bewusst abgelehnt, da noch nicht angelegte API-Ressourcen und Truststores keinen verlässlichen Gesamtdryrun erlauben.
## Konfigurierte Werte
| Objekt | Einstellung |
|---|---|
| Keycloak-Realm | `main.heim.lan` |
| Client | `PVE-SERVER`, confidential, Authorization Code Flow |
| Issuer | `https://keycloak.service.heim.lan:8443/realms/main.heim.lan` |
| PVE-Realm | `main.heim.lan`, Typ `openid` |
| PVE-Optionen | `autocreate=1`, `groups-claim=groups`, `groups-autocreate=1`, `groups-overwrite=1`, `query-userinfo=1`, `username-claim=preferred_username` |
| Gruppenmapper | Name/Claim `groups`, Group Membership, Full group path **off**, ID/access/userinfo **on** |
| Username-Mapper | `pve-preferred-username`: Benutzerattribut `username` → `preferred_username`, ID/access/userinfo on |
| SSO Idle / Max | 900 / 28800 Sekunden (15 Minuten / 8 Stunden) |
| Client Idle / Max | 900 / 28800 Sekunden, Realm-Defaults und explizite Client-Overrides |
Keycloak erhält diese **Top-Level-Gruppen**, keine Keycloak-Rollen:
`Administrator`, `PVEAdmin`, `PVEAuditor`, `PVEDatastoreAdmin`, `PVEDatastoreUser`, `PVEMappingAdmin`, `PVEMappingUser`, `PVEPoolAdmin`, `PVEPoolUser`, `PVESDNAdmin`, `PVESDNUser`, `PVESysAdmin`, `PVETemplateUser`, `PVEUserAdmin`, `PVEVMAdmin`, `PVEVMUser`.
`NoAccess` wird nicht angelegt oder gemappt. Bestehende sonstige Gruppen und ACLs bleiben erhalten. Der Mapper liefert sämtliche Mitgliedschaften; für Rollen diese flachen Top-Level-Gruppen verwenden, damit gleichnamige Untergruppen bei ausgeschaltetem vollständigem Pfad nicht verwechselt werden.
## Erster Login und Rechte
1. In Keycloak einen vorhandenen Benutzer der gewünschten Gruppe zuweisen, beispielsweise `PVEAuditor` oder `PVEAdmin`. Benutzeranlage und Mitgliedschaften werden nicht automatisch verändert.
2. Im PVE-Login den Realm `main.heim.lan` auswählen und über Keycloak anmelden.
3. PVE erzeugt beim Login den Benutzer `BENUTZERNAME@main.heim.lan` und z. B. `PVEAuditor-main.heim.lan`. Bis zum ACL-Lauf kann der Benutzer noch ohne Rechte sein.
4. Anschließend ausführen:
```bash
ansible-playbook playbook/acl.yml
```
Dieser Lauf benötigt kein Vault und keinen Keycloak-API-Zugriff. Er vergibt für jede **bereits existierende** Gruppe `<ROLE>-main.heim.lan` die gleichnamige PVE-Rolle auf `/` mit `propagate=1`. Fehlende Gruppen werden gemeldet und übersprungen. Nach dem ersten Login weiterer Gruppen erneut ausführen. Eine bereits passende ACL erzeugt keine Änderung. Wie angefordert wirken die Rechte global auf `/` und werden vererbt.
## Bestehende Realms und Username-Migration
PVE kennzeichnet `username-claim` als **bei der Anlage festzulegen**. Das Playbook setzt den Wert bei der Neuanlage und übergibt ihn nicht bei `realm modify`. Ein vorhandener Realm mit fehlendem oder abweichendem Wert führt vor der PVE-Änderung zu einer verständlichen Fehlermeldung. Ein blindes `realm modify --username-claim ...` ist kein zuverlässiger Migrationsweg.
Für einen bereits mit UUID/`subject` eingerichteten Realm zuerst Benutzer, ACLs und lokale Notfallanmeldung sichern. Dann eine geplante Realm-Neuanlage oder einen neuen PVE-Realmnamen verwenden. Ein neuer Realmname ändert Benutzer- und Gruppensuffixe; alte UUID-Benutzer werden nicht automatisch mit neuen Benutzern zusammengeführt. Dieses Paket löscht dafür keine bestehenden Realms oder Benutzer. Keycloak kann in einem solchen abgebrochenen Gesamtlauf bereits aktualisiert sein; nach der Migration lässt sich der Lauf wiederholen.
## Idempotenz, TLS und Secrets
GET-Abfragen vergleichen die verwalteten Realm-/Client-/Mapper-Felder vor POST/PUT. Clientattribute außerhalb der verwalteten Sessionwerte werden erhalten. Die konfigurierte Redirect-Liste ist maßgeblich. Client-Secret wird über den dedizierten Keycloak-Endpunkt gelesen und mit dem Vault-Wert verglichen; PVE liest die lokale Realm-Konfiguration mit `pvesh`. Java-Alias wird anhand des Zertifikatfingerprints verglichen und bei CA-Wechsel ersetzt. OS-Trust-Aktualisierung läuft zur Reparierbarkeit jedes Mal, meldet bei unverändertem Store aber keine Änderung.
Jeder API-Aufruf verwendet CA- und Hostnamenprüfung. Die API-Tasks laufen **auf der Keycloak-VM**, die Discovery-Prüfung **auf PVE**; der Controller braucht deshalb für diese Aufrufe keinen eigenen CA-Import. Es gibt kein `validate_certs: false`, `curl -k` oder abgeschaltetes Hostname-Checking. Vertrauensänderungen starten den Keycloak-Dienst neu, bevor API-Aufrufe beginnen.
Alle Secrets kommen aus Variablen/Vault und sensitive Tasks nutzen `no_log`. PVE speichert seinen OIDC-Client-Key selbst in seiner Realm-Konfiguration; Vault verschlüsselt die Quelle, nicht den Laufzeitspeicher der Zielprodukte. Beim notwendigen `pveum`-Schreibaufruf ist der Key kurzzeitig ein Prozessargument auf PVE und damit für entsprechend privilegierte lokale Beobachter sichtbar. Keine Ansible-Debug-Ausgaben oder Prozessmitschnitte für diese Tasks aktivieren. Das Java-Passwort wird über eine Umgebungsvariable statt als Passwortargument übergeben.
Secret-Rotation: `ansible-vault edit group_vars/vault.yml`, denselben neuen Client-Key für den Gesamtlauf verwenden und `site.yml` erneut ausführen. Zwischen Keycloak- und PVE-Aktualisierung kann der Login kurzzeitig scheitern. Bestehende fremde ACLs werden nicht bereinigt; Entfernen einer Rolle aus `pve_roles` entzieht daher keine zuvor vergebenen Rechte.
## Session-Verhalten
Die Realm-SSO-Werte betreffen alle Anwendungen dieses Keycloak-Realms. Client-Overrides können die globale SSO-Grenze nicht verlängern. Kürzere Client-Sessions erzwingen bei weiterhin aktiver SSO-Session nicht zwangsläufig eine neue Passworteingabe.
Keycloak-Sessionablauf ist außerdem keine PVE-Ticket-Laufzeit: PVE-Aktivität muss Keycloak nicht aktiv halten und ein abgelaufener Keycloak-Login beendet nicht automatisch ein bereits ausgestelltes PVE-Ticket. Das Paket implementiert keinen Single-Logout-Patch; lokales PVE-Logout beendet die Keycloak-SSO-Session nicht automatisch.
## Prüfung und Fehlerdiagnose
Nach Konfiguration einen tatsächlichen Browser-Login durchführen. Im Keycloak-Client unter Client scopes → Evaluate für einen Testbenutzer kontrollieren, dass `groups` ein Array wie `["PVEAuditor"]` enthält, ohne führenden `/`, und `preferred_username` vorhanden ist. Vorhandene zusätzliche Mapper für dieselben Claims auf Widersprüche prüfen.
Auf PVE:
```bash
pveum group list --output-format json
pveum acl list --output-format json
pveum user list --output-format json
curl --fail --cacert /etc/ssl/certs/ca-certificates.crt \
https://keycloak.service.heim.lan:8443/realms/main.heim.lan/.well-known/openid-configuration
```
Bei TLS-Fehlern SAN, DNS, Systemzeit, CA-Datei und vom Server ausgelieferte Intermediate-Kette prüfen. Bei `invalid_redirect_uri` den tatsächlich im Browser verwendeten PVE-Origin einschließlich Port und abschließendem `/` eintragen. Bei versteckten API-Fehlern Keycloak-Serverlogs prüfen; `no_log` nicht pauschal abschalten. Bei fehlenden Rechten Gruppenmitgliedschaft, erneuten Login und ACL-Lauf prüfen. `groups-overwrite=1` ersetzt bestehende PVE-Gruppenmitgliedschaften dieses Benutzers beim Login.
Das Paket wird lokal auf YAML-/Ansible-Syntax und ausgewählte Entscheidungslogik geprüft. Ein Integrationstest auf deinem PVE/Keycloak sowie ein echter zweiter Lauf mit `changed=0` können ohne Zugriff auf deine Hosts nicht bestätigt werden.
## Referenzen
- [Proxmox OpenID-Dokumentation](https://github.com/proxmox/pve-docs/blob/master/pveum.adoc)
- [Proxmox OpenID-Plugin, insbesondere immutable username-claim](https://github.com/proxmox/pve-access-control/blob/master/src/PVE/Auth/OpenId.pm)
- [Proxmox ACL-API](https://github.com/proxmox/pve-access-control/blob/master/src/PVE/API2/ACL.pm)
- [Keycloak Admin REST API](https://www.keycloak.org/docs-api/latest/rest-api/index.html)
- [Keycloak Truststore](https://www.keycloak.org/server/keycloak-truststore)
- [Keycloak Session-Verwaltung](https://www.keycloak.org/docs/latest/server_admin/)
- [Keycloak Client-Session-Attributnamen](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/protocol/oidc/OIDCConfigAttributes.java)
+11
View File
@@ -0,0 +1,11 @@
# Lokale Prüfung
Geprüft am 08.09.2026 mit Ansible-Core 2.19.12:
- Alle YAML-Dateien einschließlich Variablenbeispiel erfolgreich geparst.
- `site.yml` und `acl.yml`: Ansible-Syntaxprüfung erfolgreich.
- Vorbedingungen und zentrale PVE-/Keycloak-Variablenauswertung mit lokalen Testwerten erfolgreich; Client-Session-Attribute bleiben Strings, PVE-Flags sind Integer.
- Original-ACL-Tasks mit einem lokalen Ersatz für `pveum` ausgeführt: bestehende Gruppe ohne ACL erhält eine ACL; bestehende ACL mit `propagate=0` wird auf `1` korrigiert; fehlende Gruppe wird übersprungen.
- Zweiter ACL-Lauf gegen denselben Testzustand: `changed=0`, keine Fehler.
Keine Verbindung zu echten PVE-/Keycloak-Hosts wurde aufgebaut. TLS, Java-Keytool, Keycloak REST-Schreiboperationen, vollständige Idempotenz des Gesamtlaufs und Browser-Login müssen auf den Zielsystemen geprüft werden. Die lokale Prüfung ist kein Integrationstest.
+1
View File
@@ -0,0 +1 @@
1.0.0
+7
View File
@@ -0,0 +1,7 @@
[defaults]
inventory = inventory/hosts.yml
retry_files_enabled = False
host_key_checking = True
interpreter_python = auto_silent
[privilege_escalation]
become = True
+2
View File
@@ -0,0 +1,2 @@
Place the public, PEM-encoded HEIMLAN_RootCA certificate here as HEIMLAN_RootCA.crt.
Do not place the CA private key here. The certificate is not included in the archive.
+50
View File
@@ -0,0 +1,50 @@
# Copy to group_vars/all.yml. Paths are absolute on the managed host unless noted.
keycloak_base_url: https://keycloak.service.heim.lan:8443
keycloak_realm: main.heim.lan
pve_realm: main.heim.lan
keycloak_client_id: PVE-SERVER
pve_oidc_issuer: "{{ keycloak_base_url }}/realms/{{ keycloak_realm }}"
pve_redirect_uris:
- https://ts01.heim.lan:8006/
# Add each actual browser URL explicitly, e.g. https://ts01:8006/.
keycloak_admin_realm: master
keycloak_admin_client_id: admin-cli
keycloak_admin_username: "{{ vault_keycloak_admin_username }}"
keycloak_admin_password: "{{ vault_keycloak_admin_password }}"
keycloak_client_secret: "{{ vault_keycloak_client_secret }}"
# Seconds; realm values affect ALL applications in main.heim.lan.
keycloak_sso_idle: 900
keycloak_sso_max: 28800
keycloak_client_idle: 900
keycloak_client_max: 28800
# Public CA certificate on the Ansible controller, PEM, one certificate only.
heimlan_ca_src: "{{ playbook_dir }}/../files/HEIMLAN_RootCA.crt"
# Optional separately verified fingerprint, openssl x509 -fingerprint -sha256 format.
heimlan_ca_sha256: ""
system_ca_bundle: /etc/ssl/certs/ca-certificates.crt
keycloak_home: /opt/keycloak
keycloak_service: keycloak
keycloak_user: keycloak
keycloak_group: keycloak
# Must be the cacerts file of the JVM actually running Keycloak.
java_cacerts_path: /etc/ssl/certs/java/cacerts
java_keytool: /usr/bin/keytool
java_cacerts_password: "{{ vault_java_cacerts_password }}"
java_ca_alias: heimlan-rootca-ansible
pve_roles:
- Administrator
- PVEAdmin
- PVEAuditor
- PVEDatastoreAdmin
- PVEDatastoreUser
- PVEMappingAdmin
- PVEMappingUser
- PVEPoolAdmin
- PVEPoolUser
- PVESDNAdmin
- PVESDNUser
- PVESysAdmin
- PVETemplateUser
- PVEUserAdmin
- PVEVMAdmin
- PVEVMUser
+12
View File
@@ -0,0 +1,12 @@
all:
children:
pve:
hosts:
ts01:
ansible_host: ts01.heim.lan
ansible_user: root
keycloak:
hosts:
keycloak-vm:
ansible_host: keycloak.service.heim.lan
ansible_user: ansible
+9
View File
@@ -0,0 +1,9 @@
- name: Map only existing PVE groups after OIDC login
hosts: pve
become: true
serial: 1
gather_facts: false
vars_files:
- ../group_vars/all.yml
tasks:
- ansible.builtin.import_tasks: ../tasks/acl.yml
+35
View File
@@ -0,0 +1,35 @@
- name: Install private CA on both systems
hosts: pve:keycloak
become: true
vars_files:
- ../group_vars/all.yml
- ../group_vars/vault.yml
tasks:
- ansible.builtin.import_tasks: ../tasks/preflight.yml
- ansible.builtin.import_tasks: ../tasks/ca.yml
- name: Configure Keycloak trust and OIDC
hosts: keycloak
become: true
vars_files:
- ../group_vars/all.yml
- ../group_vars/vault.yml
tasks:
- ansible.builtin.import_tasks: ../tasks/java.yml
- ansible.builtin.import_tasks: ../tasks/keycloak.yml
handlers:
- name: Restart Keycloak
ansible.builtin.systemd_service:
name: "{{ keycloak_service }}"
state: restarted
- name: Configure PVE OpenID and existing group ACLs
hosts: pve
become: true
serial: 1
vars_files:
- ../group_vars/all.yml
- ../group_vars/vault.yml
tasks:
- ansible.builtin.import_tasks: ../tasks/pve.yml
- ansible.builtin.import_tasks: ../tasks/acl.yml
+33
View File
@@ -0,0 +1,33 @@
- name: Read existing PVE groups
ansible.builtin.command: pveum group list --output-format json
register: acl_groups
changed_when: false
check_mode: false
- name: Read existing PVE roles
ansible.builtin.command: pveum role list --output-format json
register: acl_roles
changed_when: false
check_mode: false
- name: Validate configured roles
ansible.builtin.assert:
that:
- "'NoAccess' not in pve_roles"
- pve_roles | difference(acl_roles.stdout | from_json | map(attribute='roleid') | list) | length == 0
- name: Read existing PVE ACLs
ansible.builtin.command: pveum acl list --output-format json
register: acl_current
changed_when: false
check_mode: false
- name: Map each existing group on root with propagation
ansible.builtin.command:
argv: [pveum, acl, modify, /, --groups, "{{ item }}-{{ pve_realm }}", --roles, "{{ item }}", --propagate, '1']
loop: "{{ pve_roles }}"
when:
- (item ~ '-' ~ pve_realm) in (acl_groups.stdout | from_json | map(attribute='groupid') | list)
- acl_current.stdout | from_json | selectattr('path', 'equalto', '/') | selectattr('type', 'equalto', 'group') | selectattr('ugid', 'equalto', item ~ '-' ~ pve_realm) | selectattr('roleid', 'equalto', item) | selectattr('propagate', 'equalto', 1) | list | length == 0
changed_when: true
- name: Show groups awaiting their first OIDC login
ansible.builtin.debug:
msg: "{{ item }}-{{ pve_realm }} does not exist yet; log in a member through OIDC, then run playbook/acl.yml."
loop: "{{ pve_roles }}"
when: (item ~ '-' ~ pve_realm) not in (acl_groups.stdout | from_json | map(attribute='groupid') | list)
+31
View File
@@ -0,0 +1,31 @@
- name: Install OS trust tools
ansible.builtin.apt:
name: [ca-certificates, openssl]
state: present
- name: Copy public root CA
ansible.builtin.copy:
src: "{{ heimlan_ca_src }}"
dest: /usr/local/share/ca-certificates/HEIMLAN_RootCA.crt
owner: root
group: root
mode: '0644'
register: ca_copy
- name: Check CA validity
ansible.builtin.command:
argv: [openssl, x509, -in, /usr/local/share/ca-certificates/HEIMLAN_RootCA.crt, -noout, -checkend, '0']
changed_when: false
- name: Read CA fingerprint
ansible.builtin.command:
argv: [openssl, x509, -in, /usr/local/share/ca-certificates/HEIMLAN_RootCA.crt, -noout, -fingerprint, -sha256]
register: ca_fingerprint
changed_when: false
- name: Verify expected fingerprint when supplied
ansible.builtin.assert:
that: ca_fingerprint.stdout.split('=')[-1] | lower == heimlan_ca_sha256 | lower
when: heimlan_ca_sha256 | length > 0
- name: Update system trust (also repairs an interrupted previous run)
ansible.builtin.command: update-ca-certificates
environment:
LC_ALL: C
register: ca_update
changed_when: "ca_copy.changed or '0 added, 0 removed' not in ca_update.stdout"
+67
View File
@@ -0,0 +1,67 @@
- name: Check actual Java truststore and Keycloak installation
ansible.builtin.stat:
path: "{{ item }}"
loop:
- "{{ java_cacerts_path }}"
- "{{ java_keytool }}"
- "{{ keycloak_home }}/bin/kc.sh"
register: java_paths
- name: Require installed JVM and Keycloak
ansible.builtin.assert:
that: item.stat.exists
fail_msg: 'Adjust Java/Keycloak paths to the existing installation.'
loop: "{{ java_paths.results }}"
loop_control:
label: "{{ item.item }}"
- name: Install CA in Keycloak system trust directory
ansible.builtin.file:
path: "{{ keycloak_home }}/conf/truststores"
state: directory
owner: "{{ keycloak_user }}"
group: "{{ keycloak_group }}"
mode: '0755'
- name: Copy CA for Keycloak truststore discovery
ansible.builtin.copy:
src: "{{ heimlan_ca_src }}"
dest: "{{ keycloak_home }}/conf/truststores/HEIMLAN_RootCA.pem"
owner: "{{ keycloak_user }}"
group: "{{ keycloak_group }}"
mode: '0644'
notify: Restart Keycloak
- name: Inspect existing managed Java CA alias
ansible.builtin.command:
argv: ["{{ java_keytool }}", -exportcert, -rfc, -alias, "{{ java_ca_alias }}", -keystore, "{{ java_cacerts_path }}", '-storepass:env', ANSIBLE_JAVA_STOREPASS]
environment:
ANSIBLE_JAVA_STOREPASS: "{{ java_cacerts_password }}"
LC_ALL: C
register: java_export
changed_when: false
failed_when: java_export.rc != 0 and 'does not exist' not in (java_export.stdout ~ java_export.stderr)
no_log: true
- name: Read existing Java CA fingerprint
ansible.builtin.command:
argv: [openssl, x509, -noout, -fingerprint, -sha256]
stdin: "{{ java_export.stdout }}"
register: java_fingerprint
changed_when: false
when: java_export.rc == 0
- name: Rotate managed Java CA alias if certificate changed
ansible.builtin.command:
argv: ["{{ java_keytool }}", -delete, -alias, "{{ java_ca_alias }}", -keystore, "{{ java_cacerts_path }}", '-storepass:env', ANSIBLE_JAVA_STOREPASS]
environment:
ANSIBLE_JAVA_STOREPASS: "{{ java_cacerts_password }}"
LC_ALL: C
when: java_export.rc == 0 and java_fingerprint.stdout != ca_fingerprint.stdout
no_log: true
notify: Restart Keycloak
- name: Import CA into the JVM used by Keycloak
ansible.builtin.command:
argv: ["{{ java_keytool }}", -importcert, -noprompt, -trustcacerts, -alias, "{{ java_ca_alias }}", -file, /usr/local/share/ca-certificates/HEIMLAN_RootCA.crt, -keystore, "{{ java_cacerts_path }}", '-storepass:env', ANSIBLE_JAVA_STOREPASS]
environment:
ANSIBLE_JAVA_STOREPASS: "{{ java_cacerts_password }}"
LC_ALL: C
when: java_export.rc != 0 or java_fingerprint.stdout | default('') != ca_fingerprint.stdout
no_log: true
notify: Restart Keycloak
- name: Apply trust before API access
ansible.builtin.meta: flush_handlers
+176
View File
@@ -0,0 +1,176 @@
- name: Configure Keycloak through verified HTTPS
no_log: true
module_defaults:
ansible.builtin.uri:
validate_certs: true
ca_path: "{{ system_ca_bundle }}"
use_proxy: false
follow_redirects: none
unredirected_headers: [Authorization]
timeout: 30
block:
- name: Obtain short-lived admin token
ansible.builtin.uri:
url: "{{ keycloak_base_url }}/realms/{{ keycloak_admin_realm }}/protocol/openid-connect/token"
method: POST
body_format: form-urlencoded
body:
grant_type: password
client_id: "{{ keycloak_admin_client_id }}"
username: "{{ keycloak_admin_username }}"
password: "{{ keycloak_admin_password }}"
status_code: 200
register: kc_token
until: kc_token.status | default(0) == 200
retries: 20
delay: 3
changed_when: false
- name: Define admin headers and realm settings
ansible.builtin.set_fact:
kc_headers:
Authorization: "Bearer {{ kc_token.json.access_token }}"
kc_api: "{{ keycloak_base_url }}/admin/realms/{{ keycloak_realm }}"
kc_realm_desired:
realm: "{{ keycloak_realm }}"
enabled: true
ssoSessionIdleTimeout: "{{ keycloak_sso_idle | int }}"
ssoSessionMaxLifespan: "{{ keycloak_sso_max | int }}"
clientSessionIdleTimeout: "{{ keycloak_client_idle | int }}"
clientSessionMaxLifespan: "{{ keycloak_client_max | int }}"
- name: Read realm
ansible.builtin.uri:
url: "{{ kc_api }}"
headers: "{{ kc_headers }}"
status_code: [200, 404]
register: kc_realm_current
- name: Create realm if missing
ansible.builtin.uri:
url: "{{ keycloak_base_url }}/admin/realms"
headers: "{{ kc_headers }}"
method: POST
body_format: json
body: "{{ kc_realm_desired }}"
status_code: 201
when: kc_realm_current.status == 404
changed_when: true
- name: Determine realm drift
ansible.builtin.set_fact:
kc_realm_drift: "{{ (kc_realm_current.json | default({}) | combine(kc_realm_desired)) != (kc_realm_current.json | default({})) }}"
- name: Update only managed realm fields
ansible.builtin.uri:
url: "{{ kc_api }}"
headers: "{{ kc_headers }}"
method: PUT
body_format: json
body: "{{ kc_realm_desired }}"
status_code: 204
when: kc_realm_current.status == 200 and kc_realm_drift
changed_when: true
- name: Ensure each top-level group exists
ansible.builtin.include_tasks: keycloak_group.yml
loop: "{{ pve_roles }}"
loop_control:
loop_var: kc_group_name
- name: Find client by exact ID
ansible.builtin.uri:
url: "{{ kc_api }}/clients?clientId={{ keycloak_client_id | urlencode }}"
headers: "{{ kc_headers }}"
register: kc_clients
- name: Select exact match
ansible.builtin.set_fact:
kc_matches: "{{ kc_clients.json | selectattr('clientId', 'equalto', keycloak_client_id) | list }}"
- name: Require unique client
ansible.builtin.assert:
that: kc_matches | length <= 1
- name: Define client settings
ansible.builtin.set_fact:
kc_client_desired:
clientId: "{{ keycloak_client_id }}"
protocol: openid-connect
enabled: true
publicClient: false
bearerOnly: false
clientAuthenticatorType: client-secret
standardFlowEnabled: true
implicitFlowEnabled: false
directAccessGrantsEnabled: false
serviceAccountsEnabled: false
redirectUris: "{{ pve_redirect_uris }}"
webOrigins: []
kc_session_attributes:
client.session.idle.timeout: "{{ keycloak_client_idle | string }}"
client.session.max.lifespan: "{{ keycloak_client_max | string }}"
- name: Create confidential PVE client
ansible.builtin.uri:
url: "{{ kc_api }}/clients"
headers: "{{ kc_headers }}"
method: POST
body_format: json
body: "{{ kc_client_desired | combine({'secret': keycloak_client_secret, 'attributes': kc_session_attributes, 'defaultClientScopes': ['profile', 'email']}) }}"
status_code: 201
when: kc_matches | length == 0
changed_when: true
- name: Read client after creation
ansible.builtin.uri:
url: "{{ kc_api }}/clients?clientId={{ keycloak_client_id | urlencode }}"
headers: "{{ kc_headers }}"
register: kc_clients
- name: Store client representation
ansible.builtin.set_fact:
kc_client_current: "{{ kc_clients.json | selectattr('clientId', 'equalto', keycloak_client_id) | first }}"
- name: Read actual client secret (not masked representation)
ansible.builtin.uri:
url: "{{ kc_api }}/clients/{{ kc_client_current.id }}/client-secret"
headers: "{{ kc_headers }}"
register: kc_secret
- name: Merge managed attributes preserving other client settings
ansible.builtin.set_fact:
kc_client_update: "{{ kc_client_desired | combine({'attributes': (kc_client_current.attributes | default({}) | combine(kc_session_attributes))}) }}"
- name: Update client only on drift or secret rotation
ansible.builtin.uri:
url: "{{ kc_api }}/clients/{{ kc_client_current.id }}"
headers: "{{ kc_headers }}"
method: PUT
body_format: json
body: "{{ kc_client_update | combine({'secret': keycloak_client_secret}) }}"
status_code: 204
when: (kc_client_current | combine(kc_client_update)) != kc_client_current or kc_secret.json.value != keycloak_client_secret
changed_when: true
- name: Ensure username claim independent of inherited client scopes
ansible.builtin.include_tasks: keycloak_mapper.yml
vars:
kc_mapper_desired:
name: pve-preferred-username
protocol: openid-connect
protocolMapper: oidc-usermodel-property-mapper
consentRequired: false
config:
user.attribute: username
claim.name: preferred_username
jsonType.label: String
id.token.claim: 'true'
access.token.claim: 'true'
userinfo.token.claim: 'true'
- name: Ensure flat group membership mapper
ansible.builtin.include_tasks: keycloak_mapper.yml
vars:
kc_mapper_desired:
name: groups
protocol: openid-connect
protocolMapper: oidc-group-membership-mapper
consentRequired: false
config:
claim.name: groups
full.path: 'false'
id.token.claim: 'true'
access.token.claim: 'true'
userinfo.token.claim: 'true'
always:
- name: Clear authentication facts
ansible.builtin.set_fact:
kc_headers: {}
kc_token: {}
kc_secret: {}
kc_client_current: {}
kc_clients: {}
kc_matches: []
+16
View File
@@ -0,0 +1,16 @@
- name: Find exact top-level Keycloak group
ansible.builtin.uri:
url: "{{ kc_api }}/groups?search={{ kc_group_name | urlencode }}&exact=true&first=0&max=100&briefRepresentation=true"
headers: "{{ kc_headers }}"
register: kc_group_search
- name: Create missing top-level Keycloak group
ansible.builtin.uri:
url: "{{ kc_api }}/groups"
headers: "{{ kc_headers }}"
method: POST
body_format: json
body:
name: "{{ kc_group_name }}"
status_code: 201
when: kc_group_search.json | selectattr('path', 'equalto', '/' ~ kc_group_name) | list | length == 0
changed_when: true
+33
View File
@@ -0,0 +1,33 @@
- name: Read client protocol mappers
ansible.builtin.uri:
url: "{{ kc_api }}/clients/{{ kc_client_current.id }}/protocol-mappers/models"
headers: "{{ kc_headers }}"
register: kc_mappers
- name: Select mapper by name
ansible.builtin.set_fact:
kc_mapper_matches: "{{ kc_mappers.json | selectattr('name', 'equalto', kc_mapper_desired.name) | list }}"
- name: Check mapper uniqueness
ansible.builtin.assert:
that: kc_mapper_matches | length <= 1
- name: Create mapper
ansible.builtin.uri:
url: "{{ kc_api }}/clients/{{ kc_client_current.id }}/protocol-mappers/models"
headers: "{{ kc_headers }}"
method: POST
body_format: json
body: "{{ kc_mapper_desired }}"
status_code: 201
when: kc_mapper_matches | length == 0
changed_when: true
- name: Update existing mapper on drift
ansible.builtin.uri:
url: "{{ kc_api }}/clients/{{ kc_client_current.id }}/protocol-mappers/models/{{ kc_mapper_matches[0].id }}"
headers: "{{ kc_headers }}"
method: PUT
body_format: json
body: "{{ kc_mapper_matches[0] | combine(kc_mapper_desired, recursive=true) }}"
status_code: 204
when:
- kc_mapper_matches | length == 1
- (kc_mapper_matches[0] | combine(kc_mapper_desired, recursive=true)) != kc_mapper_matches[0]
changed_when: true
+37
View File
@@ -0,0 +1,37 @@
- name: Check platform and required configuration
ansible.builtin.assert:
that:
- ansible_facts.os_family == 'Debian'
- not ansible_check_mode
- groups['keycloak'] | length == 1
- keycloak_base_url is match('^https://[^/]+$')
- pve_oidc_issuer == keycloak_base_url ~ '/realms/' ~ keycloak_realm
- pve_realm is match('^[A-Za-z0-9][A-Za-z0-9._-]*$')
- keycloak_realm is match('^[A-Za-z0-9][A-Za-z0-9._-]*$')
- pve_roles | length == pve_roles | unique | length
- "'NoAccess' not in pve_roles"
- keycloak_sso_idle | int > 0
- keycloak_sso_max | int >= keycloak_sso_idle | int
- keycloak_client_idle | int > 0
- keycloak_client_max | int >= keycloak_client_idle | int
- keycloak_client_idle | int <= keycloak_sso_idle | int
- keycloak_client_max | int <= keycloak_sso_max | int
- pve_redirect_uris | length > 0
fail_msg: 'Debian/Ubuntu, one Keycloak host, consistent HTTPS issuer and positive session values required. Check mode is unsupported.'
- name: Validate secret variables without logging their values
ansible.builtin.assert:
that:
- keycloak_admin_username | length > 0
- keycloak_admin_password | length > 0
- keycloak_client_secret | length >= 16
- keycloak_client_secret | length <= 256
- keycloak_client_secret == keycloak_client_secret | trim
- "'\\n' not in keycloak_client_secret"
- java_cacerts_password | length > 0
no_log: true
- name: Require exact HTTPS redirect URIs
ansible.builtin.assert:
that:
- item is match('^https://[^/]+/$')
- "'*' not in item"
loop: "{{ pve_redirect_uris }}"
+70
View File
@@ -0,0 +1,70 @@
- name: Check PVE version
ansible.builtin.command: pveversion
register: pve_version
changed_when: false
- name: Require PVE 9
ansible.builtin.assert:
that: "'pve-manager/9.' in pve_version.stdout"
- name: Verify OIDC discovery using PVE system CA trust
ansible.builtin.uri:
url: "{{ pve_oidc_issuer }}/.well-known/openid-configuration"
validate_certs: true
ca_path: "{{ system_ca_bundle }}"
use_proxy: false
follow_redirects: none
register: oidc_discovery
- name: Require exact issuer match
ansible.builtin.assert:
that: oidc_discovery.json.issuer == pve_oidc_issuer
- name: Read PVE realms
ansible.builtin.command: pveum realm list --output-format json
register: pve_realms
changed_when: false
- name: Select existing realm
ansible.builtin.set_fact:
pve_realm_matches: "{{ pve_realms.stdout | from_json | selectattr('realm', 'equalto', pve_realm) | list }}"
- name: Prevent changing another realm type
ansible.builtin.assert:
that: pve_realm_matches | length == 0 or pve_realm_matches[0].type == 'openid'
- name: Read full existing realm configuration
ansible.builtin.command:
argv: [pvesh, get, "/access/domains/{{ pve_realm }}", --output-format, json]
register: pve_realm_read
when: pve_realm_matches | length > 0
changed_when: false
no_log: true
- name: Define managed PVE realm settings
ansible.builtin.set_fact:
pve_desired:
issuer-url: "{{ pve_oidc_issuer }}"
client-id: "{{ keycloak_client_id }}"
autocreate: 1
groups-claim: groups
groups-autocreate: 1
groups-overwrite: 1
query-userinfo: 1
username-claim: preferred_username
pve_existing: "{{ (pve_realm_read.stdout | default('{}')) | from_json }}"
pve_drift: false
no_log: true
- name: Compare managed PVE fields
ansible.builtin.set_fact:
pve_drift: true
when: pve_existing.get(item.key, '') | string != item.value | string
loop: "{{ pve_desired | dict2items }}"
no_log: true
- name: Require compatible immutable username claim
ansible.builtin.assert:
that: pve_realm_matches | length == 0 or pve_existing.get('username-claim', '') == 'preferred_username'
fail_msg: 'Existing realm has a different immutable username-claim. See README migration guidance; automatic realm deletion is disabled.'
- name: Create or update PVE realm when configuration or key differs
ansible.builtin.command:
argv: "{{ ['pveum', 'realm', ('modify' if pve_realm_matches | length > 0 else 'add'), pve_realm] + ([] if pve_realm_matches | length > 0 else ['--type', 'openid', '--username-claim', 'preferred_username']) + ['--issuer-url', pve_oidc_issuer, '--client-id', keycloak_client_id, '--client-key', keycloak_client_secret, '--autocreate', '1', '--groups-claim', 'groups', '--groups-autocreate', '1', '--groups-overwrite', '1', '--query-userinfo', '1'] }}"
when: pve_realm_matches | length == 0 or pve_drift or pve_existing.get('client-key', '') != keycloak_client_secret
no_log: true
changed_when: true
- name: Clear in-memory key result
ansible.builtin.set_fact:
pve_existing: {}
pve_realm_read: {}
no_log: true
+3
View File
@@ -0,0 +1,3 @@
runs/
*.iso
*.log
+95
View File
@@ -0,0 +1,95 @@
# Unbeaufsichtigte Installation vorbereiten
## Stand
`Prepare-Unattended.ps1` liest das KIS-Workbook und bereitet die Antwortdateien vor:
- Proxmox VE: `answer.toml`
- VMware ESXi: `ks.cfg`
System und Version kommen aus dem Blatt **Server**. Die Windows-Server-Version und die Mediennamen kommen aus **Staging**. Das Programm installiert selbst noch keine Server und richtet noch keinen DHCP-, PXE- oder Webdienst ein.
## 1. Excel ausfüllen
Verwende `outputs/01a07d3f/ConfigWorkbook_KIS.xlsx`.
Im Blatt **Staging** Windows-Version, GETAC-Netzwerkkarte, IP/Präfix, DHCP-Bereich, Medienordner und die passenden ISO-Dateinamen eintragen. Im Blatt **Server** die vorgesehenen Geräte auf `Installieren = JA` setzen und ihre Angaben vervollständigen. Excel speichern, bevor du das Programm startest.
Für diesen ersten Installer-Durchlauf gelten:
- Eine Version und ein Installationsmedium je Plattform. Die Version wird niemals automatisch ersetzt. Für einen anderen Versionssatz einen getrennten Lauf vorbereiten.
- Ziel-IP im gleichen Netz wie das GETAC, außerhalb des DHCP-Bereichs und ungleich der GETAC-IP.
- Gateway und DNS müssen eingetragen sein. Anders als im ursprünglichen isolierten Workbook-Beispiel lässt dieser Generator diese Felder nicht leer. Nur vorhandene Dienste verwenden; DHCP allein macht das GETAC nicht zum Router oder DNS-Server.
- Benutzername `root`. Zusätzliche Benutzer folgen nach der Installation.
- PVE-Datenträger: vorzugsweise `ID_SERIAL=ECHTE_SERIENNUMMER`; alternativ ein bestätigter Installer-Gerätename wie `sda` oder `nvme0n1`. Keine Wildcards, kein `/dev/`-Präfix. ESXi: die bestätigte Kennung mit `naa.`, `eui.`, `t10.` oder `mpx.`.
- Normale PXE-Netzwerkkarte verwenden, nicht die BMC-Schnittstelle. Im ersten Profil ist dies zugleich die spätere Management-Netzwerkkarte.
Die ISO muss tatsächlich zur Version passen. Der Generator prüft beim Erzeugen ihre Existenz und protokolliert SHA-256, identifiziert aber noch nicht die Produktversion im ISO-Inhalt. Ein Dateiname ist kein Versionsnachweis.
## 2. Angaben prüfen
Auf dem GETAC PowerShell im Ordner `Stagging` öffnen:
```powershell
.\Prepare-Unattended.ps1
```
Das Programm zeigt die ausgewählten Systeme, Versionen, MAC-Adressen, Zielplatten und Medien. Es schreibt dabei keine Antwortdateien und fragt keine Passwörter ab. Ein anderer Speicherort der Excel-Datei kann mit `-Workbook 'C:\Pfad\ConfigWorkbook_KIS.xlsx'` angegeben werden.
Benötigt wird Windows PowerShell 5.1 oder PowerShell 7. Excel, ein Excel-Zusatzmodul, Python und ein Vault sind für das Programm nicht erforderlich. Die vorhandene Ausführungsrichtlinie des GETAC wird nicht verändert; falls die Organisation signierte Skripte verlangt, sind die Dateien nach dem dortigen Verfahren zu signieren.
## 3. Antwortdateien erzeugen
```powershell
.\Prepare-Unattended.ps1 -Generate
```
Nach der Zielübersicht mit `VORBEREITEN` bestätigen. Das erzeugt nur Dateien, startet aber noch keinen Installer. Beim späteren Einsatz löschen diese Dateien die ausgewählten Datenträger; ESXi-Kickstart enthält außerdem `vmaccepteula` und damit die Lizenzzustimmung. Vor Veröffentlichung für PXE müssen die konkreten Ziele, Medien und Lizenzbedingungen geprüft sein.
Für PVE wird die Administrator-E-Mail abgefragt. Optional kann sie bereits als zusätzliche Einstellung `Admin-E-Mail` in Spalte A und der Wert in Spalte B des Blatts Staging stehen, außerhalb belegter Zellen. Pro Server wird das neue root-Passwort verdeckt abgefragt. Das gemeinsame Passwortprofil verlangt 12–64 druckbare ASCII-Zeichen mit Groß-/Kleinbuchstaben, Zahl und Sonderzeichen ohne Leerzeichen. Damit wird keine Garantie gegeben, dass jede spätere Zielversion jede Passphrase akzeptiert.
Das Ergebnis liegt in einem neuen Ordner unter `runs`:
```text
run-.../
manifest.json
NICHT-AUTOMATISCH-STARTEN.txt
02-00-00-00-00-11/answer.toml
02-00-00-00-00-12/ks.cfg
```
Nur ausgewählte Server bekommen eine Datei. Die MAC-Adressen bestimmen die Unterordner. Das Manifest enthält die angeforderten Versionen, Datenträger, Medienpfade und Medien-Prüfsummen, keine Passwörter oder Passwort-Hashes.
Die Antwortdateien enthalten gesalzene SHA-512-crypt-Passwort-Hashes, keine Klartext-Passwörter. Der Laufordner wird unter Windows auf den ausführenden Benutzer beschränkt und ist aus Git ausgeschlossen. Hashes bleiben vertraulich. Der Klartext wird während der Hash-Erzeugung kurz im Prozess benötigt; vollständige Löschung aller verwalteten Speicher-Kopien ist nicht zugesichert. Nach Verwendung den betreffenden Laufordner entfernen. Er wird nicht automatisch publiziert oder gelöscht.
## Noch erforderlicher PXE-Schritt
Auf dem GETAC müssen die richtigen Bootdateien und das Installationsmedium passend zur Excel-Version bereitgestellt werden. Das liegt außerhalb des bisherigen Generators:
1. PVE-Medium mit dem passenden `proxmox-auto-install-assistant` vorbereiten; jede erzeugte Antwortdatei mit dessen `validate-answer` prüfen. Dieses Proxmox-Werkzeug ist kein natives Windows-PowerShell-Modul. Der Vorbereitungsweg für Windows beziehungsweise eine separate Linux-Vorbereitung ist noch festzulegen.
2. ESXi-Medium entpacken und dessen Bootkonfiguration samt hostbezogenem `ks=`-Verweis vorbereiten.
3. DHCP/PXE und einen Dateidienst ausschließlich im Installationsnetz einrichten. Die Bootauswahl darf nur freigegebene MAC-Adressen bedienen. Unbekannte Geräte stoppen.
4. Antwortdateien nur für den bestätigten Durchlauf bereitstellen. Die abgeschlossene Installation muss ihre Freigabe verlieren, damit ein erneuter PXE-Start keine Neuinstallation auslöst.
5. Einen echten Testserver pro gewünschter Plattform installieren und Ergebnis, Anmeldung, Netzkonfiguration und Datenträgerzuordnung prüfen.
Ein MAC-Unterordner allein ist keine Zugangskontrolle. Die spätere Auslieferung muss gesondert implementiert und geprüft werden. Es werden keine generischen Bootdateien erzeugt, die eine beliebige ISO automatisch als kompatibel behandeln.
## Vorbereitete Profile und Grenzen
- PVE 8.4 sowie 9.x: TOML mit `root-password-hashed`, statischem IPv4-Netz und Auswahl der NIC über ihre MAC-Eigenschaft. Festes erstes KIS-Profil: ext4, Land/Tastatur `de`, Zeitzone `Europe/Berlin`. Kein ZFS/RAID-Layout in dieser Etappe.
- ESXi 7.x/8.x: Kickstart mit `rootpw --iscrypted`, expliziter Disk-Kennung, statischem IPv4 und Neustart. Keine zusätzliche Shell-/SSH-Aktivierung.
- Andere Versionen werden mit einer Meldung abgewiesen, statt ein ungeprüftes Format zu erzeugen. Diese Bereiche sind Generatorprofile, keine Aussage über Hersteller-Support oder erfolgreich getestete Hardware.
- 45 automatisierte Prüfungen unter PowerShell 7.4.1 auf macOS bestanden: XLSX-Lesen, Auswahl, Netzwerk-/Datenträgervalidierung, veröffentlichte SHA-512-crypt-Testvektoren und ein vollständiger Dateierzeugungslauf mit zwei Testservern. Die Testmedien sind absichtlich keine bootfähigen ISOs. Ein echter PVE-/ESXi-Installertest, Windows-PowerShell-5.1-Test und Windows-ACL-Test stehen aus.
Die lokalen Prüfungen lassen sich mit `./Tests/Unattended.Tests.ps1` wiederholen. Sie starten keine Netzwerkdienste und installieren keine Systeme.
## Technische Quellen
- [Proxmox Automated Installation](https://pve.proxmox.com/wiki/Automated_Installation)
- [Proxmox: offizielles TOML-Beispiel mit NIC-Auswahl](https://github.com/proxmox/pve-installer/blob/master/proxmox-auto-installer/tests/resources/parse_answer/nic_matching.toml)
- [Proxmox: offizielles Beispiel mit Passwort-Hash](https://github.com/proxmox/pve-installer/blob/master/proxmox-auto-installer/tests/resources/parse_answer/hashed_root_password.toml)
- [Broadcom: ESXi und hostbezogene Kickstart-Auslieferung](https://knowledge.broadcom.com/external/article/440457/esxi-scripted-installation-fails-to-dyna.html)
- [VMware: Default Accounts und gesalzene SHA512-Hashes](https://www.vmware.com/docs/default-accounts-in-vmware-vsphere)
- [SHA-crypt: Algorithmus und Testvektoren](https://www.akkadia.org/drepper/SHA-crypt.txt)
Die Quellen beschreiben das Dateiformat und Verfahren. Maßgeblich für den Abnahmetest ist der konkrete Installer aus dem Workbook.
+52
View File
@@ -0,0 +1,52 @@
# Änderungsverlauf
Die Projektversion steht in `VERSION`. Sie bezeichnet das Staging-Programm, nicht die in Excel gewählte PVE-, ESXi- oder Windows-Version. Das Workbook hat zusätzlich eine eigene Schema-Version (aktuell `0.2 KIS`).
Neue Änderungen werden unter `Unveröffentlicht` gesammelt. Bei einem neuen Versionsstand werden Datum und Versionsnummer ergänzt und `VERSION` aktualisiert. Vor `1.0.0` erhöhen neue Funktionen oder inkompatible Änderungen die mittlere Zahl; reine Fehlerkorrekturen erhöhen die letzte Zahl. Ab `1.0.0` gelten die üblichen Regeln für Major-, Minor- und Patch-Versionen.
## Unveröffentlicht
Noch keine weiteren Änderungen.
## 0.1.0 – 2026-09-08
Erster ausdrücklich versionierter Programmstand. Die vorherigen Entwurfsstände sind damit dokumentiert, aber nicht nachträglich als veröffentlichte Git-Versionen oder Tags ausgegeben.
### Hinzugefügt
- PowerShell-Einstieg `Prepare-Unattended.ps1` mit getrennten Abläufen für Prüfung und Dateierzeugung.
- Lesen des KIS-Workbooks ohne installierte Excel-Anwendung oder zusätzliche Excel-Module.
- Zielsystem und gewünschte Version aus Excel; keine automatisch gewählte Ersatzversion.
- Validierung von Pflichtangaben, MAC-Adressen, IPv4-Netzen, DHCP-Bereichen und konkreten Installationsdatenträgern.
- PVE-Antwortdateien (`answer.toml`) und ESXi-Kickstart-Dateien (`ks.cfg`) je ausgewähltem Server.
- Verdeckte Passwortabfrage und gesalzene SHA-512-crypt-Hashes statt Klartext-Passwörtern in Antwortdateien.
- Geschützte Laufordner, MAC-bezogene Dateipfade und Manifest mit Medien-Prüfsummen.
- Anleitung, technische Quellen und 45 automatisierte Prüfungen.
- Versionsdatei und Versionsanzeige über `-ShowVersion`.
### Übernommene Entwurfsentscheidungen
- GETAC-Notebook mit Windows Server als mobile DHCP-/PXE-Station.
- Keine Hersteller-Fernverwaltung: kein iLO, iDRAC, IPMI oder Redfish.
- KIS-Workbook mit zwei Blättern (`Staging`, `Server`, Schema 0.2) und Beispielen. Der ältere ausführliche Workbook-Entwurf bleibt als Referenz erhalten.
- Cluster, VMs, Container und Cisco-Konfigurationen bleiben spätere Ausbaustufen.
### Prüfung
- 45 lokale Prüfungen unter PowerShell 7.4.1 auf macOS bestanden, einschließlich eines vollständigen Dateierzeugungslaufs mit Test-Excel und Testmedien.
- Die Testmedien sind keine bootfähigen ISOs. Es wurde kein Hypervisor installiert.
### Bekannte Grenzen
- DHCP-/PXE-/Webdienst, Medienvorbereitung und die Auslieferung an Zielserver sind noch nicht implementiert.
- Reale PVE-/ESXi-Installationen sowie Windows-PowerShell-5.1- und Windows-ACL-Abnahme stehen aus.
- Vorbereitete Generatorprofile: PVE 8.4/9.x und ESXi 7.x/8.x; kein Nachweis jeder konkreten Zielversion.
- ISO-Inhalte werden noch nicht automatisch der angeforderten Produktversion zugeordnet.
- Erstes statisches Netzwerkprofil benötigt Gateway und DNS. PVE nutzt zunächst ext4, Land/Tastatur `de` und Zeitzone `Europe/Berlin`.
## Umgang mit Git
- Änderungen am Programm, Tests, Dokumentation und Workbook-Schema zusammen nachvollziehbar beschreiben.
- Projektversion und Änderungsverlauf bei neuen Versionsständen gemeinsam aktualisieren.
- Laufordner mit Antwortdateien und Passwort-Hashes sowie Installations-ISOs gehören nicht ins Repository; `Stagging/.gitignore` schließt sie aus.
- Git-Commits dokumentieren Änderungen. Release-Tags nur für bewusst freigegebene Versionsstände setzen; dieser Änderungsverlauf allein erstellt keinen Tag.
+74
View File
@@ -0,0 +1,74 @@
using System;
using System.IO;
using System.Text;
using System.Security.Cryptography;
// SHA-512 crypt ($6$), not a plain SHA-512 digest. Algorithm:
// https://www.akkadia.org/drepper/SHA-crypt.txt
namespace Staging {
public static class Sha512Crypt {
private const string Alphabet = "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
private static byte[] Hash(params byte[][] parts) {
using (var stream = new MemoryStream()) {
foreach (var part in parts) stream.Write(part, 0, part.Length);
var bytes = stream.ToArray();
try { using (var sha = SHA512.Create()) return sha.ComputeHash(bytes); }
finally { Array.Clear(bytes, 0, bytes.Length); }
}
}
private static byte[] Repeat(byte[] bytes, int length) {
var result = new byte[length];
for (int i = 0; i < length; i++) result[i] = bytes[i % bytes.Length];
return result;
}
private static void Encode(StringBuilder result, int a, int b, int c, int count) {
int value = (a << 16) | (b << 8) | c;
while (count-- > 0) { result.Append(Alphabet[value & 63]); value >>= 6; }
}
public static string NewSalt() {
var bytes = new byte[16];
using (var rng = RandomNumberGenerator.Create()) rng.GetBytes(bytes);
var chars = new char[16];
for (int i = 0; i < chars.Length; i++) chars[i] = Alphabet[bytes[i] & 63];
return new string(chars);
}
public static string Compute(string password, string salt, int rounds) {
if (String.IsNullOrEmpty(password) || password.Length > 256) throw new ArgumentException("Password length");
if (String.IsNullOrEmpty(salt) || salt.Length > 16) throw new ArgumentException("Salt length");
foreach (char c in salt) if (Alphabet.IndexOf(c) < 0) throw new ArgumentException("Salt character");
if (rounds < 1000 || rounds > 1000000) throw new ArgumentException("Rounds");
byte[] p = Encoding.UTF8.GetBytes(password), s = Encoding.ASCII.GetBytes(salt);
byte[] repeated = null, dp = null, ds = null, a = null;
try {
var b = Hash(p, s, p);
using (var stream = new MemoryStream()) {
stream.Write(p, 0, p.Length); stream.Write(s, 0, s.Length);
var chunk = Repeat(b, p.Length); stream.Write(chunk, 0, chunk.Length); Array.Clear(chunk, 0, chunk.Length);
for (int n = p.Length; n > 0; n >>= 1) {
var bytes = (n & 1) != 0 ? b : p; stream.Write(bytes, 0, bytes.Length);
}
var input = stream.ToArray(); a = Hash(input); Array.Clear(input, 0, input.Length);
}
Array.Clear(b, 0, b.Length);
repeated = Repeat(p, p.Length * p.Length); var digest = Hash(repeated);
dp = Repeat(digest, p.Length); Array.Clear(repeated, 0, repeated.Length); Array.Clear(digest, 0, digest.Length);
repeated = Repeat(s, s.Length * (16 + a[0])); digest = Hash(repeated);
ds = Repeat(digest, s.Length); Array.Clear(repeated, 0, repeated.Length); Array.Clear(digest, 0, digest.Length);
for (int i = 0; i < rounds; i++) {
byte[] previous = a;
a = Hash((i & 1) != 0 ? dp : previous, i % 3 != 0 ? ds : new byte[0],
i % 7 != 0 ? dp : new byte[0], (i & 1) != 0 ? previous : dp);
Array.Clear(previous, 0, previous.Length);
}
var output = new StringBuilder("$6$rounds=" + rounds + "$" + salt + "$");
for (int i = 0, j = 0; j < 21; j++, i = (i + 22) % 63)
Encode(output, a[i], a[(i + 21) % 63], a[(i + 42) % 63], 4);
Encode(output, 0, 0, a[63], 2);
return output.ToString();
} finally {
foreach (var bytes in new[] { p, s, repeated, dp, ds, a })
if (bytes != null) Array.Clear(bytes, 0, bytes.Length);
}
}
}
}
+205
View File
@@ -0,0 +1,205 @@
Set-StrictMode -Version Latest
$ErrorActionPreference = 'Stop'
function Read-ZipXml($Zip, [string]$Name, [switch]$Optional) {
$entry = $Zip.GetEntry($Name)
if (-not $entry) { if ($Optional) { return $null }; throw "XLSX-Bestandteil fehlt: $Name" }
if ($entry.Length -gt 16MB) { throw "XLSX-Bestandteil zu gross: $Name" }
$stream = $entry.Open()
$settings = New-Object System.Xml.XmlReaderSettings
$settings.DtdProcessing = [System.Xml.DtdProcessing]::Prohibit
$settings.XmlResolver = $null
$reader = [System.Xml.XmlReader]::Create($stream, $settings)
try { $doc = New-Object System.Xml.XmlDocument; $doc.XmlResolver = $null; $doc.Load($reader); return ,$doc }
finally { $reader.Dispose(); $stream.Dispose() }
}
function Read-KisWorkbook([string]$Path) {
Add-Type -AssemblyName System.IO.Compression.FileSystem
$zip = [System.IO.Compression.ZipFile]::OpenRead((Resolve-Path -LiteralPath $Path).Path)
try {
$book = Read-ZipXml $zip 'xl/workbook.xml'
$rels = Read-ZipXml $zip 'xl/_rels/workbook.xml.rels'
$shared = Read-ZipXml $zip 'xl/sharedStrings.xml' -Optional
$strings = @()
if ($shared) { $strings = @($shared.SelectNodes('//*[local-name()="si"]') | ForEach-Object {
($_.SelectNodes('.//*[local-name()="t"]') | ForEach-Object { $_.InnerText }) -join ''
}) }
$sheets = @{}
foreach ($sheet in $book.SelectNodes('//*[local-name()="sheet"]')) {
if ($sheet.GetAttribute('name') -notin @('Staging','Server')) { continue }
$rid = $sheet.GetAttribute('id','http://schemas.openxmlformats.org/officeDocument/2006/relationships')
$rel = @($rels.SelectNodes('//*[local-name()="Relationship"]') | Where-Object { $_.GetAttribute('Id') -eq $rid })
if ($rel.Count -ne 1) { throw 'Ungueltige XLSX-Beziehung' }
$target = $rel[0].GetAttribute('Target')
if ($target -match '(^/xl/|^xl/)') { $target = $target.TrimStart('/') } else { $target = 'xl/' + $target }
$xml = Read-ZipXml $zip $target
$cells = @{}; $formulas = @{}
foreach ($cell in $xml.SelectNodes('//*[local-name()="sheetData"]/*/*[local-name()="c"]')) {
$address = $cell.GetAttribute('r')
$valueNode = $cell.SelectSingleNode('./*[local-name()="v"]')
$value = if ($valueNode) { $valueNode.InnerText } else { '' }
switch ($cell.GetAttribute('t')) {
's' { $value = $strings[[int]$value] }
'inlineStr' { $value = ($cell.SelectNodes('.//*[local-name()="t"]') | ForEach-Object { $_.InnerText }) -join '' }
'e' { $value = '' }
}
$cells[$address] = [string]$value
if ($cell.SelectSingleNode('./*[local-name()="f"]')) { $formulas[$address] = $true }
}
$sheets[$sheet.GetAttribute('name')] = @{ Cells=$cells; Formulas=$formulas }
}
if (-not $sheets.ContainsKey('Staging') -or -not $sheets.ContainsKey('Server')) { throw 'KIS-Workbook mit Staging und Server erforderlich.' }
$settings = @{}
foreach ($key in $sheets.Staging.Cells.Keys) {
if ($key -notmatch '^A(\d+)$') { continue }
$row = $Matches[1]; $name = $sheets.Staging.Cells[$key]
if ($name -notin @('Projektname','Windows-Server-Version','Netzwerkkarte','GETAC-IP','Netzpräfix','DHCP von','DHCP bis','Medienordner','Proxmox-Medium','ESXi-Medium','Admin-E-Mail')) { continue }
if ($sheets.Staging.Formulas.ContainsKey("B$row")) { throw "Staging!B${row}: Eingabeformeln sind nicht erlaubt." }
if ($settings.ContainsKey($name)) { throw "Doppelte Staging-Einstellung: $name" }
$settings[$name] = [string]$sheets.Staging.Cells["B$row"]
}
$expected = @('Installieren','Servername','PXE-MAC-Adresse','System','Version','Installationsdatenträger','Ziel-IP','Präfix','Gateway','DNS-Server','Benutzername','Hinweis')
for ($i=0; $i -lt $expected.Count; $i++) {
$col = [string][char](65+$i)
if ($sheets.Server.Cells["${col}6"] -cne $expected[$i]) { throw "Server!${col}6: Erwartet '$($expected[$i])'. KIS Schema 0.2 erforderlich." }
}
foreach ($key in $sheets.Server.Cells.Keys) {
if ($key -match '^A(\d+)$' -and [int]$Matches[1] -gt 26 -and $sheets.Server.Cells[$key] -eq 'JA') { throw 'Server ausserhalb der 20 vorbereiteten Zeilen. Bereich zuerst erweitern.' }
}
$servers = @()
for ($r=7; $r -le 26; $r++) {
$values = @{}
for ($i=0; $i -lt $expected.Count; $i++) {
$cell = "$([char](65+$i))$r"
if ($sheets.Server.Formulas.ContainsKey($cell)) { throw "Server!${cell}: Eingabeformeln sind nicht erlaubt." }
$values[$expected[$i]] = ([string]$sheets.Server.Cells[$cell]).Trim()
}
if ($values.Installieren -notin @('','JA','NEIN')) { throw "Server Zeile ${r}: Installieren muss JA oder NEIN sein." }
if ($values.Installieren -eq 'JA') { $values.Row = $r; $servers += $values }
}
return @{ Settings=$settings; Servers=$servers }
} finally { $zip.Dispose() }
}
function Get-IPv4Number([string]$Value) {
if ($Value -notmatch '^(0|[1-9][0-9]{0,2})(\.(0|[1-9][0-9]{0,2})){3}$') { throw "Ungueltige IPv4-Adresse: $Value" }
[uint64]$n=0
foreach ($octet in $Value.Split('.')) { if ([int]$octet -gt 255) { throw "Ungueltige IPv4-Adresse: $Value" }; $n=$n*256+[int]$octet }
return $n
}
function Get-Netmask([int]$Prefix) {
$parts = for ($i=0; $i -lt 4; $i++) { $bits=[Math]::Min(8,[Math]::Max(0,$Prefix-8*$i)); [int](256-[Math]::Pow(2,8-$bits)) }
return ($parts -join '.')
}
function Assert-Text([string]$Value,[string]$Pattern,[string]$Label) {
if ([string]::IsNullOrWhiteSpace($Value) -or $Value -notmatch $Pattern) { throw "${Label}: fehlt oder ungueltiges Format." }
}
function Get-InstallPlan($Config, [switch]$CheckMedia) {
$s=$Config.Settings; $hosts=@($Config.Servers)
if ($hosts.Count -eq 0) { return @() }
foreach ($key in @('Windows-Server-Version','Netzwerkkarte','GETAC-IP','Netzpräfix','DHCP von','DHCP bis','Medienordner')) {
if ([string]::IsNullOrWhiteSpace($s[$key])) { throw "Staging: '$key' fehlt." }
}
Assert-Text $s['Netzpräfix'] '^(?:[1-9]|[12][0-9]|30)$' 'Staging Netzpraefix'
$prefix=[int]$s['Netzpräfix']; [uint64]$block=[Math]::Pow(2,32-$prefix)
$getac=Get-IPv4Number $s['GETAC-IP']; $network=[uint64]([Math]::Floor($getac/$block)*$block); $broadcast=$network+$block-1
$from=Get-IPv4Number $s['DHCP von']; $to=Get-IPv4Number $s['DHCP bis']
if ($from -le $network -or $to -ge $broadcast -or $from -gt $to -or ($getac -ge $from -and $getac -le $to) -or $getac -eq $network -or $getac -eq $broadcast) { throw 'Staging: DHCP-Bereich und feste GETAC-IP muessen im selben Netz liegen und sich ausschliessen.' }
$seenMac=@{}; $seenIp=@{}; $seenName=@{}; $versions=@{}; $result=@()
foreach ($h in $hosts) {
$label="Server Zeile $($h.Row)"
Assert-Text $h.Servername '^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$' "$label Servername (FQDN)"
Assert-Text $h['PXE-MAC-Adresse'] '^(?:[0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$' "$label MAC"
$mac=$h['PXE-MAC-Adresse'].ToLowerInvariant()
if (([Convert]::ToInt32($mac.Substring(0,2),16) -band 1) -ne 0 -or $mac -eq '00:00:00:00:00:00') { throw "$label MAC ist keine Unicast-Geraeteadresse." }
if ($seenMac.ContainsKey($mac) -or $seenName.ContainsKey($h.Servername)) { throw "$label Name oder MAC doppelt." }
$seenMac[$mac]=$true; $seenName[$h.Servername]=$true
Assert-Text $h['Präfix'] '^(?:[1-9]|[12][0-9]|30)$' "$label Praefix"
$ip=Get-IPv4Number $h['Ziel-IP']
if ($seenIp.ContainsKey($h['Ziel-IP'])) { throw "$label IP doppelt." }; $seenIp[$h['Ziel-IP']]=$true
if ([int]$h['Präfix'] -ne $prefix -or $ip -le $network -or $ip -ge $broadcast -or $ip -eq $getac -or ($ip -ge $from -and $ip -le $to)) { throw "$label Ziel-IP muss im GETAC-Netz, ausserhalb DHCP und ungleich GETAC-IP liegen (KIS)." }
$gateway=Get-IPv4Number $h.Gateway
if ($gateway -le $network -or $gateway -ge $broadcast -or $gateway -eq $ip -or ($gateway -ge $from -and $gateway -le $to)) { throw "$label Gateway ungueltig." }
if (-not $h['DNS-Server']) { throw "$label DNS-Server fehlt. Fuer statische Installer-Konfiguration erforderlich." }
$dns=@($h['DNS-Server'].Split(';') | ForEach-Object { $_.Trim(); })
foreach ($d in $dns) { $null=Get-IPv4Number $d }
if ($h.Benutzername -cne 'root') { throw "$label Installation setzt das root-Konto; andere Konten spaeter anlegen." }
$platform=$h.System; $version=$h.Version
Assert-Text $version '^[0-9]+\.[0-9]+[a-zA-Z0-9._-]*$' "$label Version"
if ($versions.ContainsKey($platform) -and $versions[$platform] -cne $version) { throw 'KIS: Ein Versionssatz je Plattform und Durchlauf.' }; $versions[$platform]=$version
switch ($platform) {
'Proxmox VE' {
if ($version -notmatch '^(?:8\.[4-9]|9\.[0-9]+)(?:[._-].*)?$') { throw "$label PVE-Version '$version': Generatorprofil derzeit fuer 8.4 und 9.x vorbereitet. Kein stiller Versionsersatz." }
if ($dns.Count -ne 1) { throw "$label PVE-Profil erwartet genau einen DNS-Server." }
Assert-Text $h.Installationsdatenträger '^(?:sd[a-z]+|nvme[0-9]+n[0-9]+|vd[a-z]+|ID_SERIAL=[a-zA-Z0-9_.:+-]+)$' "$label PVE-Disk (Geraetename oder ID_SERIAL=...)"
$mediaName=$s['Proxmox-Medium']; $file='answer.toml'
}
'VMware ESXi' {
if ($version -notmatch '^[78]\.[0-9]+[a-zA-Z0-9._-]*$') { throw "$label ESXi-Version '$version': Generatorprofil derzeit fuer 7.x/8.x vorbereitet." }
Assert-Text $h.Installationsdatenträger '^(?:naa|eui|t10|mpx)\.[a-zA-Z0-9_.:-]+$' "$label ESXi-Disk (naa./eui./t10./mpx.)"
$mediaName=$s['ESXi-Medium']; $file='ks.cfg'
}
default { throw "$label System muss Proxmox VE oder VMware ESXi sein." }
}
Assert-Text $mediaName '^[^\\/:*?"<>|]+\.iso$' "$label Installationsmedium (ISO-Dateiname)"
$media=Join-Path $s.Medienordner $mediaName
if ($CheckMedia -and -not (Test-Path -LiteralPath $media -PathType Leaf)) { throw "Installationsmedium fehlt: $media" }
$result += [pscustomobject]@{ Name=$h.Servername; Mac=$mac; Platform=$platform; Version=$version; Disk=$h.Installationsdatenträger; IP=$h['Ziel-IP']; Prefix=[int]$h['Präfix']; Gateway=$h.Gateway; DNS=$dns; Media=$media; FileName=$file }
}
foreach ($h in $result) { if ($seenIp.ContainsKey($h.Gateway)) { throw 'Gateway darf keine ausgewaehlte Zielserver-IP sein.' } }
return $result
}
function New-RootHash([Security.SecureString]$Password) {
if (-not ('Staging.Sha512Crypt' -as [type])) { Add-Type -Path (Join-Path $PSScriptRoot 'Sha512Crypt.cs') }
$pointer=[Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password)
try {
$plain=[Runtime.InteropServices.Marshal]::PtrToStringBSTR($pointer)
# Conservative shared profile; do not weaken the ESXi password policy.
if ($plain.Length -lt 12 -or $plain.Length -gt 64 -or $plain -notmatch '^[\x21-\x7e]+$' -or $plain -notmatch '[A-Z]' -or $plain -notmatch '[a-z]' -or $plain -notmatch '[0-9]' -or $plain -notmatch '[^a-zA-Z0-9]') { throw 'Passwort: 12-64 druckbare ASCII-Zeichen, Gross-/Kleinbuchstaben, Zahl und Sonderzeichen, keine Leerzeichen.' }
return [Staging.Sha512Crypt]::Compute($plain,[Staging.Sha512Crypt]::NewSalt(),100000)
} finally { $plain=$null; [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($pointer) }
}
function ConvertTo-AnswerText($Server, [string]$Hash, [string]$AdminEmail) {
if ($Hash -notmatch '^\$6\$(?:rounds=[0-9]+\$)?[./a-zA-Z0-9]{1,16}\$[./a-zA-Z0-9]{86}$') { throw 'Ungueltiger SHA-512-crypt-Hash.' }
if ($Server.Platform -eq 'Proxmox VE') {
Assert-Text $AdminEmail '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$' 'PVE Admin-E-Mail'
$disk=if ($Server.Disk.StartsWith('ID_SERIAL=')) { 'filter.ID_SERIAL = "' + $Server.Disk.Substring(10) + '"' } else { 'disk-list = ["' + $Server.Disk + '"]' }
return (@(
'# Generated from KIS workbook. Destructive installation on the specified disk.',
"# Target version: $($Server.Version)", '[global]', 'keyboard = "de"', 'country = "de"',
('fqdn = "' + $Server.Name + '"'), ('mailto = "' + $AdminEmail + '"'), 'timezone = "Europe/Berlin"',
('root-password-hashed = "' + $Hash + '"'), '', '[network]', 'source = "from-answer"',
('cidr = "' + $Server.IP + '/' + $Server.Prefix + '"'), ('gateway = "' + $Server.Gateway + '"'),
('dns = "' + $Server.DNS[0] + '"'), ('filter.ID_NET_NAME_MAC = "*' + $Server.Mac.Replace(':','') + '"'),
'', '[disk-setup]', 'filesystem = "ext4"', $disk, ''
) -join "`n")
}
return (@(
'# Generated from KIS workbook. EULA acceptance and disk erase must be approved before use.',
"# Target version: $($Server.Version)", 'vmaccepteula', ('rootpw --iscrypted ' + $Hash),
('install --disk=' + $Server.Disk + ' --overwritevmfs'),
('network --bootproto=static --device=' + $Server.Mac + ' --ip=' + $Server.IP + ' --netmask=' + (Get-Netmask $Server.Prefix) + ' --gateway=' + $Server.Gateway + ' --nameserver=' + ($Server.DNS -join ',') + ' --hostname=' + $Server.Name),
'reboot', ''
) -join "`n")
}
function New-PrivateRunDirectory([string]$Parent) {
$name='run-' + [DateTime]::UtcNow.ToString('yyyyMMdd-HHmmss') + '-' + [Guid]::NewGuid().ToString('N').Substring(0,8)
$path=Join-Path $Parent $name
$null=New-Item -ItemType Directory -Path $path -Force
if ([Environment]::OSVersion.Platform -eq [PlatformID]::Win32NT) {
$acl=New-Object Security.AccessControl.DirectorySecurity
$acl.SetAccessRuleProtection($true,$false)
$sid=[Security.Principal.WindowsIdentity]::GetCurrent().User
$acl.SetOwner($sid)
$rule=New-Object Security.AccessControl.FileSystemAccessRule($sid,'FullControl','ContainerInherit,ObjectInherit','None','Allow')
$acl.AddAccessRule($rule)
Set-Acl -LiteralPath $path -AclObject $acl
} else { & chmod 700 $path; if ($LASTEXITCODE -ne 0) { throw 'Ausgabeordner konnte nicht geschuetzt werden.' } }
return $path
}
Export-ModuleMember -Function Read-KisWorkbook,Get-InstallPlan,Get-Netmask,New-RootHash,ConvertTo-AnswerText,New-PrivateRunDirectory
+50
View File
@@ -0,0 +1,50 @@
#requires -Version 5.1
[CmdletBinding()]
param(
[string]$Workbook = (Join-Path $PSScriptRoot 'outputs/01a07d3f/ConfigWorkbook_KIS.xlsx'),
[switch]$Generate,
[switch]$ShowVersion,
[string]$OutputDirectory = (Join-Path $PSScriptRoot 'runs')
)
$ErrorActionPreference='Stop'
$projectVersion=(Get-Content -LiteralPath (Join-Path $PSScriptRoot 'VERSION') -Raw).Trim()
if ($ShowVersion) { Write-Output $projectVersion; return }
Write-Host "Staging $projectVersion"
Import-Module (Join-Path $PSScriptRoot 'Modules/Unattended.psm1') -Force -DisableNameChecking
try {
$config=Read-KisWorkbook $Workbook
$plan=@(Get-InstallPlan $config -CheckMedia:$Generate)
if ($plan.Count -eq 0) { Write-Host 'Keine Server ausgewaehlt. In Excel Installieren = JA setzen, wenn der Eintrag vorbereitet ist.'; return }
$plan | Select-Object Name,Platform,Version,Mac,Disk,IP,Media | Format-List | Out-Host
Write-Host 'PVE-Profil: ext4, Tastatur/Land de, Zeitzone Europe/Berlin. Versionen kommen aus Excel.'
Write-Host 'Die angegebene ISO-Version muss inhaltlich zum Medium passen; Dateiname allein ist kein Versionsnachweis.'
if (-not $Generate) { Write-Host 'Pruefung beendet. Mit -Generate werden nach Rueckfrage Antwortdateien erzeugt. Kein PXE-Start.'; return }
$email=[string]$config.Settings['Admin-E-Mail']
if (@($plan | Where-Object Platform -eq 'Proxmox VE').Count -gt 0 -and -not $email) { $email=Read-Host 'PVE Administrator-E-Mail (fuer die Antwortdatei)' }
Write-Host 'Antwortdateien loeschen beim spaeteren Installer-Start die oben genannten Datentraeger.'
Write-Host 'Bei ESXi enthalten sie ausserdem die Zustimmung zur VMware-EULA. Dateien erst nach Medien- und Zielpruefung freigeben.'
if ((Read-Host 'Zum Vorbereiten dieser Dateien VORBEREITEN eingeben') -cne 'VORBEREITEN') { Write-Host 'Abgebrochen.'; return }
# Gather all credentials and render in memory before creating a run directory.
$answers=@{}
foreach ($server in $plan) {
$password=Read-Host "Neues root-Passwort fuer $($server.Name)" -AsSecureString
try { $hash=New-RootHash $password; $answers[$server.Mac]=ConvertTo-AnswerText $server $hash $email }
finally { $password.Dispose(); $hash=$null }
}
$run=New-PrivateRunDirectory $OutputDirectory
$utf8=New-Object Text.UTF8Encoding($false)
$manifest=@()
foreach ($server in $plan) {
$hostDir=Join-Path $run $server.Mac.Replace(':','-')
$null=New-Item -ItemType Directory -Path $hostDir
[IO.File]::WriteAllText((Join-Path $hostDir $server.FileName),$answers[$server.Mac],$utf8)
$manifest += [ordered]@{ Hostname=$server.Name; MAC=$server.Mac; Platform=$server.Platform; RequestedVersion=$server.Version; Disk=$server.Disk; Media=$server.Media; MediaSHA256=(Get-FileHash -LiteralPath $server.Media -Algorithm SHA256).Hash; AnswerFile=($server.Mac.Replace(':','-')+'/'+$server.FileName) }
}
[IO.File]::WriteAllText((Join-Path $run 'manifest.json'),(ConvertTo-Json -InputObject @($manifest) -Depth 5),$utf8)
[IO.File]::WriteAllText((Join-Path $run 'NICHT-AUTOMATISCH-STARTEN.txt'),"Vorbereitete Antwortdateien, kein aktiver Deployment-Lauf.`nPXE/HTTP-Anbindung und Installer-Validierung stehen noch aus.`nManifest pruefen. Hashes sind vertraulich. Laufordner nach Nutzung entfernen.`n",$utf8)
$answers.Clear()
Write-Host "Dateien vorbereitet: $run"
Write-Host 'DHCP/PXE wurde nicht gestartet. Naechster Schritt: mit den Medien aus Excel Bootdateien vorbereiten und auf dem GETAC testen.'
} catch { Write-Error $_; exit 1 }
+8
View File
@@ -1,5 +1,13 @@
# Stagging # Stagging
Projektversion: **0.1.0**. Änderungen und bekannte Grenzen stehen im [Änderungsverlauf](CHANGELOG.md). Die verbindliche Versionsnummer liegt in [VERSION](VERSION) und kann mit `./Prepare-Unattended.ps1 -ShowVersion` angezeigt werden. Sie ist unabhängig von den Hypervisor-Versionen in Excel und vom Workbook-Schema.
## Aktueller Programmstand
Der erste Baustein für unbeaufsichtigte Installationen ist implementiert: `Prepare-Unattended.ps1` liest das KIS-Workbook ohne Excel-Abhängigkeit, prüft ausgewählte Server und erzeugt nach interaktiver Bestätigung PVE-`answer.toml` beziehungsweise ESXi-`ks.cfg`. Die gewünschten Versionen kommen ausschließlich aus Excel. Passwörter werden verdeckt abgefragt und als gesalzene Hashes in die Antwortdateien geschrieben.
Die [Anleitung](ANLEITUNG.md) beschreibt Prüfung und Dateierzeugung. DHCP/PXE, Medienvorbereitung, Auslieferung und reale Installertests sind noch offen. Auf dem GETAC wurde nichts installiert oder gestartet.
## Projektauftrag ## Projektauftrag
Ein zentraler Staging-Server soll Infrastruktur anhand eines ConfigWorkbooks bereitstellen und konfigurieren. Das ConfigWorkbook ist eine Excel-Datei mit den Parametern für die gewünschte Zielumgebung. Ein zentraler Staging-Server soll Infrastruktur anhand eines ConfigWorkbooks bereitstellen und konfigurieren. Das ConfigWorkbook ist eine Excel-Datei mit den Parametern für die gewünschte Zielumgebung.
+116
View File
@@ -0,0 +1,116 @@
#requires -Version 5.1
$ErrorActionPreference='Stop'
Import-Module (Join-Path $PSScriptRoot '../Modules/Unattended.psm1') -Force -DisableNameChecking
Add-Type -Path (Join-Path $PSScriptRoot '../Modules/Sha512Crypt.cs')
$script:count=0
function Assert($Condition,[string]$Label) { if (-not $Condition) { throw "FAIL: $Label" }; $script:count++ }
function Reject([scriptblock]$Action,[string]$Label) { $caught=$false; try { & $Action | Out-Null } catch { $caught=$true }; Assert $caught $Label }
function Fixture {
return @{
Settings=@{ 'Windows-Server-Version'='2025'; 'Netzwerkkarte'='Ethernet'; 'GETAC-IP'='192.168.50.1'; 'Netzpräfix'='24'; 'DHCP von'='192.168.50.100'; 'DHCP bis'='192.168.50.199'; 'Medienordner'=[IO.Path]::GetTempPath(); 'Proxmox-Medium'='proxmox-ve_9.0-1.iso'; 'ESXi-Medium'='VMware-VMvisor-Installer-8.0U3.iso' }
Servers=@(
@{Row=7; Installieren='JA'; Servername='pve01.lab.example'; 'PXE-MAC-Adresse'='02:00:00:00:00:11'; System='Proxmox VE'; Version='9.0-1'; Installationsdatenträger='ID_SERIAL=TEST_DISK_01'; 'Ziel-IP'='192.168.50.11'; 'Präfix'='24'; Gateway='192.168.50.254'; 'DNS-Server'='192.168.50.53'; Benutzername='root'},
@{Row=8; Installieren='JA'; Servername='esxi01.lab.example'; 'PXE-MAC-Adresse'='02:00:00:00:00:12'; System='VMware ESXi'; Version='8.0U3'; Installationsdatenträger='naa.6000000000000001'; 'Ziel-IP'='192.168.50.12'; 'Präfix'='24'; Gateway='192.168.50.254'; 'DNS-Server'='192.168.50.53'; Benutzername='root'}
)
}
}
$expected='$6$rounds=5000$saltstring$svn8UoSVapNtMuq1ukKS4tPQd8iKwSMHWjl/O817G3uBnIFNjnQJuesI68u4OTLiBFdcbYEdFCoEOfaS35inz1'
$hash=[Staging.Sha512Crypt]::Compute('Hello world!','saltstring',5000)
Assert ($hash -ceq $expected) 'SHA512-crypt published vector'
$hash2=[Staging.Sha512Crypt]::Compute('Hello world!','saltstringsaltst',10000)
Assert ($hash2 -ceq '$6$rounds=10000$saltstringsaltst$OW1/O6BYHV6BcXZu8QVeXbDWra3Oeqh0sbHbbMCVNSnCM/UrjmM0Dp8vOuZeHBy/YTBmSK6H9qs/y3RnOaw5v.') 'SHA512-crypt 10000 rounds vector'
Assert ([Staging.Sha512Crypt]::NewSalt() -ne [Staging.Sha512Crypt]::NewSalt()) 'Random salt'
$source=Join-Path $PSScriptRoot '../outputs/01a07d3f/ConfigWorkbook_KIS.xlsx'
$config=Read-KisWorkbook $source
Assert (@($config.Servers).Count -eq 0) 'Unselected workbook stays inactive'
Assert ($config.Settings['GETAC-IP'] -eq '192.168.50.1') 'Native XLSX import'
Assert (@(Get-InstallPlan $config).Count -eq 0) 'No selected rows, no preparation'
$plan=@(Get-InstallPlan (Fixture))
Assert ($plan.Count -eq 2) 'Both installer profiles'
Assert ($plan[0].Version -eq '9.0-1' -and $plan[1].Version -eq '8.0U3') 'Versions from workbook'
Assert ((Get-Netmask 24) -eq '255.255.255.0') 'Netmask /24'
Assert ((Get-Netmask 23) -eq '255.255.254.0') 'Netmask /23'
$pve=ConvertTo-AnswerText $plan[0] $hash 'admin@example.test'
$esxi=ConvertTo-AnswerText $plan[1] $hash ''
Assert ($pve.Contains('root-password-hashed = "'+$hash+'"')) 'PVE hashed root password'
Assert ($pve.Contains('filter.ID_SERIAL = "TEST_DISK_01"')) 'PVE exact serial filter'
Assert ($pve.Contains('filter.ID_NET_NAME_MAC = "*020000000011"')) 'PVE NIC selection'
Assert ($esxi.Contains('install --disk=naa.6000000000000001 --overwritevmfs')) 'ESXi explicit disk'
Assert ($esxi.Contains('--device=02:00:00:00:00:12')) 'ESXi NIC selection'
Assert (-not $esxi.Contains('--firstdisk')) 'No first-disk fallback'
Assert (-not ($pve+$esxi).Contains('Hello world!')) 'No plaintext password in answers'
Reject { $c=Fixture; $c.Servers[0].Version=''; Get-InstallPlan $c } 'Missing version'
Reject { $c=Fixture; $c.Servers[0].Version='99.0'; Get-InstallPlan $c } 'Unknown schema version'
Reject { $c=Fixture; $c.Servers[0]['PXE-MAC-Adresse']='02:00:00:00:00:12'; Get-InstallPlan $c } 'Duplicate MAC'
Reject { $c=Fixture; $c.Servers[0]['PXE-MAC-Adresse']='ff:ff:ff:ff:ff:ff'; Get-InstallPlan $c } 'Broadcast MAC'
Reject { $c=Fixture; $c.Servers[0].Installationsdatenträger='*'; Get-InstallPlan $c } 'Wildcard disk'
Reject { $c=Fixture; $c.Servers[0].Installationsdatenträger="sda`nreboot"; Get-InstallPlan $c } 'Directive injection'
Reject { $c=Fixture; $c.Servers[0]['Ziel-IP']='192.168.50.101'; Get-InstallPlan $c } 'DHCP collision'
Reject { $c=Fixture; $c.Servers[0]['Ziel-IP']='192.168.50.1'; Get-InstallPlan $c } 'GETAC collision'
Reject { $c=Fixture; $c.Servers[0]['Ziel-IP']='192.168.50.12'; Get-InstallPlan $c } 'Duplicate target IP'
Reject { $c=Fixture; $c.Servers[0]['Ziel-IP']='192.168.51.11'; Get-InstallPlan $c } 'Different staging subnet'
Reject { $c=Fixture; $c.Servers[0]['DNS-Server']=''; Get-InstallPlan $c } 'Missing DNS'
Reject { $c=Fixture; $c.Servers[0].Gateway=''; Get-InstallPlan $c } 'Missing gateway'
Reject { $c=Fixture; $c.Servers[0].Benutzername='administrator'; Get-InstallPlan $c } 'Unsupported account'
Reject { $c=Fixture; $c.Settings['Proxmox-Medium']='../wrong.iso'; Get-InstallPlan $c } 'Media path traversal'
Reject { $c=Fixture; $c.Settings['GETAC-IP']='192.168.50.150'; Get-InstallPlan $c } 'DHCP includes station'
Reject { ConvertTo-AnswerText $plan[0] $hash "mail@example.test`nroot-password=evil" } 'Email injection'
$pw=ConvertTo-SecureString 'Only-Test-Password-123!' -AsPlainText -Force
try { $secureHash=New-RootHash $pw; Assert ($secureHash.StartsWith('$6$rounds=100000$')) 'Interactive hash profile' } finally { $pw.Dispose() }
# End-to-end import and file generation using a disposable XLSX fixture and fake
# media. These files are test data, never installation artifacts.
$temp=Join-Path ([IO.Path]::GetTempPath()) ('staging-test-'+[Guid]::NewGuid().ToString('N'))
$null=New-Item -ItemType Directory $temp
try {
$fixturePath=Join-Path $temp 'fixture.xlsx'; Copy-Item -LiteralPath $source -Destination $fixturePath
$zip=[IO.Compression.ZipFile]::Open($fixturePath,[IO.Compression.ZipArchiveMode]::Update)
try {
function Patch-Cells($Archive,[string]$EntryName,$Changes) {
$entry=$Archive.GetEntry($EntryName); $reader=New-Object IO.StreamReader($entry.Open())
try { [xml]$xml=$reader.ReadToEnd() } finally { $reader.Dispose() }
foreach ($address in $Changes.Keys) {
$node=$xml.SelectSingleNode("//*[local-name()='c' and @r='$address']")
if (-not $node) { throw "Test cell missing: $address" }
$node.RemoveAll(); $node.SetAttribute('r',$address); $node.SetAttribute('t','inlineStr')
$inline=$xml.CreateElement('is',$xml.DocumentElement.NamespaceURI); $t=$xml.CreateElement('t',$xml.DocumentElement.NamespaceURI); $t.InnerText=[string]$Changes[$address]
$null=$inline.AppendChild($t); $null=$node.AppendChild($inline)
}
$entry.Delete(); $entry=$Archive.CreateEntry($EntryName); $writer=New-Object IO.StreamWriter($entry.Open())
try { $writer.Write($xml.OuterXml) } finally { $writer.Dispose() }
}
Patch-Cells $zip 'xl/worksheets/sheet1.xml' @{ B8='2025'; B14=$temp; B15='test-pve-9.0-1.iso'; B16='test-esxi-8.0U3.iso' }
Patch-Cells $zip 'xl/worksheets/sheet2.xml' @{ A7='JA'; E7='9.0-1'; F7='ID_SERIAL=TEST_DISK'; I7='192.168.50.254'; J7='192.168.50.53'; A8='JA'; E8='8.0U3'; F8='naa.6000000000000001'; I8='192.168.50.254'; J8='192.168.50.53' }
} finally { $zip.Dispose() }
[IO.File]::WriteAllText((Join-Path $temp 'test-pve-9.0-1.iso'),'TEST ONLY - NOT AN ISO')
[IO.File]::WriteAllText((Join-Path $temp 'test-esxi-8.0U3.iso'),'TEST ONLY - NOT AN ISO')
$imported=Read-KisWorkbook $fixturePath
Assert (@($imported.Servers).Count -eq 2) 'Selected XLSX rows imported'
$parsed=@(Get-InstallPlan $imported -CheckMedia)
Assert ($parsed.Count -eq 2 -and $parsed[1].Version -eq '8.0U3') 'Complete XLSX validation'
$global:StagingTestResponses=[Collections.Generic.Queue[string]]::new()
$global:StagingTestResponses.Enqueue('admin@example.test'); $global:StagingTestResponses.Enqueue('VORBEREITEN')
function Read-Host { param($Prompt,[switch]$AsSecureString)
if ($AsSecureString) { return (ConvertTo-SecureString 'Only-Test-Password-123!' -AsPlainText -Force) }
return $global:StagingTestResponses.Dequeue()
}
& (Join-Path $PSScriptRoot '../Prepare-Unattended.ps1') -Workbook $fixturePath -Generate -OutputDirectory (Join-Path $temp 'runs')
$run=@(Get-ChildItem -LiteralPath (Join-Path $temp 'runs') -Directory)[0]
$manifestText=[IO.File]::ReadAllText((Join-Path $run.FullName 'manifest.json'))
$manifest=@(ConvertFrom-Json $manifestText)
Assert ($manifest.Count -eq 2) 'Manifest includes both hosts'
Assert (-not $manifestText.Contains('$6$')) 'Manifest excludes hashes'
foreach ($item in $manifest) {
$answer=[IO.File]::ReadAllText((Join-Path $run.FullName $item.AnswerFile))
Assert ($answer.Contains('$6$rounds=100000$')) 'Saved answer has salted hash'
Assert (-not $answer.Contains('Only-Test-Password-123!')) 'Saved answer excludes plaintext'
Assert ($item.MediaSHA256 -eq (Get-FileHash -LiteralPath $item.Media).Hash) 'Manifest media hash'
}
Assert (-not (Test-Path (Join-Path $temp 'runs/ks.cfg'))) 'No generic catch-all kickstart'
} finally {
Remove-Item Function:Read-Host -ErrorAction SilentlyContinue
Remove-Variable StagingTestResponses -Scope Global -ErrorAction SilentlyContinue
# Only the unique disposable fixture directory created by this test.
Remove-Item -LiteralPath $temp -Recurse -Force
}
Write-Host "$script:count checks passed. No network services or installations started."
+1
View File
@@ -0,0 +1 @@
0.1.0