Tham chiếu cấu hình
Hành vi của clmBot được kiểm soát bởi tệp cấu hình config.yaml nằm trong thư mục cài đặt.Tệp này được tạo tự động khi thực thi login, discover-certificate hoặc add-server, cũng có thể chỉnh sửa thủ công.
Theo mặc định, clmBot đọc config.yaml từ thư mục hiện tại, cũng có thể chỉ định đường dẫn tệp cấu hình thông qua tham số toàn cục -c:
./clm-bot-linux-amd64 -c /opt/clm-bot/config.yaml update-certificate
Cấu trúc tổng thể
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: Cấu hình tích hợp
| Trường | Mô tả |
|---|---|
base_url | Địa chỉ API đám mây, điền theo thông tin bàn giao, thường không cần sửa đổi |
ignore_ssl | Có bỏ qua xác thực chứng chỉ HTTPS hay không. Chỉ bật trong môi trường được kiểm soát sử dụng chứng chỉ tự ký |
access_key | AccessKey do đám mây phân bổ |
access_secret | AccessSecret do đám mây phân bổ. Sau khi văn bản thuần được chương trình lưu lần đầu, sẽ tự động chuyển thành giá trị mã hóa bắt đầu bằng ENC1+ |
servers: Danh sách điểm cài đặt
Mỗi mục servers[] tương ứng với một điểm cài đặt chứng chỉ:
| Trường | Mô tả |
|---|---|
id | Mã điểm cài đặt, khuyến nghị sử dụng tên có ý nghĩa nghiệp vụ |
sub_code | Số đăng ký chứng chỉ, tương ứng với đăng ký chứng chỉ trong backend quản lý, clmBot lấy chứng chỉ mới nhất theo số này |
format | Định dạng chứng chỉ và đường dẫn tệp, chỉ được giữ một trong các loại pem, pfx, jks, iis, exchange |
before_script | Tập lệnh thực thi trước khi cập nhật, nếu tập lệnh thất bại sẽ làm gián đoạn quá trình cập nhật của điểm cài đặt hiện tại |
after_script | Tập lệnh thực thi sau khi cập nhật, thường dùng để tải lại dịch vụ middleware |
format:Định dạng chứng chỉ
pem
Dành cho các trường hợp sử dụng tệp PEM như nginx, Apache HTTP Server, Tomcat, v.v.:
| Trường | Mô tả |
|---|---|
cert_path | Đường dẫn tệp chứng chỉ trang web. Khi cập nhật sẽ ghi chứng chỉ lá; nếu ca_path trống, đồng thời ghi chuỗi chứng chỉ đầy đủ |
ca_path | Đường dẫn tệp chuỗi CA, có thể để trống |
key_path | Đường dẫn tệp khóa riêng |
pfx
Dành cho các dịch vụ yêu cầu gói chứng chỉ tệp đơn (PKCS#12):
| Trường | Mô tả |
|---|---|
path | Đường dẫn tệp PFX |
key_pass | Mật khẩu khóa riêng PFX, có thể để trống khi dịch vụ đích không yêu cầu mật khẩu |
jks
Phù hợp với các tình huống Java keystore như Tomcat:
| Trường | Mô tả |
|---|---|
path | Đường dẫn tệp JKS |
alias | Bí danh mục chứng chỉ. Khi để trống, chỉ có thể tự động suy ra khi keystore chỉ có một mục |
key_pass | Mật khẩu khóa riêng của mục |
store_pass | Mật khẩu keystore |
iis
Áp dụng cho Windows IIS HTTPS binding:
| Trường | Mô tả |
|---|---|
name | Tên site IIS, có thể xem trong IIS Manager |
addr | IP liên kết HTTPS, * nghĩa là tất cả IP |
port | Cổng liên kết HTTPS |
domain | Tên miền liên kết HTTPS, có thể để trống khi không có tên miền SNI |
Điểm cài đặt IIS được clmBot tích hợp script tự động hoàn tất việc nhập chứng chỉ và cập nhật liên kết, thường không cần cấu hình script.
exchange
Dành cho chứng chỉ dịch vụ Windows Exchange:
| Trường | Mô tả |
|---|---|
services | Danh sách tên dịch vụ Exchange cần kích hoạt chứng chỉ mới, ví dụ ["IIS", "SMTP", "POP", "IMAP"] |
Hướng dẫn thực thi script
before_script và after_script được thực hiện theo thứ tự sau khi gia hạn chứng chỉ:
- Thử sao lưu tệp chứng chỉ cục bộ (tạo bản sao lưu
.bakcó dấu thời gian); nếu sao lưu thất bại thì ghi lại lỗi và tiếp tục. - Thực thi
before_script, nếu thất bại thì ngắt cập nhật tại điểm cài đặt hiện tại. - Ghi chứng chỉ mới.
- Thực thi
after_scripttheo cấu hình, tập lệnh chịu trách nhiệm tải lại hoặc khởi động lại dịch vụ middleware.
Khi chứng chỉ cục bộ đã là mới nhất, toàn bộ quá trình cập nhật (bao gồm cả script) sẽ bị bỏ qua; nếu cần buộc thực thi after_script, bạn có thể sử dụng tham số --force-after.
Script được thực thi trên Linux thông qua bash và trên Windows thông qua powershell.exe -NoProfile -ExecutionPolicy Bypass.
Biến mẫu script
Khi viết before_script / after_script, bạn có thể sử dụng các biến mẫu sau đây, clmBot sẽ thay thế chúng bằng giá trị thực tế trước khi thực thi.
Biến chung:
| Biến | Mô tả |
|---|---|
{{ .ID }} | Điểm cài đặt id |
{{ .SUB_CODE }} | Số đăng ký chứng chỉ |
{{ .OS_TYPE }} | Loại hệ điều hành (windows / linux / darwin) |
{{ .IS_WINDOWS }} | Có phải Windows không (true / false) |
{{ .IS_LINUX }} | Có phải Linux không (true / false) |
{{ .TIMESTAMP }} | Mốc thời gian hiện tại (giây) |
{{ .DATETIME }} | Ngày giờ hiện tại (định dạng 2006-01-02 15:04:05) |
{{ .DATE }} | Ngày hiện tại (định dạng 2006-01-02) |
{{ .LATEST }} | Chứng chỉ đã là mới nhất chưa (true / false). Khi dùng cùng --force-after, có thể dùng trong tập lệnh để xác định bỏ qua các thao tác tiếp theo |
Biến được cung cấp theo định dạng chứng chỉ:
| Định dạng | Biến | Mô tả |
|---|---|---|
| pem | {{ .PEM_CERT_PATH }} | Đường dẫn tệp chứng chỉ trang web |
| pem | {{ .PEM_CA_PATH }} | Đường dẫn tệp chuỗi CA |
| pem | {{ .PEM_KEY_PATH }} | Đường dẫn tệp khóa riêng |
| pfx | {{ .PFX_PATH }} | Đường dẫn tệp PFX |
| pfx | {{ .PFX_KEY_PASS }} | Mật khẩu khóa riêng PFX |
| jks | {{ .JKS_PATH }} | Đường dẫn tệp JKS |
| jks | {{ .JKS_ALIAS }} | Bí danh mục chứng chỉ |
| jks | {{ .JKS_KEY_PASS }} | Mật khẩu khóa riêng của mục |
| jks | {{ .JKS_STORE_PASS }} | Mật khẩu keystore |
| iis | {{ .IIS_SITE_NAME }} | Tên trang IIS |
| iis | {{ .IIS_IPADDR }} | IP liên kết HTTPS |
| iis | {{ .IIS_PORT }} | Cổng liên kết HTTPS |
| iis | {{ .IIS_DOMAIN }} | Tên miền liên kết HTTPS |
| exchange | {{ .EXCHANGE_SERVICES }} | Danh sách tên dịch vụ Exchange (phân tách bằng dấu phẩy) |
Khuyến nghị bảo mật
config.yamlchứa thông tin xác thực truy cập và đường dẫn khóa riêng, vui lòng giới hạn quyền truy cập tệp chỉ cho tài khoản chạy có quyền đọc và ghi (ví dụ:chmod 600 config.yaml).AccessSecretsau khi lưu sẽ được lưu trữ dưới dạng mã hóa, nhưng vẫn nên tránh sao chép tệp cấu hình đến những vị trí không đáng tin cậy.- Sử dụng tài khoản chạy riêng cho clmBot và cấp quyền theo nguyên tắc đặc quyền tối thiểu, xem Yêu cầu quyền khi chạy.