github.com/Venafi/vcert/v5@v5.10.2/README.md

[![Venafi](https://raw.githubusercontent.com/Venafi/.github/master/images/Venafi_logo.png)](https://www.venafi.com/)
[![Apache 2.0 License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Community Supported](https://img.shields.io/badge/Support%20Level-Community-brightgreen)
![Compatible with TPP 17.3+ & VCP & Firefly](https://img.shields.io/badge/Compatibility-TPP%2017.3+%20%26%20VCP%20%26%20Firefly-f9a90c)  
_**This open source project is community-supported.** To report a problem or share an idea, use
**[Issues](../../issues)**; and if you have a suggestion for fixing the issue, please include those details, too.
In addition, use **[Pull Requests](../../pulls)** to contribute actual bug fixes or proposed enhancements.
We welcome and appreciate all contributions. Got questions or want to discuss something with our team?
**[Join us on Slack](https://join.slack.com/t/venafi-integrations/shared_invite/zt-i8fwc379-kDJlmzU8OiIQOJFSwiA~dg)**!_

# VCert

[![GoDoc](https://godoc.org/github.com/Venafi/vcert?status.svg)](https://pkg.go.dev/github.com/Venafi/vcert)
[![Go Report Card](https://goreportcard.com/badge/github.com/Venafi/vcert)](https://goreportcard.com/report/github.com/Venafi/vcert)
[![Used By](https://sourcegraph.com/github.com/Venafi/vcert/-/badge.svg)](https://sourcegraph.com/github.com/Venafi/vcert?badge)

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 Trust Protection Platform](https://www.venafi.com/platform/trust-protection-platform) 
or [Venafi Control Plane](https://www.venafi.com/venaficloud) or [Venafi Firefly](https://venafi.com/firefly/).

See [VCert CLI for Venafi Trust Protection Platform](README-CLI-PLATFORM.md) or
[VCert CLI for Venafi Control Plane](README-CLI-CLOUD.md) or [VCert CLI for Venafi Firefly](README-CLI-FIREFLY.md) 
to get started with the command line utility.

#### Compatibility

VCert releases are tested using the latest version of Trust Protection Platform. General functionality of the
[latest VCert release](../../releases/latest) should be compatible with Trust Protection Platform 17.3 or higher.
Custom Fields and Instance Tracking require TPP 18.2 or higher, and Token Authentication requires TPP 20.1 or higher.

## Developer Setup

1. Configure your Go environment according to https://golang.org/doc/install.
2. Verify that GOPATH environment variable is set correctly
3. Download the source code:
   ```sh
   go get github.com/Venafi/vcert/v5
   ```
   
   or pre Go 1.13

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

   Go 1.11 with go modules enabled or go 1.13 and up make sure to clone outside of `$GOPATH/src`
   ```sh
   git clone https://github.com/Venafi/vcert.git
   ```

4. Build the command line utilities for Linux, macOS, and Windows:
   ```sh
   make build
   ```

## Using VCert to integrate Venafi with your application

For code samples of programmatic use, please review the files in [examples folder](./examples).

### Common part
1. In your `main.go` file, make the following import declarations:  
   ```golang
   import (
       "github.com/Venafi/vcert/v5"
       "github.com/Venafi/vcert/v5/pkg/certificate"
       "github.com/Venafi/vcert/v5/pkg/endpoint"
   )
   ```
2. Create a configuration object of type `&vcert.Config` that 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.

### Enroll certificate
1. Instantiate a client by calling the `NewClient` method of the vcert class with the configuration object.
2. Compose a certificate request object of type `&certificate.Request`.
3. Generate a key pair and CSR for the certificate request by calling the `GenerateRequest` method of the client.
4. Submit the request by passing the certificate request object to the `RequestCertificate` method of the client.
5. Use the request ID to pickup the certificate using the `RetrieveCertificate` method of the client.

### New TLS listener for domain
1. Call `vcert.Config` method `NewListener` with list of domains as arguments. 
For example `("test.example.com:8443", "example.com")`
2. Use gotten `net.Listener` as argument to built-in `http.Serve` or other https servers. 

Samples are in a state where you can build/execute them using the following commands (after setting the environment 
variables discussed later):
```sh
go build -o cli ./example
go test -v ./example -run TestRequestCertificate
```

## Prerequisites for using with Trust Protection Platform

1. A user account that has been granted WebSDK Access
2. 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)
3. Policy applied to the folder which specifies:
    1. CA Template that Trust Protection Platform will use to enroll certificate requests submitted by VCert
    2. Subject DN values for Organizational Unit (OU), Organization (O), City (L), State (ST) and Country (C)
    3. Management Type not locked or locked to 'Enrollment'
    4. Certificate Signing Request (CSR) Generation unlocked or not locked to 'Service Generated CSR'
    5. Generate Key/CSR on Application not locked or locked to 'No'
    6. (Recommended) Disable Automatic Renewal set to 'Yes'
    7. (Recommended) Key Bit Strength set to 2048 or higher
    8. (Recommended) Domain Whitelisting policy appropriately assigned

The requirement for the CA Template to be assigned by policy follows a long-standing Venafi best practice 
which also met our design objective to keep the certificate request process simple for VCert users. 
If you require the ability to specify the CA Template with the request you can use the TPP REST APIs 
but please be advised this goes against Venafi recommendations.

## Testing with Trust Protection Platform and Venafi Control Plane

Unit tests:
```sh
make test
```

Integration tests for Trust Protection Platform and Venafi Control Plane require access to those products. Environment 
variables are used to specify required settings including credentials.  The Venafi Control Plane API key and zone value
fragments (i.e. `Application Name`\\`Issuing Template API Alias`) are readily available in the web interface.

```sh
export TPP_URL=https://tpp.venafi.example/vedsdk
export TPP_USER=tpp-user
export TPP_PASSWORD=tpp-password
export TPP_ZONE='some\suggested_policy'
export TPP_ZONE_RESTRICTED='some\locked_policy'
export TPP_ZONE_ECDSA='some\ecdsa_policy'

make tpp_test
```

```sh
export CLOUD_URL=https://api.venafi.cloud/v1
export CLOUD_APIKEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLOUD_ZONE='My Application\Permissive CIT'
export CLOUD_ZONE_RESTRICTED='Your Application\Restrictive CIT'

make cloud_test
```

Command line utility tests make use of [Cucumber & Aruba](https://github.com/cucumber/aruba) feature files.

- To run tests for all features in parallel:
   ```sh
   make cucumber
   ```
  
- To run tests only for a specific feature:
  ```sh
  make cucumber FEATURE=./features/basic/version.feature
  ```
  Available features are: 
  - `basic`
  - `config`
  - `enroll`
  - `format`
  - `gencsr`
  - `renew`
  - `revoke`

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. 

## Playbook functionality

For detailed explanations about the playbook and how it is build please check here: [Readme Playbook](./README-PLAYBOOK.md)

## Contributing to VCert

Venafi welcomes contributions from the developer community.

1. Fork it to your account (https://github.com/Venafi/vcert/fork)
2. Clone your fork:
   ```sh
   git clone git@github.com:youracct/vcert.git
   ```
3. Create a feature branch:
   ```sh
   git checkout -b your-branch-name
   ```
4. Implement and test your changes
5. Commit your changes:
   ```sh
   git commit -am 'Added some cool functionality'
   ```
6. Push to the branch
   ```sh
   git push origin your-branch-name
   ```
7. Create a new Pull Request at https://github.com/youracct/vcert/pull/new/your-branch-name

## License

Copyright © Venafi, Inc. All rights reserved.

VCert is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.

Please direct questions/comments to opensource@venafi.com.