Forge Home

bsdauth

Puppet Module for managing BSD authentication

12,079 downloads

5,911 latest version

5.0 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

  • 2.0.0 (latest)
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Apr 29th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=4.4.0 <6.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'bodgit-bsdauth', '2.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bodgit-bsdauth
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bodgit-bsdauth --version 2.0.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

bodgit/bsdauth — version 2.0.0 Apr 29th 2018

bsdauth

Tested with Travis CI

Build Status Coverage Status Puppet Forge Dependency Status

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 https://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.