Referencia de configuración
El comportamiento de clmBot está controlado por el archivo de configuración config.yaml en el directorio de instalación. Este archivo se genera automáticamente al ejecutar login, discover-certificate o add-server, y también se puede editar manualmente.
De forma predeterminada, clmBot lee config.yaml desde el directorio actual; también se puede especificar la ruta del archivo de configuración mediante el parámetro global -c:
./clm-bot-linux-amd64 -c /opt/clm-bot/config.yaml update-certificate
Estructura general
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: Configuración de acceso
| 字段 | 说明 |
|---|---|
base_url | Dirección API en la nube, completar según la información de entrega; generalmente no requiere modificación |
ignore_ssl | Si se ignora la verificación del certificado HTTPS. Activar únicamente en entornos controlados que utilicen certificados autofirmados |
access_key | AccessKey asignado por la nube |
access_secret | AccessSecret asignado por la nube. Tras ser guardado en texto plano por el programa por primera vez, se migrará automáticamente a un valor cifrado que comienza con ENC1+ |
servers:lista de puntos de instalación
Cada entrada servers[] corresponde a un punto de instalación de certificados:
| 字段 | 说明 |
|---|---|
id | Identificador del punto de instalación; se recomienda usar un nombre con significado comercial |
sub_code | Número de suscripción del certificado, correspondiente a la suscripción de certificados en el panel de administración; clmBot obtiene el certificado más reciente según este valor |
format | Formato y ruta del archivo del certificado; solo se puede conservar uno de pem, pfx, jks, iis, exchange |
before_script | Script ejecutado antes de la actualización; si falla, se interrumpe la actualización del punto de instalación actual |
after_script | Script ejecutado después de la actualización; se usa comúnmente para recargar los servicios de middlewares |
format:Formato del certificado
pem
Adecuado para escenarios que utilizan archivos PEM, como nginx, Apache HTTP Server, Tomcat, entre otros:
| Campo | Descripción |
|---|---|
cert_path | Ruta del archivo de certificado del sitio. Al actualizar, se escribe el certificado hoja; si ca_path está vacío, también se escribe la cadena de certificados completa |
ca_path | Ruta del archivo de la cadena CA, puede estar vacía |
key_path | Ruta del archivo de la clave privada |
pfx
Adecuado para servicios que requieren un paquete de certificado de archivo único (PKCS#12):
| Campo | Descripción |
|---|---|
path | Ruta del archivo PFX |
key_pass | Contraseña de la clave privada PFX, puede dejarse vacía si el servicio de destino no requiere contraseña |
jks
Adecuado para escenarios de Java keystore como Tomcat:
| Campo | Descripción |
|---|---|
path | Ruta del archivo JKS |
alias | Alias de la entrada del certificado. Si está vacío, solo se puede inferir automáticamente cuando el keystore tiene una sola entrada |
key_pass | Contraseña de la clave privada de la entrada |
store_pass | Contraseña del almacén de claves |
iis
Aplica al enlace HTTPS de Windows IIS:
| Campo | Descripción |
|---|---|
name | Nombre del sitio IIS, consultable en el administrador de IIS |
addr | IP de enlace HTTPS, * indica todas las IP |
port | Puerto de enlace HTTPS |
domain | Dominio de enlace HTTPS, puede dejarse vacío si no hay dominio SNI |
El punto de instalación de IIS lo completa automáticamente el script integrado de clmBot para la importación del certificado y la actualización del enlace; generalmente no se requiere configurar un script.
exchange
Aplica al certificado de servicio de Exchange en Windows:
| Campo | Descripción |
|---|---|
services | Lista de nombres de servicios de Exchange que requieren habilitar el nuevo certificado, como ["IIS", "SMTP", "POP", "IMAP"] |
Descripción de la ejecución de los scripts
before_script y after_script se ejecutan en el siguiente orden al actualizar el certificado:
- Intentar realizar una copia de seguridad del archivo de certificado local (generar una copia de seguridad
.bakcon marca de tiempo); si la copia de seguridad falla, registrar el error y continuar. - Ejecutar
before_script; si falla, interrumpir la actualización del punto de instalación actual. - Escribir el nuevo certificado.
- Ejecutar
after_scriptsegún la configuración; el script se encarga de recargar o reiniciar el servicio de middleware.
Cuando el certificado local ya está actualizado, toda la actualización (incluido el script) se omite; si necesita forzar la ejecución de after_script, puede usar el parámetro --force-after.
El script se ejecuta en Linux a través de bash, y en Windows mediante powershell.exe -NoProfile -ExecutionPolicy Bypass.
Variables de plantilla del script
Al escribir before_script / after_script, puede usar las siguientes variables de plantilla, que clmBot reemplazará con los valores reales antes de la ejecución.
Variables generales:
| Variable | Descripción |
|---|---|
{{ .ID }} | Punto de instalación id |
{{ .SUB_CODE }} | Número de suscripción del certificado |
{{ .OS_TYPE }} | Tipo de sistema operativo (windows / linux / darwin) |
{{ .IS_WINDOWS }} | Si es Windows (true / false) |
{{ .IS_LINUX }} | Es Linux (true / false) |
{{ .TIMESTAMP }} | Marca de tiempo actual (segundos) |
{{ .DATETIME }} | Fecha y hora actuales (formato 2006-01-02 15:04:05) |
{{ .DATE }} | Fecha actual (formato 2006-01-02) |
{{ .LATEST }} | Indica si el certificado ya está actualizado (true / false). Al usarlo junto con --force-after, permite determinar en el script si se deben omitir los pasos posteriores |
Variables proporcionadas según el formato del certificado:
| Formato | Variable | Descripción |
|---|---|---|
| pem | {{ .PEM_CERT_PATH }} | Ruta del archivo del certificado del sitio |
| pem | {{ .PEM_CA_PATH }} | Ruta del archivo de la cadena CA |
| pem | {{ .PEM_KEY_PATH }} | Ruta del archivo de la clave privada |
| pfx | {{ .PFX_PATH }} | Ruta del archivo PFX |
| pfx | {{ .PFX_KEY_PASS }} | Contraseña de la clave privada PFX |
| jks | {{ .JKS_PATH }} | Ruta del archivo JKS |
| jks | {{ .JKS_ALIAS }} | Alias de la entrada del certificado |
| jks | {{ .JKS_KEY_PASS }} | Contraseña de la clave privada de la entrada |
| jks | {{ .JKS_STORE_PASS }} | Contraseña del almacén de claves |
| iis | {{ .IIS_SITE_NAME }} | Nombre del sitio IIS |
| iis | {{ .IIS_IPADDR }} | IP del enlace HTTPS |
| iis | {{ .IIS_PORT }} | Puerto del enlace HTTPS |
| iis | {{ .IIS_DOMAIN }} | Dominio de enlace HTTPS |
| exchange | {{ .EXCHANGE_SERVICES }} | Lista de nombres de servicio de Exchange (separados por comas) |
Sugerencias de seguridad
config.yamlcontiene las credenciales de acceso y la ruta de la clave privada; restrinja los permisos del archivo para que solo la cuenta de ejecución pueda leer y escribir (por ejemplo,chmod 600 config.yaml).AccessSecretse almacena en formato cifrado tras guardarse, pero aun así debe evitar copiar el archivo de configuración a ubicaciones no confiables.- Utilice una cuenta de ejecución dedicada para clmBot y otorgue permisos con el principio de privilegio mínimo; consulte Requisitos de permisos de ejecución.