https://github.com/silverstripe/silverstripe-webauthn-authenticator

A Web Authentication (WebAuthn) authenticator for silverstripe/silverstripe-mfa
https://github.com/silverstripe/silverstripe-webauthn-authenticator

2fa hacktoberfest mfa silverstripe u2f webauthn

Last synced: 3 months ago
JSON representation

A Web Authentication (WebAuthn) authenticator for silverstripe/silverstripe-mfa

• Host: GitHub
• URL: https://github.com/silverstripe/silverstripe-webauthn-authenticator
• Owner: silverstripe
• License: bsd-3-clause
• Created: 2019-03-20T23:27:21.000Z (almost 6 years ago)
• Default Branch: 5
• Last Pushed: 2024-04-09T04:39:54.000Z (10 months ago)
• Last Synced: 2024-04-09T18:07:15.174Z (10 months ago)
• Topics: 2fa, hacktoberfest, mfa, silverstripe, u2f, webauthn
• Language: PHP
• Homepage:
• Size: 1.49 MB
• Stars: 4
• Watchers: 9
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# Silverstripe WebAuthn Authenticator

[![CI](https://github.com/silverstripe/silverstripe-webauthn-authenticator/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-webauthn-authenticator/actions/workflows/ci.yml)

[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

The silverstripe/webauthn-authenticator module provides a [Web Authentication (WebAuthn)](https://webauthn.guide/)

authentication method for the [silverstripe/mfa module](https://github.com/silverstripe/silverstripe-mfa), 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](https://www.yubico.com/). 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](docs/en/readme.md).

## Installation

```bash

composer require silverstripe/webauthn-authenticator

```

## Documentation

Read the [WebAuthn authenticator documentation](https://docs.silverstripe.org/en/optional_features/mfa/authentictors/webauthn).

## License

See [License](LICENSE.md)

## 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.