证书

该开源项目得到社区支持。要报告问题或分享想法，请使用问题；如果您有解决问题的建议，也请提供这些详细信息。此外，使用Pull Request来贡献实际的错误修复或建议的增强功能。我们欢迎并感谢所有贡献。有疑问或想与我们的团队讨论一些问题吗？加入我们的 Slack ！

证书

VCert 是一个 Go 库、SDK 和命令行实用程序，旨在通过使用 Venafi 信任保护平台或 Venafi 控制平面来简化符合企业安全策略的机器身份（也称为 SSL/TLS 证书和密钥）的密钥生成和注册或韦纳菲萤火虫。

请参阅适用于 Venafi 信任保护平台的 VCert CLI 或适用于 Venafi 控制平面的 VCert CLI 或适用于 Venafi Firefly 的 VCert CLI 以开始使用命令行实用程序。

兼容性

VCert 版本使用最新版本的 Trust Protection Platform 进行测试。最新 VCert 版本的一般功能应与 Trust Protection Platform 17.3 或更高版本兼容。自定义字段和实例跟踪需要 TPP 18.2 或更高版本，令牌身份验证需要 TPP 20.1 或更高版本。

开发者设置

1. 根据 https://golang.org/doc/install 配置您的 Go 环境。

2. 验证 GOPATH 环境变量设置是否正确

3. 下载源代码：

   go get github.com/Venafi/vcert/v5

   或 Go 1.13 之前的版本

   git clone https://github.com/Venafi/vcert.git $GOPATH /src/github.com/Venafi/vcert/v5

   启用 go 模块的 Go 1.11 或 go 1.13 及更高版本确保克隆到$GOPATH/src之外

   git clone https://github.com/Venafi/vcert.git

4. 构建适用于 Linux、macOS 和 Windows 的命令行实用程序：

   make build

使用 VCert 将 Venafi 与您的应用程序集成

有关编程使用的代码示例，请查看示例文件夹中的文件。

公共部分

1. 在main.go文件中，进行以下导入声明：

    import (
       "github.com/Venafi/vcert/v5"
       "github.com/Venafi/vcert/v5/pkg/certificate"
       "github.com/Venafi/vcert/v5/pkg/endpoint"
   )

2. 创建类型为&vcert.Config的配置对象，用于指定 Venafi 连接详细信息。解决方案通常设计为从机密库、.ini 文件、环境变量或命令行参数中获取这些详细信息。

注册证书

1. 通过使用配置对象调用 vcert 类的NewClient方法来实例化客户端。
2. 编写&certificate.Request类型的证书请求对象。
3. 通过调用客户端的GenerateRequest方法，生成证书请求的密钥对和CSR。
4. 通过将证书请求对象传递给客户端的RequestCertificate方法来提交请求。
5. 使用请求 ID 通过客户端的RetrieveCertificate方法获取证书。

域的新 TLS 侦听器

1. 使用域列表作为参数调用vcert.Config方法NewListener 。例如("test.example.com:8443", "example.com")
2. 使用获取的net.Listener作为内置http.Serve或其他 https 服务器的参数。

示例处于可以使用以下命令构建/执行它们的状态（在设置稍后讨论的环境变量之后）：

go build -o cli ./example
go test -v ./example -run TestRequestCertificate

使用 Trust Protection Platform 的先决条件

1. 已被授予 WebSDK 访问权限的用户帐户
2. 已向用户授予以下权限的文件夹（区域）： View 、 Read 、 Write 、 Create 、 Revoke （用于撤销操作）和Private Key Read （用于生成 CSR 服务时的拾取操作）
3. 应用于指定文件夹的策略：
   1. Trust Protection Platform 将用于注册 VCert 提交的证书请求的 CA 模板
   2. 组织单位 (OU)、组织 (O)、城市 (L)、州 (ST) 和国家 (C) 的主题 DN 值
   3. 管理类型未锁定或锁定为“注册”
   4. 证书签名请求 (CSR) 生成已解锁或未锁定为“服务生成的 CSR”
   5. 在未锁定或锁定为“否”的应用程序上生成密钥/CSR
   6. （推荐）禁用自动续订设置为“是”
   7. （推荐）密钥位强度设置为 2048 或更高
   8. （推荐）适当分配域白名单策略

按策略分配 CA 模板的要求遵循长期的 V​​enafi 最佳实践，这也满足我们的设计目标，即让 VCert 用户保持简单的证书请求流程。如果您需要能够通过请求指定 CA 模板，您可以使用 TPP REST API，但请注意，这违背了 Venafi 建议。

使用信任保护平台和 Venafi 控制平面进行测试

单元测试：

make test

Trust Protection Platform 和 Venafi Control Plane 的集成测试需要访问这些产品。环境变量用于指定所需的设置，包括凭据。 Venafi 控制平面 API 密钥和区域值片段（即Application Name Issuing Template API Alias ）可在 Web 界面中轻松获得。

 export TPP_URL=https://tpp.venafi.example/vedsdk
export TPP_USER=tpp-user
export TPP_PASSWORD=tpp-password
export TPP_ZONE= ' somesuggested_policy '
export TPP_ZONE_RESTRICTED= ' somelocked_policy '
export TPP_ZONE_ECDSA= ' someecdsa_policy '

make tpp_test

 export CLOUD_URL=https://api.venafi.cloud/v1
export CLOUD_APIKEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLOUD_ZONE= ' My ApplicationPermissive CIT '
export CLOUD_ZONE_RESTRICTED= ' Your ApplicationRestrictive CIT '

make cloud_test

命令行实用程序测试利用 Cucumber 和 Aruba 功能文件。

• 要并行运行所有功能的测试：

  make cucumber

• 仅针对特定功能运行测试：

  make cucumber FEATURE=./features/basic/version.feature

  可用的功能有：

  • basic
  • config
  • enroll
  • format
  • gencsr
  • renew
  • revoke

运行时，这些测试将使用 Ruby 版本的 Cucumber 在自己的 Docker 容器中执行。
已完成的测试运行将报告通过、失败或跳过的测试场景和步骤的数量。

剧本功能

有关该剧本及其构建方式的详细说明，请查看此处：Readme Playbook

为 VCert 做出贡献

Venafi 欢迎开发者社区的贡献。

1. 将其分叉到您的帐户（https://github.com/Venafi/vcert/fork）
2. 克隆你的叉子：

   git clone [email protected]:youracct/vcert.git

3. 创建一个功能分支：

   git checkout -b your-branch-name

4. 实施并测试您的更改
5. 提交您的更改：

   git commit -am ' Added some cool functionality '

6. 推送到分支

   git push origin your-branch-name

7. 在 https://github.com/youracct/vcert/pull/new/your-branch-name 创建新的 Pull 请求

执照

版权所有 © Venafi, Inc. 保留所有权利。

VCert 根据 Apache 许可证 2.0 版获得许可。请参阅许可证以获取完整的许可证文本。

请将问题/意见发送至 [email protected]。