User Manual
Setup of two factor authentication
This page guides you through setting up or managing two-factor authentication (2FA) for your awaBerry account, enhancing the security of your device connections.
Setup of two factor authentication
Summary
This page provides a comprehensive interface for managing two-factor authentication (2FA) on your awaBerry account. You can activate 2FA to protect the encryption key used for secure device connections. The process involves downloading your private key, generating a unique hash from it, and finally activating the 2FA protection. If 2FA is already active, this page will also offer options to manage or deactivate your current setup.
Page Access
You can access this page by navigating to: /tfadosetup
Page Functionalities
- View 2FA Status: At the top of the page, you can quickly see if Two-Factor Authentication is currently 'Enabled' or 'Disabled' for your account.
- Management Options (If 2FA Enabled): If Two-Factor Authentication is already active, the page will initially present options to manage your existing key (e.g., remember it in the browser, download, or initiate deactivation).
- Step 1: Download Private Key
- Information Panel: Provides crucial information about private and public keys, their role in end-to-end encryption, and a warning about the unrecoverable nature of lost keys.
- Download Private Key Button: Initiates the download of your unique private key file (e.g., `your_username.pem`). This key is essential for decrypting your device connections.
- Confirmation Checkbox: You must confirm that you have securely stored the downloaded private key before proceeding.
- Continue Button: Moves you to the next step of the 2FA setup once the private key is downloaded and confirmed.
- Skip Setup Button: (Available if 2FA is not yet active) Allows you to postpone 2FA setup, returning to your main dashboard. You can always activate it later from your user settings.
- Step 2: Upload Key and Generate Hash Key
- Information Panel: Explains that this step creates a unique hash from your private key, which acts as a 'password' for your 2FA setup.
- File Upload Area: Use the 'Select private key file' button or icon to upload the `.pem` file you downloaded in Step 1.
- Hashed Key Display: Once the correct private key is uploaded, a unique 'hashed key' is generated and displayed. There's a convenient copy icon to easily copy this hash.
- Password Manager Integration: Instructions are provided on how to save this hashed key, along with your associated awaBerry 2FA username (derived from your email), into your password manager.
- 'Add credentials to password manager' Button: Confirms that you have entered the correct username and hashed key, allowing you to proceed.
- Step 3: Activate Two Factor Authentication
- Confirmation Message: This screen confirms that the 2FA setup is complete and awaits your final activation.
- Continue Button: Press this button to finalize the activation, encrypting your private key with the generated hash and enabling 2FA on your account.
- Step 4: Activation Success
- Success Message: Informs you that two-factor authentication has been successfully activated.
- Automatic Redirection: After a short delay, the page automatically redirects you to the 2FA login page to complete your session with the new security settings.
Scenario Executions
Possible usage steps within this page
Follow these steps for a successful Two-Factor Authentication setup:
- Start the Setup: Navigate to the Two-Factor Authentication setup page. The page will indicate that 2FA is 'Disabled'.
- Download Private Key (Step 1):
- Read the important notes about key loss.
- Click the "Download private key" button to save your unique private key file to a secure location on your device.
- Check the box next to "I have stored the private key in a safe place." to confirm your backup.
- Click the "Continue" button to proceed.
- Upload Key and Generate Hash (Step 2):
- Click the "Select private key file" button or the file icon.
- Select and upload the `.pem` file you downloaded in the previous step.
- The page will display your "Resulting hashed key". Click the copy icon next to it to copy the hash to your clipboard.
- In the provided fields, paste the copied hash key into the 'Password' field. The 'Username' field will be pre-filled with your awaBerry 2FA username.
- Click the "Add credentials to password manager" button.
- Activate Two Factor Authentication (Step 3):
- Review the confirmation message stating that setup is complete.
- Click the "Continue" button to finalize and activate 2FA for your account.
- Activation Success (Step 4):
- The page will display a success message and automatically redirect you to the 2FA login page after a few seconds.
Possible errors which may occur on this page
Be aware of these potential issues during 2FA setup:
- Attempting to continue without downloading the private key (Step 1): If you click "Continue" in Step 1 before downloading the private key file, a message will appear instructing you to "Download the file first to continue." This ensures you secure your key before proceeding.
- Attempting to continue without confirming private key storage (Step 1): If you click "Continue" in Step 1 without checking the "I have stored the private key in a safe place." checkbox, an error message will prompt you to "Please select the checkbox to confirm that you have stored the private key in a safe place." This is a critical safety measure.
- Uploading the wrong file in Step 2: If you upload a file that is not your original private key (e.g., a different `.pem` file, or any other file type), an error message will be displayed: "Wrong file - please upload the private key file you downloaded in the previous step." The system verifies the content of the uploaded key.
- Entering an incorrect hashed key in Step 2: When entering or pasting the hashed key into the password field for your password manager (or attempting to proceed with an incorrect value), an error message "Incorrect hash key - please paste the correct one." will appear. The system requires an exact match for security.
- Navigating away during setup: If you leave the setup process before completion (e.g., closing the browser tab or navigating to another page without using the 'Skip' option), your 2FA setup will not be activated. You will need to restart the process.
