Yii2 module providing multi-factor authentication
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/readme
src
tests
.gitignore
.php_cs
.scrutinizer.yml
.travis.yml
CHANGELOG.md
LICENSE
README.md
chkipper.json
composer.json
hidev.yml
history.md
phpunit.xml.dist
version

README.md

Yii2 MFA

Multi-factor authentication for Yii2 projects

Latest Stable Version Total Downloads Build Status Scrutinizer Code Coverage Scrutinizer Code Quality Dependency Status

This package provides:

  • TOTP - Time-based One-time Password Algorithm used for two factor authentication
  • checking for user allowed IPs
  • generation and checking recovery codes (PLANNED)

Uses:

Can be plugged into any exising Yii2 project. See how it is used in hiqdev/hiam.

Installation

The preferred way to install this yii2-extension is through composer.

Either run

php composer.phar require "hiqdev/yii2-mfa"

or add

"hiqdev/yii2-mfa": "*"

to the require section of your composer.json.

Configuration

This extension provides pluggable configuration to be used with composer-config-plugin.

Also you can use it usual way by copy-pasting config. See src/config/web.php for configuration example.

Available configuration parameters:

  • organization.name

For more details please see src/config/params.php.

Usage

This plugin provides behavior and configuration attaches it to user component on beforeLogin event. And then the behavior validates IPs and TOTP on every login.

To use this plugin you need to provide:

  • allowed_ips readable and writable property in your user component for allowed IPs functionality
  • totp_secret readable and writable property in your user component for TOTP functionality

IPs and TOTP functions are independent and you can provide just one of properties to have only corresponding functionality.

License

This project is released under the terms of the BSD-3-Clause license. Read more here.

Copyright © 2016-2018, HiQDev (http://hiqdev.com/)