Skip to content
This repository has been archived by the owner on Jan 26, 2025. It is now read-only.

Releases: AllanOricil/esp32-mfa-authenticator

v0.19.0

04 Jan 22:36
Compare
Choose a tag to compare

0.19.0 (2025-01-04)

Features

  • there can exist up to 100 services divided between 10 groups (981f14c)

v0.18.0

02 Jan 21:10
Compare
Choose a tag to compare

0.18.0 (2025-01-02)

Bug Fixes

  • ensure resource routes validate session before providing data (bedc219)
  • improve auth api (df985c1)
  • invalid password (ef09c45)
  • manager: error while validating session (f7ddbba)
  • manager: page not loading because assets are missing (af81775)
  • manager: re-auth during hard refreshes while session cookie (13e8cea)
  • manager: unauthorized due to missing session (9a2b3c4)

Features

  • add username/password auth route in the manager server (e38fe39)
  • enable manager only if username, password and key are set in config.yml (6e299be)
  • manager: add authentication with username and password (cc01402)
  • manager: add fetchServices and updateServices to esp32-mfa-authenticator client (c615cb3)
  • manager: add first iteration of the icon (0e92fc6)
  • manager: fetch services from server (2b51738)

BREAKING CHANGES

Some of the config.yml properties were renamed to ease the configuration. Below is the old and new schemas, respectively:

BEFORE

# [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

AFTER

# [REQUIRED] configure the credentials used to connect to a wifi network
wifi:
  # [REQUIRED] (text) wifi connection password
  password: test
  # [REQUIRED] (text) wifi id
  ssid: test

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

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

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

# [OPTIONAL] configure the management app
manager:
  # [OPTIONAL] configure authentication for the management app. The management app is enabled only if username, password, key are set.
  authentication:
    # [REQUIRED] (text) username to start a session
    username: admin
    # [REQUIRED] (text) HMAC-SHA256 hashed password to start a session
    password: 7dbd45736c57090dd62a7e1c8db1a08c353b4a836f2c6b43fd1dd3f1e747ea59
    # [REQUIRED] (text) 32 characters key used to hash the password
    key: TUwNzIxF5lJncAJVMkmb4EiSP9vm0OyF
    # [OPTIONAL] (number) [default 5] amount of minutes for the session duration
    session_length: 5

v0.17.0

30 Dec 19:17
Compare
Choose a tag to compare

0.17.0 (2024-12-30)

Features

  • use esp_log.h as the logger library (09f4ac3)

v0.16.0

27 Dec 03:44
Compare
Choose a tag to compare

0.16.0 (2024-12-27)

Bug Fixes

  • align pin screen theme with totp screen for consistency (f2c59b5)

Features

  • group index is rendered when a group does not have services (cd945c3)

v0.15.0

26 Dec 16:33
Compare
Choose a tag to compare

0.15.0 (2024-12-26)

Bug Fixes

  • ensure group default to 0 when not in bounds (630f406)

Features

  • increase MAX_NUMBER_OF_GROUPS to 10 (c440976)

v0.14.0

26 Dec 03:22
Compare
Choose a tag to compare

0.14.0 (2024-12-26)

Features

  • enable organizing services into groups (6d290af)
demo_groups.mp4

BREAKING CHANGES

The file storing services must be named services.yml and now need to follow this schema:

services: list
  - name: text[60]
    secret: text
    group: number

For example:

services:
  - name: aws:root:[email protected]
    secret: encoded-secret
    group: 0
  - name: aws:staging:[email protected]
    secret: encoded-secret
    group: 0
  - name: aws:production:[email protected]
    secret: encoded-secret
    group: 0
  - name: aws:1234565:[email protected]
    secret: encoded-secret
    group: 1
  - name: aws:6785910:[email protected]
    secret: encoded-secret
    group: 1
  - name: aws:7815795:[email protected]
    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

v0.13.1

22 Dec 21:08
Compare
Choose a tag to compare

0.13.1 (2024-12-22)

Bug Fixes

  • destroy touch config screen when no longer needed to release mem (e01f8de)
  • min==max delta due to calibration values being all 0 (ebf7deb)

v0.13.0

22 Dec 17:32
Compare
Choose a tag to compare

0.13.0 (2024-12-22)

Features

  • add screen to configure touch sensor (75485d3)
demo_touch_calibration_screen.mp4

v0.12.0

07 Dec 21:22
Compare
Choose a tag to compare

0.12.0 (2024-12-07)

Features

  • display PIN screen immediately upon screen wake-up (e548745)

v0.11.0

29 Jul 00:57
Compare
Choose a tag to compare

0.11.0 (2024-07-29)

Features

  • lock board after N failed unlock attempts (d30f1ab)
20240728_214549.mp4