bsdauth

Tested with Travis CI

Table of Contents

  1. Description

  2. Setup - The basics of getting started with bsdauth

  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

This module manages the BSD authentication framework primarily found on OpenBSD. It manages the /etc/login.conf configuration file containing all of the login classes and installs any packages required for additional login styles.

OpenBSD is supported using Puppet 4.4.0 or later.

Setup

Beginning with bsdauth

To maintain the default /etc/login.conf content and login classes, use the following:

include ::bsdauth
include ::bsdauth::authpf
include ::bsdauth::bgpd
include ::bsdauth::pbuild
include ::bsdauth::unbound

Usage

To override the default login classes, (you then must manage all of them):

class { '::bsdauth':
  classes => {
    'auth-defaults' => {
      'capabilities' => [
        'auth=yubikey,passwd',
      ],
      'order'        => '01',
    },
    ...
  },
}

To add an additional login class:

include ::bsdauth
::bsdauth::class { 'example':
  capabilities => [
    'auth=yubikey,passwd',
    'tc=default',
  ],
}

To enable LDAP login support:

include ::bsdauth
include ::bsdauth::ldap
::bsdauth::ldap::class { 'ldap':
  base_dn => 'dc=example,dc=com',
  servers => [
    {
      'hostname' => '192.0.2.1',
    },
  ],
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at bodgit.github.io/puppet-bsdauth/.

Limitations

This module has been built on and tested against Puppet 4.4.0 and higher.

The module has been tested on:

  • OpenBSD 6.2/6.3

Development

The module has both rspec-puppet and beaker-rspec tests. Run them with:

$ bundle exec rake test
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>

Please log issues or pull requests at github.