// Copyright 2018 yuzu emulator team // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #include #include #include #include #include "common/logging/log.h" #include "core/crypto/aes_util.h" #include "core/crypto/ctr_encryption_layer.h" #include "core/file_sys/content_archive.h" #include "core/file_sys/nca_patch.h" #include "core/file_sys/partition_filesystem.h" #include "core/file_sys/romfs.h" #include "core/file_sys/vfs_offset.h" #include "core/loader/loader.h" namespace FileSys { // Media offsets in headers are stored divided by 512. Mult. by this to get real offset. constexpr u64 MEDIA_OFFSET_MULTIPLIER = 0x200; constexpr u64 SECTION_HEADER_SIZE = 0x200; constexpr u64 SECTION_HEADER_OFFSET = 0x400; constexpr u32 IVFC_MAX_LEVEL = 6; enum class NCASectionFilesystemType : u8 { PFS0 = 0x2, ROMFS = 0x3, }; struct NCASectionHeaderBlock { INSERT_PADDING_BYTES(3); NCASectionFilesystemType filesystem_type; NCASectionCryptoType crypto_type; INSERT_PADDING_BYTES(3); }; static_assert(sizeof(NCASectionHeaderBlock) == 0x8, "NCASectionHeaderBlock has incorrect size."); struct NCASectionRaw { NCASectionHeaderBlock header; std::array block_data; std::array section_ctr; INSERT_PADDING_BYTES(0xB8); }; static_assert(sizeof(NCASectionRaw) == 0x200, "NCASectionRaw has incorrect size."); struct PFS0Superblock { NCASectionHeaderBlock header_block; std::array hash; u32_le size; INSERT_PADDING_BYTES(4); u64_le hash_table_offset; u64_le hash_table_size; u64_le pfs0_header_offset; u64_le pfs0_size; INSERT_PADDING_BYTES(0x1B0); }; static_assert(sizeof(PFS0Superblock) == 0x200, "PFS0Superblock has incorrect size."); struct RomFSSuperblock { NCASectionHeaderBlock header_block; IVFCHeader ivfc; INSERT_PADDING_BYTES(0x118); }; static_assert(sizeof(RomFSSuperblock) == 0x200, "RomFSSuperblock has incorrect size."); struct BKTRHeader { u64_le offset; u64_le size; u32_le magic; INSERT_PADDING_BYTES(0x4); u32_le number_entries; INSERT_PADDING_BYTES(0x4); }; static_assert(sizeof(BKTRHeader) == 0x20, "BKTRHeader has incorrect size."); struct BKTRSuperblock { NCASectionHeaderBlock header_block; IVFCHeader ivfc; INSERT_PADDING_BYTES(0x18); BKTRHeader relocation; BKTRHeader subsection; INSERT_PADDING_BYTES(0xC0); }; static_assert(sizeof(BKTRSuperblock) == 0x200, "BKTRSuperblock has incorrect size."); union NCASectionHeader { NCASectionRaw raw; PFS0Superblock pfs0; RomFSSuperblock romfs; BKTRSuperblock bktr; }; static_assert(sizeof(NCASectionHeader) == 0x200, "NCASectionHeader has incorrect size."); bool IsValidNCA(const NCAHeader& header) { // TODO(DarkLordZach): Add NCA2/NCA0 support. return header.magic == Common::MakeMagic('N', 'C', 'A', '3'); } u8 NCA::GetCryptoRevision() const { u8 master_key_id = header.crypto_type; if (header.crypto_type_2 > master_key_id) master_key_id = header.crypto_type_2; if (master_key_id > 0) --master_key_id; return master_key_id; } boost::optional NCA::GetKeyAreaKey(NCASectionCryptoType type) const { const auto master_key_id = GetCryptoRevision(); if (!keys.HasKey(Core::Crypto::S128KeyType::KeyArea, master_key_id, header.key_index)) return boost::none; std::vector key_area(header.key_area.begin(), header.key_area.end()); Core::Crypto::AESCipher cipher( keys.GetKey(Core::Crypto::S128KeyType::KeyArea, master_key_id, header.key_index), Core::Crypto::Mode::ECB); cipher.Transcode(key_area.data(), key_area.size(), key_area.data(), Core::Crypto::Op::Decrypt); Core::Crypto::Key128 out; if (type == NCASectionCryptoType::XTS) std::copy(key_area.begin(), key_area.begin() + 0x10, out.begin()); else if (type == NCASectionCryptoType::CTR || type == NCASectionCryptoType::BKTR) std::copy(key_area.begin() + 0x20, key_area.begin() + 0x30, out.begin()); else LOG_CRITICAL(Crypto, "Called GetKeyAreaKey on invalid NCASectionCryptoType type={:02X}", static_cast(type)); u128 out_128{}; memcpy(out_128.data(), out.data(), 16); LOG_DEBUG(Crypto, "called with crypto_rev={:02X}, kak_index={:02X}, key={:016X}{:016X}", master_key_id, header.key_index, out_128[1], out_128[0]); return out; } boost::optional NCA::GetTitlekey() { const auto master_key_id = GetCryptoRevision(); u128 rights_id{}; memcpy(rights_id.data(), header.rights_id.data(), 16); if (rights_id == u128{}) { status = Loader::ResultStatus::ErrorInvalidRightsID; return boost::none; } auto titlekey = keys.GetKey(Core::Crypto::S128KeyType::Titlekey, rights_id[1], rights_id[0]); if (titlekey == Core::Crypto::Key128{}) { status = Loader::ResultStatus::ErrorMissingTitlekey; return boost::none; } if (!keys.HasKey(Core::Crypto::S128KeyType::Titlekek, master_key_id)) { status = Loader::ResultStatus::ErrorMissingTitlekek; return boost::none; } Core::Crypto::AESCipher cipher( keys.GetKey(Core::Crypto::S128KeyType::Titlekek, master_key_id), Core::Crypto::Mode::ECB); cipher.Transcode(titlekey.data(), titlekey.size(), titlekey.data(), Core::Crypto::Op::Decrypt); return titlekey; } VirtualFile NCA::Decrypt(NCASectionHeader s_header, VirtualFile in, u64 starting_offset) { if (!encrypted) return in; switch (s_header.raw.header.crypto_type) { case NCASectionCryptoType::NONE: LOG_DEBUG(Crypto, "called with mode=NONE"); return in; case NCASectionCryptoType::CTR: // During normal BKTR decryption, this entire function is skipped. This is for the metadata, // which uses the same CTR as usual. case NCASectionCryptoType::BKTR: LOG_DEBUG(Crypto, "called with mode=CTR, starting_offset={:016X}", starting_offset); { boost::optional key = boost::none; if (has_rights_id) { status = Loader::ResultStatus::Success; key = GetTitlekey(); if (key == boost::none) { if (status == Loader::ResultStatus::Success) status = Loader::ResultStatus::ErrorMissingTitlekey; return nullptr; } } else { key = GetKeyAreaKey(NCASectionCryptoType::CTR); if (key == boost::none) { status = Loader::ResultStatus::ErrorMissingKeyAreaKey; return nullptr; } } auto out = std::make_shared( std::move(in), key.value(), starting_offset); std::vector iv(16); for (u8 i = 0; i < 8; ++i) iv[i] = s_header.raw.section_ctr[0x8 - i - 1]; out->SetIV(iv); return std::static_pointer_cast(out); } case NCASectionCryptoType::XTS: // TODO(DarkLordZach): Find a test case for XTS-encrypted NCAs default: LOG_ERROR(Crypto, "called with unhandled crypto type={:02X}", static_cast(s_header.raw.header.crypto_type)); return nullptr; } } NCA::NCA(VirtualFile file_, VirtualFile bktr_base_romfs_, u64 bktr_base_ivfc_offset) : file(std::move(file_)), bktr_base_romfs(bktr_base_romfs_ ? std::move(bktr_base_romfs_) : nullptr) { status = Loader::ResultStatus::Success; if (file == nullptr) { status = Loader::ResultStatus::ErrorNullFile; return; } if (sizeof(NCAHeader) != file->ReadObject(&header)) { LOG_ERROR(Loader, "File reader errored out during header read."); status = Loader::ResultStatus::ErrorBadNCAHeader; return; } encrypted = false; if (!IsValidNCA(header)) { if (header.magic == Common::MakeMagic('N', 'C', 'A', '2')) { status = Loader::ResultStatus::ErrorNCA2; return; } if (header.magic == Common::MakeMagic('N', 'C', 'A', '0')) { status = Loader::ResultStatus::ErrorNCA0; return; } NCAHeader dec_header{}; Core::Crypto::AESCipher cipher( keys.GetKey(Core::Crypto::S256KeyType::Header), Core::Crypto::Mode::XTS); cipher.XTSTranscode(&header, sizeof(NCAHeader), &dec_header, 0, 0x200, Core::Crypto::Op::Decrypt); if (IsValidNCA(dec_header)) { header = dec_header; encrypted = true; } else { if (dec_header.magic == Common::MakeMagic('N', 'C', 'A', '2')) { status = Loader::ResultStatus::ErrorNCA2; return; } if (dec_header.magic == Common::MakeMagic('N', 'C', 'A', '0')) { status = Loader::ResultStatus::ErrorNCA0; return; } if (!keys.HasKey(Core::Crypto::S256KeyType::Header)) status = Loader::ResultStatus::ErrorMissingHeaderKey; else status = Loader::ResultStatus::ErrorIncorrectHeaderKey; return; } } has_rights_id = std::find_if_not(header.rights_id.begin(), header.rights_id.end(), [](char c) { return c == '\0'; }) != header.rights_id.end(); const std::ptrdiff_t number_sections = std::count_if(std::begin(header.section_tables), std::end(header.section_tables), [](NCASectionTableEntry entry) { return entry.media_offset > 0; }); std::vector sections(number_sections); const auto length_sections = SECTION_HEADER_SIZE * number_sections; if (encrypted) { auto raw = file->ReadBytes(length_sections, SECTION_HEADER_OFFSET); Core::Crypto::AESCipher cipher( keys.GetKey(Core::Crypto::S256KeyType::Header), Core::Crypto::Mode::XTS); cipher.XTSTranscode(raw.data(), length_sections, sections.data(), 2, SECTION_HEADER_SIZE, Core::Crypto::Op::Decrypt); } else { file->ReadBytes(sections.data(), length_sections, SECTION_HEADER_OFFSET); } is_update = std::find_if(sections.begin(), sections.end(), [](const NCASectionHeader& header) { return header.raw.header.crypto_type == NCASectionCryptoType::BKTR; }) != sections.end(); ivfc_offset = 0; for (std::ptrdiff_t i = 0; i < number_sections; ++i) { auto section = sections[i]; if (section.raw.header.filesystem_type == NCASectionFilesystemType::ROMFS) { const std::size_t base_offset = header.section_tables[i].media_offset * MEDIA_OFFSET_MULTIPLIER; ivfc_offset = section.romfs.ivfc.levels[IVFC_MAX_LEVEL - 1].offset; const std::size_t romfs_offset = base_offset + ivfc_offset; const std::size_t romfs_size = section.romfs.ivfc.levels[IVFC_MAX_LEVEL - 1].size; auto raw = std::make_shared(file, romfs_size, romfs_offset); auto dec = Decrypt(section, raw, romfs_offset); if (dec == nullptr) { if (status != Loader::ResultStatus::Success) return; if (has_rights_id) status = Loader::ResultStatus::ErrorIncorrectTitlekeyOrTitlekek; else status = Loader::ResultStatus::ErrorIncorrectKeyAreaKey; return; } if (section.raw.header.crypto_type == NCASectionCryptoType::BKTR) { if (section.bktr.relocation.magic != Common::MakeMagic('B', 'K', 'T', 'R') || section.bktr.subsection.magic != Common::MakeMagic('B', 'K', 'T', 'R')) { status = Loader::ResultStatus::ErrorBadBKTRHeader; return; } if (section.bktr.relocation.offset + section.bktr.relocation.size != section.bktr.subsection.offset) { status = Loader::ResultStatus::ErrorBKTRSubsectionNotAfterRelocation; return; } const u64 size = MEDIA_OFFSET_MULTIPLIER * (header.section_tables[i].media_end_offset - header.section_tables[i].media_offset); if (section.bktr.subsection.offset + section.bktr.subsection.size != size) { status = Loader::ResultStatus::ErrorBKTRSubsectionNotAtEnd; return; } const u64 offset = section.romfs.ivfc.levels[IVFC_MAX_LEVEL - 1].offset; RelocationBlock relocation_block{}; if (dec->ReadObject(&relocation_block, section.bktr.relocation.offset - offset) != sizeof(RelocationBlock)) { status = Loader::ResultStatus::ErrorBadRelocationBlock; return; } SubsectionBlock subsection_block{}; if (dec->ReadObject(&subsection_block, section.bktr.subsection.offset - offset) != sizeof(RelocationBlock)) { status = Loader::ResultStatus::ErrorBadSubsectionBlock; return; } std::vector relocation_buckets_raw( (section.bktr.relocation.size - sizeof(RelocationBlock)) / sizeof(RelocationBucketRaw)); if (dec->ReadBytes(relocation_buckets_raw.data(), section.bktr.relocation.size - sizeof(RelocationBlock), section.bktr.relocation.offset + sizeof(RelocationBlock) - offset) != section.bktr.relocation.size - sizeof(RelocationBlock)) { status = Loader::ResultStatus::ErrorBadRelocationBuckets; return; } std::vector subsection_buckets_raw( (section.bktr.subsection.size - sizeof(SubsectionBlock)) / sizeof(SubsectionBucketRaw)); if (dec->ReadBytes(subsection_buckets_raw.data(), section.bktr.subsection.size - sizeof(SubsectionBlock), section.bktr.subsection.offset + sizeof(SubsectionBlock) - offset) != section.bktr.subsection.size - sizeof(SubsectionBlock)) { status = Loader::ResultStatus::ErrorBadSubsectionBuckets; return; } std::vector relocation_buckets(relocation_buckets_raw.size()); std::transform(relocation_buckets_raw.begin(), relocation_buckets_raw.end(), relocation_buckets.begin(), &ConvertRelocationBucketRaw); std::vector subsection_buckets(subsection_buckets_raw.size()); std::transform(subsection_buckets_raw.begin(), subsection_buckets_raw.end(), subsection_buckets.begin(), &ConvertSubsectionBucketRaw); u32 ctr_low; std::memcpy(&ctr_low, section.raw.section_ctr.data(), sizeof(ctr_low)); subsection_buckets.back().entries.push_back( {section.bktr.relocation.offset, {0}, ctr_low}); subsection_buckets.back().entries.push_back({size, {0}, 0}); boost::optional key = boost::none; if (encrypted) { if (has_rights_id) { status = Loader::ResultStatus::Success; key = GetTitlekey(); if (key == boost::none) { status = Loader::ResultStatus::ErrorMissingTitlekey; return; } } else { key = GetKeyAreaKey(NCASectionCryptoType::BKTR); if (key == boost::none) { status = Loader::ResultStatus::ErrorMissingKeyAreaKey; return; } } } if (bktr_base_romfs == nullptr) { status = Loader::ResultStatus::ErrorMissingBKTRBaseRomFS; return; } auto bktr = std::make_shared( bktr_base_romfs, std::make_shared(file, romfs_size, base_offset), relocation_block, relocation_buckets, subsection_block, subsection_buckets, encrypted, encrypted ? key.get() : Core::Crypto::Key128{}, base_offset, bktr_base_ivfc_offset, section.raw.section_ctr); // BKTR applies to entire IVFC, so make an offset version to level 6 files.push_back(std::make_shared( bktr, romfs_size, section.romfs.ivfc.levels[IVFC_MAX_LEVEL - 1].offset)); romfs = files.back(); } else { files.push_back(std::move(dec)); romfs = files.back(); } } else if (section.raw.header.filesystem_type == NCASectionFilesystemType::PFS0) { u64 offset = (static_cast(header.section_tables[i].media_offset) * MEDIA_OFFSET_MULTIPLIER) + section.pfs0.pfs0_header_offset; u64 size = MEDIA_OFFSET_MULTIPLIER * (header.section_tables[i].media_end_offset - header.section_tables[i].media_offset); auto dec = Decrypt(section, std::make_shared(file, size, offset), offset); if (dec != nullptr) { auto npfs = std::make_shared(std::move(dec)); if (npfs->GetStatus() == Loader::ResultStatus::Success) { dirs.push_back(std::move(npfs)); if (IsDirectoryExeFS(dirs.back())) exefs = dirs.back(); } else { if (has_rights_id) status = Loader::ResultStatus::ErrorIncorrectTitlekeyOrTitlekek; else status = Loader::ResultStatus::ErrorIncorrectKeyAreaKey; return; } } else { if (status != Loader::ResultStatus::Success) return; if (has_rights_id) status = Loader::ResultStatus::ErrorIncorrectTitlekeyOrTitlekek; else status = Loader::ResultStatus::ErrorIncorrectKeyAreaKey; return; } } } status = Loader::ResultStatus::Success; } Loader::ResultStatus NCA::GetStatus() const { return status; } std::vector> NCA::GetFiles() const { if (status != Loader::ResultStatus::Success) return {}; return files; } std::vector> NCA::GetSubdirectories() const { if (status != Loader::ResultStatus::Success) return {}; return dirs; } std::string NCA::GetName() const { return file->GetName(); } std::shared_ptr NCA::GetParentDirectory() const { return file->GetContainingDirectory(); } NCAContentType NCA::GetType() const { return header.content_type; } u64 NCA::GetTitleId() const { if (is_update || status == Loader::ResultStatus::ErrorMissingBKTRBaseRomFS) return header.title_id | 0x800; return header.title_id; } bool NCA::IsUpdate() const { return is_update; } VirtualFile NCA::GetRomFS() const { return romfs; } VirtualDir NCA::GetExeFS() const { return exefs; } VirtualFile NCA::GetBaseFile() const { return file; } u64 NCA::GetBaseIVFCOffset() const { return ivfc_offset; } bool NCA::ReplaceFileWithSubdirectory(VirtualFile file, VirtualDir dir) { return false; } } // namespace FileSys