georgestephanis / two-factor
Two-Factor Authentication for WordPress.
Installs: 44
Dependents: 0
Suggesters: 0
Security: 0
Stars: 685
Watchers: 51
Forks: 143
Open Issues: 82
Type:wordpress-plugin
Requires
- php: >=5.6
Requires (Dev)
- automattic/vipwpcs: ^2.3
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.2
- php-coveralls/php-coveralls: ^2.5
- phpcompatibility/php-compatibility: 10.x-dev as 9.99.99
- phpcompatibility/phpcompatibility-wp: dev-master
- phpunit/phpunit: ^9.5
- roots/wordpress-core-installer: ^1.100
- roots/wordpress-full: ~6.0
- spatie/phpunit-watcher: ^1.23
- wp-coding-standards/wpcs: ^2.3
- wp-phpunit/wp-phpunit: ^6.0
- yoast/phpunit-polyfills: ^1.0
- dev-master
- 0.9.0
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.3
- 0.7.2
- 0.7.1
- 0.7.0
- 0.7.0-rc.1
- 0.6.0
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.8
- 0.4.7
- 0.4.6
- 0.4.5
- 0.4.4
- 0.4.3
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.0
- 0.2.0
- dev-dependabot/npm_and_yarn/postcss-8.4.31
- dev-disable_provider
- dev-version-0.8.2-bump
- dev-release/0.8.2
- dev-add/fallback-email
- dev-dependabot/npm_and_yarn/word-wrap-1.2.4
- dev-fix/577-destroy-sessions-on-enable
- dev-reauth-no-providers-fatal
- dev-364-coverage-reporting
- dev-broadcast-events
- dev-pr-389-recrypt
- dev-remove/fido-u2f
- dev-dxw-feature/generate-qr-internally
- dev-core/proposal
- dev-feature/profile-shortcode
- dev-feature/email-code-link
- dev-ux/user-configuration
- dev-fix/xmlrpc-bypass
- dev-add/totp-ajax
This package is not auto-updated.
Last update: 2024-04-25 15:28:41 UTC
README
Two-Factor plugin for WordPress. View on WordPress.org →
Usage
See the readme.txt for installation and usage instructions.
Contribute
Please report (non-security) issues and open pull requests on GitHub. See below for information on reporting potential security/privacy vulnerabilities.
Join the #core-passwords
channel on WordPress Slack (sign up here).
To use the provided development environment, you'll first need to install and launch Docker. Once it's running, the next steps are:
$ git clone https://github.com/wordpress/two-factor.git
$ cd two-factor
$ composer install
$ npm install
$ npm run build
$ npm run env start
See package.json
for other available scripts you might want to use during development, like linting and testing.
When you're ready, open a pull request with the suggested changes.
Testing
Running tests in Docker
- Run
npm run env start
- Run
npm run test
ornpm run test:watch
.
Running tests locally
- Create a MySQL database for the tests. Don't reuse an existing database, because all of the data will be deleted every time the tests are run.
- Add the following to your
~/.bashrc
, with the values for the database you created above:export WORDPRESS_DB_NAME=wp_tests export WORDPRESS_DB_USER=wp_tests export WORDPRESS_DB_PASSWORD=wp_tests
source ~/.bashrc
- Run
composer run test
orcomposer run test:watch
.
To view the code coverage report, you can open a web browser, go to File > Open file...
, and then select {path to two-factor}/tests/logs/html/index.html
.
Deployments
Deployments to WP.org plugin repository are handled automatically by the GitHub action .github/workflows/deploy.yml. All merges to the master
branch are commited to the trunk
directory while all Git tags are pushed as versioned releases under the tags
directory.
Known Issues
- PHP codebase doesn't pass the WordPress coding standard checks, see #437.
Credits
Created by contributors and released under GPLv2 or later.
Security
Please privately report any potential security issues to the WordPress HackerOne program.