Files
certd/packages/plugins/plugin-cert/src/plugin/cert-plugin/index.ts

294 lines
7.0 KiB
TypeScript
Raw Normal View History

2023-01-11 20:39:48 +08:00
import { Autowire, HttpClient, IAccessService, IContext, IsTaskPlugin, ITaskPlugin, RunStrategy, TaskInput, TaskOutput } from "@certd/pipeline";
2022-11-08 22:10:42 +08:00
import forge from "node-forge";
import dayjs from "dayjs";
import { AcmeService } from "./acme";
import _ from "lodash";
2022-12-29 23:52:51 +08:00
import { Logger } from "log4js";
2023-01-11 20:39:48 +08:00
import { Decorator } from "@certd/pipeline/src/decorator";
import { DnsProviderDefine, dnsProviderRegistry } from "../../dns-provider";
import fs from "fs";
import os from "os";
export class CertInfo {
2022-11-08 22:10:42 +08:00
crt: string;
key: string;
csr: string;
2023-01-11 20:39:48 +08:00
detail: any;
expires: number;
constructor(opts: { crt: string; key: string; csr: string }) {
this.crt = opts.crt;
this.key = opts.key;
this.csr = opts.csr;
const { detail, expires } = this.getCrtDetail(this.crt);
this.detail = detail;
this.expires = expires.getTime();
}
getCrtDetail(crt: string) {
const pki = forge.pki;
const detail = pki.certificateFromPem(crt.toString());
const expires = detail.validity.notAfter;
return { detail, expires };
}
saveToFile(type: "crt" | "key", path?: string) {
if (path == null) {
//写入临时目录
path = `${os.tmpdir()}/certd/tmp/${Math.floor(Math.random() * 1000000)}/cert.${type}`;
}
fs.writeFileSync(path, this[type]);
return path;
}
}
2022-12-29 23:52:51 +08:00
@IsTaskPlugin({
name: "CertApply",
title: "证书申请",
desc: "免费通配符域名证书申请,支持多个域名打到同一个证书上",
default: {
2022-11-08 22:10:42 +08:00
input: {
2022-12-29 23:52:51 +08:00
renewDays: 20,
forceUpdate: false,
2022-11-08 22:10:42 +08:00
},
2022-12-29 23:52:51 +08:00
strategy: {
runStrategy: RunStrategy.AlwaysRun,
2022-11-08 22:10:42 +08:00
},
2022-12-29 23:52:51 +08:00
},
2022-11-08 22:10:42 +08:00
})
2022-12-29 23:52:51 +08:00
export class CertApplyPlugin implements ITaskPlugin {
@TaskInput({
title: "域名",
component: {
name: "a-select",
vModel: "value",
mode: "tags",
open: false,
},
required: true,
col: {
span: 24,
},
helper:
"支持通配符域名,例如: *.foo.com 、 *.test.handsfree.work\n" +
"支持多个域名、多个子域名、多个通配符域名打到一个证书上域名必须是在同一个DNS提供商解析\n" +
"多级子域名要分成多个域名输入(*.foo.com的证书不能用于xxx.yyy.foo.com\n" +
"输入一个回车之后,再输入下一个",
})
domains!: string;
@TaskInput({
title: "邮箱",
component: {
name: "a-input",
vModel: "value",
},
required: true,
helper: "请输入邮箱",
})
email!: string;
@TaskInput({
title: "DNS提供商",
component: {
name: "pi-dns-provider-selector",
},
required: true,
helper: "请选择dns解析提供商",
})
dnsProviderType!: string;
@TaskInput({
title: "DNS解析授权",
component: {
name: "pi-access-selector",
},
required: true,
helper: "请选择dns解析提供商授权",
})
dnsProviderAccess!: string;
@TaskInput({
title: "更新天数",
component: {
name: "a-input-number",
vModel: "value",
},
required: true,
helper: "到期前多少天后更新证书",
})
renewDays!: number;
@TaskInput({
title: "强制更新",
component: {
name: "a-switch",
vModel: "checked",
},
helper: "是否强制重新申请证书",
})
forceUpdate!: string;
@TaskInput({
title: "CsrInfo",
})
csrInfo: any;
2022-11-08 22:10:42 +08:00
// @ts-ignore
acme: AcmeService;
2022-12-29 23:52:51 +08:00
@Autowire()
logger!: Logger;
@Autowire()
userContext!: IContext;
@Autowire()
accessService!: IAccessService;
@Autowire()
http!: HttpClient;
@Autowire()
pipelineContext!: IContext;
@TaskOutput({
title: "域名证书",
})
cert?: CertInfo;
async onInit() {
2022-11-08 22:10:42 +08:00
this.acme = new AcmeService({ userContext: this.userContext, logger: this.logger });
}
2022-12-29 23:52:51 +08:00
async execute(): Promise<void> {
const oldCert = await this.condition();
2022-11-08 22:10:42 +08:00
if (oldCert != null) {
2022-12-29 23:52:51 +08:00
return this.output(oldCert);
2022-11-08 22:10:42 +08:00
}
2022-12-29 23:52:51 +08:00
const cert = await this.doCertApply();
return this.output(cert);
}
output(cert: any) {
this.cert = cert;
2022-11-08 22:10:42 +08:00
}
/**
*
* @param input
*/
2022-12-29 23:52:51 +08:00
async condition() {
if (this.forceUpdate) {
2022-11-08 22:10:42 +08:00
return null;
}
let oldCert;
try {
oldCert = await this.readCurrentCert();
} catch (e) {
this.logger.warn("读取cert失败", e);
}
if (oldCert == null) {
this.logger.info("还未申请过,准备申请新证书");
return null;
}
2022-12-29 23:52:51 +08:00
const ret = this.isWillExpire(oldCert.expires, this.renewDays);
2022-11-08 22:10:42 +08:00
if (!ret.isWillExpire) {
this.logger.info(`证书还未过期:过期时间${dayjs(oldCert.expires).format("YYYY-MM-DD HH:mm:ss")},剩余${ret.leftDays}`);
return oldCert;
}
this.logger.info("即将过期,开始更新证书");
return null;
}
2022-12-29 23:52:51 +08:00
async doCertApply() {
const email = this["email"];
const domains = this["domains"];
const dnsProviderType = this["dnsProviderType"];
const dnsProviderAccessId = this["dnsProviderAccess"];
2022-11-08 22:10:42 +08:00
const csrInfo = _.merge(
{
country: "CN",
state: "GuangDong",
locality: "ShengZhen",
organization: "CertD Org.",
organizationUnit: "IT Department",
emailAddress: email,
},
2022-12-29 23:52:51 +08:00
this.csrInfo
2022-11-08 22:10:42 +08:00
);
this.logger.info("开始申请证书,", email, domains);
2023-01-11 20:39:48 +08:00
const dnsProviderPlugin = dnsProviderRegistry.get(dnsProviderType);
const DnsProviderClass = dnsProviderPlugin.target;
const dnsProviderDefine = dnsProviderPlugin.define as DnsProviderDefine;
2022-11-08 22:10:42 +08:00
const access = await this.accessService.getById(dnsProviderAccessId);
2023-01-11 20:39:48 +08:00
2022-11-08 22:10:42 +08:00
// @ts-ignore
2023-01-11 20:39:48 +08:00
const dnsProvider: IDnsProvider = new DnsProviderClass();
const context = { access, logger: this.logger, http: this.http };
Decorator.inject(dnsProviderDefine.autowire, dnsProvider, context);
await dnsProvider.onInit();
2022-11-08 22:10:42 +08:00
const cert = await this.acme.order({
email,
domains,
dnsProvider,
csrInfo,
isTest: false,
});
await this.writeCert(cert);
const ret = await this.readCurrentCert();
return {
...ret,
isNew: true,
};
}
formatCert(pem: string) {
pem = pem.replace(/\r/g, "");
pem = pem.replace(/\n\n/g, "\n");
pem = pem.replace(/\n$/g, "");
return pem;
}
async writeCert(cert: { crt: string; key: string; csr: string }) {
const newCert = {
crt: this.formatCert(cert.crt),
key: this.formatCert(cert.key),
csr: this.formatCert(cert.csr),
};
await this.pipelineContext.set("cert", newCert);
}
async readCurrentCert() {
2023-01-11 20:39:48 +08:00
const cert: any = await this.pipelineContext.get("cert");
2022-11-08 22:10:42 +08:00
if (cert == null) {
return undefined;
}
2023-01-11 20:39:48 +08:00
return new CertInfo(cert);
2022-11-08 22:10:42 +08:00
}
/**
* 20
* @param expires
* @param maxDays
* @returns {boolean}
*/
isWillExpire(expires: number, maxDays = 20) {
if (expires == null) {
throw new Error("过期时间不能为空");
}
// 检查有效期
const leftDays = dayjs(expires).diff(dayjs(), "day");
return {
isWillExpire: leftDays < maxDays,
leftDays,
};
}
}
2023-05-09 09:56:31 +08:00
new CertApplyPlugin();