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
| Feld | Beschreibung |
|---|---|
base_url | Cloud-API-Adresse, gemäß Lieferinformationen ausfüllen, normalerweise keine Änderung erforderlich |
ignore_ssl | Ob die HTTPS-Zertifikatsprüfung ignoriert werden soll. Nur in kontrollierten Umgebungen mit selbstsignierten Zertifikaten aktivieren |
access_key | Von der Cloud zugewiesener AccessKey |
access_secret | Von 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:
| Feld | Beschreibung |
|---|---|
id | Installationspunktkennung, empfohlen mit geschäftsrelevantem Namen |
sub_code | Zertifikatsabonnementnummer, entspricht dem Zertifikatsabonnement im Verwaltungsbackend, clmBot ruft darüber das neueste Zertifikat ab |
format | Zertifikatsformat und Dateipfad, nur eine der folgenden Optionen ist zulässig: pem, pfx, jks, iis, exchange |
before_script | Skript, das vor der Aktualisierung ausgeführt wird; ein Fehler im Skript unterbricht die Aktualisierung des aktuellen Installationspunkts |
after_script | Skript, 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.:
| Feld | Beschreibung |
|---|---|
cert_path | Pfad der Site-Zertifikatsdatei. Beim Aktualisieren wird das Blattzertifikat geschrieben; wenn ca_path leer ist, wird gleichzeitig die vollständige Zertifikatskette geschrieben |
ca_path | Pfad der CA-Ketten-Datei, kann leer sein |
key_path | Pfad der privaten Schlüsseldatei |
pfx
Für Dienste, die ein einzelnes Zertifikatspaket (PKCS#12) benötigen:
| Feld | Beschreibung |
|---|---|
path | Pfad der PFX-Datei |
key_pass | Passwort 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:
| Feld | Beschreibung |
|---|---|
path | Pfad der JKS-Datei |
alias | Alias des Zertifikatseintrags. Wenn leer, kann nur automatisch abgeleitet werden, wenn der Keystore genau einen Eintrag enthält |
key_pass | Passwort des Eintrags-Privatschlüssels |
store_pass | Keystore-Passwort |
iis
Gilt für Windows IIS HTTPS-Bindungen:
| Feld | Beschreibung |
|---|---|
name | IIS-Standortname, einsehbar im IIS-Manager |
addr | HTTPS-Bindungs-IP, * steht für alle IPs |
port | HTTPS-Bindungsport |
domain | HTTPS-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:
| Feld | Beschreibung |
|---|---|
services | Liste 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:
- Es wird versucht, die lokalen Zertifikatsdateien zu sichern (Erstellung einer Sicherung mit Zeitstempel
.bak); bei Fehlschlag wird ein Fehler protokolliert und fortgefahren. - Ausführung von
before_script– bei Fehlschlag wird die Aktualisierung des aktuellen Installationspunkts abgebrochen. - Das neue Zertifikat wird geschrieben.
- Gemäß Konfiguration wird
after_scriptausgefü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:
| Variable | Beschreibung |
|---|---|
{{ .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:
| Format | Variable | Beschreibung |
|---|---|---|
| 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.yamlenthä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).AccessSecretwird 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.