subbrute_device.c

#include "subbrute_device.h"

#include <storage/storage.h>
#include <lib/flipper_format/flipper_format_i.h>
#include <lib/subghz/subghz_protocol_registry.h>

#define TAG "SubBruteDevice"

SubBruteDevice* subbrute_device_alloc(const SubGhzDevice* radio_device) {
    SubBruteDevice* instance = malloc(sizeof(SubBruteDevice));

    instance->current_step = 0;

    instance->protocol_info = NULL;
    instance->file_protocol_info = NULL;
    instance->decoder_result = NULL;
    instance->receiver = NULL;
    instance->environment = subghz_environment_alloc();
    subghz_environment_set_protocol_registry(
        instance->environment, (void*)&subghz_protocol_registry);

    instance->radio_device = radio_device;

    subbrute_device_attack_set_default_values(instance, SubBruteAttackCAME12bit433);

    return instance;
}

void subbrute_device_free(SubBruteDevice* instance) {
    furi_assert(instance);

    // I don't know how to free this
    instance->decoder_result = NULL;

    if(instance->receiver != NULL) {
        subghz_receiver_free(instance->receiver);
        instance->receiver = NULL;
    }

    subghz_environment_free(instance->environment);
    instance->environment = NULL;

    subbrute_device_free_protocol_info(instance);

    free(instance);
}

uint64_t subbrute_device_add_step(SubBruteDevice* instance, int8_t step) {
    if(step > 0) {
        if((instance->current_step + step) - instance->max_value == 1) {
            instance->current_step = 0x00;
        } else {
            uint64_t value = instance->current_step + step;
            if(value == instance->max_value) {
                instance->current_step = value;
            } else {
                instance->current_step = value % instance->max_value;
            }
        }
    } else {
        if(instance->current_step + step == 0) {
            instance->current_step = 0x00;
        } else if(instance->current_step == 0) {
            instance->current_step = instance->max_value;
        } else {
            uint64_t value = ((instance->current_step + step) + instance->max_value);
            if(value == instance->max_value) {
                instance->current_step = value;
            } else {
                instance->current_step = value % instance->max_value;
            }
        }
    }

    return instance->current_step;
}

bool subbrute_device_save_file(SubBruteDevice* instance, const char* dev_file_name) {
    furi_assert(instance);

#ifdef FURI_DEBUG
    FURI_LOG_D(TAG, "subbrute_device_save_file: %s", dev_file_name);
#endif

    Storage* storage = furi_record_open(RECORD_STORAGE);
    FlipperFormat* file = flipper_format_file_alloc(storage);
    bool result = false;
    do {
        if(!flipper_format_file_open_always(file, dev_file_name)) {
            FURI_LOG_E(TAG, "Failed to open file: %s", dev_file_name);
            break;
        }
        Stream* stream = flipper_format_get_raw_stream(file);
        if(instance->attack == SubBruteAttackLoadFile) {
            subbrute_protocol_file_generate_file(
                stream,
                instance->file_protocol_info->frequency,
                instance->file_protocol_info->preset,
                instance->file_protocol_info->file,
                instance->current_step,
                instance->file_protocol_info->bits,
                instance->file_protocol_info->te,
                instance->bit_index,
                instance->key_from_file,
                instance->two_bytes);
        } else {
            subbrute_protocol_default_generate_file(
                stream,
                instance->protocol_info->frequency,
                instance->protocol_info->preset,
                instance->protocol_info->file,
                instance->current_step,
                instance->protocol_info->bits,
                instance->protocol_info->te);
        }

        result = true;
    } while(false);

    if(!result) {
        FURI_LOG_E(TAG, "subbrute_device_save_file failed!");
    }

    flipper_format_file_close(file);
    flipper_format_free(file);
    furi_record_close(RECORD_STORAGE);

    return result;
}

SubBruteFileResult subbrute_device_attack_set(
    SubBruteDevice* instance,
    SubBruteAttacks type,
    uint8_t extra_repeats) {
    furi_assert(instance);
#ifdef FURI_DEBUG
    FURI_LOG_D(TAG, "subbrute_device_attack_set: %d, extra_repeats: %d", type, extra_repeats);
#endif
    subbrute_device_attack_set_default_values(instance, type);

    if(type != SubBruteAttackLoadFile) {
        subbrute_device_free_protocol_info(instance);
        instance->protocol_info = subbrute_protocol(type);
    }

    instance->extra_repeats = extra_repeats;

    // For non-file types we didn't set SubGhzProtocolDecoderBase
    instance->receiver = subghz_receiver_alloc_init(instance->environment);
    subghz_receiver_set_filter(instance->receiver, SubGhzProtocolFlag_Decodable);
    // furi_hal_subghz_reset(); // TODO Is this necessary?

    uint8_t protocol_check_result = SubBruteFileResultProtocolNotFound;
#ifdef FURI_DEBUG
    uint8_t bits;
    uint32_t te;
    uint8_t repeat;
    FuriHalSubGhzPreset preset;
    SubBruteFileProtocol file;
#endif
    if(type != SubBruteAttackLoadFile) {
        instance->decoder_result = subghz_receiver_search_decoder_base_by_name(
            instance->receiver, subbrute_protocol_file(instance->protocol_info->file));

        if(!instance->decoder_result ||
           instance->decoder_result->protocol->type == SubGhzProtocolTypeDynamic) {
            FURI_LOG_E(TAG, "Can't load SubGhzProtocolDecoderBase in phase non-file decoder set");
        } else {
            protocol_check_result = SubBruteFileResultOk;

            // Calc max value
            instance->max_value = subbrute_protocol_calc_max_value(
                instance->attack, instance->protocol_info->bits, instance->two_bytes);
        }
#ifdef FURI_DEBUG
        bits = instance->protocol_info->bits;
        te = instance->protocol_info->te;
        repeat = instance->protocol_info->repeat + instance->extra_repeats;
        preset = instance->protocol_info->preset;
        file = instance->protocol_info->file;
#endif
    } else {
        // And here we need to set preset enum
        protocol_check_result = SubBruteFileResultOk;

        // Calc max value
        instance->max_value = subbrute_protocol_calc_max_value(
            instance->attack, instance->file_protocol_info->bits, instance->two_bytes);
#ifdef FURI_DEBUG
        bits = instance->file_protocol_info->bits;
        te = instance->file_protocol_info->te;
        repeat = instance->file_protocol_info->repeat + instance->extra_repeats;
        preset = instance->file_protocol_info->preset;
        file = instance->file_protocol_info->file;
#endif
    }

    subghz_receiver_free(instance->receiver);
    instance->receiver = NULL;

    if(protocol_check_result != SubBruteFileResultOk) {
        return SubBruteFileResultProtocolNotFound;
    }

#ifdef FURI_DEBUG
    FURI_LOG_I(
        TAG,
        "subbrute_device_attack_set: %s, bits: %d, preset: %s, file: %s, te: %ld, repeat: %d, max_value: %lld",
        subbrute_protocol_name(instance->attack),
        bits,
        subbrute_protocol_preset(preset),
        subbrute_protocol_file(file),
        te,
        repeat,
        instance->max_value);
#endif

    return SubBruteFileResultOk;
}

uint8_t subbrute_device_load_from_file(SubBruteDevice* instance, const char* file_path) {
    furi_assert(instance);
#ifdef FURI_DEBUG
    FURI_LOG_D(TAG, "subbrute_device_load_from_file: %s", file_path);
#endif
    SubBruteFileResult result;

    Storage* storage = furi_record_open(RECORD_STORAGE);
    FlipperFormat* fff_data_file = flipper_format_file_alloc(storage);

    subbrute_device_free_protocol_info(instance);
    instance->file_protocol_info = malloc(sizeof(SubBruteProtocol));

    FuriString* temp_str;
    temp_str = furi_string_alloc();
    uint32_t temp_data32;

    instance->receiver = subghz_receiver_alloc_init(instance->environment);
    subghz_receiver_set_filter(instance->receiver, SubGhzProtocolFlag_Decodable);
    // furi_hal_subghz_reset(); // TODO Is this necessary?

    do {
        if(!flipper_format_file_open_existing(fff_data_file, file_path)) {
            FURI_LOG_E(TAG, "Error open file %s", file_path);
            result = SubBruteFileResultErrorOpenFile;
            break;
        }
        if(!flipper_format_read_header(fff_data_file, temp_str, &temp_data32)) {
            FURI_LOG_E(TAG, error_device_missing_header);
            result = SubBruteFileResultMissingOrIncorrectHeader;
            break;
        }

        // Frequency
        if(!flipper_format_read_uint32(fff_data_file, "Frequency", &temp_data32, 1)) {
            FURI_LOG_E(TAG, error_device_incorrect_frequency);
            result = SubBruteFileResultMissingOrIncorrectFrequency;
            break;
        }

        if(!subghz_devices_is_frequency_valid(instance->radio_device, temp_data32)) {
            FURI_LOG_E(TAG, "Unsupported radio device frequency");
            result = SubBruteFileResultMissingOrIncorrectFrequency;
            break;
        }

        instance->file_protocol_info->frequency =
            subghz_devices_set_frequency(instance->radio_device, temp_data32);

        if(!subghz_devices_set_tx(instance->radio_device)) {
            subghz_devices_idle(instance->radio_device);
            result = SubBruteFileResultFrequencyNotAllowed;
            break;
        }
        subghz_devices_idle(instance->radio_device);

        // Preset
        if(!flipper_format_read_string(fff_data_file, "Preset", temp_str)) {
            FURI_LOG_E(TAG, error_device_preset_fail);
            result = SubBruteFileResultPresetInvalid;
            break;
        }
        instance->file_protocol_info->preset = subbrute_protocol_convert_preset(temp_str);

        const char* protocol_file = NULL;
        // Protocol
        if(!flipper_format_read_string(fff_data_file, "Protocol", temp_str)) {
            FURI_LOG_E(TAG, error_device_missing_protocol);
            result = SubBruteFileResultMissingProtocol;
            break;
        }
        instance->file_protocol_info->file = subbrute_protocol_file_protocol_name(temp_str);
        protocol_file = subbrute_protocol_file(instance->file_protocol_info->file);
#ifdef FURI_DEBUG
        FURI_LOG_D(TAG, "Protocol: %s", protocol_file);
#endif

        instance->decoder_result = subghz_receiver_search_decoder_base_by_name(
            instance->receiver, furi_string_get_cstr(temp_str));

        if((!instance->decoder_result) || (strcmp(protocol_file, "RAW") == 0) ||
           (strcmp(protocol_file, "Unknown") == 0)) {
            FURI_LOG_E(TAG, error_device_protocol_unsupported);
            result = SubBruteFileResultProtocolNotSupported;
            break;
        }

        if(instance->decoder_result->protocol->type == SubGhzProtocolTypeDynamic) {
            FURI_LOG_E(TAG, "Protocol is dynamic - not supported");
            result = SubBruteFileResultDynamicProtocolNotValid;
            break;
        }
#ifdef FURI_DEBUG
        FURI_LOG_D(TAG, "Decoder: %s", instance->decoder_result->protocol->name);
#endif

        // Bit
        if(!flipper_format_read_uint32(fff_data_file, "Bit", &temp_data32, 1)) {
            FURI_LOG_E(TAG, error_device_missing_bit);
            result = SubBruteFileResultMissingOrIncorrectBit;
            break;
        }
        instance->file_protocol_info->bits = temp_data32;
#ifdef FURI_DEBUG
        FURI_LOG_D(TAG, "Bit: %d", instance->file_protocol_info->bits);
#endif

        uint8_t key_data[sizeof(uint64_t)] = {0};
        if(!flipper_format_read_hex(fff_data_file, "Key", key_data, sizeof(uint64_t))) {
            FURI_LOG_E(TAG, "Missing Key");
            result = SubBruteFileResultMissingOrIncorrectKey;
            break;
        }
        uint64_t data = 0;
        for(size_t i = 0; i < sizeof(uint64_t); i++) {
            data = (data << 8) | key_data[i];
        }
#ifdef FURI_DEBUG
        FURI_LOG_D(TAG, "Key: %.16llX", data);
#endif
        instance->key_from_file = data;

        // TE
        if(!flipper_format_read_uint32(fff_data_file, "TE", &temp_data32, 1)) {
            FURI_LOG_E(TAG, error_device_missing_te);
            //result = SubBruteFileResultMissingOrIncorrectTe;
            //break;
        } else {
            instance->file_protocol_info->te = temp_data32 != 0 ? temp_data32 : 0;
        }

        // Repeat
        if(flipper_format_read_uint32(fff_data_file, "Repeat", &temp_data32, 1)) {
#ifdef FURI_DEBUG
            FURI_LOG_D(TAG, "Repeat: %ld", temp_data32);
#endif
            instance->file_protocol_info->repeat = (uint8_t)temp_data32;
        } else {
#ifdef FURI_DEBUG
            FURI_LOG_D(TAG, "Repeat: 3 (default)");
#endif
            instance->file_protocol_info->repeat = 3;
        }

        result = SubBruteFileResultOk;
    } while(0);

    furi_string_free(temp_str);
    flipper_format_file_close(fff_data_file);
    flipper_format_free(fff_data_file);
    furi_record_close(RECORD_STORAGE);

    subghz_receiver_free(instance->receiver);

    instance->decoder_result = NULL;
    instance->receiver = NULL;

    if(result == SubBruteFileResultOk) {
#ifdef FURI_DEBUG
        FURI_LOG_D(TAG, "Loaded successfully");
#endif
    } else {
        FURI_LOG_E(TAG, "Load failed!");
        subbrute_device_free_protocol_info(instance);
    }

    return result;
}

void subbrute_device_attack_set_default_values(
    SubBruteDevice* instance,
    SubBruteAttacks default_attack) {
    furi_assert(instance);
#ifdef FURI_DEBUG
    FURI_LOG_D(TAG, "subbrute_device_attack_set_default_values");
#endif
    instance->attack = default_attack;
    instance->current_step = 0x00;
    instance->bit_index = 0x00;
    instance->extra_repeats = 0;
    instance->two_bytes = false;

    if(default_attack != SubBruteAttackLoadFile) {
        instance->max_value = subbrute_protocol_calc_max_value(
            instance->attack, instance->bit_index, instance->two_bytes);
    }
}

void subbrute_device_free_protocol_info(SubBruteDevice* instance) {
    furi_assert(instance);
    instance->protocol_info = NULL;
    if(instance->file_protocol_info) {
        free(instance->file_protocol_info);
    }
    instance->file_protocol_info = NULL;
}

const char* subbrute_device_error_get_desc(SubBruteFileResult error_id) {
    switch(error_id) {
    case(SubBruteFileResultOk):
        return error_device_ok;
    case(SubBruteFileResultErrorOpenFile):
        return error_device_invalid_path;
    case(SubBruteFileResultMissingOrIncorrectHeader):
        return error_device_missing_header;
    case(SubBruteFileResultFrequencyNotAllowed):
        return error_device_invalid_frequency;
    case(SubBruteFileResultMissingOrIncorrectFrequency):
        return error_device_incorrect_frequency;
    case(SubBruteFileResultPresetInvalid):
        return error_device_preset_fail;
    case(SubBruteFileResultMissingProtocol):
        return error_device_missing_protocol;
    case(SubBruteFileResultProtocolNotSupported):
        return error_device_protocol_unsupported;
    case(SubBruteFileResultDynamicProtocolNotValid):
        return error_device_dynamic_protocol_unsupported;
    case(SubBruteFileResultProtocolNotFound):
        return error_device_protocol_not_found;
    case(SubBruteFileResultMissingOrIncorrectBit):
        return error_device_missing_bit;
    case(SubBruteFileResultMissingOrIncorrectKey):
        return error_device_missing_key;
    case(SubBruteFileResultMissingOrIncorrectTe):
        return error_device_missing_te;
    case SubBruteFileResultUnknown:
    default:
        return error_device_unknown;
    }
}