silverstripe/webauthn-authenticator

A WebAuthn authenticator that plugs into the silverstripe/mfa module

Installs: 1 008

Dependents: 1

Suggesters: 1

Stars: 1

Watchers: 4

Forks: 1

Open Issues: 2

Type:silverstripe-vendormodule

4.0.0-rc2 2019-08-11 23:06 UTC

README

Build Status Scrutinizer Code Quality codecov SilverStripe supported module

The silverstripe/webauthn-authenticator module provides a Web Authentication (WebAuthn) authentication method for the silverstripe/mfa module, which allows you to use the Web Authentication browser API to provide a second factor for your multi-factor authentication login system.

The WebAuthn protocol supersedes FIDO U2F, while it still supports U2F-only authentication devices.

By default, we expect that this module would be used with multi-platform authenticators such as a Yubikey security key. You may choose to configure the module to support single-platform authenticators such as fingerprint scanners. More information on this can be found in the developer documentation.

Requirements

  • SilverStripe ^4.1
  • silverstripe/mfa ^4.0
  • Yarn, NodeJS (>=10) and npm (for building frontend assets)

Installation

Install with Composer:

composer require silverstripe/webauthn-authenticator ^4.0

For SilverStripe 3.7 support please use silverstripe/webauthn-authenticator ^3.0.

The WebAuthn authenticator module automatically configures itself when installed.

Documentation

For detailed developer and CMS user documentation, see the documentation readme.

License

See License

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

  • Create a new issue
  • Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
  • Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.