OpenDKIM

Table of Contents

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

Description

A Puppet module to install and manage OpenDKIM

Setup

What OpenDKIM affects {#what-opendkim-module-affects}

• install OpenDKIM package
• modify the configuration file /etc/opendkim.conf
• add and modify files in /etc/opendkim
• purge /etc/opendkim and /etc/dkim from all unuseful files

Warning : this package will replace all your RSA keys ! Before using it, be sure to add all your keys in Hiera !

Beginning with OpenDKIM

A basic example is as follows:

  class { '::opendkim':
    socket        => 'inet:8891@127.0.0.1',
    trusted_hosts => ['::1','127.0.0.1','localhost'],
    keys          => [
        { 
            domain         => 'mydomain.com',
            selector       => 'default',
            publickey      => 'p=yourPublicKey',
            privatekey     => 'Your Private Key',
            signingdomains => ['*@mydomain.com', '*@subdomain.mydomain.com'],
        }
    ]
  }

Usage

You can also use natively Hiera :

  include ::opendkim

opendkim::socket: 'inet:8891@127.0.0.1'
opendkim::trusted_hosts:
    - '::1'
    - '127.0.0.1'
    - 'localhost'
opendkim::keys:
    - domain: mydomain.com
      selector: default
      hash_algorithms: "sha1256"
      publickey: "p=yourPublicKey"
      publickeyextended: "secondLineofPublicKey"
      privatekey: | 
        -----BEGIN RSA PRIVATE KEY-----
        Your Private Key
        -----END RSA PRIVATE KEY-----
      signingdomains: 
          - '*@mydomain.com'
          - '*@subdomain.mydomain.com'

If you want to use OpenDKIM though a UNIX socket with postfix for example, you should configure the socket like this :

opendkim::socket: 'local:/var/run/opendkim/opendkim.sock'
opendkim::umask: '0111'

Reference

Public Classes

• opendkim

Class: opendkim

A class for installing the OpenDKIM package and manipulate settings in the configuration file.

Attributes

configdir

configfile

keys

gid

group

homedir

uid

umask

user

log_why

package_name

service_ensure

service_enable

service_name

socket

subdomains

sysconfigfile

trusted_hosts

mode

canonicalization

removeoldsignatures

maximum_signed_bytes

trustanchorfile

Limitations

This module has only been tested on my Debian and Centos servers. I can not guarantee for any other Operating System

Development

You are pleased to fork this module and adapt it for you needs. I am open to any Pull Request :-)

Release Notes/Contributors/Etc

v0.3 - Compatible with Puppet from 6.4 to newer

• v0.3.0 Correct a bug about an optional parameter

v0.2 - Compatible with Puppet from 4.8 to 6.3

• v0.2.9 Correct a bug about an optional parameter
• v0.2.8 Add features from Pull Requests
• v0.2.7 Add parameter maximum_signed_bytes
• v0.2.6 Add parameters: mode, canonicalization, removeoldsignatures
• v0.2.5 Make uid and gid not required any more to be defined
• v0.2.4 Correction of the default directory for CentOs : from /etc/dkim to /etc/opendkim
• v0.2.3 Minor changes and corrections about empty values

v0.1 - Compatible with Puppet up to 4.6

• v0.1.2 Virtual version (same as v0.1.0 but with bugfix about requirements and puppet version required)
• v0.1.1 Use newer implementations of Puppet (v4.8 and newer).
• v0.1.0 Replace deprecated stdlib functions with puppet data types
• v0.0.9 Correct some dependencies
• v0.0.8 Closes #1 (SystemD with inline comments)
• v0.0.7 Rename repository
• v0.0.6 Support Umask variabilization in order to use UNIX sockets
• v0.0.5 Add the homedir parameter
• v0.0.4 Ensure the pidfile directory exists
• v0.0.3 Improve some documentation parts
• v0.0.2 Improve some documentation parts
• v0.0.1 First Running version