Fido2Ui.cpp

Go to the documentation of this file.

 
#include "mod_fido2/Fido2Ui.h"
#include "mod_fido2/ctap2.h"
#include "mod_fido2/ctaphid.h"
#include "mod_fido2/fido2.h"
#include "mod_fido2/fido2_storage.h"
#include "cdc_core/KeyFingerprint.h"
#include "cdc_core/PinManager.h"
#include "cdc_core/Raii.h"
#include "cdc_hal/IDisplay.h"
#include "cdc_log.h"
#include "cdc_ui/I18n.h"
#include "cdc_ui/ViewStack.h"
#include "cdc_views/ConfirmView.h"
#include "cdc_views/ContextMenuView.h"
#include "cdc_views/InfoView.h"
#include "cdc_views/ListView.h"
#include "cdc_views/PinEntryView.h"
#include "cdc_views/ToastView.h"
#include <esp_attr.h>
#include <freertos/FreeRTOS.h>
#include <freertos/semphr.h>
#include <algorithm>
#include <cstdio>
#include <cstring>
#include <strings.h>
 
static const char* TAG = "FIDO2_UI";
 
namespace cdc::mod_fido2 {
 
constexpr ui::I18nEntry kStrings[] = {
    {"mod_fido2.title",              "WebAuthn"},
    {"mod_fido2.details",            "Details"},
    {"mod_fido2.fido2_key",          "FIDO2 Key"},
    {"mod_fido2.sign_in_to",         "Sign in to"},
    {"mod_fido2.register_key",       "Register Key"},
    {"mod_fido2.sign_in",            "Sign In"},
    {"mod_fido2.use_device",         "Use this device?"},
    {"mod_fido2.no_entries",         "No entries"},
    {"mod_fido2.overwrite_key",      "OVERWRITE KEY!"},
    {"mod_fido2.overwrite_warning",  "Overwrite existing key?"},
};
 
static void registerStrings() {
    ui::I18n::instance().registerEnglishTable(kStrings, std::size(kStrings));
}

static ui::ListView* s_listView = nullptr;
static ui::InfoView* s_detailView = nullptr;
static ui::InfoView* s_promptView = nullptr;
static ui::PinEntryView* s_pinEntry = nullptr;
 
static ui::ListItem s_listItems[FIDO2_MAX_CREDENTIALS];
EXT_RAM_BSS_ATTR static char s_labels[FIDO2_MAX_CREDENTIALS][100];
static uint8_t s_sortMap[FIDO2_MAX_CREDENTIALS];
static uint8_t s_listCount = 0;

static SemaphoreHandle_t s_promptSem = nullptr;
static SemaphoreHandle_t s_promptMutex = nullptr;
static volatile fido2_user_presence_result_t s_promptResult = FIDO2_UP_PENDING;
static char s_promptRpId[FIDO2_RP_ID_MAX_LEN] = {};
static fido2_action_t s_promptAction = FIDO2_ACTION_AUTHENTICATE;
static uint8_t s_promptReturnDepth = 0;
static ui::IView* s_promptReturnView = nullptr;
static bool s_promptWasLocked = false;
static bool s_promptBacklightWasOn = false;
static volatile bool s_promptActive = false;
 
static void ensurePromptMutex() {
    if (!s_promptMutex) {
        s_promptMutex = xSemaphoreCreateMutex();
    }
}

static SemaphoreHandle_t s_overwriteSem = nullptr;
static volatile bool s_overwriteApproved = false;
 
static void onOverwriteConfirm(void* /*ud*/) {
    s_overwriteApproved = true;
    if (s_overwriteSem) xSemaphoreGive(s_overwriteSem);
}
static void onOverwriteCancel(void* /*ud*/) {
    s_overwriteApproved = false;
    if (s_overwriteSem) xSemaphoreGive(s_overwriteSem);
}

static int strcasecmp_safe(const char* a, const char* b) {
    if (!a && !b) return 0;
    if (!a) return -1;
    if (!b) return 1;
    return strcasecmp(a, b);
}

static void rebuildList() {
    s_listCount = 0;
    uint8_t count = fido2_get_credential_count();
    if (count == 0) {
        // Show "No entries" placeholder
        s_listItems[0].label = ui::tr("mod_fido2.no_entries");
        s_listItems[0].userData = nullptr;
        s_listItems[0].icon = 0;
        s_listItems[0].iconDisabled = true;
        if (s_listView) {
            s_listView->init(ui::tr("mod_fido2.title"), s_listItems, 1);
            s_listView->setHint(ui::tr("core.hint_back"));
        }
        return;
    }
 
    for (uint8_t i = 0; i < count && i < FIDO2_MAX_CREDENTIALS; i++) {
        s_sortMap[i] = i;
        fido2_credential_info_t info = {};
        if (fido2_get_credential_info(i, &info)) {
            if (strlen(info.user_name) > 0) {
                snprintf(s_labels[i], sizeof(s_labels[i]),
                         "%.45s (%.45s)", info.rp_id, info.user_name);
            } else {
                snprintf(s_labels[i], sizeof(s_labels[i]),
                         "%.45s", info.rp_id);
            }
        } else {
            s_labels[i][0] = '\0';
        }
    }
 
    std::sort(s_sortMap, s_sortMap + count, [](uint8_t a, uint8_t b) {
        return strcasecmp_safe(s_labels[a], s_labels[b]) < 0;
    });
 
    for (uint8_t display = 0; display < count; display++) {
        uint8_t store_idx = s_sortMap[display];
        s_listItems[display].label = s_labels[store_idx];
        s_listItems[display].userData = reinterpret_cast<void*>(static_cast<uintptr_t>(display));
        s_listItems[display].icon = 0;
        s_listItems[display].iconDisabled = false;
        s_listCount++;
    }
 
    if (s_listView) {
        s_listView->init(ui::tr("mod_fido2.title"), s_listItems, s_listCount);
        s_listView->setHint(ui::tr("core.hint_list_menu"));
    }
}

static void showDetail(uint16_t display_index) {
    uint8_t count = fido2_get_credential_count();
    if (display_index >= count) return;
 
    uint8_t store_index = s_sortMap[display_index];
    fido2_credential_info_t info = {};
    if (!fido2_get_credential_info(store_index, &info)) {
        return;
    }
 
    const char* key_type = (strncmp(info.rp_id, "ssh:", 4) == 0) ? "SSH" : "WebAuthn";
    const char* algo_name = (info.curve == CDC_CURVE_ED25519) ? "Ed25519" : "P-256";
 
    char fingerprint[KEY_FINGERPRINT_MAX_LEN] = {};
    uint8_t pubkey[64] = {};
    size_t pubkey_len = (info.curve == CDC_CURVE_ED25519) ? 32 : 64;
    if (fido2_storage_get_pubkey(info.slot, pubkey)) {
        key_fingerprint_from_pubkey(pubkey, pubkey_len, fingerprint, sizeof(fingerprint));
    } else {
        strlcpy(fingerprint, "(no key)", sizeof(fingerprint));
    }
 
    static char detail_text[384];
    uint16_t slot_phys = static_cast<uint16_t>(fido2_storage_ecc_start() + info.slot);
    snprintf(detail_text, sizeof(detail_text),
             "Relying Party:\n%s\n\n"
             "Type: %s  Algo: %s\n"
             "User: %s\n"
             "Slot: %d\n"
             "Sign count: %lu\n"
             "Resident: %s\n\n"
             "Fingerprint:\n%s\n\n"
             "%s",
             info.rp_id,
             key_type, algo_name,
             strlen(info.user_name) > 0 ? info.user_name : "(none)",
             slot_phys,
             info.sign_count,
             info.resident_key ? ui::tr("core.yes") : ui::tr("core.no"),
             fingerprint,
             ui::tr("core.hint_back"));
 
    if (!s_detailView) {
        s_detailView = new ui::InfoView();
    }
    s_detailView->init(ui::tr("mod_fido2.fido2_key"), detail_text);
    ui::ViewStack::instance().push(s_detailView);
}

static void handleDelete(uint16_t display_index) {
    uint8_t count = fido2_get_credential_count();
    if (display_index >= count) return;
 
    uint8_t store_index = s_sortMap[display_index];
    fido2_credential_info_t info = {};
    if (!fido2_get_credential_info(store_index, &info)) {
        return;
    }
 
    if (fido2_delete_credential(info.slot)) {
        rebuildList();
        if (s_listView) {
            s_listView->init(ui::tr("mod_fido2.title"), s_listItems, s_listCount);
            s_listView->setHint(ui::tr("core.hint_list_menu"));
        }
    }
}

static void onListSelect(uint16_t index, void* userData) {
    (void)userData;
    showDetail(index);
}

static void onListMenu(uint16_t index, void* userData) {
    (void)userData;
    if (s_listCount == 0) return;
 
    static ui::ContextMenuItem items[3];
    uint16_t sel = s_listView ? s_listView->getSelection() : index;
    if (sel >= s_listCount) {
        sel = 0;
    }
    items[0] = {ui::tr("mod_fido2.details"), []() { showDetail(s_listView ? s_listView->getSelection() : 0); }};
    items[1] = {ui::tr("core.delete"), []() { handleDelete(s_listView ? s_listView->getSelection() : 0); }};
    items[2] = {ui::tr("core.cancel"), []() {}};
    static char s_contextTitle[FIDO2_RP_ID_MAX_LEN] = {};
    const uint8_t store_idx = s_sortMap[sel];
    fido2_credential_info_t info = {};
    const char* title = s_labels[store_idx];
    if (fido2_get_credential_info(store_idx, &info)) {
        strncpy(s_contextTitle, info.rp_id, sizeof(s_contextTitle) - 1);
        s_contextTitle[sizeof(s_contextTitle) - 1] = '\0';
        title = s_contextTitle;
    }
    showContextMenu(title, items, 3);
}

static void restoreView() {
    auto& stack = ui::ViewStack::instance();
    while (stack.depth() > s_promptReturnDepth) {
        stack.pop();
    }
}

static void promptComplete(fido2_user_presence_result_t result) {
    s_promptActive = false;
 
    if (result == FIDO2_UP_APPROVED) {
        ui::showToastSuccess(ui::tr("core.ok"), 2000);
    } else {
        ui::showToastError(ui::tr("core.failed"), 2000);
    }
 
    auto& stack = ui::ViewStack::instance();
    stack.releaseExclusive(s_promptView);
 
    restoreView();
 
    if (result == FIDO2_UP_APPROVED &&
        (s_promptAction == FIDO2_ACTION_REGISTER || s_promptAction == FIDO2_ACTION_OVERWRITE) &&
        s_promptReturnView == s_listView) {
        rebuildList();
    }
 
    auto* display = cdc::hal::getDisplayInstance();
    if (display && !s_promptBacklightWasOn) {
        display->backlightOff();
    }
 
    stack.render();
 
    s_promptResult = result;
    if (s_promptSem) {
        xSemaphoreGive(s_promptSem);
    }
}

static bool onPinVerify(const char* pin) {
    return cdc::core::PinManager::instance().verifyBadgePin(pin);
}

static void onPinSuccess() {
    auto& stack = ui::ViewStack::instance();
    stack.releaseExclusive(s_pinEntry);
    stack.acquireExclusive(s_promptView);
    promptComplete(FIDO2_UP_APPROVED);
}

static void onPinCancel() {
    auto& stack = ui::ViewStack::instance();
    stack.releaseExclusive(s_pinEntry);
    stack.acquireExclusive(s_promptView);
    promptComplete(FIDO2_UP_DENIED);
}

static void onPinFailure(bool lockedOut) {
    if (lockedOut) {
        ui::showToastError(ui::tr("core.too_many_attempts"), 2000);
        auto& stack = ui::ViewStack::instance();
        stack.releaseExclusive(s_pinEntry);
        stack.acquireExclusive(s_promptView);
        promptComplete(FIDO2_UP_DENIED);
    } else {
        ui::showToastError(ui::tr("core.wrong_pin"), 1000);
    }
}

static void onPromptApprove(void* userData) {
    (void)userData;
    if (fido2_is_pin_verified()) {
        promptComplete(FIDO2_UP_APPROVED);
        return;
    }
 
    if (s_promptWasLocked && cdc::core::PinManager::instance().isPinSet()) {
        if (!s_pinEntry) {
            s_pinEntry = new ui::PinEntryView();
            s_pinEntry->init(ui::tr("core.enter_pin"),
                             cdc::core::PinManager::BADGE_PIN_MAX, 3);
            s_pinEntry->setMinLength(cdc::core::PinManager::BADGE_PIN_MIN);
            s_pinEntry->setOnVerify(onPinVerify);
            s_pinEntry->setOnSuccess(onPinSuccess);
            s_pinEntry->setOnCancel(onPinCancel);
            s_pinEntry->setOnFailure(onPinFailure);
            s_pinEntry->setShowMessages(false);
        } else {
            s_pinEntry->init(ui::tr("core.enter_pin"),
                             cdc::core::PinManager::BADGE_PIN_MAX, 3);
            s_pinEntry->setMinLength(cdc::core::PinManager::BADGE_PIN_MIN);
            s_pinEntry->setShowMessages(false);
        }
        {
            auto& stack = ui::ViewStack::instance();
            stack.releaseExclusive(s_promptView);
            stack.acquireExclusive(s_pinEntry);
            stack.push(s_pinEntry);
        }
        return;
    }
 
    promptComplete(FIDO2_UP_APPROVED);
}

static void onPromptDeny(void* userData) {
    (void)userData;
    fido2_set_pin_verified(false);
    promptComplete(FIDO2_UP_DENIED);
}

void fido2_ui_init() {
    registerStrings();
    if (!s_listView) {
        s_listView = new ui::ListView();
        s_listView->setOnSelect(onListSelect);
        s_listView->setOnMenu(onListMenu);
    }
    rebuildList();
 
    if (!s_promptSem) {
        s_promptSem = xSemaphoreCreateBinary();
    }
}

cdc::ui::IView* fido2_ui_get_list_view() {
    if (!s_listView) {
        fido2_ui_init();
    }
    rebuildList();
    return s_listView;
}

const char* fido2_ui_get_label() {
    return ui::tr("mod_fido2.title");
}

fido2_user_presence_result_t fido2_ui_user_presence_callback(
    const char* rp_id,
    fido2_action_t action,
    const char* user_name
) {
    (void)user_name;
 
    const char* actionStr = (action == FIDO2_ACTION_SELECT) ? "SELECT" :
                            (action == FIDO2_ACTION_REGISTER) ? "REGISTER" :
                            (action == FIDO2_ACTION_OVERWRITE) ? "OVERWRITE" : "AUTH";
    LOG_I(TAG, "User presence: action=%s, rp='%s', promptActive=%d",
          actionStr, rp_id ? rp_id : "(null)", s_promptActive ? 1 : 0);
 
    // Browser-discovery probes never touch the UI: they are protocol-only
    // pings to ask "is a device there?" and must not influence presence state.
    if (action == FIDO2_ACTION_SELECT && rp_id &&
        (strcmp(rp_id, ".dummy") == 0 || strcmp(rp_id, "make.me.blink") == 0)) {
        LOG_I(TAG, "Auto-approving browser probe '%s'", rp_id);
        return FIDO2_UP_APPROVED;
    }
 
    ensurePromptMutex();
 
    if (s_promptActive) {
        LOG_W(TAG, "Presence request supersedes active prompt -> cancel old");
        fido2_ui_abort_prompt();
    }
 
    cdc::core::MutexGuard prompt_lock(s_promptMutex);
 
    if (!s_promptSem) {
        s_promptSem = xSemaphoreCreateBinary();
        if (!s_promptSem) {
            return FIDO2_UP_DENIED;
        }
    }
 
    if (action == FIDO2_ACTION_OVERWRITE) {
        if (!s_overwriteSem) {
            s_overwriteSem = xSemaphoreCreateBinary();
            if (!s_overwriteSem) {
                return FIDO2_UP_DENIED;
            }
        }
        while (xSemaphoreTake(s_overwriteSem, 0) == pdTRUE) {}
 
        auto* display = cdc::hal::getDisplayInstance();
        bool backlightWasOn = display && display->isBacklightOn();
        if (display && !backlightWasOn) {
            display->backlightOn();
        }
 
        const char* confirm_msg = ui::tr("mod_fido2.overwrite_warning");
 
        s_overwriteApproved = false;
        ui::showConfirm(confirm_msg, onOverwriteConfirm, onOverwriteCancel,
                        ui::ConfirmView::Icon::WARNING);
 
        const uint32_t cid = ctaphid_get_current_cid();
        const TickType_t poll = pdMS_TO_TICKS(100);
        TickType_t remaining = pdMS_TO_TICKS(30000);
        bool approved = false;
        bool timedOut = true;
        while (remaining > 0) {
            TickType_t wait = remaining < poll ? remaining : poll;
            if (xSemaphoreTake(s_overwriteSem, wait) == pdTRUE) {
                approved = s_overwriteApproved;
                timedOut = false;
                break;
            }
            ctaphid_send_keepalive(cid, CTAPHID_STATUS_UPNEEDED);
            remaining -= wait;
        }
        if (timedOut) {
            LOG_W(TAG, "Overwrite confirm timeout");
        }
 
        if (!approved) {
            if (display && !backlightWasOn) {
                display->backlightOff();
            }
            LOG_I(TAG, "Overwrite denied/timeout - aborting registration");
            return FIDO2_UP_DENIED;
        }
        LOG_I(TAG, "Overwrite acknowledged, proceeding to user-presence prompt");
        action = FIDO2_ACTION_REGISTER;
    }
 
    strncpy(s_promptRpId, rp_id ? rp_id : "Unknown", sizeof(s_promptRpId) - 1);
    s_promptRpId[sizeof(s_promptRpId) - 1] = '\0';
    s_promptAction = action;
    s_promptResult = FIDO2_UP_PENDING;
    s_promptActive = true;  // Mark prompt as active for race condition detection
 
    while (xSemaphoreTake(s_promptSem, 0) == pdTRUE) {
        LOG_W(TAG, "Drained stale semaphore");
    }
 
    if (!s_promptView) {
        s_promptView = new ui::InfoView();
    }
 
    auto& stack = ui::ViewStack::instance();
    if (!stack.acquireExclusive(s_promptView)) {
        LOG_W(TAG, "Could not acquire ViewStack lock for FIDO2 prompt");
        s_promptActive = false;
        return FIDO2_UP_DENIED;
    }
    s_promptReturnDepth = stack.depth();
    s_promptReturnView = stack.current();
    s_promptWasLocked = (s_promptReturnDepth <= 1) && (action != FIDO2_ACTION_SELECT);
 
    // A WebAuthn request takes priority: dismiss any open modal (e.g. the
    // lock-screen actions menu), which would otherwise overlay the prompt and
    // swallow all key input.
    stack.hideModal();
 
    auto* display = cdc::hal::getDisplayInstance();
    if (display) {
        s_promptBacklightWasOn = display->isBacklightOn();
        if (!s_promptBacklightWasOn) {
            display->backlightOn();
        }
    }
 
    const char* headline = nullptr;
    if (action == FIDO2_ACTION_SELECT) {
        headline = ui::tr("mod_fido2.use_device");
    } else if (action == FIDO2_ACTION_REGISTER) {
        headline = ui::tr("mod_fido2.register_key");
    } else if (action == FIDO2_ACTION_OVERWRITE) {
        headline = ui::tr("mod_fido2.overwrite_key");
    } else {
        headline = ui::tr("mod_fido2.sign_in");
    }
 
    static char prompt_text[260];
    if (action == FIDO2_ACTION_SELECT) {
        snprintf(prompt_text, sizeof(prompt_text),
                 "%s\n\n%s",
                 headline,
                 ui::tr("core.hint_approve_deny"));
    } else if (action == FIDO2_ACTION_OVERWRITE) {
        snprintf(prompt_text, sizeof(prompt_text),
                 "!!! %s !!!\n\n%s\n\n%s\n\n%s",
                 headline,
                 s_promptRpId,
                 ui::tr("mod_fido2.overwrite_warning"),
                 ui::tr("core.hint_approve_deny"));
    } else {
        snprintf(prompt_text, sizeof(prompt_text),
                 "%s\n\n%s\n\n%s",
                 headline,
                 s_promptRpId,
                 ui::tr("core.hint_approve_deny"));
    }
 
    const char* title = ui::tr("mod_fido2.title");
    LOG_I(TAG, "Prompt title='%s', text='%.50s...'", title ? title : "(null)", prompt_text);
 
    s_promptView->init(title, prompt_text);
    s_promptView->setYesNoCallbacks(onPromptApprove, onPromptDeny, nullptr);
 
    stack.push(s_promptView);
    stack.resetInactivityTimer();
    stack.render();
 
    ctap2_clear_cancel();
 
    const uint32_t up_cid = ctaphid_get_current_cid();
    const TickType_t up_poll = pdMS_TO_TICKS(100);
    TickType_t up_remaining = pdMS_TO_TICKS(30000);
    bool up_done = false;
    bool up_cancelled = false;
    while (up_remaining > 0) {
        TickType_t wait = up_remaining < up_poll ? up_remaining : up_poll;
        if (xSemaphoreTake(s_promptSem, wait) == pdTRUE) {
            up_done = true;
            break;
        }
        if (ctap2_is_cancelled()) {
            up_cancelled = true;
            break;
        }
        ctaphid_send_keepalive(up_cid, CTAPHID_STATUS_UPNEEDED);
        up_remaining -= wait;
    }
    if (up_done) {
        fido2_user_presence_result_t result = s_promptResult;
        s_promptActive = false;
        if (result == FIDO2_UP_PENDING) {
            LOG_W(TAG, "Semaphore signalled with PENDING result -> deny");
            result = FIDO2_UP_DENIED;
        }
        return result;
    }
 
    if (up_cancelled) {
        LOG_W(TAG, "User presence cancelled by CTAP host");
    } else {
        LOG_W(TAG, "User presence timeout");
    }
    s_promptActive = false;
    stack.releaseExclusive(s_promptView);
    restoreView();
 
    if (display && !s_promptBacklightWasOn) {
        display->backlightOff();
    }
 
    stack.render();
    return up_cancelled ? FIDO2_UP_DENIED : FIDO2_UP_TIMEOUT;
}
 
bool fido2_ui_abort_prompt() {
    if (!s_promptActive) {
        return false;
    }
    LOG_W(TAG, "Prompt aborted externally");
    promptComplete(FIDO2_UP_DENIED);
    return true;
}
 
} // namespace cdc::mod_fido2