GodMode9/arm9/source/game/firm.c

#include "firm.h"
#include "aes.h"
#include "sha.h"
#include "nand.h"
#include "keydb.h"
#include "unittype.h"
#include "ff.h"

// 0 -> pre 9.5 / 1 -> 9.5 / 2 -> post 9.5
#define A9L_CRYPTO_TYPE(hdr) (((hdr)->k9l[3] == 0xFF) ? 0 : ((hdr)->k9l[3] == '1') ? 1 : 2)

// valid addresses for FIRM section loading
// pairs of start / end address, provided by Wolfvak
#define FIRM_VALID_ADDRESS  \
    0x08000040, 0x08100000, \
    0x18000000, 0x18600000, \
    0x1FF00000, 0x1FFFFC00

// valid addresses (installable) for FIRM section loading
#define FIRM_VALID_ADDRESS_INSTALL  \
    FIRM_VALID_ADDRESS, \
    0x10000000, 0x10200000

// valid addresses (bootable) for FIRM section loading
#define FIRM_VALID_ADDRESS_BOOT \
    FIRM_VALID_ADDRESS, \
    0x20000000, 0x27FFFA00

static const u32 whitelist_boot[] = { FIRM_VALID_ADDRESS_BOOT };
static const u32 whitelist_install[] = { FIRM_VALID_ADDRESS_INSTALL };

#define WLIST(i)    ((i) ? whitelist_install : whitelist_boot)
#define WLIST_SZ(i) (((i) ? sizeof(whitelist_install) : sizeof(whitelist_boot)) / (sizeof(u32) * 2))

#define ADDR_IN_RANGE(a, s, e)  (clamp(a, s, e) == (a))
#define ADDR_IN_SECTION(a, s)  (ADDR_IN_RANGE(a, (s)->address, (s)->address + (s)->size))

u32 GetFirmSize(FirmHeader* header) {
    static const u8 magic[] = { FIRM_MAGIC };
    if (memcmp(header->magic, magic, sizeof(magic)) != 0)
        return 0;

    u32 firm_size = sizeof(FirmHeader);
    int section_arm9 = -1;
    for (u32 i = 0; i < 4; i++) {
        FirmSectionHeader* section = header->sections + i;
        if (!section->size)
            continue;

        if (section->offset > FIRM_MAX_SIZE || section->size > FIRM_MAX_SIZE)
            return 0;
        if (section->offset < sizeof(FirmHeader))
            return 0;
        if ((section->offset % 512) || (section->size % 512))
            return 0;
        if (ADDR_IN_SECTION(header->entry_arm9, section))
            section_arm9 = i;

        firm_size = max(firm_size, section->offset + section->size);
    }

    if (firm_size > FIRM_MAX_SIZE)
        return 0;

    if (section_arm9 < 0)
        return 0;

    return firm_size;
}

u32 ValidateFirmHeader(FirmHeader* header, u32 data_size) {
    u32 firm_size = GetFirmSize(header);
    return (!firm_size || (data_size && (firm_size > data_size))) ? 1 : 0;
}

u32 ValidateFirmA9LHeader(FirmA9LHeader* header) {
    static const u8 enckeyX0x15hash[2][0x20] =
    {
        {
            0x0A, 0x85, 0x20, 0x14, 0x8F, 0x7E, 0xB7, 0x21, 0xBF, 0xC6, 0xC8, 0x82, 0xDF, 0x37, 0x06, 0x3C,
            0x0E, 0x05, 0x1D, 0x1E, 0xF3, 0x41, 0xE9, 0x80, 0x1E, 0xC9, 0x97, 0x82, 0xA0, 0x84, 0x43, 0x08
        },
        {
            0xFC, 0x46, 0x74, 0x78, 0x73, 0x01, 0xD3, 0x23, 0x52, 0x94, 0x97, 0xED, 0xA8, 0x5B, 0xCF, 0xD2,
            0xDA, 0x2D, 0xFA, 0x47, 0x8E, 0x2D, 0x98, 0x89, 0xBA, 0x60, 0xE8, 0x43, 0x5C, 0x1B, 0x93, 0x65
        }
    };

    return sha_cmp(enckeyX0x15hash[IS_DEVKIT ? 1 : 0], header->keyX0x15, 0x10, SHA256_MODE);
}

u32 ValidateFirm(void* firm, u32 firm_size, bool installable) {
    FirmHeader* header = (FirmHeader*) firm;
    u32 skipchk_mask = 0;

    const u32 *whitelist = WLIST(installable);
    u32 whitelist_size = WLIST_SZ(installable);

    // validate firm header
    if ((firm_size < sizeof(FirmHeader)) || (ValidateFirmHeader(header, firm_size) != 0))
        return 1;

    // overrides for b9s / superhax fb3ds firms
    if (installable) {
        const u8 *resv = header->reserved0;
        if (resv[0x2D] == 'B' && resv[0x2E] == '9' && resv[0x2F] == 'S')
            skipchk_mask |= BIT(3);

        if ((header->sections[1].size == 0x200) &&
            (header->sections[1].address == 0x07FFFE8C))
            skipchk_mask |= BIT(1);
    }

    // hash verify all available sections and check load address
    for (u32 i = 0; i < 4; i++) {
        bool bad_loadaddr;
        FirmSectionHeader* section = header->sections + i;

        if ((skipchk_mask & BIT(i)) || !section->size)
            continue;

        if (sha_cmp(section->hash, ((u8*) firm) + section->offset, section->size, SHA256_MODE) != 0)
            return 1;

        bad_loadaddr = true;
        for (u32 a = 0; a < whitelist_size; a++) {
            u32 start = whitelist[2 * a], end = whitelist[(2 * a) + 1];
            if (ADDR_IN_RANGE(section->address, start, end) &&
                ADDR_IN_RANGE(section->address + section->size, start, end)) {
                bad_loadaddr = false;
                break;
            }
        }

        if (bad_loadaddr)
            return 1;
    }

    // ARM9 / ARM11 entrypoints available?
    if (!header->entry_arm9 || (installable && !header->entry_arm11))
        return 1;

    // B9S screeninit flag?
    if (installable && (header->reserved0[0]&0x1))
        return 1;

    return 0;
}

FirmSectionHeader* FindFirmArm9Section(FirmHeader* firm) {
    u32 entry = firm->entry_arm9;
    for (u32 i = 0; i < 4; i++) {
        FirmSectionHeader* section = firm->sections + i;
        if (section->size && ADDR_IN_SECTION(entry, section))
            return section;
    }
    return NULL;
}

u32 GetArm9BinarySize(FirmA9LHeader* a9l) {
    char* size_ascii = a9l->size_ascii;
    u32 size = 0;
    for (u32 i = 0; (i < 8) && *(size_ascii + i); i++)
        size = (size * 10) + (*(size_ascii + i) - '0');
    return size;
}

u32 SetupSecretKey(u32 keynum) {
    static u8 __attribute__((aligned(32))) sector[0x200];
    static u32 got_keys = 0;
    u8* key = sector + (keynum*0x10);
    
    if (keynum >= 0x200/0x10)
        return 1; // safety
    
    // try to load full secret sector
    if (!got_keys) {
        ReadNandSectors(sector, 0x96, 1, 0x11, NAND_SYSNAND);
        if (ValidateSecretSector(sector) == 0)
            got_keys = 0xFFFFFFFF; // => got them all
    }

    // try to load key from file
    if (!(got_keys & (0x1<<keynum)) && (keynum < 2)) {
        if (LoadKeyFromFile(key, 0x11, 'N', (keynum == 0) ? "95" : "96") == 0)
            got_keys |= (0x1<<keynum); // got at least this key
    }
    
    // setup the key
    if (got_keys & (0x1<<keynum)) {
        setup_aeskey(0x11, key);
        use_aeskey(0x11);
        return 0;
    }
    
    // out of options
    return 1;
}

u32 DecryptA9LHeader(FirmA9LHeader* header) {
    u32 type = A9L_CRYPTO_TYPE(header);
    
    if (SetupSecretKey(0) != 0) return 1;
    aes_decrypt(header->keyX0x15, header->keyX0x15, 1, AES_CNT_ECB_DECRYPT_MODE);
    if (type) {
        if (SetupSecretKey((type == 1) ? 0 : 1) != 0) return 1;
        aes_decrypt(header->keyX0x16, header->keyX0x16, 1, AES_CNT_ECB_DECRYPT_MODE);
    }
    
    return 0;
}

u32 SetupArm9BinaryCrypto(FirmA9LHeader* header) {
    u32 type = A9L_CRYPTO_TYPE(header);
    
    if (type == 0) {
        u8 __attribute__((aligned(32))) keyX0x15[0x10];
        memcpy(keyX0x15, header->keyX0x15, 0x10);
        if (SetupSecretKey(0) != 0) return 1;
        aes_decrypt(keyX0x15, keyX0x15, 1, AES_CNT_ECB_DECRYPT_MODE);
        setup_aeskeyX(0x15, keyX0x15);
        setup_aeskeyY(0x15, header->keyY0x150x16);
        use_aeskey(0x15);
    } else {
        u8 __attribute__((aligned(32))) keyX0x16[0x10];
        memcpy(keyX0x16, header->keyX0x16, 0x10);
        if (SetupSecretKey((type == 1) ? 0 : 1) != 0) return 1;
        aes_decrypt(keyX0x16, keyX0x16, 1, AES_CNT_ECB_DECRYPT_MODE);
        setup_aeskeyX(0x16, keyX0x16);
        setup_aeskeyY(0x16, header->keyY0x150x16);
        use_aeskey(0x16);
    }
    
    return 0;
}

u32 DecryptArm9Binary(void* data, u32 offset, u32 size, FirmA9LHeader* a9l) {
    // offset == offset inside ARM9 binary
    // ARM9 binary begins 0x800 byte after the ARM9 loader header
    
    // only process actual ARM9 binary
    u32 size_bin = GetArm9BinarySize(a9l);
    if (offset >= size_bin) return 0;
    else if (size >= size_bin - offset)
        size = size_bin - offset;
    
    // decrypt data
    if (SetupArm9BinaryCrypto(a9l) != 0) return 1;
    ctr_decrypt_byte(data, data, size, offset, AES_CNT_CTRNAND_MODE, a9l->ctr);
    
    return 0;
}

u32 DecryptFirm(void* data, u32 offset, u32 size, FirmHeader* firm, FirmA9LHeader* a9l) {
    // ARM9 binary size / offset
    FirmSectionHeader* arm9s = FindFirmArm9Section(firm);
    u32 offset_arm9bin = arm9s->offset + ARM9BIN_OFFSET;
    u32 size_arm9bin = GetArm9BinarySize(a9l);
    
    // sanity checks
    if (!size_arm9bin || (size_arm9bin + ARM9BIN_OFFSET > arm9s->size))
        return 1; // bad header / data
    
    // check if ARM9 binary in data
    if ((offset_arm9bin >= offset + size) ||
        (offset >= offset_arm9bin + size_arm9bin))
        return 0; // section not in data
    
    // determine data / offset / size
    u8* data8 = (u8*)data;
    u8* data_i = data8;
    u32 offset_i = 0;
    u32 size_i = size_arm9bin;
    if (offset_arm9bin < offset)
        offset_i = offset - offset_arm9bin;
    else data_i = data8 + (offset_arm9bin - offset);
    size_i = size_arm9bin - offset_i;
    if (size_i > size - (data_i - data8))
        size_i = size - (data_i - data8);
    
    return DecryptArm9Binary(data_i, offset_i, size_i, a9l);
}

u32 DecryptFirmSequential(void* data, u32 offset, u32 size) {
    // warning: this will only work for sequential processing
    // also, only for blocks aligned to 0x200 bytes
    // unexpected results otherwise
    static FirmHeader firm = { 0 };
    static FirmA9LHeader a9l = { 0 };
    static FirmHeader* firmptr = NULL;
    static FirmA9LHeader* a9lptr = NULL;
    static FirmSectionHeader* arm9s = NULL;
    
    // fetch firm header from data
    if ((offset == 0) && (size >= sizeof(FirmHeader))) {
        memcpy(&firm, data, sizeof(FirmHeader));
        firmptr = (ValidateFirmHeader(&firm, 0) == 0) ? &firm : NULL;
        arm9s = (firmptr) ? FindFirmArm9Section(firmptr) : NULL;
        a9lptr = NULL;
    }
    
    // safety check, firm header pointer
    if (!firmptr) return 1;
    
    // fetch ARM9 loader header from data
    if (arm9s && !a9lptr && (offset <= arm9s->offset) &&
        ((offset + size) >= arm9s->offset + sizeof(FirmA9LHeader))) {
        memcpy(&a9l, (u8*)data + arm9s->offset - offset, sizeof(FirmA9LHeader));
        a9lptr = (ValidateFirmA9LHeader(&a9l) == 0) ? &a9l : NULL;
    }
    
    return (a9lptr) ? DecryptFirm(data, offset, size, firmptr, a9lptr) : 0;
}

u32 DecryptFirmFull(void* data, u32 size) {
    // this expects the full FIRM being in memory
    FirmHeader* firm = (FirmHeader*) data;
    FirmSectionHeader* arm9s = FindFirmArm9Section(firm);
    if (ValidateFirmHeader(firm, size) != 0) return 1; // not a proper firm
    if (!arm9s) return 0; // no ARM9 section -> not encrypted -> done
    
    FirmA9LHeader* a9l = (FirmA9LHeader*)(void*) ((u8*) data + arm9s->offset);
    if (ValidateFirmA9LHeader(a9l) != 0) return 0; // no ARM9bin -> not encrypted -> done
    
    // decrypt FIRM and ARM9loader header
    if ((DecryptFirm(data, 0, size, firm, a9l) != 0) || (DecryptA9LHeader(a9l) != 0))
        return 1;
    
    // fix ARM9 section SHA and ARM9 entrypoint
    sha_quick(arm9s->hash, (u8*) data + arm9s->offset, arm9s->size, SHA256_MODE);
    firm->entry_arm9 = ARM9ENTRY_FIX(firm);
    
    return 0;
}