SoftHSM

Table of Contents

1. Overview
2. Setup - The basics of getting started with dns
   • Setup requirements
   • Beginning with SoftHSM
   • Tokens
3. Reference - An under-the-hood peek at what the module is doing and how
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Overview

Install SoftHSM and manage security tokens

Module Description

Setup

What SoftHSM affects

• installs and manages softhsm2

Setup Requirements

• puppetlabs-stdlib 4.17.0
• icann-tea 0.2.12

Beginning with SoftHSM

install either package with no token

class { '::softhsm': }

Tokens

Add a new token

softhsm::token { 'test'
  pin    => '1111',
  so_pin => '1111',
}

you can also pass tokens directly to the class

class {'::softhsm':
  tokens => {
    'test' => {
      'pin'    => '1111',
      'so_pin' => '1111',
    },
  },
}

Or via hiera

softhsm::tokens:
  test:
    pin: 1111
    so_pin: 1111

Reference

• Public Classes
  • dns
• Public Types
  • softhsm::token

Classes

Public Classes

Class: softhsm

Parameters

• package (String, Default: 'softhsm2'): The SoftHSM package to install
• conf_file (Stdlib::Absolutepath, Default: '/etc/softhsm/softhsm2.conf'): the location of the lof file
• tokendir (Stdlib::Absolutepath, Default: '/var/lib/softhsm/tokens/'): the location of the tokens directory
• objectstore_backend (Enum['file','db'], Default: 'file'): how to stor objects
• log_level (Tea::Syslog_level, Default: 'info'): Syslog level to use
• tokens (Hash[String, Softhsm::Token], Default: {}): tokens to configure
• $user (String, Default: 'root'): owner of the token directory and its sub-directories
• $group (String, Default: 'root'): group owner of the token directory and its sub-directories

Public Types

Type softhsm::token

Parameters

• pin (Pattern[/\d{4,255}/]): user pin to configure
• so_pin (Pattern[/\d{4,255}/]): security office pin to configure

Limitations

This module has been tested on:

• Ubuntu 12.04, 14.04
• FreeBSD 10

Development

Pull requests welcome but please also update documentation and tests.

Contributors

• b4ldr
• btoonk