NFC refactoring (#3050)

"A long time ago in a galaxy far, far away...." we started NFC subsystem refactoring. Starring: - @gornekich - NFC refactoring project lead, architect, senior developer - @gsurkov - architect, senior developer - @RebornedBrain - senior developer Supporting roles: - @skotopes, @DrZlo13, @hedger - general architecture advisors, code review - @Astrrra, @doomwastaken, @Hellitron, @ImagineVagon333 - quality assurance Special thanks: @bettse, @pcunning, @nxv, @noproto, @AloneLiberty and everyone else who has been helping us all this time and contributing valuable knowledges, ideas and source code.
2023-10-24 12:08:09 +09:00
parent 35c903494c
commit d92b0a82cc
514 changed files with 41487 additions and 68124 deletions
@@ -0,0 +1,252 @@
+#include "mf_classic.h"
+#include "mf_classic_render.h"
+
+#include <nfc/protocols/mf_classic/mf_classic_poller.h>
+
+#include "nfc/nfc_app_i.h"
+
+#include "../nfc_protocol_support_common.h"
+#include "../nfc_protocol_support_gui_common.h"
+
+#define TAG "MfClassicApp"
+
+enum {
+    SubmenuIndexDetectReader = SubmenuIndexCommonMax,
+    SubmenuIndexWrite,
+    SubmenuIndexUpdate,
+};
+
+static void nfc_scene_info_on_enter_mf_classic(NfcApp* instance) {
+    const NfcDevice* device = instance->nfc_device;
+    const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
+
+    FuriString* temp_str = furi_string_alloc();
+    furi_string_cat_printf(
+        temp_str, "\e#%s\n", nfc_device_get_name(device, NfcDeviceNameTypeFull));
+    nfc_render_mf_classic_info(data, NfcProtocolFormatTypeFull, temp_str);
+
+    widget_add_text_scroll_element(
+        instance->widget, 0, 0, 128, 52, furi_string_get_cstr(temp_str));
+
+    furi_string_free(temp_str);
+}
+
+static void nfc_scene_more_info_on_enter_mf_classic(NfcApp* instance) {
+    const NfcDevice* device = instance->nfc_device;
+    const MfClassicData* mfc_data = nfc_device_get_data(device, NfcProtocolMfClassic);
+
+    furi_string_reset(instance->text_box_store);
+    nfc_render_mf_classic_dump(mfc_data, instance->text_box_store);
+
+    text_box_set_font(instance->text_box, TextBoxFontHex);
+    text_box_set_text(instance->text_box, furi_string_get_cstr(instance->text_box_store));
+    view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewTextBox);
+}
+
+static NfcCommand nfc_scene_read_poller_callback_mf_classic(NfcGenericEvent event, void* context) {
+    furi_assert(event.protocol == NfcProtocolMfClassic);
+
+    NfcApp* instance = context;
+    const MfClassicPollerEvent* mfc_event = event.event_data;
+    NfcCommand command = NfcCommandContinue;
+
+    if(mfc_event->type == MfClassicPollerEventTypeRequestMode) {
+        nfc_device_set_data(
+            instance->nfc_device, NfcProtocolMfClassic, nfc_poller_get_data(instance->poller));
+        size_t uid_len = 0;
+        const uint8_t* uid = nfc_device_get_uid(instance->nfc_device, &uid_len);
+        if(mf_classic_key_cache_load(instance->mfc_key_cache, uid, uid_len)) {
+            FURI_LOG_I(TAG, "Key cache found");
+            mfc_event->data->poller_mode.mode = MfClassicPollerModeRead;
+        } else {
+            FURI_LOG_I(TAG, "Key cache not found");
+            view_dispatcher_send_custom_event(
+                instance->view_dispatcher, NfcCustomEventPollerIncomplete);
+            command = NfcCommandStop;
+        }
+    } else if(mfc_event->type == MfClassicPollerEventTypeRequestReadSector) {
+        uint8_t sector_num = 0;
+        MfClassicKey key = {};
+        MfClassicKeyType key_type = MfClassicKeyTypeA;
+        if(mf_classic_key_cahce_get_next_key(
+               instance->mfc_key_cache, &sector_num, &key, &key_type)) {
+            mfc_event->data->read_sector_request_data.sector_num = sector_num;
+            mfc_event->data->read_sector_request_data.key = key;
+            mfc_event->data->read_sector_request_data.key_type = key_type;
+            mfc_event->data->read_sector_request_data.key_provided = true;
+        } else {
+            mfc_event->data->read_sector_request_data.key_provided = false;
+        }
+    } else if(mfc_event->type == MfClassicPollerEventTypeSuccess) {
+        nfc_device_set_data(
+            instance->nfc_device, NfcProtocolMfClassic, nfc_poller_get_data(instance->poller));
+        const MfClassicData* mfc_data =
+            nfc_device_get_data(instance->nfc_device, NfcProtocolMfClassic);
+        NfcCustomEvent custom_event = mf_classic_is_card_read(mfc_data) ?
+                                          NfcCustomEventPollerSuccess :
+                                          NfcCustomEventPollerIncomplete;
+        view_dispatcher_send_custom_event(instance->view_dispatcher, custom_event);
+        command = NfcCommandStop;
+    }
+
+    return command;
+}
+
+static void nfc_scene_read_on_enter_mf_classic(NfcApp* instance) {
+    mf_classic_key_cache_reset(instance->mfc_key_cache);
+    nfc_poller_start(instance->poller, nfc_scene_read_poller_callback_mf_classic, instance);
+}
+
+static bool nfc_scene_read_on_event_mf_classic(NfcApp* instance, uint32_t event) {
+    if(event == NfcCustomEventPollerIncomplete) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicDictAttack);
+    }
+
+    return true;
+}
+
+static void nfc_scene_read_menu_on_enter_mf_classic(NfcApp* instance) {
+    Submenu* submenu = instance->submenu;
+    const MfClassicData* data = nfc_device_get_data(instance->nfc_device, NfcProtocolMfClassic);
+
+    if(!mf_classic_is_card_read(data)) {
+        submenu_add_item(
+            submenu,
+            "Detect Reader",
+            SubmenuIndexDetectReader,
+            nfc_protocol_support_common_submenu_callback,
+            instance);
+    }
+}
+
+static void nfc_scene_read_success_on_enter_mf_classic(NfcApp* instance) {
+    const NfcDevice* device = instance->nfc_device;
+    const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
+
+    FuriString* temp_str = furi_string_alloc();
+    furi_string_cat_printf(
+        temp_str, "\e#%s\n", nfc_device_get_name(device, NfcDeviceNameTypeFull));
+    nfc_render_mf_classic_info(data, NfcProtocolFormatTypeShort, temp_str);
+
+    widget_add_text_scroll_element(
+        instance->widget, 0, 0, 128, 52, furi_string_get_cstr(temp_str));
+
+    furi_string_free(temp_str);
+}
+
+static void nfc_scene_saved_menu_on_enter_mf_classic(NfcApp* instance) {
+    Submenu* submenu = instance->submenu;
+    const MfClassicData* data = nfc_device_get_data(instance->nfc_device, NfcProtocolMfClassic);
+
+    if(!mf_classic_is_card_read(data)) {
+        submenu_add_item(
+            submenu,
+            "Detect Reader",
+            SubmenuIndexDetectReader,
+            nfc_protocol_support_common_submenu_callback,
+            instance);
+    }
+    submenu_add_item(
+        submenu,
+        "Write to Initial Card",
+        SubmenuIndexWrite,
+        nfc_protocol_support_common_submenu_callback,
+        instance);
+    submenu_add_item(
+        submenu,
+        "Update from Initial Card",
+        SubmenuIndexUpdate,
+        nfc_protocol_support_common_submenu_callback,
+        instance);
+}
+
+static void nfc_scene_emulate_on_enter_mf_classic(NfcApp* instance) {
+    const MfClassicData* data = nfc_device_get_data(instance->nfc_device, NfcProtocolMfClassic);
+    instance->listener = nfc_listener_alloc(instance->nfc, NfcProtocolMfClassic, data);
+    nfc_listener_start(instance->listener, NULL, NULL);
+}
+
+static bool nfc_scene_read_menu_on_event_mf_classic(NfcApp* instance, uint32_t event) {
+    if(event == SubmenuIndexDetectReader) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicDetectReader);
+        dolphin_deed(DolphinDeedNfcDetectReader);
+        return true;
+    }
+
+    return false;
+}
+
+static bool nfc_scene_saved_menu_on_event_mf_classic(NfcApp* instance, uint32_t event) {
+    bool consumed = false;
+
+    if(event == SubmenuIndexDetectReader) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicDetectReader);
+        consumed = true;
+    } else if(event == SubmenuIndexWrite) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicWriteInitial);
+        consumed = true;
+    } else if(event == SubmenuIndexUpdate) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicUpdateInitial);
+        consumed = true;
+    }
+
+    return consumed;
+}
+
+static bool nfc_scene_save_name_on_event_mf_classic(NfcApp* instance, uint32_t event) {
+    bool consumed = false;
+
+    if(event == NfcCustomEventTextInputDone) {
+        mf_classic_key_cache_save(
+            instance->mfc_key_cache,
+            nfc_device_get_data(instance->nfc_device, NfcProtocolMfClassic));
+        consumed = true;
+    }
+
+    return consumed;
+}
+
+const NfcProtocolSupportBase nfc_protocol_support_mf_classic = {
+    .features = NfcProtocolFeatureEmulateFull | NfcProtocolFeatureMoreInfo,
+
+    .scene_info =
+        {
+            .on_enter = nfc_scene_info_on_enter_mf_classic,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_more_info =
+        {
+            .on_enter = nfc_scene_more_info_on_enter_mf_classic,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_read =
+        {
+            .on_enter = nfc_scene_read_on_enter_mf_classic,
+            .on_event = nfc_scene_read_on_event_mf_classic,
+        },
+    .scene_read_menu =
+        {
+            .on_enter = nfc_scene_read_menu_on_enter_mf_classic,
+            .on_event = nfc_scene_read_menu_on_event_mf_classic,
+        },
+    .scene_read_success =
+        {
+            .on_enter = nfc_scene_read_success_on_enter_mf_classic,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_saved_menu =
+        {
+            .on_enter = nfc_scene_saved_menu_on_enter_mf_classic,
+            .on_event = nfc_scene_saved_menu_on_event_mf_classic,
+        },
+    .scene_save_name =
+        {
+            .on_enter = nfc_protocol_support_common_on_enter_empty,
+            .on_event = nfc_scene_save_name_on_event_mf_classic,
+        },
+    .scene_emulate =
+        {
+            .on_enter = nfc_scene_emulate_on_enter_mf_classic,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+};
@@ -0,0 +1,5 @@
+#pragma once
+
+#include "../nfc_protocol_support_base.h"
+
+extern const NfcProtocolSupportBase nfc_protocol_support_mf_classic;
@@ -0,0 +1,30 @@
+#include "mf_classic_render.h"
+
+#include "../iso14443_3a/iso14443_3a_render.h"
+
+void nfc_render_mf_classic_info(
+    const MfClassicData* data,
+    NfcProtocolFormatType format_type,
+    FuriString* str) {
+    nfc_render_iso14443_3a_info(data->iso14443_3a_data, format_type, str);
+
+    uint8_t sectors_total = mf_classic_get_total_sectors_num(data->type);
+    uint8_t keys_total = sectors_total * 2;
+    uint8_t keys_found = 0;
+    uint8_t sectors_read = 0;
+    mf_classic_get_read_sectors_and_keys(data, &sectors_read, &keys_found);
+
+    furi_string_cat_printf(str, "\nKeys Found: %u/%u", keys_found, keys_total);
+    furi_string_cat_printf(str, "\nSectors Read: %u/%u", sectors_read, sectors_total);
+}
+
+void nfc_render_mf_classic_dump(const MfClassicData* data, FuriString* str) {
+    uint16_t total_blocks = mf_classic_get_total_block_num(data->type);
+
+    for(size_t i = 0; i < total_blocks; i++) {
+        for(size_t j = 0; j < sizeof(MfClassicBlock); j += 2) {
+            furi_string_cat_printf(
+                str, "%02X%02X ", data->block[i].data[j], data->block[i].data[j + 1]);
+        }
+    }
+}
@@ -0,0 +1,12 @@
+#pragma once
+
+#include <nfc/protocols/mf_classic/mf_classic.h>
+
+#include "../nfc_protocol_support_render_common.h"
+
+void nfc_render_mf_classic_info(
+    const MfClassicData* data,
+    NfcProtocolFormatType format_type,
+    FuriString* str);
+
+void nfc_render_mf_classic_dump(const MfClassicData* data, FuriString* str);