DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:twofactorsmsgateway

Two Factor Authentication - SMS Gateway Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" unknown

plugin SMS email gateway support plugin for the Two Factor Authentication plugin.

Last updated on
2017-08-05
Provides
Helper
Repository
Source
Requires
twofactor

Summary

This module provides the Two Factor Authentication plugin with the needed functionality to send emails to SMS gateways as a means to provide one-time passwords.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

This plugin requires configuration prior to being functional. By default it is off and will need to be turned on.

Additionally, there is a gateway.txt file in the plugin folder. This file contains a list of “email” addresses that are used to send emails to various cell phone providers' SMS gateways. The format is <displayed provider name>@<gateway domain>. If a provider is not listed, they can be added to the file using that same format. The gateway must be configured to receive emails for <phone number>@<gateway domain>, such as 8005551212@vtext.com.

User Setup

In order to use the SMS gateway, the user will have to configure the wiki to send passwords by SMS. This can be done through the Two Factor configuration link at the upper right menu.

Once at the Two Factor configuration page, there will be a textbox for the user's cell phone number and a dropdown menu for the cell phone provider. Enter the phone number to use, the provider for that number, and click “Save” to send a test message to the phone. Last, enter the password sent to the phone into the verification textbox and clicking the “Save” button again. If needed, click on the “Resend Password” button to send another password to the phone.

The phone number can be updated, and the user will need to verify that the new number supplied can receive the sent passwords. The user can also check the “Revoke codes by SMS gateway” option and click “Save” to disable sending passwords to the phone.

User Login

The user logs in normally. If there is a field to supply a token, leave it blank to have the wiki send a one-time password. The user will be redirected to a screen to supply the sent password. Enter the password in the Verification Code field and click “Complete Login” to continue. If the password is not received within a minute or two, clicking on the “Resend Code” button will send a new password. If more than one module is configured to send passwords, the user can have the same password sent using all configured modules by checking the “Resend OTP using all configured options” checkbox then clicking on “Resend Code”.

Configuration and Settings

“enable” - Turn on or off the use of SMS Appliance for two factor authentication. Default: off

Development

There is no further development planned at this time, but it may change based on feedback.

Change Log

Known Bugs and Issues

None at this time

ToDo/Wish List

None at this time

FAQ

WIP. I will pull discussion questions and post them here as blatant questions come up.

Big Thanks / Acknowledgement

First, I want to thank my employer, Antelope Valley College, for allowing me to release this code to the open source community.

A big thanks goes out to Dan Popp for the work on his Google 2FA pluginauthgoogle2fa Plugin- it provided me with the idea, libraries, and a code template to get this project started.

Discussion

Feel free to write anything constructive. My hope is that this plugin will provide many admins with useful functionality.

plugin/twofactorsmsgateway.txt · Last modified: 2017-08-05 04:50 by wilminator