SSL Certificate module for Puppet

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with sslcertificate
   • What sslcertificate affects
   • Beginning with sslcertificate
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. License
8. Development - Guide for contributing to the module

Overview

Small defined type that will allow you to manage Windows certificates.

Module Description

A module that will allow you to install your certificates on Windows machines. It will manage pfx, cer, der, p7b, sst certificates.

Setup

What sslcertificate affects

• Installs certificates into your Windows key stores

Beginning with sslcertificate

To install a certificate in the My directory of the LocalMachine root store:

    sslcertificate { "Install-PFX-Certificate" :
      name       => 'mycert.pfx',
      password   => 'password123',
      location   => 'C:\',
      thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
    }

To install a certificate in an alternative directory:

    sslcertificate { "Install-Intermediate-Certificate" :
      name       => 'go_daddy_intermediate.p7b',
      location   => 'C:\',
      store_dir  => 'CA',
      root_store => 'LocalMachine',
      thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
    }

To install a certificate in the My directory of the LocalMachine root store and set the key as not exportable:

    sslcertificate { "Install-PFX-Certificate" :
      name           => 'mycert.pfx',
      password       => 'password123',
      location       => 'C:',
      thumbprint     => '07E5C1AF7F5223CB975CC29B5455642F5570798B',
      exportable  => false
  }

For more details on the different options available with certificate management directories, see Windows Dev Center.

Usage

Classes and Defined Types

Defined Type: sslcertificate

The primary definition of the sslcertificate module. This definition will install the certificates into your keystore(s).

Parameters within sslcertificate:

password

The password for the given certificate

location

The location where the file certificate is. Do not end the string with any forward or backslash. Note that in puppet manifests, double-backslashes must be re-doubled, even in single-quoted strings, e.g.

    sslcertificate { "Install-PFX-Certificate from UNC path" :
      name       => 'mycert.pfx',
      password   => 'password123',
      location   => '\\\\StorageServer\Fileshare',
      thumbprint => '07E5C1AF7F5223CB975CC29B5455642F5570798B'
    }

thumbprint

The thumbprint used to verify the certificate

store_dir

The certifcate store where the certificate will be installed to

root_store

The store location for the given certification store. Either LocalMachine or CurrentUser

scripts_dir

This parameter has been deprecated and isn't used anymore. The scripts aren't saved to disk anymore.

exportable

Flag to set the key as exportable. true == exportable; false == not exportable. By default is set to true.

wildcard

Flag to set the MachineKeySet flag in import, used for importing wildcard certificates. Defaults to false

interstore

If this is set to true, any intermediate certificates included will be imported in the same store_dir, not the intermediate store. Defaults to false

Reference

Definition

Public Definition

• sslcertificate: Guides the installation of certificates

Limitations

This module is tested on the following platforms:

• Windows 2008 R2

It is tested with the OSS version of Puppet only.

License

This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL Licensing.

Development

Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.

Transfer notice

This module was previously maintained by Vox Pupuli. It was migrated to Puppet/Perforce in 2023.