README.md

puppet-sslcert

####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 sslcert
   • What sslcert affects
   • Setup requirements
   • Beginning with sslcert
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. 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 and remove your certificates on Windows machines. It will manage pfx, cer, der, p7b, sst certificates.

##Setup

###What sslcert affects

• Installs certificates into your Windows key stores

###Beginning with sslcert

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

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

To install a certifcate in an alterntative direcotory:

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

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

##Usage

###Classes and Defined Types

####Defined Type: sslcert The primary definition of the sslcert module. This definition will install the certificates into your keystore(s)

Parameters within sslcert: #####password The password for the given certifcate

#####location The location to store intermediate certificates

#####thumbprint The thumbprint used to verify the certifcate

#####store_dir The certifcate store where the certifcate will be installed to

#####root_store The store location for the given certifcation store. Either LocalMachine or CurrentUser

##Reference

###Defintion ####Public Definition

• sslcert: 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.

##Development

###Contributing

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