alexandregz/twofactor_gauthenticator

This RoundCube plugin adds the Google 2-step verification to the login proccess (OTP)

Installs: 2 305

Dependents: 0

Suggesters: 0

Stars: 85

Watchers: 13

Forks: 20

Open Issues: 6

Type: roundcube-plugin

dev-master 2017-11-25 22:10 UTC

README

This RoundCube plugin adds the 2-step verification(OTP) to the login proccess.

It works with all TOTP applications RFC 6238

Some code by: Ricardo Signes Justin Buchanan Ricardo Iván Vieitez Parra

GoogleAuthenticator class by Michael Kliewe (to see secrets)

qrcode.js by ShimSangmin

Also thx to Victor R. Rodriguez Dominguez for some ideas and support

Login

2Steps

Installation

(Or use composer HOME_RC$ composer require alexandregz/twofactor_gauthenticator:dev-master

NOTE: Answer N when composer ask you about plugin activation)

  • Activate the plugin into HOME_RC/config/config.inc.php: $config['plugins'] = array('twofactor_gauthenticator');

Configuration

Go to the Settings task and in the "2steps Google verification" menu, click 'Setup all fields (needs Save)'.

The plugin automatically creates the secret for you.

To add accounts to the app, you can use the QR-Code (easy-way) or type the secret. After checking the first code click 'Save'.

Settings by default

Settings OK

QR-Code example

Also, you can add "Recovery codes" for use one time (they delete when are used). Recovery codes are OPTIONAL, so they can be left blank.

Recovery codes

Check codes

Recovery codes

Enrollment Users

If config value force_enrollment_users is true, ALL users needs to login with 2-step method. They receive alert message about that, and they can't skip without save configuration

Samefield

If config value 2step_codes_on_login_form is true, 2-step codes (and recovery) must be sended with password value, append to this, from the login screen: "Normal" codes just following password (passswordCODE), recovery codes after two pipes (passsword||RECOVERYCODE)

Actually only into samefield branch

Codes

Codes have a 2*30 seconds clock tolerance, like by default with Google app (Maybe editable in future versions)

License

MIT, see License

Notes

Tested with RoundCube 0.9.5 and Google app. Also with Roundcube 1.0.4

Remember, sync time it's essential for TOTP: "For this to work, the clocks of the user's device and the server need to be roughly synchronized (the server will typically accept one-time passwords generated from timestamps that differ by ±1 from the client's timestamp)" (from http://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm)

Author

Alexandre Espinosa Menor aemenor@gmail.com

Issues

Open issues using github, don't send me emails about that, please -usually Gmail marks messages like SPAM

Testing

Using with Kolab

Add a symlink into the public_html/assets directory

Show explained https://github.com/alexandregz/twofactor_gauthenticator/issues/29#issuecomment-156838186 by https://github.com/d7415

Client implementations

You can use various OTP clients -link by https://github.com/helmo

Logs

Suggested by simon@magrin.com

To log errors with bad codes, change the $_enable_logs variable to true.

The logs are stored to the file HOME_RC/logs/log_errors_2FA.txt -directory must be created

Whitelist

You can define whitelist IPs into config file (see config.inc.php.dist) to automatic login -the plugin don't ask you for code

Uninstall

To deactivate the plugin, you can use two methods:

  • To only one user: restore the user prefs from DB to null (rouncubeDB.users.prefs) -the user plugin options stored there.

  • To all: remove the plugin from config.inc.php/remove the plugin itself