NodeBB/nodebb-plugin-2factor
2
0
Fork 0
mirror of https://hk.gh-proxy.com/https://github.com/NodeBB/nodebb-plugin-2factor.git synced 2025-10-03 09:11:01 +08:00
Code Issues Projects Packages Wiki Activity Actions
Two-Factor Authentication for NodeBB
263 commits 5 branches 82 tags 1.3 MiB
Find a file
Julian Lam ebae8a681e 7.0.2
2023-02-06 13:52:06 -05:00
docs refactor: update plugin to treat logged-in users who have not passed 2FA check as guests, return standard API error on API calls when 2FA not passed [breaking] 2023-01-10 11:44:03 -05:00
languages refactor: finished up 2fa choices refactor 2022-06-01 14:52:22 -04:00
lib fix: update account page to use buildAccountData middleware, nodebb/nodebb#11198 2023-01-25 12:44:06 -05:00
screenshots Fleshed out Admin Panel Page 2015-07-28 14:22:09 -04:00
static fix: update account page to use buildAccountData middleware, nodebb/nodebb#11198 2023-01-25 12:44:06 -05:00
.eslintrc Allow hardware keys as a second factor, + eslint (#68) 2022-01-07 13:48:19 -05:00
.gitattributes init 2014-06-04 16:08:24 -04:00
.gitignore init 2014-06-04 16:08:24 -04:00
.npmignore init 2014-06-04 16:08:24 -04:00
commitlint.config.js Allow hardware keys as a second factor, + eslint (#68) 2022-01-07 13:48:19 -05:00
library.js fix: add back exemptPaths for api/v3 2023-02-06 13:52:04 -05:00
LICENSE updated structure, added MIT license, moved ACP js to its own separate file 2015-03-13 14:05:43 -04:00
package.json 7.0.2 2023-02-06 13:52:06 -05:00
plugin.json fix: update account page to use buildAccountData middleware, nodebb/nodebb#11198 2023-01-25 12:44:06 -05:00
README.md docs: update attribution 2022-01-10 14:19:14 -05:00
TRANSLATE.md closes #3 2015-09-16 13:37:19 -04:00
websockets.js fix: utils usage 2022-05-30 11:39:48 -04:00
yarn.lock chore(deps): bump json5 from 1.0.1 to 1.0.2 2023-01-10 13:51:52 -05:00

README.md

Two-Factor Authentication for NodeBB

In addition to regular authentication via username/password or SSO, a second layer of security can be configured, permitting access only if:

  • A time-based one-time password is supplied, typically generated/stored on a mobile device, or
  • A hardware token is activated, such as a Yubikey or other similar product

The Two-Factor Authentication plugin will expose this feature to end-users, allowing them to configure their devices and enabling this enhanced security on their account.

Version History

  • v3.x
    • Introduces hardware key support via WebAuthn.
    • This version is fully backwards compatible with v2.x. The major version bump was merely due to the introduction of the new functionality

Caveats

  • Due to browser limitations, the hardware key on mobile devices (especially Android devices) may not be supported. For more information on which devices are and are not supported, please consult this chart

Installation

Install the plugin via the ACP/Plugins page.

Screenshots

Token Generation Step

Token Generation Step

Challenge Step

Challenge Step

Attributions

Keeb.it logo

Thanks to @yLothar and the KEEB.it community for sponsoring WebAuthn and hardware key support.