Zum Hauptinhalt springen

Konfigurationsreferenz

Das Verhalten von clmBot wird durch die Konfigurationsdatei config.yaml im Installationsverzeichnis gesteuert. Diese Datei wird automatisch bei der Ausführung von login, discover-certificate oder add-server generiert und kann auch manuell bearbeitet werden.

Standardmäßig liest clmBot config.yaml aus dem aktuellen Verzeichnis. Alternativ kann der Pfad zur Konfigurationsdatei über den globalen Parameter -c angegeben werden:

./clm-bot-linux-amd64 -c /opt/clm-bot/config.yaml update-certificate

Gesamtstruktur​

app:
base_url: https://<云端地址>
ignore_ssl: false
access_key: YOUR_ACCESS_KEY
access_secret: YOUR_ACCESS_SECRET

servers:
- id: nginx_pem
sub_code: <证书订阅号>
format:
pem:
cert_path: /etc/nginx/ssl/example.com.crt
ca_path: /etc/nginx/ssl/example.com.ca.crt
key_path: /etc/nginx/ssl/example.com.key
before_script: |
...
after_script: |
nginx -t && nginx -s reload

app:Verbindungskonfiguration​

FeldBeschreibung
base_urlCloud-API-Adresse, gemäß Lieferinformationen ausfüllen, normalerweise keine Änderung erforderlich
ignore_sslOb die HTTPS-Zertifikatsprüfung ignoriert werden soll. Nur in kontrollierten Umgebungen mit selbstsignierten Zertifikaten aktivieren
access_keyVon der Cloud zugewiesener AccessKey
access_secretVon der Cloud zugewiesenes AccessSecret. Nachdem der Klartext zum ersten Mal vom Programm gespeichert wurde, wird er automatisch in einen verschlüsselten Wert migriert, der mit ENC1+ beginnt

servers: Liste der Installationspunkte​

Jeder servers[]-Eintrag entspricht einem Zertifikatsinstallationspunkt:

FeldBeschreibung
idInstallationspunktkennung, empfohlen mit geschäftsrelevantem Namen
sub_codeZertifikatsabonnementnummer, entspricht dem Zertifikatsabonnement im Verwaltungsbackend, clmBot ruft darüber das neueste Zertifikat ab
formatZertifikatsformat und Dateipfad, nur eine der folgenden Optionen ist zulässig: pem, pfx, jks, iis, exchange
before_scriptSkript, das vor der Aktualisierung ausgeführt wird; ein Fehler im Skript unterbricht die Aktualisierung des aktuellen Installationspunkts
after_scriptSkript, das nach der Aktualisierung ausgeführt wird, üblicherweise zum Neuladen des Middleware-Dienstes

format: Zertifikatsformat​

pem​

Geeignet für Szenarien, die PEM-Dateien verwenden, wie nginx, Apache HTTP Server, Tomcat usw.:

FeldBeschreibung
cert_pathPfad der Site-Zertifikatsdatei. Beim Aktualisieren wird das Blattzertifikat geschrieben; wenn ca_path leer ist, wird gleichzeitig die vollständige Zertifikatskette geschrieben
ca_pathPfad der CA-Ketten-Datei, kann leer sein
key_pathPfad der privaten Schlüsseldatei

pfx​

Für Dienste, die ein einzelnes Zertifikatspaket (PKCS#12) benötigen:

FeldBeschreibung
pathPfad der PFX-Datei
key_passPasswort für den privaten Schlüssel der PFX-Datei; kann leer gelassen werden, wenn der Zieldienst kein Passwort erfordert

jks​

Für Java Keystore-Szenarien wie Tomcat:

FeldBeschreibung
pathPfad der JKS-Datei
aliasAlias des Zertifikatseintrags. Wenn leer, kann nur automatisch abgeleitet werden, wenn der Keystore genau einen Eintrag enthält
key_passPasswort des Eintrags-Privatschlüssels
store_passKeystore-Passwort

iis​

Gilt für Windows IIS HTTPS-Bindungen:

FeldBeschreibung
nameIIS-Standortname, einsehbar im IIS-Manager
addrHTTPS-Bindungs-IP, * steht für alle IPs
portHTTPS-Bindungsport
domainHTTPS-Bindungsdomain, kann bei Fehlen einer SNI-Domain leer gelassen werden

Der IIS-Installationspunkt wird vom eingebauten clmBot-Skript automatisch für den Zertifikatsimport und die Bindungsaktualisierung ausgeführt; eine Skriptkonfiguration ist in der Regel nicht erforderlich.

exchange​

Gilt für Windows Exchange-Dienstzertifikate:

FeldBeschreibung
servicesListe der Exchange-Dienstnamen, für die das neue Zertifikat aktiviert werden muss, z. B. ["IIS", "SMTP", "POP", "IMAP"]

Hinweise zur Skriptausführung​

before_script und after_script werden bei der Zertifikatsaktualisierung in der folgenden Reihenfolge ausgeführt:

  1. Es wird versucht, die lokalen Zertifikatsdateien zu sichern (Erstellung einer Sicherung mit Zeitstempel .bak); bei Fehlschlag wird ein Fehler protokolliert und fortgefahren.
  2. Ausführung von before_script – bei Fehlschlag wird die Aktualisierung des aktuellen Installationspunkts abgebrochen.
  3. Das neue Zertifikat wird geschrieben.
  4. Gemäß Konfiguration wird after_script ausgeführt; das Skript übernimmt das Neuladen oder den Neustart des Middleware-Dienstes.

Wenn das lokale Zertifikat bereits auf dem neuesten Stand ist, wird das gesamte Update (einschließlich des Skripts) übersprungen; wenn eine erzwungene Ausführung von after_script erforderlich ist, kann der Parameter --force-after verwendet werden.

Das Skript wird auf Linux über bash ausgeführt, auf Windows über powershell.exe -NoProfile -ExecutionPolicy Bypass.

Skript-Template-Variablen​

Beim Schreiben von before_script / after_script können die folgenden Template-Variablen verwendet werden, die von clmBot vor der Ausführung durch die tatsächlichen Werte ersetzt werden.

Allgemeine Variablen:

VariableBeschreibung
{{ .ID }}Installationspunkt id
{{ .SUB_CODE }}Zertifikatsabonnement
{{ .OS_TYPE }}Betriebssystemtyp (windows / linux / darwin)
{{ .IS_WINDOWS }}Ist Windows (true / false)
{{ .IS_LINUX }}Ob Linux (true / false)
{{ .TIMESTAMP }}Aktueller Zeitstempel (Sekunden)
{{ .DATETIME }}Aktuelles Datum und Uhrzeit (2006-01-02 15:04:05-Format)
{{ .DATE }}Aktuelles Datum (2006-01-02-Format)
{{ .LATEST }}Ob das Zertifikat bereits aktuell ist (true / false). In Kombination mit --force-after kann im Skript entschieden werden, ob nachfolgende Schritte übersprungen werden

Variablen nach Zertifikatsformat:

FormatVariableBeschreibung
pem{{ .PEM_CERT_PATH }}Dateipfad des Site-Zertifikats
pem{{ .PEM_CA_PATH }}Dateipfad der CA-Kette
pem{{ .PEM_KEY_PATH }}Dateipfad des privaten Schlüssels
pfx{{ .PFX_PATH }}Dateipfad der PFX-Datei
pfx{{ .PFX_KEY_PASS }}PFX-Privatschlüssel-Passwort
jks{{ .JKS_PATH }}JKS-Dateipfad
jks{{ .JKS_ALIAS }}Zertifikatseintrags-Alias
jks{{ .JKS_KEY_PASS }}Passwort für den Eintrags-Privatschlüssel
jks{{ .JKS_STORE_PASS }}Keystore-Passwort
iis{{ .IIS_SITE_NAME }}IIS-Websitename
iis{{ .IIS_IPADDR }}HTTPS-Bindungs-IP
iis{{ .IIS_PORT }}HTTPS-Bindungsport
iis{{ .IIS_DOMAIN }}HTTPS-Bindungsdomäne
exchange{{ .EXCHANGE_SERVICES }}Liste der Exchange-Dienstnamen (durch Kommas getrennt)

Sicherheitsempfehlungen​

  • config.yaml enthält Zugangsdaten und private Schlüsselpfade. Beschränken Sie die Dateiberechtigungen auf Lesen/Schreiben nur für das Ausführungskonto (z. B. chmod 600 config.yaml).
  • AccessSecret wird nach dem Speichern verschlüsselt abgelegt, aber Sie sollten dennoch vermeiden, die Konfigurationsdatei an unzuverlässige Orte zu kopieren.
  • Verwenden Sie für clmBot ein dediziertes Ausführungskonto und gewähren Sie nur minimale Berechtigungen. Siehe Ausführungsberechtigungsanforderungen.