Added makeCFDictionaryFrom

Author: AlexanderOMara

Security/cfutilities.test.ts

@@ -0,0 +1,33 @@
+import { assertEquals, assertInstanceOf } from '@std/assert';
+import { encodeBinary, encodeXml, PLArray, PLDictionary } from '@hqtsm/plist';
+import { assertThrowsCFError } from '../spec/assert.ts';
+import { makeCFDictionaryFrom } from './cfutilities.ts';
+
+Deno.test('makeCFDictionaryFrom: view', () => {
+	const data = encodeXml(new PLDictionary());
+	const dict = makeCFDictionaryFrom(data);
+	assertInstanceOf(dict, PLDictionary);
+});
+
+Deno.test('makeCFDictionaryFrom: pointer', () => {
+	const data = encodeBinary(new PLDictionary());
+	const view = new Uint8Array(data.byteLength + 2);
+	view.set(data, 1);
+	const dict = makeCFDictionaryFrom(view.subarray(1), data.byteLength);
+	assertInstanceOf(dict, PLDictionary);
+});
+
+Deno.test('makeCFDictionaryFrom: null', () => {
+	const dict = makeCFDictionaryFrom(null);
+	assertEquals(dict, null);
+});
+
+Deno.test('makeCFDictionaryFrom: array', () => {
+	const data = encodeXml(new PLArray());
+	assertThrowsCFError(() => makeCFDictionaryFrom(data));
+});
+
+Deno.test('makeCFDictionaryFrom: bad', () => {
+	const invalid = new TextEncoder().encode('<badplist>');
+	assertEquals(makeCFDictionaryFrom(invalid), null);
+});

Security/cfutilities.ts

@@ -0,0 +1,79 @@
+import type { ArrayBufferPointer } from '@hqtsm/struct';
+import { decode, type DecodeXmlDecoder, PLDictionary } from '@hqtsm/plist';
+import type { size_t } from '../libc/stddef.ts';
+import { pointerBytes, viewBytes } from '../util/memory.ts';
+import { CFError } from './errors.ts';
+
+/**
+ * Decode plist dictionary from buffer.
+ *
+ * @param data Data buffer.
+ * @param decoder Optional XML decoder for obscure encoding.
+ * @returns Dictionary or null.
+ */
+export function makeCFDictionaryFrom(
+	data: ArrayBufferLike | ArrayBufferView | null,
+	decoder?: DecodeXmlDecoder,
+): PLDictionary | null;
+
+/**
+ * Decode plist dictionary from pointer.
+ *
+ * @param data Data pointer.
+ * @param length Data length in bytes.
+ * @param decoder Optional XML decoder for obscure encoding.
+ * @returns Dictionary or null.
+ */
+export function makeCFDictionaryFrom(
+	data: ArrayBufferPointer | null,
+	length: size_t,
+	decoder?: DecodeXmlDecoder,
+): PLDictionary | null;
+
+/**
+ * Decode plist dictionary from buffer or pointer.
+ *
+ * @param data Data buffer or pointer.
+ * @param length Data length in bytes, or optional XML decoder.
+ * @param decoder Optional XML decoder for obscure encoding.
+ * @returns Dictionary or null.
+ */
+export function makeCFDictionaryFrom(
+	data: ArrayBufferLike | ArrayBufferView | ArrayBufferPointer | null,
+	length?: size_t | DecodeXmlDecoder,
+	decoder?: DecodeXmlDecoder,
+): PLDictionary | null {
+	if (data) {
+		let d;
+		if (typeof length === 'number') {
+			d = pointerBytes(data, length);
+		} else {
+			decoder = length;
+			d = viewBytes(data as ArrayBufferLike | ArrayBufferView);
+		}
+		let plist = null;
+		try {
+			// Attempt decode using Mac CF constraints.
+			({ plist } = decode(d, {
+				binary: {
+					int64: true,
+					stringKeys: true,
+				},
+				xml: {
+					int64: true,
+					decoder,
+				},
+				openstep: {
+					utf16le: true,
+				},
+			}));
+		} catch {
+			// Ignore.
+		}
+		if (plist && !PLDictionary.is(plist)) {
+			CFError.throwMe();
+		}
+		return plist;
+	}
+	return null;
+}

Security/mod.ts

@@ -1,4 +1,5 @@
 export * from './blob.ts';
+export * from './cfutilities.ts';
 export * from './CSCommon.ts';
 export * from './CSCommonPriv.ts';
 export * from './endian.ts';