Forge Home

opendkim

Manage an OpenDKIM configuration

101,660 downloads

1,216 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.3.0 (latest)
  • 0.2.9
  • 0.2.8
  • 0.2.7
  • 0.2.6
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
  • 0.0.9
  • 0.0.8
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Aug 24th 2023
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.8.0 < 7.0.0
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'lvicainne-opendkim', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add lvicainne-opendkim
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install lvicainne-opendkim --version 0.3.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

lvicainne/opendkim — version 0.3.0 Aug 24th 2023

OpenDKIM

Puppet Forge Build Status

Table of Contents

  1. Description
  2. Setup - The basics of getting started 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

  • 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
      publickey: "p=yourPublicKey"
      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

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.2 - Compatible with Puppetfrom 4.8 to newer

  • 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