https://github.com/voxpupuli/puppet-googleauthenticator

Google-authenticator module for Puppet
https://github.com/voxpupuli/puppet-googleauthenticator

hacktoberfest puppet

Last synced: 4 days ago
JSON representation

Google-authenticator module for Puppet

• Host: GitHub
• URL: https://github.com/voxpupuli/puppet-googleauthenticator
• Owner: voxpupuli
• License: apache-2.0
• Created: 2012-04-19T12:32:41.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T07:36:18.000Z (5 months ago)
• Last Synced: 2024-10-29T14:22:35.862Z (3 months ago)
• Topics: hacktoberfest, puppet
• Language: Puppet
• Homepage: https://forge.puppet.com/puppet/googleauthenticator
• Size: 276 KB
• Stars: 13
• Watchers: 41
• Forks: 19
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
puppet-googleauthenticator

===========================

[![Puppet Forge Version](http://img.shields.io/puppetforge/v/voxpupuli/googleauthenticator.svg)](https://forge.puppetlabs.com/puppet/googleauthenticator)

[![Puppet Forge Downloads](http://img.shields.io/puppetforge/dt/voxpupuli/googleauthenticator.svg)](https://forge.puppetlabs.com/puppet/googleauthenticator)

[![Build Status](https://img.shields.io/travis/voxpupuli/puppet-googleauthenticator/master.svg)](https://travis-ci.org/voxpupuli/puppet-googleauthenticator)

[![Gemnasium](https://img.shields.io/gemnasium/voxpupuli/puppet-googleauthenticator.svg)](https://gemnasium.com/voxpupuli/puppet-googleauthenticator)

[![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)

Google-authenticator module for Puppet.

This module allows to easily deploy google-authenticator two-step authentication for users using the PAM google-authenticator module.

Requirements

------------

* Service['ssh'] must be managed for the node.

Simple example

--------------

    # Setup PAM

    # Only root uses tokens locally, all users need one through SSH

    # Note that key authentication with SSH never requires a token

    googleauthenticator::pam {

      'login': mode => 'root-only';

      'su':    mode => 'root-only';

      'sshd':  mode => 'all-users';

    }

    # Add 2 step verification for a user

    googleauthenticator::user {'root':

      secret_key => 'C6SSDFBBH6P76EDM',

      scratch_codes => ['78905638', '14036415', '77983530', '22071921', '19861182'],

    }

Adding PAM modes

----------------

In order to use the module, you have to setup each PAM module using googleauthenticator::pam. Two values are currently available by default for the mode:

* all-users: All users will be prompted for a token for this PAM module;

* root-only: Only root will be prompted for a token for this PAM module;

* systemwide-users: Google-authenticator files are store in /etc/google-authenticator/${user}/google_authenticator files instead of the home of each user. Use googleauthenticator::user::systemwide to manage the user files. This is useful for users with encrypted home directories.

In the first and third cases, users who have not configured google-authenticator on their account will not be able to authenticate using the given module.

You can setup new modes by adding googleauthenticator::pam::mode definitions, for example:

    googleauthenticator::pam::mode {

      'sysadmin':

        # Only ask for a token if users are in the sysadmin group

        condition => 'user ingroup sysadmin';

      'optional-users':

        # Users with a UID above 1000 don't need a token

        succeed_if => 'uid > 1000',

        # It's ok to not have a ~/.google_authenticator file

        nullok     => true;

    }

    googleauthenticator::pam::mode {['joe','foo']:

      mode => 'sysadmin',

    }

Note

----

Because the PAM module for Google-authenticator currently uses only one file for both configuration and living data (see [ticket #167](http://code.google.com/p/google-authenticator/issues/detail?id=167)), scratch codes that are used get redeployed every time, and current values stored in the ~/.google_authenticator file (such as timestamps for rate limit) get overridden. The cleanest way to handle this would be for the PAM module to use two different files for configuration and living data, but this is currently not possible.

Transfer Notice

---------------

This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).

The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.

Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.

Previously: https://github.com/camptocamp/puppet-googleauthenticator