Revision as of 14:28, 14 December 2022

Overview

Multi-Factor Authentication is a method of authentication in which a user is granted access to your SmartSimple Cloud system only after successfully presenting two or more pieces of evidence to an authentication mechanism.

The security impact of Multi-Factor Authentication (MFA) is that while a user may lose an access card or get tricked into sharing a password, the odds of both happening to a single user are dramatically reduced. Using MFA therefore enhances an organization's ability to ensure that no one is using illegitimate means to gain access. 

SmartSimple Cloud supports two different approaches to Multi-Factor Authentication:

• Time-based One-Time Password (TOTP) via an authenticator app.

IMPORTANT: YOU MUST setup your authenticator app and link to your user account BEFORE enabling this type of MFA if you are an existing user. Additional steps are required. Please see below for details.

• Single Use Verification Code sent by either Email or SMS.

No additional configuration steps required for this type of MFA.

Configuration - Essentials

All settings related to multi-factor authentication are in a single location

1. Navigate to Global Settings > Security > Password and Activation Policies
2. Scroll to Authentication Options and toggle on Enable Multi-Factor Authentication
3. Specify the roles that require authentication via TOTP and/or Verification Code

        NOTE: If new roles are added to the system, the MFA configuration must also be updated 

Authentication Options

Setting up Verification Codes for Email

The easiest way to set up MFA is through the email that was used for user registration and login. Be sure to follow the instructions carefully to avoid accidentally locking yourself or others out of their accounts.

1. Go to Menu Icon > Global Settings > Security tab > Password and Activation Policies and then scroll down to the section marked Authentication Options.
2. Toggle on Enable Multi-Factor Authentication. You will see additional settings displayed for different authentication methods. 
3. Under the Roles with Verification Code via SMS or Email setting, you will need to decide which roles need to be authenticated via a verification code sent through the email address used for login. Ensure that users assigned to this role have not opted out of receiving system emails. Click the Save button at the bottom of the page to activate changes.
   
   

Logging in with a Verification Code from Email

When a user has been assigned a role that requires a verification code, they can login using the following steps:

1. When the user logs in using their email and password, they will be prompted to enter a verification code that was sent to their email.
   
   
2. The user can check their email to copy the verification number.
   
   
3. Enter the verification code into the field and then click Submit to finish authenticated login.

Setting up Verification Codes for SMS

In order for users to receive SMS messages, a SmartSimple administrator must first enable SMS services by going to Menu Icon > Global Settings > Communications tab > Toggle on Enable SMS Notification. Ensure that the target users have an active mobile number filled into this standard field. If the phone number field is empty, users will not be able to receive any SMS messages for login and may be locked out of their accounts once activated.

Logging in with a Verification Codes for SMS

1. When the user logs in, they will be presented with the option to receive a verification code via email (if available) or through SMS. The user can click Send Code by Text Message.
   
   
2. The user can check their mobile messages, enter the code into the field, and then click Submit to finish authenticated login.
   
   

Configuration - Advanced

Setting up a Time-Based One-Time Password (TOTP) For Existing Users

NOTE: Before enabling MFA for use with TOTP, all existing users with roles intended for TOTP must first scan their TOTP Secret Key or TOTP QR Code into an authenticator app.

In order to use TOTP effectively, users must first download an authenticator application onto their mobile devices. Popular authentication apps include Google Authenticator, Microsoft Authenticator, or 2FAS. Once downloaded, the following steps will allow the user to sync their SmartSimple account with their mobile authentication application:

1. Go to User Menu > Personal Settings
   
2. Select the Security tab in the following modal window.
   
3. On your mobile device, open the authenticator app and select “Add new device” or similar. Then select “Scan QR Code” or similar.
   
4. Using the scanner within the mobile app, scan the TOTP QR Code found under your Personal Settings.
5. A new device should be added to your list. Alternatively, you could also use the TOTP Secret Key as opposed to the TOTP QR Code.
6. In your SmartSimple instance, in the Configuration Menu (9-Square Grid Icon), select Global Settings.
   
7. Select the Security Tab from the Global Settings.
8. Click Password and Activation Policies.
9. Under “Authentication Options”, toggle on Enable Multi-Factor Authentication (MFA).
10. In the setting Roles with Time-Based One-Time Password (TOTP) include the roles that you will be adding 2-Factor Authentication for. Note that the existing users in these roles must first scan the QR Code on their mobile device before this setting should be toggled on.
11. Toggle on Enable Trusted Device if you would like users to be able to bypass entering a code for a time period after the code has been successfully entered. If enabled, also enter the time period that the 2-Factor Authentication will be bypassed for trusted users.
12. Scroll to the bottom of the page and click Save.
13. To test your MFA, log out of your account, and then log back in. You should now see a page following login called “Multi-Factor Authentication.” Enter the password in the Authenticator app here, and access will be granted into the system.
    

Logging in the First Time with TOTP for Existing Users

When logging into the system for the first time after TOTP has been activated on the user's role, the user must first follow these steps:

1. From the login screen select the "Forgot Password" link and enter the email used to login to your system
2. In the email received select the activation link
3. You will be routed to a page to set your password.
4. Enter in your new password. Press Submit when done.
5. You will then be presented with the following screen:
   
   

   TOTP Setup Page.
6. Follow the instructions listed on the screen, starting by installing an authenticator app on your mobile device.
7. Clicking the button "Show TOTP Key and QR Code" reveals the QR and secret code used with an authentication app.

TOTP Setup Page.

Settings Explained

See Also

• User Roles