Skip to content

Latest commit

 

History

History
149 lines (99 loc) · 10.3 KB

README.md

File metadata and controls

149 lines (99 loc) · 10.3 KB
Raw

Venafi

VenafiPS - Automate your Venafi TLS Protect Datacenter and Cloud platforms!

Testing Deployment Documentation Status PowerShell Gallery Version PowerShell Gallery

Welcome to VenafiPS (where the PS stands for PowerShell, not Professional Services 😃). Here you will find a PowerShell module to automate Venafi TLS Protect Datacenter (TLSPDC), formerly known as Trust Protection Platform, and TLS Protect Cloud (TLSPC). Please let us know how you are using this module and what we can do to make it better! Ask questions or feel free to submit an issue/enhancement.

Documentation

Documentation can be found at http://VenafiPS.readthedocs.io or by using built-in PowerShell help. Every effort has been made to document each parameter and provide good examples.

Supported Platforms

VenafiPS works on PowerShell v5.1 as well as cross-platform PowerShell on Windows, Linux, and Mac.

Install Module

VenafiPS is published to the PowerShell Gallery. The most recent version is listed in the badge 'powershell gallery' above and can be viewed by clicking on it. To install the module, you need to have PowerShell installed first. On Windows, Windows PowerShell (v5.x) will already be installed, but is recommended to install the latest version of cross-platform PowerShell. For Linux or macOS, you will need to install PowerShell; follow those links for guidance. Once PowerShell is installed, start a PowerShell prompt and execute Install-Module -Name VenafiPS which will install from the gallery.

⚠️ If using an older operating system, eg. Windows Server 2016, and you receive errors downloading/installing nuget when attempting to install VenafiPS, your SSL/TLS version is most likely at the default and will not work. Execute the following before installing the module,

[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12

Additional Modules

  • If running on Windows with PowerShell v5, multithreading is supported with Microsoft.PowerShell.ThreadJob, a Microsoft PowerShell module. Install this for increased performance on the functions that support it. Version 2.1.0 has been tested.
  • There are a few TLSPC functions which require Sodium encryption. These functions require the PSSodium module be installed from the PowerShell Gallery. Also for those functions, on Windows, the latest C++ runtime must be installed. Version 0.4.2 has been tested.

Usage

As the module supports both TLSPDC and TLSPC, you will note different names for the functions. Functions with -Vdc are for TLSPDC only, -Vc are for TLSPC only, and -Venafi are for both. You can easily see the available commands for each platform with

Get-Command -Module VenafiPS -Name '*-Vdc*' # for TLSPDC functions
Get-Command -Module VenafiPS -Name '*-Vc*' # for TLSPC functions

For TLSPDC, token based authentication must be setup and configured.

Interactive Session

For an interactive session, we want to create a Venafi session which will hold the details needed for future operations. Start a new PowerShell prompt (even if you have one from the install-module step) and create a new VenafiPS session with:

# username/password for TLSPDC.  TLSPC uses any value for username and your api key for the password
$cred = Get-Credential

# create a session for TLSPDC
New-VenafiSession -Server 'venafi.mycompany.com' -Credential $cred -ClientId 'MyApp' -Scope @{'certificate'='manage'}

# create a session for TLSPC (your API key can be found in your user profile -> preferences)
New-VenafiSession -VcKey $cred

The above will create a session variable named $VenafiSession which will be used by default in other functions.

View the help on all the ways you can create a new Venafi session with

help New-VenafiSession -full

To utilize the SecretManagement vault functionality, ensure you complete the setup below.

Automated Scenarios

For non-interactive usage including ci/cd, the module can be used without creating a session. For all functions, you can substitute a VenafiSession object with either a TLSPDC token or TLSPC key, eg. -VenafiSession 'e9fe8860-a4c5-427f-bece-18204b04ac85'. You can also provide these as environment variables, VDC_TOKEN or VC_KEY. If providing a TLSPDC token, either as the value for -VenafiSession or as an environment variable, a server environment variable, VDC_SERVER, must also be set.

TLSPDC Examples

One of the easiest ways to get started is to use Find-VdcObject:

$allPolicy = Find-VdcObject -Path '\ved\policy' -Recursive

This will return all objects in the Policy folder. You can also search from the root folder, \ved.

To find a certificate object, not retrieve an actual certificate, use:

$cert = Find-VdcCertificate -First 1

Check out the parameters for Find-VdcCertificate as there's an extensive list to search on.

Now you can take that certificate object and find all log entries associated with it:

$cert | Read-VdcLog

To perform many of the core certificate actions, we will use Invoke-VdcCertificateAction. For example, to create a new session and renew a certificate, use the following:

New-VenafiSession -Server 'venafi.mycompany.com' -Credential $cred -ClientId 'MyApp' -Scope @{'certificate'='manage'}
Invoke-VdcCertificateAction -CertificateId '\VED\Policy\My folder\app.mycompany.com' -Renew

You can also find and perform an action on mutliple objects. In this example we find all certificates expriring in the next 30 days and renew them

Find-VdcCertificate -ExpireBefore (Get-Date).AddDays(30) -ExpireAfter (Get-Date) | Invoke-VdcCertificateAction -Renew

You can also have multiple sessions at once, either to the same server with different credentials or different servers. This can be helpful to determine the difference between what different users can access or perhaps compare folder structures across environments. The below will compare the objects one user can see vs. another.

# assume you've created 1 session already as shown above...

$user2Cred = Get-Credential # specify credentials for a different/limited user

# get a session as user2 and save the session in a variable
$user2Session = New-VenafiSession -ServerUrl 'https://venafi.mycompany.com' -Credential $user2Cred -PassThru

# get all objects in the Policy folder for the first user
$all = Find-VdcObject -Path '\ved\policy' -Recursive

# get all objects in the Policy folder for user2
$all2 = Find-VdcObject -Path '\ved\policy' -Recursive -VenafiSession $user2Session

Compare-Object -ReferenceObject $all -DifferenceObject $all2 -Property Path

TLSPC Examples

Most of the same functionality from the above examples exist for TLSPC as well. Simply replace -Vdc with -Vc.

Token/Key Secret Storage

To securely store and retrieve secrets, VenafiPS has added support for the PowerShell SecretManagement module. This can be used to store your access tokens, refresh tokens, or vaas key. To use this feature, a vault will need to be created. You can use SecretStore provided by the PowerShell team or any other vault type. All of this functionality has been added to New-VenafiSession. To prepare your environment, execute the following:

  • Install-Module Microsoft.PowerShell.SecretManagement
  • Install-Module Microsoft.PowerShell.SecretStore or whichever vault you would like to use
  • Register-SecretVault -Name VenafiPS -ModuleName Microsoft.PowerShell.SecretStore. If you are using a different vault type, replace the value for -ModuleName.
  • If using the vault Microsoft.PowerShell.SecretStore, execute Set-SecretStoreConfiguration -Authentication None -Confirm:$false. Note, although the vault authentication is set to none, this just turns off the password required to access the vault, it does not mean your secrets are not encrypted. This is required for automation purposes. If using a different vault type, ensure you turn off any features which inhibit automation.
  • Check out the help for New-VenafiSession for the many ways you can store and retrieve secrets from the vault, but the easiest way to get started is:
    • New-VenafiSession -Server my.venafi.com -Credential $myCred -ClientId MyApp -Scope $scope -VaultRefreshTokenName tlspdc-token. This will create a new token based session and store the refresh token in the vault. The server and clientid will be stored with the refresh token as metadata. Scope does not need to be stored as it is inherent in the token.
    • To create a new session going forward, New-VenafiSession -VaultRefreshTokenName tlspdc-token. This will retrieve the refresh token and associated metadata from the vault, retrieve a new access token based on that refresh token and create a new session.

Note, extension vaults are registered to the current logged in user context, and will be available only to that user (unless also registered to other users).

Contributing

Please feel free to log an issue for any new features you would like, bugs you come across, or just simply a question. We are happy to have people contribute to the codebase as well.