ESP32 MFA Authenticator

This is a personal project that I created to help me to get MFA TOTPs without using my phone.

Other motives:

it is not safe to store both the password and the MFA secret in the same place, like in a password manager. It creates a single point of failure.
it is not safe to store secrets on a device that you use when going out.
it is not safe to store MFA secrets for my personal and professional life in the same place.
if my phone is stolen or lost, I would have to re-register MFA for all services.
secrets are decoupled from the device, and this allows me to easily switch to another one when necessary. I just need to insert the SD card containing my services onto another device flashed with the same code.
not all services that I use support fido keys or passkeys.
yubikey is expensive where I live, and I would need a lot.
I wanted to learn how MFA works.
I wanted to learn how ESP32 works.

🌐 Install

You can flash your ESP32-CYD board with the latest build using this site.

Important

Read the site and the github workflows source codes to verify that the build artifact is, in fact, the one from the latest release published in this repository.

Note

This site was based on https://esphome.github.io/esp-web-tools/

🎬 Demos

demo_2.mp4

demo_3.mp4

demo_v0.5.0.mp4

demo_v0.5.0-2.mp4

demo_groups.mp4

⚙️ Parts

ESP32-2432S028
3D printed black case
Acrillic case

Tip

You can buy this board from Aliexpress clicking on any of these affiliate links: USD BRL

Tip

You can buy this acrillic case from Aliexpress clicking on any of these affiliate links: USD BRL

Tip

The 3D model for the black case was taking from this link

💵 Total Project Cost

Part	Cost
ESP32-2432S028	9.25 USD
3D printed black case	12.7 USD
Acrillic case	2.5 USD

Note

The above list doesn't consider expenses with taxes and shipping.

Note

Prices were taking in February 2024.

💻 Dev Environment Requirements

dependency	version
python	>= v3.9
node	>= v18.18
npm	>= v10.2
vscode	>= v1.87
platform.io ide vscode extension	>= v3.3
docker	>= v25.0

Important

Don't forget to install a driver to allow your OS to recognize esp32

Important

Node and npm, its package manager, are required because several development tools are used in this project. Among these tools are those that enforce the "conventional commits" standard. This standard is a lightweight convention on top of commit messages, offering an easy set of rules for creating an explicit commit history.

Tip

If platform.io extension does not recognize your board after clicking on Upload, Upload and Monitor or Monitor buttons, it means the driver was not properly setup. In MacOS, after installing the driver from Sillicon Labs, I had to restart the system before mac could identify the board.

🔌 Boot and Reset Requirements

2.4Ghz WiFi signal with internet connection, in order to sync the board's clock with the NTP server.
SD card with config.yml in the root as shown below:

⚙️ config.yml

# [REQUIRED] necessary for enabling future changes
version: 0.0.0

wifi:
  # [REQUIRED] (text) wifi connection password
  password: test
  # [REQUIRED] (text) wifi id
  ssid: test

mqtt:
  # [OPTIONAL] (text) mqtt server port
  port: 1883
  # [OPTIONAL] (text) mqtt server ip
  server: 192.168.0.1
  # [OPTIONAL] (text) mqtt connection username
  username: test
  # [OPTIONAL] (text) mqtt connection password
  password: test

security:
  # [OPTIONAL] (number) [default 3] board is locked and requires a hard reset, after N wrong unlock attempts
  max_number_of_wrong_unlock_attempts: 3
  pin:
    # [OPTIONAL] (text) pin code composed of numbers only and HMAC-SHA256 hashed
    hash: test
    # [OPTIONAL] (text) key used to hash pin code
    key: test

display:
  # [OPTIONAL] (number) [default 10] if provided, the display will turn off after n seconds have passed
  sleep_timeout: 10

touch:
  # [OPTIONAL] (bool=false|0) calibrate touch sensor if true or 1
  force_calibration: 0

Important

Upon the initial boot, it is imperative to undergo the calibration process at least once, as outlined in the How to build section below.

Tip

Once the boot process is finished, remove the SD card from the board, and store it somewhere safe. Before rebooting, or if you want to add new secrets, remember to put it back in the board.

📖 Guides

📚 How to navigate and control the board

Change groups: Swipe left or right to navigate between different groups.
Lock Screen: Tap twice to lock the screen.
Wake up: Tap once to wake up the board.

📚 How to build

Install PlatformIO's official CLI using this tutorial, and then follow the next steps:

Run platformio device list and annotate the device port of your board.

Tip

You can discover which port belongs to your board by comparing the outputs of this command when your board is connected and when it is not.

Run ./scripts/dev.sh --port ${DEVICE_PORT} to build and flash the code into your board

Important

Remember to substitue ${DEVICE_PORT} with the value you got in step 1.

📚 How to listen to the serial port using PlatformIO CLI

To listen to the serial port using PlatformIO CLI you can use the following commnad:

platformio device monitor --environment esp32-cyd

📚 How to register a Service

Services are registered in a file called services.yml that must be located in the root of an SD card. It must follow the schema shown below:

# [REQUIRED] (list) stores a list of services
services:
  # [REQUIRED] (text) unique name for a service in a group. It must not exceed 60 characters.
  - name: abc
    # [REQUIRED] (text) Base32 encoded secret for the service.
    secret: abc
    # [OPTIONAL] (number) [default 0] it also defaults to 0 if < 0 or > 9
    group: 0

For example:

services:
  - name: aws:root:allanoricil@company-1.com
    secret: encoded-secret
    group: 0
  - name: aws:staging:allanoricil@company-1.com
    secret: encoded-secret
    group: 0
  - name: aws:production:allanoricil@company-1.com
    secret: encoded-secret
    group: 0
  - name: aws:1234565:allanoricil@company-2.com
    secret: encoded-secret
    group: 1
  - name: aws:6785910:allanoricil@company-2.com
    secret: encoded-secret
    group: 1
  - name: aws:7815795:allanoricil@company-2.com
    secret: encoded-secret
    group: 1
  - name: github
    secret: encoded-secret
    group: 2
  - name: docker
    secret: encoded-secret
    group: 2
  - name: npm
    secret: encoded-secret
    group: 2

Important

At present, you can create up to 10 groups, with each group containing up to 10 services.

Important

The service name must not exceed 60 characters.

Important

Secrets must be stored unencrypted and encoded using Base32. All MFA services I tried already provide secrets in Base32 encoding. If you find one that does not, ensure the secret is Base32 encoded before adding it to the file.

Important

If you don't set the "group" property for a service, it will default to 0. Additionally, if the "group" property is less than 0 or greater than 9, it will also default to 0.

Important

The service name acts as a unique key within a group. If two services share the same key within the same group, the last one listed in the file will be the one used.

📚 How to verify if TOTP codes are correct

Go to https://totp.danhersam.com/
Paste/type your encoded base 32 secret in the secret field, and then compare the TOTP code shown with the one you are seeing on the ESP32's screen.

📚 How to recalibrate the touch sensor

Open your config.yml file.
Add the following property at the root level:

touch:
  force_calibration: true

Insert the SD card with the updated config.yml into your board.
Press the RST button on the board to reboot it.
Wait for the calibration screen to appear, as shown below:

Follow the on-screen instructions to complete the calibration process.
Once the calibration is finished, update config.yml again:

touch:
  force_calibration: false

Save the file, insert the SD card back into the board, and reboot by pressing the RST button.
Confirm that the calibration screen no longer appears.
Your touchscreen is now calibrated and ready to use! 🎉

Note

The calibration state will initiate upon the initial boot of the board, regardless of the content stored in config.yml, if no calibration is found in SPIFFS.

Important

The pin screen won't work if you did not calibrate the touch sensor.

📚 How to update `config.yml` from a browser

When the board is connected to your local network, a settings page, similarly to the one found in routers, can be used to update the config.yml in the SD card without the need of inserting it on a different computer. You can access this settings page at http://${LOCAL_NETWORK_DEVICE_IP}/esp32/settings.

Important

At the moment, all secrets in this form must be set before submiting it. If you fail to do it, all secrets in your config.yml will be overwritten by *****.

Important

For security purposes, none of the secrets are exposed by the board's webserver. If you inspect the page using your browser dev tools, you will noticed that all secrets are fetched as *****. In the future, after implementing HTTPS, you will be to manage those secrets from the browser, but only after providing a PIN number of using your fingerprint.

📚 How to setup PIN number

Option 1

Use this website to create a strong secret that is exactly 32 characters long. Copy the value from Encryption key 256, which has exactly 32 characters

Open this website to hash your pin number. Add you pin number as plain text, in the first input. You must use numbers only because the UI doesn't support letters or symbols, and it must contain at least 6 digits and no more than 20 digits.
Copy the generated hash. It must be 64 characters long.

In your config.yml

set hash with the generated hash you got in step 3
set key with the secret you got in step 1

security:
  pin:
    hash: 7dbd45736c57090dd62a7e1c8db1a08c353b4a836f2c6b43fd1dd3f1e747ea59
    key: TUwNzIxF5lJncAJVMkmb4EiSP9vm0OyF
  max_number_of_wrong_unlock_attempts: 3

Option 2

Use this website to create a strong secret that is exactly 32 characters long. Copy the value from Encryption key 256, which has exactly 32 characters

Open a terminal and run the following comand to hash your pin number. Don't forget to substitute "YOUR_PIN_NUMBER" and "YOUR_32_CHARACTERS_LONG_SECRET". The PIN must consist only of digits and must be between 6 and 20 digits in length.

echo -n "YOUR_PIN_NUMBER" | openssl dgst -sha256 -hmac "YOUR_32_CHARACTERS_LONG_SECRET" | awk '{print $2}'

Copy the generated hash. It must be 64 characters long.
In your config.yml

set hash with the generated hash you got in step 3
set key with the secret you got in step 1

security:
  pin:
    hash: 7dbd45736c57090dd62a7e1c8db1a08c353b4a836f2c6b43fd1dd3f1e747ea59
    key: TUwNzIxF5lJncAJVMkmb4EiSP9vm0OyF
  max_number_of_wrong_unlock_attempts: 3

🎯 Roadmap

✅ Display multiple TOTP codes

People often use multiple services that require MFA TOTP codes with high frequency because of their short living sessions.

✅ Unlock with PIN Code

It is not secure to have unencrypted secrets stored without protection

✅ Manage board settings using a browser

Users can manage their board settings using a browser. Once the board is connected to the local network, open a browser and type {IP_ADDRESS}/esp32/settings.

Important

At the moment, secrets must be re-entered before submiting the form. If you don't re-type the secrets, they will be stored as ******* in the SD card, and this will break the boot.

✅ Display turns off automatically after N seconds without user interaction

After booting, the display turns off automatically if it doesn't receive touch events after N seconds. N is a configurable in the config.yml.

✅ Organize Services into Groups

Services can be organized into groups.

✅ Lock board after N wrong unlock attempts

Improve the validation function to block access to the board after few wrong attempts happened. With this enhancement, brute forcing all possible combinations won't be possible.

🔜 Unlock with fingerprint

Instead of typing a pin code, it will be possible to unlock the board using a fingerprint. The goal is to ease the access to the TOTP codes, while maintaining them secure. It will also work globally or by group.

🔜 Create chrome extension to ease registering TOTP secrets

When the ESP32-MFA-Authenticator extension is enabled, a new button called "register secret" appears, in the browser's context menu, when right clicking over a QR code. When selecting this button, the registration flow starts.

💖 Become a Sponsor

If this device has made your life easier, consider supporting its development by clicking the button below.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

ESP32 MFA Authenticator

🌐 Install

🎬 Demos

⚙️ Parts

💵 Total Project Cost

💻 Dev Environment Requirements

🔌 Boot and Reset Requirements

⚙️ config.yml

📖 Guides

📚 How to navigate and control the board

📚 How to build

📚 How to listen to the serial port using PlatformIO CLI

📚 How to register a Service

📚 How to verify if TOTP codes are correct

📚 How to recalibrate the touch sensor

📚 How to update `config.yml` from a browser

📚 How to setup PIN number

Option 1

Option 2

🎯 Roadmap

✅ Display multiple TOTP codes

✅ Unlock with PIN Code

✅ Manage board settings using a browser

✅ Display turns off automatically after N seconds without user interaction

✅ Organize Services into Groups

✅ Lock board after N wrong unlock attempts

🔜 Unlock with fingerprint

🔜 Create chrome extension to ease registering TOTP secrets

💖 Become a Sponsor

Files

README.md

Latest commit

History

README.md

File metadata and controls

ESP32 MFA Authenticator

🌐 Install

🎬 Demos

⚙️ Parts

💵 Total Project Cost

💻 Dev Environment Requirements

🔌 Boot and Reset Requirements

⚙️ config.yml

📖 Guides

📚 How to navigate and control the board

📚 How to build

📚 How to listen to the serial port using PlatformIO CLI

📚 How to register a Service

📚 How to verify if TOTP codes are correct

📚 How to recalibrate the touch sensor

📚 How to update config.yml from a browser

📚 How to setup PIN number

Option 1

Option 2

🎯 Roadmap

✅ Display multiple TOTP codes

✅ Unlock with PIN Code

✅ Manage board settings using a browser

✅ Display turns off automatically after N seconds without user interaction

✅ Organize Services into Groups

✅ Lock board after N wrong unlock attempts

🔜 Unlock with fingerprint

🔜 Create chrome extension to ease registering TOTP secrets

💖 Become a Sponsor

📚 How to update `config.yml` from a browser