VCert is a Go library, SDK, and command line utility designed to simplify key generation and enrollment of machine identities (also known as SSL/TLS certificates and keys) that comply with enterprise security policy by using the Venafi Platform or Venafi Cloud.
- Configure your Go environment according to https://golang.org/doc/install.
- Verify that GOPATH environment variable is set correctly
- Download the source code:
go get github.com/Venafi/vcert
git clone https://github.com/Venafi/vcert.git $GOPATH/src/github.com/Venafi/vcert
- Build the command line utilities for Linux, MacOS, and Windows:
For code samples of programmatic use, please review the files in /example.
- In your main.go file, make the following import declarations:
- Create a configuration object of type
&vcert.Configthat specifies the Venafi connection details. Solutions are typically designed to get those details from a secrets vault, .ini file, environment variables, or command line parameters.
- Instantiate a client by calling the
NewClientmethod of the vcert class with the configuration object.
- Compose a certiticate request object of type
- Generate a key pair and CSR for the certificate request by calling the
GenerateRequestmethod of the client.
- Submit the request by passing the certificate request object to the
RequestCertificatemethod of the client.
- Use the request ID to pickup the certificate using the
RetrieveCertificatemethod of the client.
Samples are in a state where you can build/execute them using the following commands (after setting the environment variables discussed later):
go build -o cli ./example go test -v ./example -run TestRequestCertificate
For command line examples, please see the Knowledge Base at support.venafi.com.
Prerequisites for using with Trust Protection Platform
- A user account that has been granted WebSDK Access
- A folder (zone) where the user has been granted the following permissions: View, Read, Write, Create, Revoke (for the revoke action), and Private Key Read (for the pickup action when CSR is service generated)
- Policy applied to the folder which specifies:
- CA Template that Trust Protection Platform will use to enroll certificate requests submitted by VCert
- Subject DN values for Organizational Unit (OU), Organization (O), City (L), State (ST) and Country (C)
- Management Type not locked or locked to 'Enrollment'
- Certificate Signing Request (CSR) Generation not locked or locked to 'Service Generated CSR'
- Generate Key/CSR on Application not locked or locked to 'No'
- (Recommended) Disable Automatic Renewal set to 'Yes'
- (Recommended) Key Bit Strength set to 2048 or higher
- (Recommended) Domain Whitelisting policy appropriately assigned
Testing with Trust Protection Platform and Cloud
Integration tests for Trust Protection Platform and Cloud products require endpoint connection variables:
export VCERT_TPP_URL=https://tpp.venafi.example/vedsdk export VCERT_TPP_USER=tpp-user export VCERT_TPP_PASSWORD=tpp-password export VCERT_TPP_ZONE='some\policy' make tpp_test
export VCERT_CLOUD_URL=https://api.venafi.cloud/v1 export VCERT_CLOUD_APIKEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx export VCERT_CLOUD_ZONE=Default make cloud_test
Command line utility tests make use of Cucumber & Aruba feature files.
- To run tests for all features in parallel:
- To run tests only for a specific feature (e.g. basic, config, enroll, format, gencsr, renew, or revoke):
make cucumber FEATURE=./features/basic/version.feature
When run, these tests will be executed in their own Docker container using the Ruby version of Cucumber.
The completed test run will report on the number of test "scenarios" and "steps" that passed, failed, or were skipped.
Contributing to VCert
- Fork it to your account (https://github.com/Venafi/vcert/fork)
- Clone your fork (
git clone firstname.lastname@example.org:youracct/vcert.git)
- Create a feature branch (
git checkout -b your-branch-name)
- Implement and test your changes
- Commit your changes (
git commit -am 'Added some cool functionality')
- Push to the branch (
git push origin your-branch-name)
- Create a new Pull Request (https://github.com/youracct/vcert/pull/new/working-branch)
- First open source release
Copyright © Venafi, Inc. All rights reserved.
VCert is licensed under the Apache License, Version 2.0. See
LICENSE for the full license text.
Please direct questions/comments to email@example.com.