Skip to content
A Web Authentication (WebAuthn) authenticator for silverstripe/silverstripe-mfa
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx Add Transifex configuration and run text collector Jul 1, 2019
_config
client FIX Look for HTTPS in frontend availability check before WebAuthn API… Jul 1, 2019
docs/en
lang Add Transifex configuration and run text collector Jul 1, 2019
src Update interface elements to match designs Jul 1, 2019
tests Update interface elements to match designs Jul 1, 2019
.editorconfig Add module structure for SilverStripe 4 Mar 7, 2019
.eslintrc.js Add module structure for SilverStripe 4 Mar 7, 2019
.gitattributes Add module structure for SilverStripe 4 Mar 7, 2019
.gitignore Add map files to .gitignore Jun 18, 2019
.nvmrc Adding a WebAuthn authenticator Mar 20, 2019
.scrutinizer.yml Add module structure for SilverStripe 4 Mar 7, 2019
.travis.yml Update interface elements to match designs Jul 1, 2019
CONTRIBUTING.md Rename markdown files and delete changelog Mar 7, 2019
LICENSE.md Add some unit tests for CredentialRepository, remove placeholder file… May 13, 2019
README.md DOCS Update docs to provide a little more information about what WebA… Jul 1, 2019
code-of-conduct.md
composer.json
package.json FIX Backend errors are now handled in the Register component for WebA… Jun 24, 2019
phpcs.xml.dist Add some unit tests for CredentialRepository, remove placeholder file… May 13, 2019
phpunit.xml.dist
webpack.config.js FIX Updating with new interface methods and moving components to reso… Apr 4, 2019
yarn.lock

README.md

SilverStripe WebAuthn Authenticator

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.

You can’t perform that action at this time.