perf: 支持cloudflare域名

2026-04-15 05:00:52 +08:00 · 2024-06-15 02:17:34 +08:00
parent 368132daae
commit fbb9a47e8f
14 changed files with 206 additions and 106 deletions
--- a/packages/ui/certd-server/src/plugins/plugin-aliyun/dns-provider/aliyun-dns-provider.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-aliyun/dns-provider/aliyun-dns-provider.ts
@@ -120,7 +120,7 @@ export class AliyunDnsProvider extends AbstractDnsProvider{
      throw e;
    }
  }
-  async removeRecord(options: RemoveRecordOptions): Promise<any> {
+  async removeRecord(options: RemoveRecordOptions<any>): Promise<any> {
    const { fullRecord, value, record } = options;
    const params = {
      RegionId: 'cn-hangzhou',
--- a/packages/ui/certd-server/src/plugins/plugin-cloudflare/access.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-cloudflare/access.ts
@@ -6,7 +6,7 @@ import { IsAccess, AccessInput } from '@certd/pipeline';
 */
@IsAccess({
  name: 'cloudflare',
-  title: '授权插件示例',
+  title: 'cloudflare授权',
  desc: '',
 })
 export class CloudflareAccess {
--- a/packages/ui/certd-server/src/plugins/plugin-cloudflare/dns-provider.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-cloudflare/dns-provider.ts
@@ -2,62 +2,118 @@ import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOp
 import { Autowire, HttpClient, ILogger } from "@certd/pipeline";
 import { CloudflareAccess } from "./access";

-// TODO  这里注册一个dnsProvider
+export type CloudflareRecord = {
+  id: string;
+  type: string;
+  name: string;
+  content: string;
+  ttl: number;
+  proxied: boolean;
+  zone_id: string;
+  zone_name: string;
+  created_on: string;
+  modified_on: string;
+};
+
+
+// 这里通过IsDnsProvider注册一个dnsProvider
@IsDnsProvider({
  name: 'cloudflare',
  title: 'cloudflare',
-  desc: 'cloudflare dns provider示例',
+  desc: 'cloudflare dns provider',
+  // 这里是对应的 cloudflare的access类型名称
  accessType: 'cloudflare',
 })
-export class CloudflareDnsProvider extends AbstractDnsProvider{
+export class CloudflareDnsProvider extends AbstractDnsProvider<CloudflareRecord>{
+  // 通过Autowire传递context
  @Autowire()
  logger! : ILogger;
  access!: CloudflareAccess;
  http!: HttpClient;
  async onInstance() {
    //一些初始化的操作
+    // 也可以通过ctx成员变量传递context， 与Autowire效果一样
    this.access = this.ctx.access as CloudflareAccess;
    this.http = this.ctx.http
  }


+  async getZoneId(domain:string){
+    const url = `https://api.cloudflare.com/client/v4/zones?name=${domain}`;
+    const res = await this.doRequestApi(url,null,"get");
+    return res.result[0].id
+  }
+
+
+  private async doRequestApi(url: string,data:any = null,method:string="post") {
+      const res = await this.http.request<any,any>({
+        url,
+        method,
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${this.access.apiToken}`,
+        },
+        data
+      });
+      if (!res.success) {
+        throw new Error(`${JSON.stringify(res.errors)}`);
+      }
+      return res
+  }
+
  /**
-   * curl --request POST \
-   *   --url https://api.cloudflare.com/client/v4/zones/zone_id/dns_records \
-   *   --header 'Content-Type: application/json' \
-   *   --header 'X-Auth-Email: ' \
-   *   --data '{
-   *   "content": "198.51.100.4",
-   *   "name": "example.com",
-   *   "proxied": false,
-   *   "type": "A",
-   *   "comment": "Domain verification record",
-   *   "tags": [
-   *     "owner:dns-team"
-   *   ],
-   *   "ttl": 60
-   * }'
+    * 创建dns解析记录，用于验证域名所有权
   */
-  async createRecord(options: CreateRecordOptions): Promise<any> {
+  async createRecord(options: CreateRecordOptions): Promise<CloudflareRecord> {
+
+    /**
+     * fullRecord: '_acme-challenge.test.example.com',
+     * value: 一串uuid
+     * type: 'TXT',
+     * domain: 'example.com'
+     */
    const { fullRecord, value, type,domain } = options;
    this.logger.info('添加域名解析：', fullRecord, value, type,domain);

-    this.http.post('https://api.cloudflare.com/client/v4/zones/zone_id/dns_records')
+    const zoneId = await this.getZoneId(domain);
+    this.logger.info('获取zoneId成功:',zoneId)

-    //TODO 然后调用接口，创建txt类型的dns解析记录
-    // .. 这里调用对应平台的后台接口
-    const access = this.access;
-    this.logger.debug('access', access);
+    // 给domain下创建txt类型的dns解析记录，fullRecord
+    let url = `https://api.cloudflare.com/client/v4/zones/${zoneId}/dns_records`;
+    const res = await this.doRequestApi(url, {
+        content: value,
+        name: fullRecord,
+        type: type,
+        ttl: 60,
+    })
+    const record = res.result as CloudflareRecord;
+    this.logger.info(`添加域名解析成功:fullRecord=${fullRecord},value=${value}`);
+    this.logger.info(`dns解析记录:${JSON.stringify(record)}`,)
+
+    //本接口需要返回本次创建的dns解析记录，这个记录会在删除的时候用到
+    return record
  }
-  async removeRecord(options: RemoveRecordOptions): Promise<any> {
+
+
+  /**
+   *  删除dns解析记录,清理申请痕迹
+   * @param options
+   */
+  async removeRecord(options: RemoveRecordOptions<CloudflareRecord>): Promise<void> {
    const { fullRecord, value, record } = options;
-    this.logger.info('删除域名解析：', fullRecord, value, record);
-    //TODO 这里调用删除txt dns解析记录接口
-    const access = this.access;
-    this.logger.debug('access', access);
-    this.logger.info('删除域名解析成功:', fullRecord, value);
+    this.logger.info('删除域名解析：', fullRecord, value);
+    if(!record){
+      this.logger.info('record不存在');
+      return
+    }
+    //这里调用删除txt dns解析记录接口
+    const zoneId = record.zone_id;
+    const recordId = record.id;
+    let url = `https://api.cloudflare.com/client/v4/zones/${zoneId}/dns_records/${recordId}`;
+    await this.doRequestApi(url,null,"delete")
+    this.logger.info(`删除域名解析成功:fullRecord=${fullRecord},value=${value}`);
  }
 }

-//TODO 实例化这个provider，将其自动注册到系统中
+//实例化这个provider，将其自动注册到系统中
 new CloudflareDnsProvider();
--- a/packages/ui/certd-server/src/plugins/plugin-demo/access.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-demo/access.ts
@@ -1,4 +1,4 @@
-import { IsAccess, AccessInput } from '@certd/pipeline';
+import { IsAccess, AccessInput, IAccess } from "@certd/pipeline";

 /**
 * 这个注解将注册一个授权配置
@@ -9,7 +9,7 @@ import { IsAccess, AccessInput } from '@certd/pipeline';
  title: '授权插件示例',
  desc: '',
 })
-export class DemoAccess {
+export class DemoAccess implements IAccess{
  /**
   * 授权属性配置
   */
--- a/packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.ts
@@ -1,43 +1,81 @@
 import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions } from "@certd/plugin-cert";
-import { Autowire, ILogger } from "@certd/pipeline";
+import { Autowire, HttpClient, ILogger } from "@certd/pipeline";
 import { DemoAccess } from "./access";

-// TODO  这里注册一个dnsProvider
+
+type DemoRecord = {
+  // 这里定义Record记录的数据结构，跟对应云平台接口返回值一样即可，一般是拿到id就行，用于删除txt解析记录，清理申请痕迹
+  // id:string
+}
+
+// 这里通过IsDnsProvider注册一个dnsProvider
@IsDnsProvider({
-  name: 'demo',
-  title: 'Dns提供商Demo',
-  desc: 'dns provider示例',
-  accessType: 'demo', //这里是对应的access name
+  name: "demo",
+  title: "Dns提供商Demo",
+  desc: "dns provider示例",
+  // 这里是对应的云平台的access类型名称
+  accessType: "demo"
 })
-export class DemoDnsProvider extends AbstractDnsProvider {
+export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
+  // 通过Autowire注入工具对象
  @Autowire()
  access!: DemoAccess;
  @Autowire()
  logger!: ILogger;
+  http!: HttpClient;

  async onInstance() {
-    const access: any = this.access;
-    this.logger.debug('access', access);
+    // 也可以通过ctx成员变量传递context， 与Autowire效果一样
+    this.http = this.ctx.http;
+    this.logger.debug("access", this.access);
    //初始化的操作
    //...
  }


+  /**
+   * 创建dns解析记录，用于验证域名所有权
+   */
  async createRecord(options: CreateRecordOptions): Promise<any> {
-    const { fullRecord, value, type,domain } = options;
-    this.logger.info('添加域名解析：', fullRecord, value, type,domain);
-    //TODO 然后调用接口，创建txt类型的dns解析记录
-    // .. 这里调用对应平台的后台接口
-    const access = this.access;
-    this.logger.debug('access', access);
+    /**
+     * options 参数说明
+     * fullRecord: '_acme-challenge.example.com',
+     * value: 一串uuid
+     * type: 'TXT',
+     * domain: 'example.com'
+     */
+    const { fullRecord, value, type, domain } = options;
+    this.logger.info("添加域名解析：", fullRecord, value, type, domain);
+
+    // 调用创建dns解析记录的对应的云端接口，创建txt类型的dns解析记录
+    // 请根据实际接口情况调用，例如：
+    // const createDnsRecordUrl = "xxx"
+    // const record = this.http.post(createDnsRecordUrl,{
+    //   // 授权参数
+    //   // 创建dns解析记录的参数
+    // })
+    // //返回本次创建的dns解析记录，这个记录会在删除的时候用到
+    // return record
  }
-  async removeRecord(options: RemoveRecordOptions): Promise<any> {
+
+  /**
+   *  删除dns解析记录,清理申请痕迹
+   * @param options
+   */
+  async removeRecord(options: RemoveRecordOptions<DemoRecord>): Promise<void> {
    const { fullRecord, value, record } = options;
-    this.logger.info('删除域名解析：', fullRecord, value, record);
-    //TODO 这里调用删除txt dns解析记录接口
-    const access = this.access;
-    this.logger.debug('access', access);
-    this.logger.info('删除域名解析成功:', fullRecord, value);
+    this.logger.info("删除域名解析：", fullRecord, value, record);
+    //这里调用删除txt dns解析记录接口
+    //请根据实际接口情况调用，例如：
+
+    // const deleteDnsRecordUrl = "xxx"
+    // const res = this.http.delete(deleteDnsRecordUrl,{
+    //   // 授权参数
+    //   // 删除dns解析记录的参数
+    // })
+    //
+
+    this.logger.info("删除域名解析成功:", fullRecord, value);
  }
 }

--- a/packages/ui/certd-server/src/plugins/plugin-huawei/dns-provider/huawei-dns-provider.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-huawei/dns-provider/huawei-dns-provider.ts
@@ -100,7 +100,7 @@ export class HuaweiDnsProvider extends AbstractDnsProvider{
      throw e;
    }
  }
-  async removeRecord(options: RemoveRecordOptions): Promise<any> {
+  async removeRecord(options: RemoveRecordOptions<any>): Promise<any> {
    const { fullRecord, value, record } = options;
    const req: ApiRequestOptions = {
      url: `${this.dnsEndpoint}/v2/zones/${record.zone_id}/recordsets/${record.id}`,
--- a/packages/ui/certd-server/src/plugins/plugin-tencent/dns-provider/dnspod-dns-provider.ts
+++ b/packages/ui/certd-server/src/plugins/plugin-tencent/dns-provider/dnspod-dns-provider.ts
@@ -91,7 +91,7 @@ export class DnspodDnsProvider extends AbstractDnsProvider {
    return ret.record;
  }

-  async removeRecord(options: RemoveRecordOptions) {
+  async removeRecord(options: RemoveRecordOptions<any>) {
    const { fullRecord, value, record } = options;
    const domain = await this.matchDomain(fullRecord);