Tfa::startUser() method

Start two-factor authentication for User

Modules must implement this method unless they do not need to generate or send authentication codes to the user. Below are details on how to implement this method:

A. For modules that generate and validate their own authentication codes:

  1. Generate an authentication code for user
  2. Save the code to session
  3. Send the code to the user via whatever TFA channel is used
  4. Call parent::startUser($user)
  5. Return true (if no errors)

B. For modules that use an external service to generate, send and validate codes:

  1. Call on the external service to generate and the code to user
  2. Call parent::startUser($user)
  3. Return true (if no errors)

C. Modules that do not generate or send codes, but only validate them (i.e. TOTP): You can omit implementation, leaving just the built-in one below. But if you do implement it, make sure you call the parent::startUser($user).

Usage

$bool = $tfa->startUser(User $user, array $settings);

Arguments

NameType(s)Description
userUser
settingsarray

Settings configured by user

Return value

bool

True on success, false on fail


Tfa methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer