firesphere/yubiauth

Enable authentication with a Yubikey

Thursday, May 24, 2018
by Firesphere
Repository
1 Watchers
4 Stars
118 Installations

PHP
0 Dependents
1 Suggesters
2 Forks
1 Open issues
21 Versions
4 % Grown

The README.md

status

, _(*1)

WARNING

Current SS4 branch is broken, based on the refactoring of authentication inside the core., _(*2)

Until that refactor is completed, the SS4 version of this module will not work properly., _(*3)

Usage

Install the module using composer:, _(*4)

composer require firesphere\yubiauth

Configuration

Configure your ClientID and API key in your environment file., _(*5)

define('YUBIAUTH_CLIENTID', '1234');
define('YUBIAUTH_APIKEY', 'apikeyfromyubico');  // https://upgrade.yubico.com/getapikey');

Options

Optionally, configure your own URL endpoint in your YML file:, _(*6)

YubikeyAuthenticator:
    AuthURL: 'https://my-auth-url.com'

Note of caution

If you use your own Yubikey Authentication server, any One Time Password sent to that will not be invalid on the public Yubico API's, _(*7)

To disable the existing MemberAuthenticator, add the following to your _config.php:, _(*8)

Authenticator::unregister_authenticator('MemberAuthenticator');

This is not a good idea to do on a dev environment ;), _(*9)

Configuration

The amount of days, or total amount of logins without Yubikey, are set in the config.yml. You can override it in your mysite config with the following setting:, _(*10)

Firesphere\YubiAuth\YubikeyAuthenticator:
  MaxNoYubiLogin: 25
  MaxNoYubiLoginDays: 5

Requirements:

SilverStripe CMS 3.2 or higher
SilverStripe Framework 3.2 or higher
enygma/yubikey master

Test your yubikey

https://demo.yubico.com/, _(*11)

Actual license

This module is published under BSD 3-clause license, although these are not in the actual classes, the license does apply:, _(*12)

http://www.opensource.org/licenses/BSD-2-Clause, _(*13)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:, _(*16)

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE., _(*17)

Did you read this entire readme? You rock!

Pictured below is a cow, just for you., _(*18)


               /( ,,,,, )\
              _\,;;;;;;;,/_
           .-"; ;;;;;;;;; ;"-.
           '.__/`_ / \ _`\__.'
              | (')| |(') |
              | .--' '--. |
              |/ o     o \|
              |           |
             / \ _..=.._ / \
            /:. '._____.'   \
           ;::'    / \      .;
           |     _|_ _|_   ::|
         .-|     '==o=='    '|-.
        /  |  . /       \    |  \
        |  | ::|         |   | .|
        |  (  ')         (.  )::|
        |: |   |;  U U  ;|:: | `|
        |' |   | \ U U / |'  |  |
        ##V|   |_/`"""`\_|   |V##
           ##V##         ##V##

The Versions

24/05 2018

dev-master

9999999-dev

Enable authentication with a Yubikey

silverstripe-vendormodule yubiauth

Enable authentication with a Yubikey

firesphere/yubiauth

The README.md

status

WARNING

Usage

Configuration

Options

Note of caution

Configuration

Requirements:

Test your yubikey

Actual license

Did you read this entire readme? You rock!

The Versions

dev-master

The Requires

The Development Requires

by Simon Erkelens

by Simon `Firesphere` Erkelens

dev-ss3

The Requires

by Simon Erkelens

2.2.0

The Requires

The Development Requires

by Simon `Firesphere` Erkelens

2.1

The Requires

The Development Requires

by Simon `Firesphere` Erkelens

dev-ss4

The Requires

The Development Requires

by Simon Erkelens

by Simon `Firesphere` Erkelens

dev-mfa-base

The Requires

The Development Requires

by Simon `Firesphere` Erkelens

2.0.1

The Requires

The Development Requires

by Simon `Firesphere` Erkelens

2.0

The Requires

The Development Requires

by Simon `Firesphere` Erkelens

dev-develop

The Requires

by Simon Erkelens

1.1.4

The Requires

by Simon Erkelens

1.1.3

The Requires

by Simon Erkelens

1.1.2

The Requires

by Simon Erkelens

dev-release/1.1.2

The Requires

by Simon Erkelens

1.1.1

The Requires

by Simon Erkelens

dev-release/1.1.1

The Requires

by Simon Erkelens

1.1.0

The Requires

by Simon Erkelens

dev-release/1.1.0

The Requires

by Simon Erkelens

1.0.1

The Requires

by Simon Erkelens

dev-release/1.0.1