import { AbstractTaskPlugin, IsTaskPlugin, pluginGroups, RunStrategy, TaskInput, TaskOutput } from '@certd/pipeline'; import { SshClient } from '../../lib/ssh.js'; import { CertInfo, CertReader, CertReaderHandleContext } from '@certd/plugin-cert'; import * as fs from 'fs'; import { SshAccess } from '../../access/index.js'; import dayjs from 'dayjs'; @IsTaskPlugin({ name: 'uploadCertToHost', title: '部署证书到主机', icon: 'line-md:uploading-loop', group: pluginGroups.host.key, desc: '上传证书到主机,然后执行部署脚本命令', default: { strategy: { runStrategy: RunStrategy.SkipWhenSucceed, }, }, }) export class UploadCertToHostPlugin extends AbstractTaskPlugin { @TaskInput({ title: '域名证书', helper: '请选择前置任务输出的域名证书', component: { name: 'output-selector', from: ['CertApply', 'CertApplyLego'], }, required: true, }) cert!: CertInfo; @TaskInput({ title: '证书格式', helper: '要部署的证书格式,支持pem、pfx、der、jks', component: { name: 'a-select', options: [ { value: 'pem', label: 'pem,Nginx等大部分应用' }, { value: 'pfx', label: 'pfx,一般用于IIS' }, { value: 'der', label: 'der,一般用于Apache' }, { value: 'jks', label: 'jks,一般用于JAVA应用' }, ], }, required: true, }) certType!: string; @TaskInput({ title: '证书保存路径', helper: '填写应用原本的证书保存路径,路径要包含证书文件名,例如:/tmp/cert.pem', component: { placeholder: '/root/deploy/nginx/full_chain.pem', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'pem'; }) } `, required: true, rules: [{ type: 'filepath' }], }) crtPath!: string; @TaskInput({ title: '私钥保存路径', helper: '需要有写入权限,路径要包含私钥文件名,例如:/tmp/cert.key', component: { placeholder: '/root/deploy/nginx/cert.key', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'pem'; }) } `, required: true, rules: [{ type: 'filepath' }], }) keyPath!: string; @TaskInput({ title: '中间证书保存路径', helper: '路径要包含文件名,一般情况传上面两个文件即可,极少数情况需要这个中间证书', component: { placeholder: '/root/deploy/nginx/intermediate.pem', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'pem'; }) } `, rules: [{ type: 'filepath' }], }) icPath!: string; @TaskInput({ title: 'PFX证书保存路径', helper: '填写应用原本的证书保存路径,路径要包含证书文件名,例如:D:\\iis\\cert.pfx', component: { placeholder: 'D:\\iis\\cert.pfx', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'pfx'; }) } `, required: true, rules: [{ type: 'filepath' }], }) pfxPath!: string; @TaskInput({ title: 'DER证书保存路径', helper: '填写应用原本的证书保存路径,路径要包含证书文件名,例如:/tmp/cert.der', component: { placeholder: '/root/deploy/apache/cert.der', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'der'; }) } `, required: true, rules: [{ type: 'filepath' }], }) derPath!: string; @TaskInput({ title: 'jks证书保存路径', helper: '填写应用原本的证书保存路径,路径要包含证书文件名,例如:/tmp/cert.jks', component: { placeholder: '/root/deploy/java_app/cert.jks', }, mergeScript: ` return { show: ctx.compute(({form})=>{ return form.certType === 'jks'; }) } `, required: true, rules: [{ type: 'filepath' }], }) jksPath!: string; @TaskInput({ title: '主机登录配置', helper: 'access授权', component: { name: 'access-selector', type: 'ssh', }, required: true, }) accessId!: string; @TaskInput({ title: '自动创建远程目录', helper: '是否自动创建远程目录,如果关闭则你需要自己确保远程目录存在', value: true, component: { name: 'a-switch', vModel: 'checked', }, }) mkdirs = true; @TaskInput({ title: 'shell脚本命令', component: { name: 'a-textarea', vModel: 'value', rows: 6, }, helper: '上传后执行脚本命令,不填则不执行\n注意:如果目标主机是windows,且终端是cmd,系统会自动将多行命令通过“&&”连接成一行', required: false, }) script!: string; @TaskInput({ title: '注入环境变量', value: false, component: { name: 'a-switch', vModel: 'checked', }, helper: '是否将证书域名、路径等信息注入脚本执行环境变量中,具体的变量名称,可以运行后从日志中查看', required: false, }) injectEnv!: string; @TaskOutput({ title: '证书保存路径', }) hostCrtPath!: string; @TaskOutput({ title: '私钥保存路径', }) hostKeyPath!: string; @TaskOutput({ title: '中间证书保存路径', }) hostIcPath!: string; @TaskOutput({ title: 'PFX保存路径', }) hostPfxPath!: string; @TaskOutput({ title: 'DER保存路径', }) hostDerPath!: string; @TaskOutput({ title: 'jks保存路径', }) hostJksPath!: string; async onInstance() {} copyFile(srcFile: string, destFile: string) { if (!srcFile || !destFile) { this.logger.warn(`srcFile:${srcFile} 或 destFile:${destFile} 为空,不复制`); return; } const dir = destFile.substring(0, destFile.lastIndexOf('/')); if (!fs.existsSync(dir)) { fs.mkdirSync(dir, { recursive: true }); } fs.copyFileSync(srcFile, destFile); this.logger.info(`复制文件:${srcFile} => ${destFile}`); } async execute(): Promise { const { crtPath, keyPath, cert, accessId } = this; const certReader = new CertReader(cert); const handle = async (opts: CertReaderHandleContext) => { const { tmpCrtPath, tmpKeyPath, tmpDerPath, tmpJksPath, tmpPfxPath, tmpIcPath } = opts; // if (this.copyToThisHost) { // this.logger.info('复制到目标路径'); // this.copyFile(tmpCrtPath, crtPath); // this.copyFile(tmpKeyPath, keyPath); // this.copyFile(tmpIcPath, this.icPath); // this.copyFile(tmpPfxPath, this.pfxPath); // this.copyFile(tmpDerPath, this.derPath); // this.logger.warn('复制到当前主机功能已迁移到 “复制到本机”插件,请尽快换成复制到本机插件'); // return; // } if (accessId == null) { this.logger.error('复制到当前主机功能已迁移到 “复制到本机”插件,请换成复制到本机插件'); return; } const connectConf: SshAccess = await this.accessService.getById(accessId); const sshClient = new SshClient(this.logger); if (!accessId) { throw new Error('主机登录授权配置不能为空'); } this.logger.info('准备上传文件到服务器'); const transports: any = []; if (crtPath) { transports.push({ localPath: tmpCrtPath, remotePath: crtPath, }); this.logger.info(`上传证书到主机:${crtPath}`); } if (keyPath) { transports.push({ localPath: tmpKeyPath, remotePath: keyPath, }); this.logger.info(`上传私钥到主机:${keyPath}`); } if (this.icPath) { transports.push({ localPath: tmpIcPath, remotePath: this.icPath, }); this.logger.info(`上传中间证书到主机:${this.icPath}`); } if (this.pfxPath) { transports.push({ localPath: tmpPfxPath, remotePath: this.pfxPath, }); this.logger.info(`上传PFX证书到主机:${this.pfxPath}`); } if (this.derPath) { transports.push({ localPath: tmpDerPath, remotePath: this.derPath, }); this.logger.info(`上传DER证书到主机:${this.derPath}`); } if (this.jksPath) { transports.push({ localPath: tmpJksPath, remotePath: this.jksPath, }); this.logger.info(`上传jks证书到主机:${this.jksPath}`); } this.logger.info('开始上传文件到服务器'); await sshClient.uploadFiles({ connectConf, transports, mkdirs: this.mkdirs, }); this.logger.info('上传文件到服务器成功'); //输出 this.hostCrtPath = crtPath; this.hostKeyPath = keyPath; this.hostIcPath = this.icPath; this.hostPfxPath = this.pfxPath; this.hostDerPath = this.derPath; this.hostJksPath = this.jksPath; }; await certReader.readCertFile({ logger: this.logger, handle, }); if (this.script && this.script?.trim()) { const connectConf: SshAccess = await this.accessService.getById(accessId); const sshClient = new SshClient(this.logger); this.logger.info('执行脚本命令'); //环境变量 const env = {}; if (this.injectEnv) { const domains = certReader.getAllDomains(); for (let i = 0; i < domains.length; i++) { env[`CERT_DOMAIN_${i}`] = domains[i]; } env['CERT_EXPIRES'] = dayjs(certReader.getCrtDetail().expires).unix(); env['HOST_CRT_PATH'] = this.hostCrtPath || ''; env['HOST_KEY_PATH'] = this.hostKeyPath || ''; env['HOST_IC_PATH'] = this.hostIcPath || ''; env['HOST_PFX_PATH'] = this.hostPfxPath || ''; env['HOST_DER_PATH'] = this.hostDerPath || ''; } const scripts = this.script.split('\n'); await sshClient.exec({ connectConf, script: scripts, env, }); } } } new UploadCertToHostPlugin();