2020-10-01 07:17:59 +01:00
/*
* cnmt . h
*
2022-03-17 12:58:40 +00:00
* Copyright ( c ) 2020 - 2022 , DarkMatterCore < pabloacurielz @ gmail . com > .
2020-10-01 07:17:59 +01:00
*
* This file is part of nxdumptool ( https : //github.com/DarkMatterCore/nxdumptool).
*
2021-03-25 19:26:58 +00:00
* nxdumptool is free software : you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation , either version 3 of the License , or
* ( at your option ) any later version .
2020-10-01 07:17:59 +01:00
*
2021-03-25 19:26:58 +00:00
* nxdumptool is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
2020-10-01 07:17:59 +01:00
*
* You should have received a copy of the GNU General Public License
2021-03-25 19:26:58 +00:00
* along with this program . If not , see < https : //www.gnu.org/licenses/>.
2020-10-01 07:17:59 +01:00
*/
# pragma once
# ifndef __CNMT_H__
# define __CNMT_H__
# include "pfs.h"
2021-03-24 17:25:19 +00:00
# ifdef __cplusplus
extern " C " {
# endif
2020-10-01 07:17:59 +01:00
# define CNMT_DIGEST_SIZE SHA256_HASH_SIZE
/// Equivalent to NcmContentMetaAttribute.
typedef enum {
ContentMetaAttribute_IncludesExFatDriver = BIT ( 0 ) ,
ContentMetaAttribute_Rebootless = BIT ( 1 ) ,
2021-09-26 22:59:41 +01:00
ContentMetaAttribute_Compacted = BIT ( 2 ) , ///< One or more NCAs use SparseInfo data.
2020-10-14 01:15:21 +01:00
ContentMetaAttribute_Count = 3 ///< Total values supported by this enum.
2020-10-01 07:17:59 +01:00
} ContentMetaAttribute ;
2020-10-08 19:31:09 +01:00
typedef enum {
2023-03-29 22:14:21 +01:00
ContentMetaInstallState_Committed = BIT ( 0 ) ,
ContentMetaInstallState_Count = 1 ///< Total values supported by this enum.
2020-10-01 07:17:59 +01:00
} ContentMetaInstallState ;
/// Extended variation of NcmContentMetaHeader. This is essentially the start of every CNMT file.
/// Depending on the content meta type value, this header may be followed by an additional extended header for that specific content meta type.
/// NcmPackagedContentInfo and/or NcmContentMetaInfo entries may follow afterwards.
/// If the extended data size field from the extended header (if available) is non-zero, this data is saved after the content info entries.
/// Finally, a 0x20 byte long digest is appended to the EOF.
typedef struct {
u64 title_id ;
2022-03-17 12:37:24 +00:00
Version version ;
2020-10-01 07:17:59 +01:00
u8 content_meta_type ; ///< NcmContentMetaType.
u8 reserved_1 ;
u16 extended_header_size ; ///< Must match the size from the extended header struct for this content meta type (SystemUpdate, Application, Patch, AddOnContent, Delta).
u16 content_count ; ///< Determines how many NcmPackagedContentInfo entries are available after the extended header.
u16 content_meta_count ; ///< Determines how many NcmContentMetaInfo entries are available after the NcmPackagedContentInfo entries. Only used for SystemUpdate.
u8 content_meta_attribute ; ///< ContentMetaAttribute.
u8 storage_id ; ///< NcmStorageId.
u8 content_install_type ; ///< NcmContentInstallType.
2020-10-08 19:31:09 +01:00
u8 install_state ; ///< ContentMetaInstallState.
2022-03-17 12:37:24 +00:00
Version required_download_system_version ;
2020-10-01 07:17:59 +01:00
u8 reserved_2 [ 0x4 ] ;
2020-10-02 11:28:41 +01:00
} ContentMetaPackagedContentMetaHeader ;
2020-10-01 07:17:59 +01:00
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPackagedContentMetaHeader , 0x20 ) ;
2020-10-01 07:17:59 +01:00
/// Extended header for the SystemUpdate title.
/// Equivalent to NcmSystemUpdateMetaExtendedHeader.
typedef struct {
u32 extended_data_size ;
} ContentMetaSystemUpdateMetaExtendedHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaSystemUpdateMetaExtendedHeader , 0x4 ) ;
2020-10-01 07:17:59 +01:00
/// Extended header for Application titles.
2022-03-17 12:37:24 +00:00
/// Equivalent to NcmApplicationMetaExtendedHeader, but using Version structs.
2020-10-01 07:17:59 +01:00
typedef struct {
u64 patch_id ;
2022-03-17 12:37:24 +00:00
Version required_system_version ;
Version required_application_version ;
2020-10-01 07:17:59 +01:00
} ContentMetaApplicationMetaExtendedHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaApplicationMetaExtendedHeader , 0x10 ) ;
2020-10-01 07:17:59 +01:00
/// Extended header for Patch titles.
2022-03-17 12:37:24 +00:00
/// Equivalent to NcmPatchMetaExtendedHeader, but using a Version struct.
2020-10-01 07:17:59 +01:00
typedef struct {
u64 application_id ;
2022-03-17 12:37:24 +00:00
Version required_system_version ;
2020-10-01 07:17:59 +01:00
u32 extended_data_size ;
u8 reserved [ 0x8 ] ;
} ContentMetaPatchMetaExtendedHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPatchMetaExtendedHeader , 0x18 ) ;
2023-03-29 22:14:21 +01:00
typedef enum {
ContentMetaContentAccessibility_Individual = BIT ( 0 ) ,
ContentMetaContentAccessibility_Count = 1 ///< Total values supported by this enum.
} ContentMetaContentAccessibility ;
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
/// Extended header for AddOnContent tiles (15.0.0+).
2022-03-17 12:37:24 +00:00
/// Equivalent to NcmAddOnContentMetaExtendedHeader, but using a Version struct.
2020-10-01 07:17:59 +01:00
typedef struct {
u64 application_id ;
2022-03-17 12:37:24 +00:00
Version required_application_version ;
2023-03-29 22:14:21 +01:00
u8 content_accessibility ; ///< ContentMetaContentAccessibility.
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
u8 reserved [ 0x3 ] ;
u64 data_patch_id ;
2020-10-01 07:17:59 +01:00
} ContentMetaAddOnContentMetaExtendedHeader ;
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
NXDT_ASSERT ( ContentMetaAddOnContentMetaExtendedHeader , 0x18 ) ;
/// Old extended header for AddOnContent titles (1.0.0 - 14.1.2).
/// Equivalent to NcmLegacyAddOnContentMetaExtendedHeader, but using a Version struct.
typedef struct {
u64 application_id ;
Version required_application_version ;
u8 reserved [ 0x4 ] ;
} ContentMetaLegacyAddOnContentMetaExtendedHeader ;
NXDT_ASSERT ( ContentMetaLegacyAddOnContentMetaExtendedHeader , 0x10 ) ;
2021-03-24 17:25:19 +00:00
2020-10-01 07:17:59 +01:00
/// Extended header for Delta titles.
typedef struct {
u64 application_id ;
u32 extended_data_size ;
u8 reserved [ 0x4 ] ;
} ContentMetaDeltaMetaExtendedHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaDeltaMetaExtendedHeader , 0x10 ) ;
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
/// Extended header for DataPatch titles.
/// Equivalent to NcmDataPatchMetaExtendedHeader, but using a Version struct.
typedef struct {
u64 data_id ;
u64 application_id ;
Version required_application_version ;
u32 extended_data_size ;
u8 reserved [ 0x8 ] ;
} ContentMetaDataPatchMetaExtendedHeader ;
NXDT_ASSERT ( ContentMetaDataPatchMetaExtendedHeader , 0x20 ) ;
2020-10-01 07:17:59 +01:00
typedef enum {
ContentMetaFirmwareVariationVersion_Invalid = 0 ,
ContentMetaFirmwareVariationVersion_V1 = 1 ,
ContentMetaFirmwareVariationVersion_V2 = 2 ,
ContentMetaFirmwareVariationVersion_Unknown = 3
} ContentMetaFirmwareVariationVersion ;
/// Header for the extended data region in the SystemUpdate title, pointed to by the extended header.
/// If version is ContentMetaFirmwareVariationVersion_V1, this is followed by 'variation_count' ContentMetaFirmwareVariationInfoV1 entries.
/// Otherwise, if version is ContentMetaFirmwareVariationVersion_V2, this is followed by:
2020-10-13 15:00:03 +01:00
/// * 'variation_count' firmware variation IDs (4 bytes each).
2020-10-01 07:17:59 +01:00
/// * 'variation_count' ContentMetaFirmwareVariationInfoV2 entries.
/// * (Optionally) A variable number of NcmContentMetaInfo entries, which is the sum of all 'meta_count' values from ContentMetaFirmwareVariationInfoV2 entries where 'refer_to_base' is set to false.
typedef struct {
u32 version ; ///< ContentMetaFirmwareVariationVersion.
u32 variation_count ; ///< Determines how many firmware variation entries are available after this header.
} ContentMetaSystemUpdateMetaExtendedDataHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaSystemUpdateMetaExtendedDataHeader , 0x8 ) ;
2020-10-01 07:17:59 +01:00
/// Used if the firmware variation version matches ContentMetaFirmwareVariationVersion_V1.
typedef struct {
u32 firmware_variation_id ;
u8 reserved [ 0x1C ] ;
} ContentMetaFirmwareVariationInfoV1 ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaFirmwareVariationInfoV1 , 0x20 ) ;
2020-10-01 07:17:59 +01:00
/// Used if the firmware variation version matches ContentMetaFirmwareVariationVersion_V2.
typedef struct {
bool refer_to_base ;
u8 reserved_1 [ 0x3 ] ;
u32 meta_count ;
u8 reserved_2 [ 0x18 ] ;
} ContentMetaFirmwareVariationInfoV2 ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaFirmwareVariationInfoV2 , 0x20 ) ;
2020-10-01 07:17:59 +01:00
/// Header for the extended data region in Patch titles, pointed to by the extended header.
/// This is followed by:
/// * 'history_count' ContentMetaPatchHistoryHeader entries.
/// * 'delta_history_count' ContentMetaPatchDeltaHistory entries.
/// * 'delta_count' ContentMetaPatchDeltaHeader entries.
/// * 'fragment_set_count' ContentMetaFragmentSet entries.
/// * 'history_content_count' NcmContentInfo entries.
/// * 'delta_content_count' NcmPackagedContentInfo entries.
/// * A variable number of ContentMetaFragmentIndicator entries, which is the sum of all 'fragment_count' values from ContentMetaFragmentSet entries.
typedef struct {
u32 history_count ;
u32 delta_history_count ;
u32 delta_count ;
u32 fragment_set_count ;
u32 history_content_count ;
u32 delta_content_count ;
u8 reserved [ 0x4 ] ;
} ContentMetaPatchMetaExtendedDataHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPatchMetaExtendedDataHeader , 0x1C ) ;
2020-10-01 07:17:59 +01:00
typedef struct {
NcmContentMetaKey content_meta_key ;
u8 digest [ CNMT_DIGEST_SIZE ] ;
u16 content_info_count ;
u8 reserved [ 0x6 ] ;
} ContentMetaPatchHistoryHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPatchHistoryHeader , 0x38 ) ;
2020-10-01 07:17:59 +01:00
typedef struct {
u64 source_patch_id ;
u64 destination_patch_id ;
2022-03-17 12:37:24 +00:00
Version source_version ;
Version destination_version ;
2020-10-01 07:17:59 +01:00
u64 download_size ;
u8 reserved [ 0x8 ] ;
} ContentMetaPatchDeltaHistory ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPatchDeltaHistory , 0x28 ) ;
2020-10-01 07:17:59 +01:00
typedef struct {
u64 source_patch_id ;
u64 destination_patch_id ;
2022-03-17 12:37:24 +00:00
Version source_version ;
Version destination_version ;
2020-10-01 07:17:59 +01:00
u16 fragment_set_count ;
u8 reserved_1 [ 0x6 ] ;
u16 content_info_count ;
u8 reserved_2 [ 0x6 ] ;
} ContentMetaPatchDeltaHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaPatchDeltaHeader , 0x28 ) ;
2020-10-01 07:17:59 +01:00
typedef enum {
ContentMetaUpdateType_ApplyAsDelta = 0 ,
ContentMetaUpdateType_Overwrite = 1 ,
ContentMetaUpdateType_Create = 2
} ContentMetaUpdateType ;
2020-10-08 19:31:09 +01:00
# pragma pack(push, 1)
2020-10-01 07:17:59 +01:00
typedef struct {
NcmContentId source_content_id ;
NcmContentId destination_content_id ;
u32 source_size_low ;
u16 source_size_high ;
u32 destination_size_low ;
u16 destination_size_high ;
u16 fragment_count ;
2020-10-08 19:31:09 +01:00
u8 fragment_target_content_type ; ///< NcmContentType.
2020-10-01 07:17:59 +01:00
u8 update_type ; ///< ContentMetaUpdateType.
u8 reserved [ 0x4 ] ;
} ContentMetaFragmentSet ;
2020-10-08 19:31:09 +01:00
# pragma pack(pop)
2020-10-01 07:17:59 +01:00
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaFragmentSet , 0x34 ) ;
2020-10-01 07:17:59 +01:00
typedef struct {
u16 content_info_index ;
u16 fragment_index ;
} ContentMetaFragmentIndicator ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaFragmentIndicator , 0x4 ) ;
2020-10-01 07:17:59 +01:00
/// Header for the extended data region in Delta titles, pointed to by the extended header.
/// This is followed by:
/// * 'fragment_set_count' ContentMetaFragmentSet entries.
/// * A variable number of ContentMetaFragmentIndicator entries, which is the sum of all 'fragment_count' values from ContentMetaFragmentSet entries.
typedef struct {
u64 source_patch_id ;
u64 destination_patch_id ;
2022-03-17 12:37:24 +00:00
Version source_version ;
Version destination_version ;
2020-10-01 07:17:59 +01:00
u16 fragment_set_count ;
u8 reserved [ 0x6 ] ;
} ContentMetaDeltaMetaExtendedDataHeader ;
2021-03-24 17:25:19 +00:00
NXDT_ASSERT ( ContentMetaDeltaMetaExtendedDataHeader , 0x20 ) ;
2020-10-01 07:17:59 +01:00
typedef struct {
2020-10-02 11:28:41 +01:00
NcaContext * nca_ctx ; ///< Pointer to the NCA context for the Meta NCA from which CNMT data is retrieved.
PartitionFileSystemContext pfs_ctx ; ///< PartitionFileSystemContext for the Meta NCA FS section #0, which is where the CNMT is stored.
PartitionFileSystemEntry * pfs_entry ; ///< PartitionFileSystemEntry for the CNMT in the Meta NCA FS section #0. Used to generate a NcaHierarchicalSha256Patch if needed.
NcaHierarchicalSha256Patch nca_patch ; ///< NcaHierarchicalSha256Patch generated if CNMT modifications are needed. Used to seamlessly replace Meta NCA data while writing it.
///< Bear in mind that generating a patch modifies the NCA context.
char * cnmt_filename ; ///< Pointer to the CNMT filename in the Meta NCA FS section #0.
u8 * raw_data ; ///< Pointer to a dynamically allocated buffer that holds the raw CNMT.
u64 raw_data_size ; ///< Raw CNMT size. Kept here for convenience - this is part of 'pfs_entry'.
u8 raw_data_hash [ SHA256_HASH_SIZE ] ; ///< SHA-256 checksum calculated over the whole raw CNMT. Used to determine if NcaHierarchicalSha256Patch generation is truly needed.
ContentMetaPackagedContentMetaHeader * packaged_header ; ///< Pointer to the ContentMetaPackagedContentMetaHeader within 'raw_data'.
u8 * extended_header ; ///< Pointer to the extended header within 'raw_data', if available. May be casted to other types. Its size is stored in 'packaged_header'.
2020-10-13 03:46:59 +01:00
NcmPackagedContentInfo * packaged_content_info ; ///< Pointer to the NcmPackagedContentInfo entries within 'raw_data', if available. The content count is stored in 'packaged_header'.
2020-10-02 11:28:41 +01:00
NcmContentMetaInfo * content_meta_info ; ///< Pointer to the NcmContentMetaInfo entries within 'raw_data', if available. The content meta count is stored in 'packaged_header'.
u8 * extended_data ; ///< Pointer to the extended data block within 'raw_data', if available.
u32 extended_data_size ; ///< Size of the extended data block within 'raw_data', if available. Kept here for convenience - this is part of the header in 'extended_data'.
u8 * digest ; ///< Pointer to the digest within 'raw_data'.
2022-07-05 02:04:28 +01:00
char * authoring_tool_xml ; ///< Pointer to a dynamically allocated, NULL-terminated buffer that holds AuthoringTool-like XML data.
2020-10-02 11:28:41 +01:00
///< This is always NULL unless cnmtGenerateAuthoringToolXml() is used on this ContentMetaContext.
u64 authoring_tool_xml_size ; ///< Size for the AuthoringTool-like XML. This is essentially the same as using strlen() on 'authoring_tool_xml'.
///< This is always 0 unless cnmtGenerateAuthoringToolXml() is used on this ContentMetaContext.
2020-10-01 07:17:59 +01:00
} ContentMetaContext ;
/// Initializes a ContentMetaContext using a previously initialized NcaContext (which must belong to a Meta NCA).
bool cnmtInitializeContext ( ContentMetaContext * out , NcaContext * nca_ctx ) ;
2020-10-22 05:38:14 +01:00
/// Updates NcmPackagedContentInfo data for the content entry with size, type and ID offset values that match the ones from the input NcaContext.
bool cnmtUpdateContentInfo ( ContentMetaContext * cnmt_ctx , NcaContext * nca_ctx ) ;
/// Generates a Partition FS entry patch for the NcaContext pointed to by the input ContentMetaContext, using its raw CNMT data.
bool cnmtGenerateNcaPatch ( ContentMetaContext * cnmt_ctx ) ;
2020-10-28 22:48:46 +00:00
/// Writes data from the Partition FS entry patch in the input ContentMetaContext to the provided buffer.
2020-10-22 05:38:14 +01:00
void cnmtWriteNcaPatch ( ContentMetaContext * cnmt_ctx , void * buf , u64 buf_size , u64 buf_offset ) ;
2020-10-02 10:53:58 +01:00
/// Generates an AuthoringTool-like XML using information from a previously initialized ContentMetaContext, as well as a pointer to 'nca_ctx_count' NcaContext with content information.
/// If the function succeeds, XML data and size will get saved to the 'authoring_tool_xml' and 'authoring_tool_xml_size' members from the ContentMetaContext.
bool cnmtGenerateAuthoringToolXml ( ContentMetaContext * cnmt_ctx , NcaContext * nca_ctx , u32 nca_ctx_count ) ;
2020-10-01 07:17:59 +01:00
/// Helper inline functions.
NX_INLINE void cnmtFreeContext ( ContentMetaContext * cnmt_ctx )
{
if ( ! cnmt_ctx ) return ;
pfsFreeContext ( & ( cnmt_ctx - > pfs_ctx ) ) ;
pfsFreeEntryPatch ( & ( cnmt_ctx - > nca_patch ) ) ;
if ( cnmt_ctx - > raw_data ) free ( cnmt_ctx - > raw_data ) ;
2020-10-02 10:53:58 +01:00
if ( cnmt_ctx - > authoring_tool_xml ) free ( cnmt_ctx - > authoring_tool_xml ) ;
2020-10-01 07:17:59 +01:00
memset ( cnmt_ctx , 0 , sizeof ( ContentMetaContext ) ) ;
}
2020-10-02 10:53:58 +01:00
NX_INLINE bool cnmtIsValidContext ( ContentMetaContext * cnmt_ctx )
{
return ( cnmt_ctx & & cnmt_ctx - > nca_ctx & & cnmt_ctx - > pfs_entry & & cnmt_ctx - > cnmt_filename & & cnmt_ctx - > raw_data & & cnmt_ctx - > raw_data_size & & cnmt_ctx - > packaged_header & & \
( ( cnmt_ctx - > packaged_header - > extended_header_size & & cnmt_ctx - > extended_header ) | | ( ! cnmt_ctx - > packaged_header - > extended_header_size & & ! cnmt_ctx - > extended_header ) ) & & \
2020-10-13 03:46:59 +01:00
( ( cnmt_ctx - > packaged_header - > content_count & & cnmt_ctx - > packaged_content_info ) | | ( ! cnmt_ctx - > packaged_header - > content_count & & ! cnmt_ctx - > packaged_content_info ) ) & & \
( ( cnmt_ctx - > packaged_header - > content_meta_count & & cnmt_ctx - > content_meta_info ) | | ( ! cnmt_ctx - > packaged_header - > content_meta_count & & ! cnmt_ctx - > content_meta_info ) ) & & \
( ( cnmt_ctx - > extended_data_size & & cnmt_ctx - > extended_data ) | | ( ! cnmt_ctx - > extended_data_size & & ! cnmt_ctx - > extended_data ) ) & & cnmt_ctx - > digest ) ;
2020-10-02 10:53:58 +01:00
}
2020-10-06 16:41:26 +01:00
NX_INLINE u64 cnmtGetRequiredTitleId ( ContentMetaContext * cnmt_ctx )
{
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
if ( ! cnmtIsValidContext ( cnmt_ctx ) ) return 0 ;
u8 content_meta_type = cnmt_ctx - > packaged_header - > content_meta_type ;
if ( content_meta_type = = NcmContentMetaType_Application | | content_meta_type = = NcmContentMetaType_Patch | | content_meta_type = = NcmContentMetaType_AddOnContent )
{
return * ( ( u64 * ) cnmt_ctx - > extended_header ) ;
} else
if ( content_meta_type = = NcmContentMetaType_DataPatch )
{
return ( ( ContentMetaDataPatchMetaExtendedHeader * ) cnmt_ctx - > extended_header ) - > application_id ;
}
return 0 ;
2020-10-06 16:41:26 +01:00
}
NX_INLINE u32 cnmtGetRequiredTitleVersion ( ContentMetaContext * cnmt_ctx )
{
Preliminar 15.x support.
This commit uses my yet unmerged libnx PR to update ncm_types.h.
PoC code hasn't been updated yet, so proper support for DLC updates will arrive at a later time.
Note to self: implement a way to provide access to loaded DataPatch TitleInfo entries (linked list hell).
* bktr: renamed bktrBucketInitializeSubStorageReadParams to bktrInitializeSubStorageReadParams to avoid redundancy, added debug code to dump BucketInfo and BucketTree tables if BucketTree storage initialization fails.
* cnmt: updated ContentMetaAddOnContentMetaExtendedHeader struct to its 15.x equivalent, added ContentMetaLegacyAddOnContentMetaExtendedHeader struct, added ContentMetaDataPatchMetaExtendedHeader struct, updated the cnmtGetRequiredTitleId and cnmtGetRequiredTitleVersion functions to support DataPatch titles, updated cnmtInitializeContext to support both the new AddOnContent extended header and DataPatch titles, added debug code to dump the whole CNMT if context initialization fails, updated cnmtGenerateAuthoringToolXml to support DataPatch titles.
* keys: updated block hashes to match 15.x keyset, use case-insensitive comparison while looking for entry names in keysReadKeysFromFile, make sure the eticket_rsa_kek is non-zero before proceeding in keysGetDecryptedEticketRsaDeviceKey.
* nca: updated NcaKeyGeneration enum, added reminder about updating NcaSignatureKeyGeneration if necessary, replaced ncaFsSectionCheckHashRegionAccess with ncaFsSectionCheckPlaintextHashRegionAccess, removed all extents checks on Patch RomFS and sparse sections, updated ncaGetFsSectionTypeName to reflect if a FS section holds a sparse layer or not.
* nca_storage: updated ncaStorageInitializeContext to avoid initializing a compressed storage if a sparse layer is also used (fixes issues with Them's Fightin' Herds), updated ncaStorageSetPatchOriginalSubStorage to enforce the presence of a compressed storage in a patch if the base FS holds a compressed storage.
* npdm: added reminder about updating NpdmSignatureKeyGeneration if necessary, updated NpdmFsAccessControlFlags enum, updated NpdmAccessibility enum, updated NpdmSystemCallId enum, fixed typos.
* title: updated all relevant functions that deal with NcmContentMetaType values to also handle DataPatch titles, added functions to handle DataPatchId values, removed titleConvertNcmContentSizeToU64 and titleConvertU64ToNcmContentSize functions in favor of ncmContentInfoSizeToU64 and ncmU64ToContentInfoSize from my unmerged libnx PR, updated internal arrays to match 15.x changes, renamed titleOrphanTitleInfoSortFunction to titleInfoEntrySortFunction and updated it to also sort entries by version and storage ID, updated titleGenerateTitleInfoEntriesForTitleStorage to sort TitleInfo entries, simplified titleDuplicateTitleInfo a bit by using macros.
2022-10-23 15:44:47 +01:00
if ( ! cnmtIsValidContext ( cnmt_ctx ) ) return 0 ;
u8 content_meta_type = cnmt_ctx - > packaged_header - > content_meta_type ;
if ( content_meta_type = = NcmContentMetaType_Application | | content_meta_type = = NcmContentMetaType_Patch | | content_meta_type = = NcmContentMetaType_AddOnContent )
{
return ( ( Version * ) ( cnmt_ctx - > extended_header + sizeof ( u64 ) ) ) - > value ;
} else
if ( content_meta_type = = NcmContentMetaType_DataPatch )
{
return ( ( ContentMetaDataPatchMetaExtendedHeader * ) cnmt_ctx - > extended_header ) - > required_application_version . value ;
}
return 0 ;
2020-10-06 16:41:26 +01:00
}
2021-03-23 14:06:52 +00:00
# ifdef __cplusplus
}
2021-03-24 17:25:19 +00:00
# endif
# endif /* __CNMT_H__ */