- PHP ^7.1
- SilverStripe ^4.1
- defuse/php-encryption ^2.2 and OpenSSL PHP extension
Install with Composer:
composer require silverstripe/mfa ^4.0
You should also install one of the additional multi factor authenticator modules:
After installing this module and a supported factor method module (e.g. TOTP), the default member authenticator will be replaced with the MFA authenticator instead. This will provide no change in the steps taken to log in until an MFA Method has also been configured for the site:
SilverStripe\MFA\Service\MethodRegistry:
methods:
- MyMethod
- Another\Method\Here
After installing, an option in site configuration will enable MFA for users, which will automatically be added after login and to member profiles.
This module provides two distinct processes for MFA; verification and registration. This module provides a decoupled architecture where front-end and back-end are separate. Provided with the module is a React app that interfaces with default endpoints added by this module. Please refer to the docs for specific information about the included functionality:
- Debugging
- Front-end React components
- Back-end controllers and traits
- Local development
- Encryption providers
- Data store interfaces
See license.
This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.
All methods, with public
visibility, are part of the public API. All other methods are not part of the public API.
Where possible, we'll try to keep protected
methods backwards-compatible in minor/patch versions, but if you're
overriding methods then please test your work before upgrading.
Please create an issue for any bugs you've found, or features you're missing.