@tootallnate/cnmt 0.0.0

package/.turbo/turbo-build.log

@@ -0,0 +1,4 @@
+
+> @tootallnate/cnmt@0.0.0 build /Users/nrajlich/Code/TooTallNate/switch-tools/packages/cnmt
+> tsc
+

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * CNMT (Content Meta) builder for Nintendo Switch.
+ *
+ * Builds CNMT binary data used inside Meta NCAs to describe
+ * the contents (NCAs) of an application package.
+ *
+ * Reference: hacbrewpack/cnmt.c, hacbrewpack/cnmt.h
+ */
+/** CNMT content types */
+export declare enum ContentType {
+    Meta = 0,
+    Program = 1,
+    Data = 2,
+    Control = 3,
+    HtmlDocument = 4,
+    LegalInformation = 5,
+    DeltaFragment = 6
+}
+/** CNMT meta type */
+export declare enum MetaType {
+    SystemProgram = 1,
+    SystemData = 2,
+    SystemUpdate = 3,
+    BootImagePackage = 4,
+    BootImagePackageSafe = 5,
+    Application = 128,
+    Patch = 129,
+    AddOnContent = 130,
+    Delta = 131
+}
+/**
+ * A content record describing one NCA.
+ */
+export interface ContentRecord {
+    /** SHA-256 hash of the entire NCA file (32 bytes) */
+    hash: Uint8Array;
+    /** NCA ID: first 16 bytes of the hash */
+    ncaId: Uint8Array;
+    /** NCA file size (up to 6 bytes / 48 bits) */
+    size: number;
+    /** Content type */
+    type: ContentType;
+    /** ID offset (usually 0) */
+    idOffset?: number;
+}
+export interface CnmtOptions {
+    /** Application title ID */
+    titleId: bigint;
+    /** Title version (default: 0) */
+    titleVersion?: number;
+    /** Content records for the NCAs in this package */
+    contentRecords: ContentRecord[];
+}
+/**
+ * Build a CNMT binary blob.
+ *
+ * @param options - CNMT configuration
+ * @returns CNMT binary data as ArrayBuffer
+ */
+export declare function build(options: CnmtOptions): ArrayBuffer;

package/dist/index.js

@@ -0,0 +1,99 @@
+/**
+ * CNMT (Content Meta) builder for Nintendo Switch.
+ *
+ * Builds CNMT binary data used inside Meta NCAs to describe
+ * the contents (NCAs) of an application package.
+ *
+ * Reference: hacbrewpack/cnmt.c, hacbrewpack/cnmt.h
+ */
+/** CNMT content types */
+export var ContentType;
+(function (ContentType) {
+    ContentType[ContentType["Meta"] = 0] = "Meta";
+    ContentType[ContentType["Program"] = 1] = "Program";
+    ContentType[ContentType["Data"] = 2] = "Data";
+    ContentType[ContentType["Control"] = 3] = "Control";
+    ContentType[ContentType["HtmlDocument"] = 4] = "HtmlDocument";
+    ContentType[ContentType["LegalInformation"] = 5] = "LegalInformation";
+    ContentType[ContentType["DeltaFragment"] = 6] = "DeltaFragment";
+})(ContentType || (ContentType = {}));
+/** CNMT meta type */
+export var MetaType;
+(function (MetaType) {
+    MetaType[MetaType["SystemProgram"] = 1] = "SystemProgram";
+    MetaType[MetaType["SystemData"] = 2] = "SystemData";
+    MetaType[MetaType["SystemUpdate"] = 3] = "SystemUpdate";
+    MetaType[MetaType["BootImagePackage"] = 4] = "BootImagePackage";
+    MetaType[MetaType["BootImagePackageSafe"] = 5] = "BootImagePackageSafe";
+    MetaType[MetaType["Application"] = 128] = "Application";
+    MetaType[MetaType["Patch"] = 129] = "Patch";
+    MetaType[MetaType["AddOnContent"] = 130] = "AddOnContent";
+    MetaType[MetaType["Delta"] = 131] = "Delta";
+})(MetaType || (MetaType = {}));
+/** CNMT header size: 0x20 bytes */
+const HEADER_SIZE = 0x20;
+/** Extended application header size: 0x10 bytes */
+const EXTENDED_APP_HEADER_SIZE = 0x10;
+/** Content record size: 0x38 bytes */
+const CONTENT_RECORD_SIZE = 0x38;
+/** Digest size: 0x20 bytes */
+const DIGEST_SIZE = 0x20;
+/**
+ * Build a CNMT binary blob.
+ *
+ * @param options - CNMT configuration
+ * @returns CNMT binary data as ArrayBuffer
+ */
+export function build(options) {
+    const { titleId, titleVersion = 0, contentRecords } = options;
+    // Total size = header + extended header + content records + digest
+    const totalSize = HEADER_SIZE +
+        EXTENDED_APP_HEADER_SIZE +
+        contentRecords.length * CONTENT_RECORD_SIZE +
+        DIGEST_SIZE;
+    const buffer = new ArrayBuffer(totalSize);
+    const view = new DataView(buffer);
+    const bytes = new Uint8Array(buffer);
+    let offset = 0;
+    // --- CNMT Header (0x20 bytes) ---
+    // title_id (8 bytes)
+    view.setBigUint64(offset + 0x00, titleId, true);
+    // title_version (4 bytes)
+    view.setUint32(offset + 0x08, titleVersion, true);
+    // type (1 byte)
+    view.setUint8(offset + 0x0c, MetaType.Application);
+    // padding (1 byte) — already zero
+    // extended_header_size (2 bytes)
+    view.setUint16(offset + 0x0e, EXTENDED_APP_HEADER_SIZE, true);
+    // content_entry_count (2 bytes)
+    view.setUint16(offset + 0x10, contentRecords.length, true);
+    // meta_entry_count (2 bytes) — 0
+    // padding (remaining bytes of header) — already zero
+    offset += HEADER_SIZE;
+    // --- Extended Application Header (0x10 bytes) ---
+    // patch_title_id = title_id + 0x800
+    view.setBigUint64(offset + 0x00, titleId + 0x800n, true);
+    // required_system_version (4 bytes) — 0
+    // padding (4 bytes) — already zero
+    offset += EXTENDED_APP_HEADER_SIZE;
+    // --- Content Records (0x38 bytes each) ---
+    for (const record of contentRecords) {
+        // hash (0x20 bytes)
+        bytes.set(record.hash.subarray(0, 0x20), offset + 0x00);
+        // ncaid (0x10 bytes)
+        bytes.set(record.ncaId.subarray(0, 0x10), offset + 0x20);
+        // size (6 bytes, little-endian)
+        const size = record.size;
+        view.setUint32(offset + 0x30, size & 0xffffffff, true);
+        view.setUint16(offset + 0x34, Math.floor(size / 0x100000000) & 0xffff, true);
+        // type (1 byte)
+        view.setUint8(offset + 0x36, record.type);
+        // id_offset (1 byte)
+        view.setUint8(offset + 0x37, record.idOffset ?? 0);
+        offset += CONTENT_RECORD_SIZE;
+    }
+    // --- Digest (0x20 bytes) ---
+    // All zeros (already zeroed from ArrayBuffer allocation)
+    return buffer;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,yBAAyB;AACzB,MAAM,CAAN,IAAY,WAQX;AARD,WAAY,WAAW;IACtB,6CAAQ,CAAA;IACR,mDAAW,CAAA;IACX,6CAAQ,CAAA;IACR,mDAAW,CAAA;IACX,6DAAgB,CAAA;IAChB,qEAAoB,CAAA;IACpB,+DAAiB,CAAA;AAClB,CAAC,EARW,WAAW,KAAX,WAAW,QAQtB;AAED,qBAAqB;AACrB,MAAM,CAAN,IAAY,QAUX;AAVD,WAAY,QAAQ;IACnB,yDAAoB,CAAA;IACpB,mDAAiB,CAAA;IACjB,uDAAmB,CAAA;IACnB,+DAAuB,CAAA;IACvB,uEAA2B,CAAA;IAC3B,uDAAkB,CAAA;IAClB,2CAAY,CAAA;IACZ,yDAAmB,CAAA;IACnB,2CAAY,CAAA;AACb,CAAC,EAVW,QAAQ,KAAR,QAAQ,QAUnB;AAED,mCAAmC;AACnC,MAAM,WAAW,GAAG,IAAI,CAAC;AAEzB,mDAAmD;AACnD,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,sCAAsC;AACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC;AAEjC,8BAA8B;AAC9B,MAAM,WAAW,GAAG,IAAI,CAAC;AA2BzB;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,OAAoB;IACzC,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,CAAC,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAE9D,mEAAmE;IACnE,MAAM,SAAS,GACd,WAAW;QACX,wBAAwB;QACxB,cAAc,CAAC,MAAM,GAAG,mBAAmB;QAC3C,WAAW,CAAC;IAEb,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAErC,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,mCAAmC;IACnC,qBAAqB;IACrB,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAChD,0BAA0B;IAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAClD,gBAAgB;IAChB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,kCAAkC;IAClC,iCAAiC;IACjC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,EAAE,wBAAwB,EAAE,IAAI,CAAC,CAAC;IAC9D,gCAAgC;IAChC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3D,iCAAiC;IACjC,qDAAqD;IAErD,MAAM,IAAI,WAAW,CAAC;IAEtB,mDAAmD;IACnD,oCAAoC;IACpC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,EAAE,OAAO,GAAG,MAAM,EAAE,IAAI,CAAC,CAAC;IACzD,wCAAwC;IACxC,mCAAmC;IAEnC,MAAM,IAAI,wBAAwB,CAAC;IAEnC,4CAA4C;IAC5C,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;QACrC,oBAAoB;QACpB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;QACxD,qBAAqB;QACrB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;QACzD,gCAAgC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,EAAE,IAAI,GAAG,UAAU,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,CACb,MAAM,GAAG,IAAI,EACb,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,WAAW,CAAC,GAAG,MAAM,EACvC,IAAI,CACJ,CAAC;QACF,gBAAgB;QAChB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,qBAAqB;QACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;QAEnD,MAAM,IAAI,mBAAmB,CAAC;IAC/B,CAAC;IAED,8BAA8B;IAC9B,yDAAyD;IAEzD,OAAO,MAAM,CAAC;AACf,CAAC"}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@tootallnate/cnmt",
+  "version": "0.0.0",
+  "type": "module",
+  "description": "CNMT (Content Meta) builder for Nintendo Switch NCAs",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  },
+  "keywords": [],
+  "author": "Nathan Rajlich <n@n8.io>",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,144 @@
+/**
+ * CNMT (Content Meta) builder for Nintendo Switch.
+ *
+ * Builds CNMT binary data used inside Meta NCAs to describe
+ * the contents (NCAs) of an application package.
+ *
+ * Reference: hacbrewpack/cnmt.c, hacbrewpack/cnmt.h
+ */
+
+/** CNMT content types */
+export enum ContentType {
+	Meta = 0,
+	Program = 1,
+	Data = 2,
+	Control = 3,
+	HtmlDocument = 4,
+	LegalInformation = 5,
+	DeltaFragment = 6,
+}
+
+/** CNMT meta type */
+export enum MetaType {
+	SystemProgram = 0x01,
+	SystemData = 0x02,
+	SystemUpdate = 0x03,
+	BootImagePackage = 0x04,
+	BootImagePackageSafe = 0x05,
+	Application = 0x80,
+	Patch = 0x81,
+	AddOnContent = 0x82,
+	Delta = 0x83,
+}
+
+/** CNMT header size: 0x20 bytes */
+const HEADER_SIZE = 0x20;
+
+/** Extended application header size: 0x10 bytes */
+const EXTENDED_APP_HEADER_SIZE = 0x10;
+
+/** Content record size: 0x38 bytes */
+const CONTENT_RECORD_SIZE = 0x38;
+
+/** Digest size: 0x20 bytes */
+const DIGEST_SIZE = 0x20;
+
+/**
+ * A content record describing one NCA.
+ */
+export interface ContentRecord {
+	/** SHA-256 hash of the entire NCA file (32 bytes) */
+	hash: Uint8Array;
+	/** NCA ID: first 16 bytes of the hash */
+	ncaId: Uint8Array;
+	/** NCA file size (up to 6 bytes / 48 bits) */
+	size: number;
+	/** Content type */
+	type: ContentType;
+	/** ID offset (usually 0) */
+	idOffset?: number;
+}
+
+export interface CnmtOptions {
+	/** Application title ID */
+	titleId: bigint;
+	/** Title version (default: 0) */
+	titleVersion?: number;
+	/** Content records for the NCAs in this package */
+	contentRecords: ContentRecord[];
+}
+
+/**
+ * Build a CNMT binary blob.
+ *
+ * @param options - CNMT configuration
+ * @returns CNMT binary data as ArrayBuffer
+ */
+export function build(options: CnmtOptions): ArrayBuffer {
+	const { titleId, titleVersion = 0, contentRecords } = options;
+
+	// Total size = header + extended header + content records + digest
+	const totalSize =
+		HEADER_SIZE +
+		EXTENDED_APP_HEADER_SIZE +
+		contentRecords.length * CONTENT_RECORD_SIZE +
+		DIGEST_SIZE;
+
+	const buffer = new ArrayBuffer(totalSize);
+	const view = new DataView(buffer);
+	const bytes = new Uint8Array(buffer);
+
+	let offset = 0;
+
+	// --- CNMT Header (0x20 bytes) ---
+	// title_id (8 bytes)
+	view.setBigUint64(offset + 0x00, titleId, true);
+	// title_version (4 bytes)
+	view.setUint32(offset + 0x08, titleVersion, true);
+	// type (1 byte)
+	view.setUint8(offset + 0x0c, MetaType.Application);
+	// padding (1 byte) — already zero
+	// extended_header_size (2 bytes)
+	view.setUint16(offset + 0x0e, EXTENDED_APP_HEADER_SIZE, true);
+	// content_entry_count (2 bytes)
+	view.setUint16(offset + 0x10, contentRecords.length, true);
+	// meta_entry_count (2 bytes) — 0
+	// padding (remaining bytes of header) — already zero
+
+	offset += HEADER_SIZE;
+
+	// --- Extended Application Header (0x10 bytes) ---
+	// patch_title_id = title_id + 0x800
+	view.setBigUint64(offset + 0x00, titleId + 0x800n, true);
+	// required_system_version (4 bytes) — 0
+	// padding (4 bytes) — already zero
+
+	offset += EXTENDED_APP_HEADER_SIZE;
+
+	// --- Content Records (0x38 bytes each) ---
+	for (const record of contentRecords) {
+		// hash (0x20 bytes)
+		bytes.set(record.hash.subarray(0, 0x20), offset + 0x00);
+		// ncaid (0x10 bytes)
+		bytes.set(record.ncaId.subarray(0, 0x10), offset + 0x20);
+		// size (6 bytes, little-endian)
+		const size = record.size;
+		view.setUint32(offset + 0x30, size & 0xffffffff, true);
+		view.setUint16(
+			offset + 0x34,
+			Math.floor(size / 0x100000000) & 0xffff,
+			true
+		);
+		// type (1 byte)
+		view.setUint8(offset + 0x36, record.type);
+		// id_offset (1 byte)
+		view.setUint8(offset + 0x37, record.idOffset ?? 0);
+
+		offset += CONTENT_RECORD_SIZE;
+	}
+
+	// --- Digest (0x20 bytes) ---
+	// All zeros (already zeroed from ArrayBuffer allocation)
+
+	return buffer;
+}

package/test/index.test.ts

@@ -0,0 +1,105 @@
+import { describe, it, expect } from 'vitest';
+import { build, ContentType, MetaType } from '../src/index.js';
+
+function bytesToHex(bytes: Uint8Array): string {
+	return Array.from(bytes)
+		.map((b) => b.toString(16).padStart(2, '0'))
+		.join('');
+}
+
+describe('CNMT builder', () => {
+	it('should build a CNMT with correct header', () => {
+		const titleId = 0x0100000000001000n;
+		const fakeHash = new Uint8Array(32);
+		for (let i = 0; i < 32; i++) fakeHash[i] = i;
+		const fakeNcaId = fakeHash.subarray(0, 16);
+
+		const cnmt = build({
+			titleId,
+			contentRecords: [
+				{
+					hash: fakeHash,
+					ncaId: fakeNcaId,
+					size: 0x100000,
+					type: ContentType.Program,
+				},
+				{
+					hash: fakeHash,
+					ncaId: fakeNcaId,
+					size: 0x80000,
+					type: ContentType.Control,
+				},
+			],
+		});
+
+		const view = new DataView(cnmt);
+		const bytes = new Uint8Array(cnmt);
+
+		// Header (0x20 bytes)
+		expect(view.getBigUint64(0x00, true)).toBe(titleId);
+		expect(view.getUint32(0x08, true)).toBe(0); // title_version
+		expect(view.getUint8(0x0c)).toBe(MetaType.Application);
+		expect(view.getUint16(0x0e, true)).toBe(0x10); // extended_header_size
+		expect(view.getUint16(0x10, true)).toBe(2); // content_entry_count
+
+		// Extended header (0x10 bytes starting at 0x20)
+		expect(view.getBigUint64(0x20, true)).toBe(titleId + 0x800n); // patch_title_id
+
+		// Content record 0 (at offset 0x30, 0x38 bytes)
+		expect(view.getUint8(0x30 + 0x36)).toBe(ContentType.Program);
+
+		// Content record 1 (at offset 0x30 + 0x38 = 0x68)
+		expect(view.getUint8(0x68 + 0x36)).toBe(ContentType.Control);
+
+		// Total size = 0x20 (header) + 0x10 (ext header) + 2 * 0x38 (records) + 0x20 (digest)
+		expect(cnmt.byteLength).toBe(0x20 + 0x10 + 2 * 0x38 + 0x20);
+	});
+
+	it('should store NCA size as 6-byte little-endian', () => {
+		const fakeHash = new Uint8Array(32).fill(0xab);
+		const fakeNcaId = fakeHash.subarray(0, 16);
+		const size = 0x0102030405; // 5-byte value
+
+		const cnmt = build({
+			titleId: 0x0100000000001000n,
+			contentRecords: [
+				{
+					hash: fakeHash,
+					ncaId: fakeNcaId,
+					size,
+					type: ContentType.Program,
+				},
+			],
+		});
+
+		const view = new DataView(cnmt);
+		const recordOffset = 0x30; // header + ext header
+
+		// Read the 6-byte size at record + 0x30
+		const low = view.getUint32(recordOffset + 0x30, true);
+		const high = view.getUint16(recordOffset + 0x34, true);
+		const reconstructed = low + high * 0x100000000;
+		expect(reconstructed).toBe(size);
+	});
+
+	it('should end with a 0x20-byte zero digest', () => {
+		const fakeHash = new Uint8Array(32).fill(0xff);
+		const fakeNcaId = fakeHash.subarray(0, 16);
+
+		const cnmt = build({
+			titleId: 0x0100000000001000n,
+			contentRecords: [
+				{
+					hash: fakeHash,
+					ncaId: fakeNcaId,
+					size: 100,
+					type: ContentType.Program,
+				},
+			],
+		});
+
+		const bytes = new Uint8Array(cnmt);
+		const digest = bytes.subarray(bytes.length - 0x20);
+		expect(bytesToHex(digest)).toBe('00'.repeat(0x20));
+	});
+});

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "outDir": "./dist",
+    "declaration": true,
+    "sourceMap": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}