feat: new ca provider: custom acme ca

2025-05-16 21:40:40 +08:00
parent 980d1ee0b9
commit 122d766cab
16 changed files with 206 additions and 40 deletions
--- a/ui/src/components/access/AccessForm.tsx
+++ b/ui/src/components/access/AccessForm.tsx
@@ -12,6 +12,7 @@ import { ACCESS_PROVIDERS, ACCESS_USAGES, type AccessProvider } from "@/domain/p
 import { useAntdForm, useAntdFormName } from "@/hooks";

 import AccessForm1PanelConfig from "./AccessForm1PanelConfig";
+import AccessFormACMECAConfig from "./AccessFormACMECAConfig";
 import AccessFormACMEHttpReqConfig from "./AccessFormACMEHttpReqConfig";
 import AccessFormAliyunConfig from "./AccessFormAliyunConfig";
 import AccessFormAWSConfig from "./AccessFormAWSConfig";
@@ -177,6 +178,8 @@ const AccessForm = forwardRef<AccessFormInstance, AccessFormProps>(({ className,
    switch (fieldProvider) {
      case ACCESS_PROVIDERS["1PANEL"]:
        return <AccessForm1PanelConfig {...nestedFormProps} />;
+      case ACCESS_PROVIDERS.ACMECA:
+        return <AccessFormACMECAConfig {...nestedFormProps} />;
      case ACCESS_PROVIDERS.ACMEHTTPREQ:
        return <AccessFormACMEHttpReqConfig {...nestedFormProps} />;
      case ACCESS_PROVIDERS.ALIYUN:
--- a/ui/src/components/access/AccessFormACMECAConfig.tsx
+++ b/ui/src/components/access/AccessFormACMECAConfig.tsx
@@ -0,0 +1,77 @@
+import { useTranslation } from "react-i18next";
+import { Form, type FormInstance, Input, Select } from "antd";
+import { createSchemaFieldRule } from "antd-zod";
+import { z } from "zod";
+
+import { type AccessConfigForACMECA } from "@/domain/access";
+
+type AccessFormACMECAConfigFieldValues = Nullish<AccessConfigForACMECA>;
+
+export type AccessFormACMECAConfigProps = {
+  form: FormInstance;
+  formName: string;
+  disabled?: boolean;
+  initialValues?: AccessFormACMECAConfigFieldValues;
+  onValuesChange?: (values: AccessFormACMECAConfigFieldValues) => void;
+};
+
+const initFormModel = (): AccessFormACMECAConfigFieldValues => {
+  return {
+    endpoint: "https://example.com/acme/directory",
+  };
+};
+
+const AccessFormACMECAConfig = ({ form: formInst, formName, disabled, initialValues, onValuesChange }: AccessFormACMECAConfigProps) => {
+  const { t } = useTranslation();
+
+  const formSchema = z.object({
+    endpoint: z.string().url(t("common.errmsg.url_invalid")),
+    eabKid: z.string().trim().nullish(),
+    eabHmacKey: z.string().trim().nullish(),
+  });
+  const formRule = createSchemaFieldRule(formSchema);
+
+  const handleFormChange = (_: unknown, values: z.infer<typeof formSchema>) => {
+    onValuesChange?.(values);
+  };
+
+  return (
+    <Form
+      form={formInst}
+      disabled={disabled}
+      initialValues={initialValues ?? initFormModel()}
+      layout="vertical"
+      name={formName}
+      onValuesChange={handleFormChange}
+    >
+      <Form.Item
+        name="endpoint"
+        label={t("access.form.acmeca_endpoint.label")}
+        rules={[formRule]}
+        tooltip={<span dangerouslySetInnerHTML={{ __html: t("access.form.acmeca_endpoint.tooltip") }}></span>}
+      >
+        <Input placeholder={t("access.form.acmeca_endpoint.placeholder")} />
+      </Form.Item>
+
+      <Form.Item
+        name="eabKid"
+        label={t("access.form.acmeca_eab_kid.label")}
+        rules={[formRule]}
+        tooltip={<span dangerouslySetInnerHTML={{ __html: t("access.form.acmeca_eab_kid.tooltip") }}></span>}
+      >
+        <Input autoComplete="new-password" placeholder={t("access.form.acmeca_eab_kid.placeholder")} />
+      </Form.Item>
+
+      <Form.Item
+        name="eabHmacKey"
+        label={t("access.form.acmeca_eab_hmac_key.label")}
+        rules={[formRule]}
+        tooltip={<span dangerouslySetInnerHTML={{ __html: t("access.form.acmeca_eab_hmac_key.tooltip") }}></span>}
+      >
+        <Input.Password autoComplete="new-password" placeholder={t("access.form.acmeca_eab_hmac_key.placeholder")} />
+      </Form.Item>
+    </Form>
+  );
+};
+
+export default AccessFormACMECAConfig;
--- a/ui/src/domain/access.ts
+++ b/ui/src/domain/access.ts
@@ -7,6 +7,7 @@ export interface AccessModel extends BaseModel {
  */ Record<string, unknown> &
    (
      | AccessConfigFor1Panel
+      | AccessConfigForACMECA
      | AccessConfigForACMEHttpReq
      | AccessConfigForAliyun
      | AccessConfigForAWS
@@ -75,6 +76,12 @@ export type AccessConfigFor1Panel = {
  allowInsecureConnections?: boolean;
 };

+export type AccessConfigForACMECA = {
+  endpoint: string;
+  eabKid?: string;
+  eabHmacKey?: string;
+};
+
 export type AccessConfigForACMEHttpReq = {
  endpoint: string;
  mode?: string;
--- a/ui/src/domain/provider.ts
+++ b/ui/src/domain/provider.ts
@@ -5,6 +5,7 @@
 */
 export const ACCESS_PROVIDERS = Object.freeze({
  ["1PANEL"]: "1panel",
+  ACMECA: "acmeca",
  ACMEHTTPREQ: "acmehttpreq",
  ALIYUN: "aliyun",
  AWS: "aws",
@@ -153,6 +154,7 @@ export const accessProvidersMap: Map<AccessProvider["type"] | string, AccessProv
    [ACCESS_PROVIDERS.GOOGLETRUSTSERVICES, "provider.googletrustservices", "/imgs/providers/google.svg", [ACCESS_USAGES.CA]],
    [ACCESS_PROVIDERS.SSLCOM, "provider.sslcom", "/imgs/providers/sslcom.svg", [ACCESS_USAGES.CA]],
    [ACCESS_PROVIDERS.ZEROSSL, "provider.zerossl", "/imgs/providers/zerossl.svg", [ACCESS_USAGES.CA]],
+    [ACCESS_PROVIDERS.ACMECA, "provider.acmeca", "/imgs/providers/acmeca.svg", [ACCESS_USAGES.CA]],

    [ACCESS_PROVIDERS.EMAIL, "provider.email", "/imgs/providers/email.svg", [ACCESS_USAGES.NOTIFICATION]],
    [ACCESS_PROVIDERS.DINGTALKBOT, "provider.dingtalkbot", "/imgs/providers/dingtalk.svg", [ACCESS_USAGES.NOTIFICATION]],
@@ -179,6 +181,7 @@ export const accessProvidersMap: Map<AccessProvider["type"] | string, AccessProv
  NOTICE: If you add new constant, please keep ASCII order.
 */
 export const CA_PROVIDERS = Object.freeze({
+  ACMECA: `${ACCESS_PROVIDERS.ACMECA}`,
  BUYPASS: `${ACCESS_PROVIDERS.BUYPASS}`,
  GOOGLETRUSTSERVICES: `${ACCESS_PROVIDERS.GOOGLETRUSTSERVICES}`,
  LETSENCRYPT: `${ACCESS_PROVIDERS.LETSENCRYPT}`,
@@ -209,6 +212,7 @@ export const caProvidersMap: Map<CAProvider["type"] | string, CAProvider> = new
    [CA_PROVIDERS.GOOGLETRUSTSERVICES],
    [CA_PROVIDERS.SSLCOM],
    [CA_PROVIDERS.ZEROSSL],
+    [CA_PROVIDERS.ACMECA],
  ].map(([type, builtin]) => [
    type,
    {
--- a/ui/src/i18n/locales/en/nls.access.json
+++ b/ui/src/i18n/locales/en/nls.access.json
@@ -44,6 +44,13 @@
  "access.form.1panel_allow_insecure_conns.label": "Insecure SSL/TLS connections",
  "access.form.1panel_allow_insecure_conns.switch.on": "Allow",
  "access.form.1panel_allow_insecure_conns.switch.off": "Disallow",
+  "access.form.acmeca_endpoint.label": "Endpoint",
+  "access.form.acmeca_endpoint.placeholder": "Please enter endpoint",
+  "access.form.acmeca_endpoint.tooltip": "For more information, see <a href=\"https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1\" target=\"_blank\">https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1</a>",
+  "access.form.acmeca_eab_kid.label": "ACME EAB KID (Optional)",
+  "access.form.acmeca_eab_kid.placeholder": "Please enter ACME EAB KID",
+  "access.form.acmeca_eab_hmac_key.label": "ACME EAB HMAC key (Optional)",
+  "access.form.acmeca_eab_hmac_key.placeholder": "Please enter ACME EAB HMAC key",
  "access.form.acmehttpreq_endpoint.label": "Endpoint",
  "access.form.acmehttpreq_endpoint.placeholder": "Please enter endpoint",
  "access.form.acmehttpreq_endpoint.tooltip": "For more information, see <a href=\"https://go-acme.github.io/lego/dns/httpreq/\" target=\"_blank\">https://go-acme.github.io/lego/dns/httpreq/</a>",
--- a/ui/src/i18n/locales/en/nls.provider.json
+++ b/ui/src/i18n/locales/en/nls.provider.json
@@ -2,7 +2,8 @@
  "provider.1panel": "1Panel",
  "provider.1panel.console": "1Panel - Console",
  "provider.1panel.site": "1Panel - Website",
-  "provider.acmehttpreq": "Http Request (ACME Proxy)",
+  "provider.acmeca": "ACME Custom CA Endpoint",
+  "provider.acmehttpreq": "ACME Custom HTTP Endpoint",
  "provider.aliyun": "Alibaba Cloud",
  "provider.aliyun.alb": "Alibaba Cloud - ALB (Application Load Balancer)",
  "provider.aliyun.apigw": "Alibaba Cloud - API Gateway",
--- a/ui/src/i18n/locales/zh/nls.access.json
+++ b/ui/src/i18n/locales/zh/nls.access.json
@@ -44,6 +44,13 @@
  "access.form.1panel_allow_insecure_conns.label": "忽略 SSL/TLS 证书错误",
  "access.form.1panel_allow_insecure_conns.switch.on": "允许",
  "access.form.1panel_allow_insecure_conns.switch.off": "不允许",
+  "access.form.acmeca_endpoint.label": "服务端点",
+  "access.form.acmeca_endpoint.placeholder": "请输入服务端点",
+  "access.form.acmeca_endpoint.tooltip": "这是什么？请参阅 <a href=\"https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1\" target=\"_blank\">https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.1</a>",
+  "access.form.acmeca_eab_kid.label": "ACME EAB KID（可选）",
+  "access.form.acmeca_eab_kid.placeholder": "请输入 ACME EAB KID",
+  "access.form.acmeca_eab_hmac_key.label": "ACME EAB HMAC Key（可选）",
+  "access.form.acmeca_eab_hmac_key.placeholder": "请输入 ACME EAB HMAC Key",
  "access.form.acmehttpreq_endpoint.label": "服务端点",
  "access.form.acmehttpreq_endpoint.placeholder": "请输入服务端点",
  "access.form.acmehttpreq_endpoint.tooltip": "这是什么？请参阅 <a href=\"https://go-acme.github.io/lego/dns/httpreq/\" target=\"_blank\">https://go-acme.github.io/lego/dns/httpreq/</a>",
--- a/ui/src/i18n/locales/zh/nls.provider.json
+++ b/ui/src/i18n/locales/zh/nls.provider.json
@@ -2,7 +2,8 @@
  "provider.1panel": "1Panel",
  "provider.1panel.console": "1Panel - 面板",
  "provider.1panel.site": "1Panel - 网站",
-  "provider.acmehttpreq": "Http Request (ACME Proxy)",
+  "provider.acmeca": "ACME 自定义 CA 端点",
+  "provider.acmehttpreq": "ACME 自定义 HTTP 端点",
  "provider.aliyun": "阿里云",
  "provider.aliyun.alb": "阿里云 - 应用型负载均衡 ALB",
  "provider.aliyun.apigw": "阿里云 - API 网关",