duo_unix

The duo_unix module handles the deployment of duo_unix (login_duo or pam_duo) across a range of Linux distributions. The module will handle repository dependencies, installation of the duo_unix package, configuration of OpenSSH, and PAM alterations as needed.

For further information about duo_unix, view the official documentation.

Table of Contents

1. Description
2. Setup - The basics of getting started with duo_unix
   • What duo_unix affects
   • Setup requirements
   • Beginning with duo_unix
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Contributing

Description

The duo_unix Puppet module installs and manages duo_unix (login_duo or pam_duo).

This module is meant to be a drop-in replacement for the abandoned official puppet module.

Setup

What duo_unix affects

This module will add the official Duo Inc. repository. It will also then install the appropriate package(s) for your system.

It will also optionally alter some files on your system to help ensure that user login attempts will correctly require Duo to succeed.

If usage is set to login, it will set the following directives in /etc/ssh/sshd_config

ForceCommand       /usr/sbin/login_duo
PermitTunnel       no
AllowTcpForwarding no

If usage is set to pam, it will alter your pam config. Those changes are distribution-specific. To see exactly what is changed, please refer to the manifests/pam_config.pp file.

If accept_env_factor is set to yes, it will configure your sshd_config to allow DUO_PASSCODE as an AcceptEnv value to enable out-of-band 2FA in the shell for use cases such as scp. This feature is only possible if usage is set to login.

Setup Requirements

This module requires some additional modules, but it is highly likely that they are already installed on your puppet server. They are as follows:

• puppetlabs/apt 6.0 - 9.0
• puppetlabs/augeas_core 1.0.0 - 2.0.0
• puppetlabs/stdlib 5.0.0 - 10.0.0
• puppetlabs/yumrepo_core 1.0.0 - 2.0.0

Beginning with duo_unix

The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.

Usage

class { 'duo_unix':
  usage             => 'login',
  ikey              => 'your integration key',
  skey              => 'your secret key',
  host              => 'api-yourhost.duosecurity.com',
  motd              => 'yes',
  accept_env_factor => 'no',
  duo_rsyslog       => false, 
}

Notes

• accept_env_factor is set to 'no' by default, but when set to 'yes', enables DUO_PASSCODE as desribed above for out-of-band 2FA
• duo_rsyslog is set to false by default, but when set to true, enables sending duo auth messages to the OS-default auth log (this is also very helpful for simplifying fail2ban config if also used)

Limitations

In the past the official Duo module supported various RedHat derivatives. This module currently only makes minor attempts to support them.

Contributing

Pull requests are welcome, but all code must meet the following requirements

• Is fully tested
  • Note: Unit testing uses the rspec-puppet-augeas Ruby gem, which requires the following local packages (at least in Debian-based environments) to be installed: ruby-augeas augeas-tools augeas-lenses libaugeas-dev
• All tests must pass
• Follows the Puppet language style guide
• All commits must be signed