Differences

This shows you the differences between two versions of the page.

--- plugin:twofactoremail [2018-06-28 03:53] – Pushed update 18-06-28 wilminator
+++ plugin:twofactoremail [2023-07-11 23:52] (current) – version upped andi
@@ Line 3: / Line 3: @@
 ---- plugin ----
 description: Email support plugin for the Twofactor authentication plugin.
-author     : Michael Wilmes
+author     : Andreas Gohr, Michael Wilmes
-email      : michael.wilmes@gmail.com
+email      : dokuwiki@cosmocode.de
-type       : Helper
+type       : action
-lastupdate : 2018-06-28
+lastupdate : 2023-07-11
-compatible : 2015-08-10a "Detritus"
+compatible : Hogfather
 depends    : twofactor
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : 2fa, two-factor, email, security, authentication
-downloadurl: https://github.com/wilminator/dokuwiki-plugin-twofactoremail/zipball/master
+downloadurl: https://github.com/cosmocode/dokuwiki-plugin-twofactoremail/zipball/master
-bugtracker : https://github.com/wilminator/dokuwiki-plugin-twofactoremail/issues
+bugtracker : https://github.com/cosmocode/dokuwiki-plugin-twofactoremail/issues
-sourcerepo : https://github.com/wilminator/dokuwiki-plugin-twofactoremail/
+sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-twofactoremail/
 donationurl:
-screenshot_img : http://i.imgur.com/wqcCAKE.png
+screenshot_img :
 ----
-===== Summary =====
 This module provides the Two Factor Authentication plugin with the needed functionality to use the email address associated with their user profile as a means to provide one-time passwords.
@@ Line 27: / Line 25: @@
 ===== Installation =====
-Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
+Please refer to the [[twofactor#installation|twofactor Installation notes]] before installing this plugin.
-This plugin requires configuration prior to being functional.  By default it is off and will need to be turned on.
+=== Change Log ===
-===== ANOTHER MAJOR REVISION =====
+{{rss>https://github.com/cosmocode/dokuwiki-plugin-twofactoremail/commits/master.atom}}
-As of 2018-06-28, I have changed one of the methods in the main twofactor module that breaks all prior versions of this module.  I have updated all the modules, so as long as you update ALL twofactor modules, this should not be an issue.
 ===== User Setup =====
-In order to receive passwords by email, the user will have to confirm that passwords can be received at that address. This can be done through the Two Factor configuration link at the upper right menu.
+Users can add this provider in their two factor profile, a code will be sent to the email address associated with their wiki account to verify the receiving works.
-NOTE: The user interface appears to be slightly broken.  The user needs to follow the directions as is to setup the module.
-Once at the Two Factor configuration page, there will be a checkbox labeled "Resend code to email".  check it and click "Save" to send a test message to the wiki registered email address. Last, enter the password sent to that address into the verification textbox and click the "Save" button again.  If needed, click on the "Resend Password" button again to send another password to the email address.
-The user can check the "Revoke codes by email" option and click "Save" to disable sending passwords by email.
-===== 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 alternate email for two factor authentication.  Default: off
+Administrators can configure the tolerance when comparing tokens. Keep in mind that receiving emails may not be instantaneous and a higher tolerance might be needed.
-===== Development =====
-There is no further development planned at this time.
-=== Change Log ===
-{{rss>https://github.com/wilminator/dokuwiki-plugin-twofactoremail/commits/master.atom}}
-=== Known Bugs and Issues ===
-  * The user interface is broken.  I need to add the "enable" checkbox for the user like is present in all other modules for consistency and to make the config menu less confusing.
-=== ToDo/Wish List ===
-  * Fix the user configuration UI.
-===== 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 plugin[[plugin:authgoogle2fa|authgoogle2fa 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.