From 283b150d60070cadb8be3aecc822fa6aadf3b8ed Mon Sep 17 00:00:00 2001 From: Fu Diwei Date: Fri, 18 Apr 2025 17:46:40 +0800 Subject: [PATCH] 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);