From 364ceb23997bc9972be2f8d2049c81d1eb7a8b2e Mon Sep 17 00:00:00 2001 From: fondoger Date: Wed, 16 Apr 2025 21:53:19 +0800 Subject: [PATCH 1/3] Fix Azure KeyVault bug --- internal/deployer/providers.go | 11 +-- .../azure-keyvault/azure_keyvault.go | 13 +-- .../azure-keyvault/azure_keyvault.go | 28 +++++- .../azure-keyvault/azure_keyvault_test.go | 87 +++++++++++++++++++ ...eployNodeConfigFormAzureKeyVaultConfig.tsx | 17 ++++ ui/src/i18n/locales/en/nls.common.json | 1 + .../i18n/locales/en/nls.workflow.nodes.json | 3 + ui/src/i18n/locales/zh/nls.common.json | 1 + .../i18n/locales/zh/nls.workflow.nodes.json | 3 + ui/src/utils/validators.ts | 5 ++ 10 files changed, 155 insertions(+), 14 deletions(-) create mode 100644 internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go diff --git a/internal/deployer/providers.go b/internal/deployer/providers.go index c2136d20..f700b213 100644 --- a/internal/deployer/providers.go +++ b/internal/deployer/providers.go @@ -297,11 +297,12 @@ func createDeployer(options *deployerOptions) (deployer.Deployer, error) { switch options.Provider { case domain.DeployProviderTypeAzureKeyVault: deployer, err := pAzureKeyVault.NewDeployer(&pAzureKeyVault.DeployerConfig{ - TenantId: access.TenantId, - ClientId: access.ClientId, - ClientSecret: access.ClientSecret, - CloudName: access.CloudName, - KeyVaultName: maputil.GetString(options.ProviderDeployConfig, "keyvaultName"), + TenantId: access.TenantId, + ClientId: access.ClientId, + ClientSecret: access.ClientSecret, + CloudName: access.CloudName, + KeyVaultName: maputil.GetString(options.ProviderDeployConfig, "keyvaultName"), + CertificateName: maputil.GetString(options.ProviderDeployConfig, "certificateName"), }) return deployer, err diff --git a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go index 4439aa68..c39ed892 100644 --- a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go @@ -22,6 +22,8 @@ type DeployerConfig struct { CloudName string `json:"cloudName,omitempty"` // Key Vault 名称。 KeyVaultName string `json:"keyvaultName"` + // Certificate 名称。 + CertificateName string `json:"certificateName"` } type DeployerProvider struct { @@ -38,11 +40,12 @@ func NewDeployer(config *DeployerConfig) (*DeployerProvider, error) { } uploader, err := uploadersp.NewUploader(&uploadersp.UploaderConfig{ - TenantId: config.TenantId, - ClientId: config.ClientId, - ClientSecret: config.ClientSecret, - CloudName: config.CloudName, - KeyVaultName: config.KeyVaultName, + TenantId: config.TenantId, + ClientId: config.ClientId, + ClientSecret: config.ClientSecret, + CloudName: config.CloudName, + KeyVaultName: config.KeyVaultName, + CertificateName: config.CertificateName, }) if err != nil { return nil, xerrors.Wrap(err, "failed to create ssl uploader") diff --git a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go index 5f6f998a..308cb5d4 100644 --- a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go @@ -3,6 +3,7 @@ import ( "context" "crypto/x509" + "encoding/base64" "fmt" "log/slog" "time" @@ -29,6 +30,8 @@ type UploaderConfig struct { CloudName string `json:"cloudName,omitempty"` // Key Vault 名称。 KeyVaultName string `json:"keyvaultName"` + // Certificate 名称。 + CertificateName string `json:"certificateName,omitempty"` } type UploaderProvider struct { @@ -88,6 +91,11 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe } for _, certItem := range page.Value { + // 如果已经指定了证书名称，则跳过证书名称不匹配的证书 + if u.config.CertificateName != "" && certItem.ID.Name() != u.config.CertificateName { + continue + } + // 先对比证书有效期 if certItem.Attributes == nil { continue @@ -138,16 +146,28 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe } } - // 生成新证书名（需符合 Azure 命名规则） - certName := fmt.Sprintf("certimate-%d", time.Now().UnixMilli()) + certName := u.config.CertificateName + if certName == "" { + // 未指定证书名称时，生成包含timestamp的新证书名（需符合 Azure 命名规则） + certName = fmt.Sprintf("certimate-%d", time.Now().UnixMilli()) + } + + // Azure Key Vault 不支持导入带有Certificiate Chain的PEM证书。 + // Issue Link: https://github.com/Azure/azure-cli/issues/19017 + // 暂时的解决方法是，将 PEM 证书转换成 PFX 格式，然后再导入。 + pfxCert, err := certutil.TransformCertificateFromPEMToPFX(certPem, privkeyPem, "") + if err != nil { + u.logger.Error("failed to transform certificate from PEM to PFX", slog.String("certPem", certPem), slog.String("privkeyPem", privkeyPem)) + return nil, xerrors.Wrap(err, "failed to transform certificate from PEM to PFX") + } // 导入证书 // REF: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/import-certificate/import-certificate importCertificateParams := azcertificates.ImportCertificateParameters{ - Base64EncodedCertificate: to.Ptr(certPem), + Base64EncodedCertificate: to.Ptr(base64.StdEncoding.EncodeToString(pfxCert)), CertificatePolicy: &azcertificates.CertificatePolicy{ SecretProperties: &azcertificates.SecretProperties{ - ContentType: to.Ptr("application/x-pem-file"), + ContentType: to.Ptr("application/x-pkcs12"), }, }, Tags: map[string]*string{ diff --git a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go new file mode 100644 index 00000000..3a8ff985 --- /dev/null +++ b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go @@ -0,0 +1,87 @@ +package azurekeyvault_test + +import ( + "context" + "encoding/json" + "flag" + "fmt" + "os" + "strings" + "testing" + + provider "github.com/usual2970/certimate/internal/pkg/core/uploader/providers/azure-keyvault" +) + +var ( + fInputCertPath string + fInputKeyPath string + fTenantId string + fAccessKeyId string + fSecretAccessKey string + fKeyVaultName string + fCertificateName string +) + +func init() { + argsPrefix := "CERTIMATE_UPLOADER_AZUREKEYVAULT_" + + flag.StringVar(&fInputCertPath, argsPrefix+"INPUTCERTPATH", "", "") + flag.StringVar(&fInputKeyPath, argsPrefix+"INPUTKEYPATH", "", "") + flag.StringVar(&fTenantId, argsPrefix+"TENANTID", "", "") + flag.StringVar(&fAccessKeyId, argsPrefix+"ACCESSKEYID", "", "") + flag.StringVar(&fSecretAccessKey, argsPrefix+"SECRETACCESSKEY", "", "") + flag.StringVar(&fKeyVaultName, argsPrefix+"KEYVAULTNAME", "", "") + flag.StringVar(&fCertificateName, argsPrefix+"CERTIFICATENAME", "", "") +} + +/* +Shell command to run this test: + + go test -v ./azure_keyvault_test.go -args \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_INPUTCERTPATH="/path/to/your-input-cert.pem" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_INPUTKEYPATH="/path/to/your-input-key.pem" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_TENANTID="your-tenant-id" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_ACCESSKEYID="your-app-registration-client-id" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_SECRETACCESSKEY="your-app-registration-client-secret" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_KEYVAULTNAME="your-keyvault-name" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_CERTIFICATENAME="your-certificate-name" +*/ +func TestDeploy(t *testing.T) { + flag.Parse() + + t.Run("Deploy", func(t *testing.T) { + t.Log(strings.Join([]string{ + "args:", + fmt.Sprintf("INPUTCERTPATH: %v", fInputCertPath), + fmt.Sprintf("INPUTKEYPATH: %v", fInputKeyPath), + fmt.Sprintf("TENANTID: %v", fTenantId), + fmt.Sprintf("ACCESSKEYID: %v", fAccessKeyId), + fmt.Sprintf("SECRETACCESSKEY: %v", fSecretAccessKey), + fmt.Sprintf("KEYVAULTNAME: %v", fKeyVaultName), + fmt.Sprintf("CERTIFICATENAME: %v", fCertificateName), + }, "\n")) + + uploader, err := provider.NewUploader(&provider.UploaderConfig{ + TenantId: fTenantId, + ClientId: fAccessKeyId, + ClientSecret: fSecretAccessKey, + KeyVaultName: fKeyVaultName, + CertificateName: fCertificateName, + }) + if err != nil { + t.Errorf("err: %+v", err) + return + } + + fInputCertData, _ := os.ReadFile(fInputCertPath) + fInputKeyData, _ := os.ReadFile(fInputKeyPath) + res, err := uploader.Upload(context.Background(), string(fInputCertData), string(fInputKeyData)) + if err != nil { + t.Errorf("err: %+v", err) + return + } + + sres, _ := json.Marshal(res) + t.Logf("ok: %s", string(sres)) + }) +} diff --git a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx index 91d48cdf..9518fd25 100644 --- a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx +++ b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx @@ -2,9 +2,11 @@ import { useTranslation } from "react-i18next"; import { Form, type FormInstance, Input } from "antd"; import { createSchemaFieldRule } from "antd-zod"; import { z } from "zod"; +import { validAzureKeyVaultCertificateName } from "@/utils/validators"; type DeployNodeConfigFormAzureKeyVaultConfigFieldValues = Nullish<{ keyvaultName: string; + certificateName?: string; }>; export type DeployNodeConfigFormAzureKeyVaultConfigProps = { @@ -33,6 +35,13 @@ const DeployNodeConfigFormAzureKeyVaultConfig = ({ .string({ message: t("workflow_node.deploy.form.azure_keyvault_name.placeholder") }) .nonempty(t("workflow_node.deploy.form.azure_keyvault_name.placeholder")) .trim(), + certificateName: z + .string({ message: t("workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder") }) + .nullish() + .refine((v) =>{ + if (!v) return true; + return validAzureKeyVaultCertificateName(v); + }, t("common.errmsg.azure_keyvault_certificate_name_invalid")), }); const formRule = createSchemaFieldRule(formSchema); @@ -57,6 +66,14 @@ const DeployNodeConfigFormAzureKeyVaultConfig = ({ > + } + > + + ); }; diff --git a/ui/src/i18n/locales/en/nls.common.json b/ui/src/i18n/locales/en/nls.common.json index 0c3cd5df..d72cd687 100644 --- a/ui/src/i18n/locales/en/nls.common.json +++ b/ui/src/i18n/locales/en/nls.common.json @@ -35,6 +35,7 @@ "common.errmsg.port_invalid": "Please enter a valid port", "common.errmsg.ip_invalid": "Please enter a valid IP address", "common.errmsg.url_invalid": "Please enter a valid URL", + "common.errmsg.azure_keyvault_certificate_name_invalid": "Certificate name can only contain letters, numbers, and hyphens (-), with a length limit of 1 to 127 characters", "common.notifier.bark": "Bark", "common.notifier.dingtalk": "DingTalk", diff --git a/ui/src/i18n/locales/en/nls.workflow.nodes.json b/ui/src/i18n/locales/en/nls.workflow.nodes.json index 4ac796b3..d0d88c1e 100644 --- a/ui/src/i18n/locales/en/nls.workflow.nodes.json +++ b/ui/src/i18n/locales/en/nls.workflow.nodes.json @@ -234,6 +234,9 @@ "workflow_node.deploy.form.azure_keyvault_name.label": "Azure KeyVault name", "workflow_node.deploy.form.azure_keyvault_name.placeholder": "Please enter Azure KeyVault name", "workflow_node.deploy.form.azure_keyvault_name.tooltip": "For more information, see https://learn.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates", + "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault certificate name (Optional)", + "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "Please enter Azure KeyVault certificate name", + "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "If not filled in, a default name with a timestamp will be automatically generated.", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "Resource type", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "Please select resource type", "workflow_node.deploy.form.baiducloud_appblb_resource_type.option.loadbalancer.label": "BLB load balancer", diff --git a/ui/src/i18n/locales/zh/nls.common.json b/ui/src/i18n/locales/zh/nls.common.json index fe3a9e06..34a13ead 100644 --- a/ui/src/i18n/locales/zh/nls.common.json +++ b/ui/src/i18n/locales/zh/nls.common.json @@ -35,6 +35,7 @@ "common.errmsg.port_invalid": "请输入正确的端口号", "common.errmsg.ip_invalid": "请输入正确的 IP 地址", "common.errmsg.url_invalid": "请输入正确的 URL 地址", + "common.errmsg.azure_keyvault_certificate_name_invalid": "证书名称只能包含字母、数字和连字符（-），长度限制为 1 到 127 个字符", "common.notifier.bark": "Bark", "common.notifier.dingtalk": "钉钉", diff --git a/ui/src/i18n/locales/zh/nls.workflow.nodes.json b/ui/src/i18n/locales/zh/nls.workflow.nodes.json index 5fcb201d..ea6774e5 100644 --- a/ui/src/i18n/locales/zh/nls.workflow.nodes.json +++ b/ui/src/i18n/locales/zh/nls.workflow.nodes.json @@ -233,6 +233,9 @@ "workflow_node.deploy.form.azure_keyvault_name.label": "Azure KeyVault 名称", "workflow_node.deploy.form.azure_keyvault_name.placeholder": "请输入 Azure KeyVault 名称", "workflow_node.deploy.form.azure_keyvault_name.tooltip": "这是什么？请参阅 https://learn.microsoft.com/zh-cn/azure/key-vault/general/about-keys-secrets-certificates", + "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault 证书名称 （可选）", + "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "请输入 Azure KeyVault 证书名称", + "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "不填写时，会自动生成带时间戳的默认名称。", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "证书替换方式", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "请选择证书替换方式", "workflow_node.deploy.form.baiducloud_appblb_resource_type.option.loadbalancer.label": "替换指定负载均衡器下的全部 HTTPS/SSL 监听的证书", diff --git a/ui/src/utils/validators.ts b/ui/src/utils/validators.ts index 05d43edd..14b49fb7 100644 --- a/ui/src/utils/validators.ts +++ b/ui/src/utils/validators.ts @@ -9,6 +9,11 @@ export const validDomainName = (value: string, { allowWildcard = false }: { allo return re.test(value); }; +export const validAzureKeyVaultCertificateName = (value: string) => { + const re = /^[a-zA-Z0-9-]{1,127}$/; + return re.test(value); +} + export const validEmailAddress = (value: string) => { const re = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/; return re.test(value); From 0004eac764074570e140b1b88641020710e4b8bd Mon Sep 17 00:00:00 2001 From: fondoger Date: Thu, 17 Apr 2025 13:09:21 +0800 Subject: [PATCH 2/3] Modify code according to code suggestions --- .../core/deployer/providers/azure-keyvault/azure_keyvault.go | 4 ++-- .../core/uploader/providers/azure-keyvault/azure_keyvault.go | 1 - .../workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx | 2 +- ui/src/i18n/locales/en/nls.common.json | 1 - ui/src/i18n/locales/en/nls.workflow.nodes.json | 1 + ui/src/i18n/locales/zh/nls.common.json | 1 - ui/src/i18n/locales/zh/nls.workflow.nodes.json | 1 + 7 files changed, 5 insertions(+), 6 deletions(-) diff --git a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go index c39ed892..95daeb7f 100644 --- a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go @@ -22,8 +22,8 @@ type DeployerConfig struct { CloudName string `json:"cloudName,omitempty"` // Key Vault 名称。 KeyVaultName string `json:"keyvaultName"` - // Certificate 名称。 - CertificateName string `json:"certificateName"` + // Certificate 名称，可选。 + CertificateName string `json:"certificateName,omitempty"` } type DeployerProvider struct { diff --git a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go index 308cb5d4..78200571 100644 --- a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go @@ -157,7 +157,6 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe // 暂时的解决方法是，将 PEM 证书转换成 PFX 格式，然后再导入。 pfxCert, err := certutil.TransformCertificateFromPEMToPFX(certPem, privkeyPem, "") if err != nil { - u.logger.Error("failed to transform certificate from PEM to PFX", slog.String("certPem", certPem), slog.String("privkeyPem", privkeyPem)) return nil, xerrors.Wrap(err, "failed to transform certificate from PEM to PFX") } diff --git a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx index 9518fd25..80120fae 100644 --- a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx +++ b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx @@ -41,7 +41,7 @@ const DeployNodeConfigFormAzureKeyVaultConfig = ({ .refine((v) =>{ if (!v) return true; return validAzureKeyVaultCertificateName(v); - }, t("common.errmsg.azure_keyvault_certificate_name_invalid")), + }, t("workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid")), }); const formRule = createSchemaFieldRule(formSchema); diff --git a/ui/src/i18n/locales/en/nls.common.json b/ui/src/i18n/locales/en/nls.common.json index d72cd687..0c3cd5df 100644 --- a/ui/src/i18n/locales/en/nls.common.json +++ b/ui/src/i18n/locales/en/nls.common.json @@ -35,7 +35,6 @@ "common.errmsg.port_invalid": "Please enter a valid port", "common.errmsg.ip_invalid": "Please enter a valid IP address", "common.errmsg.url_invalid": "Please enter a valid URL", - "common.errmsg.azure_keyvault_certificate_name_invalid": "Certificate name can only contain letters, numbers, and hyphens (-), with a length limit of 1 to 127 characters", "common.notifier.bark": "Bark", "common.notifier.dingtalk": "DingTalk", diff --git a/ui/src/i18n/locales/en/nls.workflow.nodes.json b/ui/src/i18n/locales/en/nls.workflow.nodes.json index d0d88c1e..30dc637c 100644 --- a/ui/src/i18n/locales/en/nls.workflow.nodes.json +++ b/ui/src/i18n/locales/en/nls.workflow.nodes.json @@ -237,6 +237,7 @@ "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault certificate name (Optional)", "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "Please enter Azure KeyVault certificate name", "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "If not filled in, a default name with a timestamp will be automatically generated.", + "workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid": "Certificate name can only contain letters, numbers, and hyphens (-), with a length limit of 1 to 127 characters", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "Resource type", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "Please select resource type", "workflow_node.deploy.form.baiducloud_appblb_resource_type.option.loadbalancer.label": "BLB load balancer", diff --git a/ui/src/i18n/locales/zh/nls.common.json b/ui/src/i18n/locales/zh/nls.common.json index 34a13ead..fe3a9e06 100644 --- a/ui/src/i18n/locales/zh/nls.common.json +++ b/ui/src/i18n/locales/zh/nls.common.json @@ -35,7 +35,6 @@ "common.errmsg.port_invalid": "请输入正确的端口号", "common.errmsg.ip_invalid": "请输入正确的 IP 地址", "common.errmsg.url_invalid": "请输入正确的 URL 地址", - "common.errmsg.azure_keyvault_certificate_name_invalid": "证书名称只能包含字母、数字和连字符（-），长度限制为 1 到 127 个字符", "common.notifier.bark": "Bark", "common.notifier.dingtalk": "钉钉", diff --git a/ui/src/i18n/locales/zh/nls.workflow.nodes.json b/ui/src/i18n/locales/zh/nls.workflow.nodes.json index ea6774e5..a06e9c58 100644 --- a/ui/src/i18n/locales/zh/nls.workflow.nodes.json +++ b/ui/src/i18n/locales/zh/nls.workflow.nodes.json @@ -236,6 +236,7 @@ "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault 证书名称 （可选）", "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "请输入 Azure KeyVault 证书名称", "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "不填写时，会自动生成带时间戳的默认名称。", + "workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid": "证书名称只能包含字母、数字和连字符（-），长度限制为 1 到 127 个字符", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "证书替换方式", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "请选择证书替换方式", "workflow_node.deploy.form.baiducloud_appblb_resource_type.option.loadbalancer.label": "替换指定负载均衡器下的全部 HTTPS/SSL 监听的证书", From 283b150d60070cadb8be3aecc822fa6aadf3b8ed Mon Sep 17 00:00:00 2001 From: Fu Diwei Date: Fri, 18 Apr 2025 17:46:40 +0800 Subject: [PATCH 3/3] refactor: re-impl azure keyvault deployer --- .../azure-keyvault/azure_keyvault.go | 119 ++++++++++++++++-- .../azure-keyvault/azure_keyvault.go | 20 +-- .../azure-keyvault/azure_keyvault_test.go | 44 +++---- ...eployNodeConfigFormAzureKeyVaultConfig.tsx | 4 +- .../i18n/locales/en/nls.workflow.nodes.json | 2 +- .../i18n/locales/zh/nls.workflow.nodes.json | 4 +- ui/src/utils/validators.ts | 5 - 7 files changed, 140 insertions(+), 58 deletions(-) diff --git a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go index 95daeb7f..422d39d5 100644 --- a/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/deployer/providers/azure-keyvault/azure_keyvault.go @@ -2,13 +2,23 @@ import ( "context" + "crypto/x509" + "encoding/base64" + "errors" + "fmt" "log/slog" + "github.com/Azure/azure-sdk-for-go/sdk/azcore" + "github.com/Azure/azure-sdk-for-go/sdk/azcore/to" + "github.com/Azure/azure-sdk-for-go/sdk/azidentity" + "github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates" xerrors "github.com/pkg/errors" "github.com/usual2970/certimate/internal/pkg/core/deployer" "github.com/usual2970/certimate/internal/pkg/core/uploader" uploadersp "github.com/usual2970/certimate/internal/pkg/core/uploader/providers/azure-keyvault" + "github.com/usual2970/certimate/internal/pkg/utils/certutil" + azcommon "github.com/usual2970/certimate/internal/pkg/vendors/azure-sdk/common" ) type DeployerConfig struct { @@ -22,13 +32,15 @@ type DeployerConfig struct { CloudName string `json:"cloudName,omitempty"` // Key Vault 名称。 KeyVaultName string `json:"keyvaultName"` - // Certificate 名称，可选。 + // Key Vault 证书名称。 + // 选填。 CertificateName string `json:"certificateName,omitempty"` } type DeployerProvider struct { config *DeployerConfig logger *slog.Logger + sdkClient *azcertificates.Client sslUploader uploader.Uploader } @@ -39,13 +51,17 @@ func NewDeployer(config *DeployerConfig) (*DeployerProvider, error) { panic("config is nil") } + client, err := createSdkClient(config.TenantId, config.ClientId, config.ClientSecret, config.CloudName, config.KeyVaultName) + if err != nil { + return nil, xerrors.Wrap(err, "failed to create sdk client") + } + uploader, err := uploadersp.NewUploader(&uploadersp.UploaderConfig{ - TenantId: config.TenantId, - ClientId: config.ClientId, - ClientSecret: config.ClientSecret, - CloudName: config.CloudName, - KeyVaultName: config.KeyVaultName, - CertificateName: config.CertificateName, + TenantId: config.TenantId, + ClientId: config.ClientId, + ClientSecret: config.ClientSecret, + CloudName: config.CloudName, + KeyVaultName: config.KeyVaultName, }) if err != nil { return nil, xerrors.Wrap(err, "failed to create ssl uploader") @@ -54,6 +70,7 @@ func NewDeployer(config *DeployerConfig) (*DeployerProvider, error) { return &DeployerProvider{ config: config, logger: slog.Default(), + sdkClient: client, sslUploader: uploader, }, nil } @@ -69,13 +86,93 @@ func (d *DeployerProvider) WithLogger(logger *slog.Logger) deployer.Deployer { } func (d *DeployerProvider) Deploy(ctx context.Context, certPem string, privkeyPem string) (*deployer.DeployResult, error) { - // 上传证书到 KeyVault - upres, err := d.sslUploader.Upload(ctx, certPem, privkeyPem) + // 解析证书内容 + certX509, err := certutil.ParseCertificateFromPEM(certPem) if err != nil { - return nil, xerrors.Wrap(err, "failed to upload certificate file") + return nil, err + } + + // 转换证书格式 + certPfx, err := certutil.TransformCertificateFromPEMToPFX(certPem, privkeyPem, "") + if err != nil { + return nil, xerrors.Wrap(err, "failed to transform certificate from PEM to PFX") + } + + if d.config.CertificateName == "" { + // 上传证书到 KeyVault + upres, err := d.sslUploader.Upload(ctx, certPem, privkeyPem) + if err != nil { + return nil, xerrors.Wrap(err, "failed to upload certificate file") + } else { + d.logger.Info("ssl certificate uploaded", slog.Any("result", upres)) + } } else { - d.logger.Info("ssl certificate uploaded", slog.Any("result", upres)) + // 获取证书 + // REF: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/get-certificate/get-certificate + getCertificateResp, err := d.sdkClient.GetCertificate(context.TODO(), d.config.CertificateName, "", nil) + d.logger.Debug("sdk request 'keyvault.GetCertificate'", slog.String("request.certificateName", d.config.CertificateName), slog.Any("response", getCertificateResp)) + if err != nil { + var respErr *azcore.ResponseError + if !errors.As(err, &respErr) || (respErr.ErrorCode != "ResourceNotFound" && respErr.ErrorCode != "CertificateNotFound") { + return nil, xerrors.Wrap(err, "failed to execute sdk request 'keyvault.GetCertificate'") + } + } else { + oldCertX509, err := x509.ParseCertificate(getCertificateResp.CER) + if err == nil { + if certutil.EqualCertificate(certX509, oldCertX509) { + return &deployer.DeployResult{}, nil + } + } + } + + // 导入证书 + // REF: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/import-certificate/import-certificate + importCertificateParams := azcertificates.ImportCertificateParameters{ + Base64EncodedCertificate: to.Ptr(base64.StdEncoding.EncodeToString(certPfx)), + CertificatePolicy: &azcertificates.CertificatePolicy{ + SecretProperties: &azcertificates.SecretProperties{ + ContentType: to.Ptr("application/x-pkcs12"), + }, + }, + Tags: map[string]*string{ + "certimate/cert-cn": to.Ptr(certX509.Subject.CommonName), + "certimate/cert-sn": to.Ptr(certX509.SerialNumber.Text(16)), + }, + } + importCertificateResp, err := d.sdkClient.ImportCertificate(context.TODO(), d.config.CertificateName, importCertificateParams, nil) + d.logger.Debug("sdk request 'keyvault.ImportCertificate'", slog.String("request.certificateName", d.config.CertificateName), slog.Any("request.parameters", importCertificateParams), slog.Any("response", importCertificateResp)) + if err != nil { + return nil, xerrors.Wrap(err, "failed to execute sdk request 'keyvault.ImportCertificate'") + } } return &deployer.DeployResult{}, nil } + +func createSdkClient(tenantId, clientId, clientSecret, cloudName, keyvaultName string) (*azcertificates.Client, error) { + env, err := azcommon.GetCloudEnvironmentConfiguration(cloudName) + if err != nil { + return nil, err + } + clientOptions := azcore.ClientOptions{Cloud: env} + + credential, err := azidentity.NewClientSecretCredential(tenantId, clientId, clientSecret, + &azidentity.ClientSecretCredentialOptions{ClientOptions: clientOptions}) + if err != nil { + return nil, err + } + + endpoint := fmt.Sprintf("https://%s.vault.azure.net", keyvaultName) + if azcommon.IsEnvironmentGovernment(cloudName) { + endpoint = fmt.Sprintf("https://%s.vault.usgovcloudapi.net", keyvaultName) + } else if azcommon.IsEnvironmentChina(cloudName) { + endpoint = fmt.Sprintf("https://%s.vault.azure.cn", keyvaultName) + } + + client, err := azcertificates.NewClient(endpoint, credential, nil) + if err != nil { + return nil, err + } + + return client, nil +} diff --git a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go index 78200571..36af11c7 100644 --- a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go +++ b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault.go @@ -30,8 +30,6 @@ type UploaderConfig struct { CloudName string `json:"cloudName,omitempty"` // Key Vault 名称。 KeyVaultName string `json:"keyvaultName"` - // Certificate 名称。 - CertificateName string `json:"certificateName,omitempty"` } type UploaderProvider struct { @@ -91,11 +89,6 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe } for _, certItem := range page.Value { - // 如果已经指定了证书名称，则跳过证书名称不匹配的证书 - if u.config.CertificateName != "" && certItem.ID.Name() != u.config.CertificateName { - continue - } - // 先对比证书有效期 if certItem.Attributes == nil { continue @@ -146,16 +139,13 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe } } - certName := u.config.CertificateName - if certName == "" { - // 未指定证书名称时，生成包含timestamp的新证书名（需符合 Azure 命名规则） - certName = fmt.Sprintf("certimate-%d", time.Now().UnixMilli()) - } + // 生成新证书名（需符合 Azure 命名规则） + certName := fmt.Sprintf("certimate-%d", time.Now().UnixMilli()) - // Azure Key Vault 不支持导入带有Certificiate Chain的PEM证书。 + // Azure Key Vault 不支持导入带有 Certificiate Chain 的 PEM 证书。 // Issue Link: https://github.com/Azure/azure-cli/issues/19017 // 暂时的解决方法是，将 PEM 证书转换成 PFX 格式，然后再导入。 - pfxCert, err := certutil.TransformCertificateFromPEMToPFX(certPem, privkeyPem, "") + certPfx, err := certutil.TransformCertificateFromPEMToPFX(certPem, privkeyPem, "") if err != nil { return nil, xerrors.Wrap(err, "failed to transform certificate from PEM to PFX") } @@ -163,7 +153,7 @@ func (u *UploaderProvider) Upload(ctx context.Context, certPem string, privkeyPe // 导入证书 // REF: https://learn.microsoft.com/en-us/rest/api/keyvault/certificates/import-certificate/import-certificate importCertificateParams := azcertificates.ImportCertificateParameters{ - Base64EncodedCertificate: to.Ptr(base64.StdEncoding.EncodeToString(pfxCert)), + Base64EncodedCertificate: to.Ptr(base64.StdEncoding.EncodeToString(certPfx)), CertificatePolicy: &azcertificates.CertificatePolicy{ SecretProperties: &azcertificates.SecretProperties{ ContentType: to.Ptr("application/x-pkcs12"), diff --git a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go index 3a8ff985..8ef63a80 100644 --- a/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go +++ b/internal/pkg/core/uploader/providers/azure-keyvault/azure_keyvault_test.go @@ -13,13 +13,13 @@ import ( ) var ( - fInputCertPath string - fInputKeyPath string - fTenantId string - fAccessKeyId string - fSecretAccessKey string - fKeyVaultName string - fCertificateName string + fInputCertPath string + fInputKeyPath string + fTenantId string + fClientId string + fClientSecret string + fCloudName string + fKeyVaultName string ) func init() { @@ -28,10 +28,10 @@ func init() { flag.StringVar(&fInputCertPath, argsPrefix+"INPUTCERTPATH", "", "") flag.StringVar(&fInputKeyPath, argsPrefix+"INPUTKEYPATH", "", "") flag.StringVar(&fTenantId, argsPrefix+"TENANTID", "", "") - flag.StringVar(&fAccessKeyId, argsPrefix+"ACCESSKEYID", "", "") - flag.StringVar(&fSecretAccessKey, argsPrefix+"SECRETACCESSKEY", "", "") + flag.StringVar(&fClientId, argsPrefix+"CLIENTID", "", "") + flag.StringVar(&fClientSecret, argsPrefix+"CLIENTSECRET", "", "") + flag.StringVar(&fCloudName, argsPrefix+"CLOUDNAME", "", "") flag.StringVar(&fKeyVaultName, argsPrefix+"KEYVAULTNAME", "", "") - flag.StringVar(&fCertificateName, argsPrefix+"CERTIFICATENAME", "", "") } /* @@ -41,10 +41,10 @@ Shell command to run this test: --CERTIMATE_UPLOADER_AZUREKEYVAULT_INPUTCERTPATH="/path/to/your-input-cert.pem" \ --CERTIMATE_UPLOADER_AZUREKEYVAULT_INPUTKEYPATH="/path/to/your-input-key.pem" \ --CERTIMATE_UPLOADER_AZUREKEYVAULT_TENANTID="your-tenant-id" \ - --CERTIMATE_UPLOADER_AZUREKEYVAULT_ACCESSKEYID="your-app-registration-client-id" \ - --CERTIMATE_UPLOADER_AZUREKEYVAULT_SECRETACCESSKEY="your-app-registration-client-secret" \ - --CERTIMATE_UPLOADER_AZUREKEYVAULT_KEYVAULTNAME="your-keyvault-name" \ - --CERTIMATE_UPLOADER_AZUREKEYVAULT_CERTIFICATENAME="your-certificate-name" + --CERTIMATE_UPLOADER_AZUREKEYVAULT_CLIENTID="your-app-registration-client-id" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_CLIENTSECRET="your-app-registration-client-secret" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_CLOUDNAME="china" \ + --CERTIMATE_UPLOADER_AZUREKEYVAULT_KEYVAULTNAME="your-keyvault-name" */ func TestDeploy(t *testing.T) { flag.Parse() @@ -55,18 +55,18 @@ func TestDeploy(t *testing.T) { fmt.Sprintf("INPUTCERTPATH: %v", fInputCertPath), fmt.Sprintf("INPUTKEYPATH: %v", fInputKeyPath), fmt.Sprintf("TENANTID: %v", fTenantId), - fmt.Sprintf("ACCESSKEYID: %v", fAccessKeyId), - fmt.Sprintf("SECRETACCESSKEY: %v", fSecretAccessKey), + fmt.Sprintf("CLIENTID: %v", fClientId), + fmt.Sprintf("CLIENTSECRET: %v", fClientSecret), + fmt.Sprintf("CLOUDNAME: %v", fCloudName), fmt.Sprintf("KEYVAULTNAME: %v", fKeyVaultName), - fmt.Sprintf("CERTIFICATENAME: %v", fCertificateName), }, "\n")) uploader, err := provider.NewUploader(&provider.UploaderConfig{ - TenantId: fTenantId, - ClientId: fAccessKeyId, - ClientSecret: fSecretAccessKey, - KeyVaultName: fKeyVaultName, - CertificateName: fCertificateName, + TenantId: fTenantId, + ClientId: fClientId, + ClientSecret: fClientSecret, + CloudName: fCloudName, + KeyVaultName: fKeyVaultName, }) if err != nil { t.Errorf("err: %+v", err) diff --git a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx index 80120fae..6826d277 100644 --- a/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx +++ b/ui/src/components/workflow/node/DeployNodeConfigFormAzureKeyVaultConfig.tsx @@ -2,7 +2,6 @@ import { useTranslation } from "react-i18next"; import { Form, type FormInstance, Input } from "antd"; import { createSchemaFieldRule } from "antd-zod"; import { z } from "zod"; -import { validAzureKeyVaultCertificateName } from "@/utils/validators"; type DeployNodeConfigFormAzureKeyVaultConfigFieldValues = Nullish<{ keyvaultName: string; @@ -40,7 +39,7 @@ const DeployNodeConfigFormAzureKeyVaultConfig = ({ .nullish() .refine((v) =>{ if (!v) return true; - return validAzureKeyVaultCertificateName(v); + return /^[a-zA-Z0-9-]{1,127}$/.test(v); }, t("workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid")), }); const formRule = createSchemaFieldRule(formSchema); @@ -66,6 +65,7 @@ const DeployNodeConfigFormAzureKeyVaultConfig = ({ > + https://learn.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates", "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault certificate name (Optional)", "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "Please enter Azure KeyVault certificate name", - "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "If not filled in, a default name with a timestamp will be automatically generated.", + "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "Leave it blank to use a default name generated by Certimate.", "workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid": "Certificate name can only contain letters, numbers, and hyphens (-), with a length limit of 1 to 127 characters", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "Resource type", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "Please select resource type", diff --git a/ui/src/i18n/locales/zh/nls.workflow.nodes.json b/ui/src/i18n/locales/zh/nls.workflow.nodes.json index a06e9c58..3b553b47 100644 --- a/ui/src/i18n/locales/zh/nls.workflow.nodes.json +++ b/ui/src/i18n/locales/zh/nls.workflow.nodes.json @@ -233,9 +233,9 @@ "workflow_node.deploy.form.azure_keyvault_name.label": "Azure KeyVault 名称", "workflow_node.deploy.form.azure_keyvault_name.placeholder": "请输入 Azure KeyVault 名称", "workflow_node.deploy.form.azure_keyvault_name.tooltip": "这是什么？请参阅 https://learn.microsoft.com/zh-cn/azure/key-vault/general/about-keys-secrets-certificates", - "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault 证书名称 （可选）", + "workflow_node.deploy.form.azure_keyvault_certificate_name.label": "Azure KeyVault 证书名称（可选）", "workflow_node.deploy.form.azure_keyvault_certificate_name.placeholder": "请输入 Azure KeyVault 证书名称", - "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "不填写时，会自动生成带时间戳的默认名称。", + "workflow_node.deploy.form.azure_keyvault_certificate_name.tooltip": "不填写时，将由 Certimate 自动生成证书名称。", "workflow_node.deploy.form.azure_keyvault_certificate_name.errmsg.invalid": "证书名称只能包含字母、数字和连字符（-），长度限制为 1 到 127 个字符", "workflow_node.deploy.form.baiducloud_appblb_resource_type.label": "证书替换方式", "workflow_node.deploy.form.baiducloud_appblb_resource_type.placeholder": "请选择证书替换方式", diff --git a/ui/src/utils/validators.ts b/ui/src/utils/validators.ts index 14b49fb7..05d43edd 100644 --- a/ui/src/utils/validators.ts +++ b/ui/src/utils/validators.ts @@ -9,11 +9,6 @@ export const validDomainName = (value: string, { allowWildcard = false }: { allo return re.test(value); }; -export const validAzureKeyVaultCertificateName = (value: string) => { - const re = /^[a-zA-Z0-9-]{1,127}$/; - return re.test(value); -} - export const validEmailAddress = (value: string) => { const re = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/; return re.test(value);