codefareith/cf-google-authenticator

Enable Google 2FA (two factor authentication) for both, frontend- and backend accounts.

v1.2.4 2020-08-22 22:18 UTC

Requires

• ext-json: *
• typo3/cms-core: ^8.7 || ^9.5
• typo3/cms-reports: ^8.7 || ^9.5
• typo3/cms-setup: ^8.7 || ^9.5

Requires (Dev)

• codeception/codeception: ^4.1
• phpunit/php-code-coverage: 5.3.2
• roave/security-advisories: dev-master
• typo3/testing-framework: ^3.4.2

Suggests

• typo3/cms-felogin: Needed to support 2FA for frontend accounts.

Replaces

• codefareith/cf_google_authenticator: v1.2.4
• typo3-ter/cf-google-authenticator: v1.2.4

GPL-3.0-or-later

• Robin von den Bergen

• php
• security
• extension
• google
• totp
• typo3
• authenticator
• tfa
• 2fa
• two-factor-authentication
• google-authenticator
• typo3-cms
• typo3-extension
• typo3-cms-extension
• google-2fa
• google-tfa
• totp-tfa
• totp-2fa
• timed-one-time-password

README

TYPO3 CMS extension to enable Google 2FA (two factor authentication) for both, frontend- and backend accounts.

Getting Started

Follow these instructions to enable Google 2FA in your TYPO3 CMS installation.

Installation

The extension needs to be installed as any other extension of TYPO3 CMS:

1. Switch to the module “Extension Manager”.
2. Get the extension
   1. Get it from the Extension Manager: Press the “Retrieve/Update” button, search for the extension key cf_google_authenticator and import the extension from the repository.
   2. Get it from typo3.org: You can always get the current version from https://extensions.typo3.org/extension/cf_google_authenticator/ by downloading either the t3x or zip version. Upload the file afterward in the Extension Manager.
   3. Get it from packagist.org: Add this extension as dependency using Composer: composer require codefareith/cf-google-authenticator
3. Change the extension configuration to your needs

Usage

After installing and activating the extension you'll be able to activate 2FA for backend and frontend users.

Backend

1. Switch to the module "Backend Users"
2. Select a user you wish to enable 2FA for
3. Navigate to tab "Google Authenticator"
4. Check "Enable Google Authenticator"
5. Within the Google Authenticator App: scan the provided QR code or set up the authenticator manually by using the given secret
6. Fill out "One-time password" with the code created by your App
7. Save

On the TYPO3 CMS backend login screen, you'll notice a new field "Google Authenticator Code". If you've activated Google 2FA for your backend user, you'll need to enter the code, generated by the app, to log into your backend account.

If you'll ever lose your Google Authenticator, the only way to disable 2FA is via the database, by setting "tx_cfgoogleauthenticator_enable" to 0, for the desired user.

Frontend

In order to offer frontend users the possibility to secure their accounts via two-factor authentication, two conditions must be met^[1]:

1. in the extension configuration the 2FA must be activated for the frontend (deactivated by default):

   • Select the extension module and search for "[codeFareith] Google Authenticator".
   • right click on the gear (Configure)
   • activate the checkbox under "FE enabled" and then click on "save".

2. via the backend, the necessary plugin must be placed on a page provided for this purpose:

   • Select a preferred page via the page module and make sure that it is only accessible for logged in frontend users.
   • Then create a new content element on the aforementioned page.
   • Under the "Plug-Ins" tab, select "General Plug-In".
   • In the next step open the next tab called "Plug-Ins".
   • Select "Google Two-Factor-Authentication Setup" from the dropdown and click on save. Done!

^{[1] After enabling/disabling frontend 2FA, you might need to flush frontend cache in order to show/hide the one-time password field in the login form.}

History

See CHANGELOG.md

License

GNU Public License