Merge pull request #37 from KeetaNetwork/feature/support-ts-struct

Feature: Support Struct

Author: rkeene

Cargo.lock

@@ -2,7 +2,7 @@
 authors = ["Tanveer Wahid <twahid@keeta.com>"]
 edition = "2021"
 name = "asn1-napi-rs"
-version = "1.1.6"
+version = "1.2.0"
 rust-version = "1.56"
 
 [lib]

Cargo.toml

@@ -31,7 +31,7 @@ index.js: Cargo.toml Cargo.lock package.json package-lock.json tsconfig.json nod
 	rm -f index.js index.d.ts
 	mv __TMP__/index.* __TMP__/asn1-napi-rs.*.node ./
 	rmdir __TMP__
-	echo 'export type ASN1AnyJS = ASN1AnyJS[] | bigint | number | Date | Buffer | ASN1OID | ASN1Set | ASN1ContextTag | ASN1BitString | ASN1Date | ASN1String | string | boolean | null | undefined;' >> index.d.ts
+	echo 'export type ASN1AnyJS = ASN1AnyJS[] | bigint | number | Date | Buffer | ASN1OID | ASN1Set | ASN1ContextTag | ASN1BitString | ASN1Date | ASN1String | ASN1Struct | string | boolean | null | undefined;' >> index.d.ts
 
 # "index.d.ts" is generated by the rule that generates "index.js", but Make
 # lacks a way to express this outcome

Makefile

@@ -1,6 +1,6 @@
 {
 	"name": "@keetanetwork/asn1-napi-rs",
-	"version": "1.1.9",
+	"version": "1.2.0",
 	"homepage": "https://github.com/KeetaNetwork/asn1-napi-rs#readme",
 	"author": "Tanveer Wahid <twahid@keeta.com>",
 	"description": "KeetaNetwork ASN.1 TypeScript-Rust NAPI library",

package-lock.json

@@ -8,6 +8,10 @@ pub(crate) const ASN1_OBJECT_KIND_KEY: &str = "kind";
 pub(crate) const ASN1_OBJECT_DATE_KEY: &str = "date";
 /// Key string for "name" attribute of objects.
 pub(crate) const ASN1_OBJECT_NAME_KEY: &str = "name";
+/// Key string for "fieldNames" attribute of struct objects.
+pub(crate) const ASN1_OBJECT_FIELD_NAMES_KEY: &str = "fieldNames";
+/// Key string for "contains" attribute of struct objects.
+pub(crate) const ASN1_OBJECT_CONTAINS_KEY: &str = "contains";
 /// ASN1 Date format for GeneralizedTime but without milliseconds.
 pub(crate) const ASN1_DATE_TIME_GENERAL_FORMAT: &str = "%Y%m%d%H%M%SZ";
 /// ASN1 Date format for GeneralizedTime with milliseconds.

package.json

@@ -14,12 +14,13 @@ mod utils;
 use std::str::FromStr;
 
 pub use crate::asn1::ASN1Decoder;
+use crate::objects::ASN1Struct;
 
 use anyhow::Result;
 use asn1::ASN1Encoder;
 use constants::{
-	ASN1_NULL, ASN1_OBJECT_DATE_KEY, ASN1_OBJECT_KIND_KEY, ASN1_OBJECT_NAME_KEY,
-	ASN1_OBJECT_TYPE_KEY, ASN1_OBJECT_VALUE_KEY,
+	ASN1_NULL, ASN1_OBJECT_DATE_KEY, ASN1_OBJECT_FIELD_NAMES_KEY, ASN1_OBJECT_KIND_KEY,
+	ASN1_OBJECT_NAME_KEY, ASN1_OBJECT_TYPE_KEY, ASN1_OBJECT_VALUE_KEY,
 };
 use napi::{
 	bindgen_prelude::{Array, Buffer},
@@ -340,6 +341,26 @@ fn get_js_obj_from_asn_object(env: Env, data: ASN1Object) -> Result<JsObject> {
 				get_js_unknown_from_asn1_data(env, *val.contains)?,
 			)?;
 		}
+		ASN1Object::Struct(val) => {
+			obj.set_named_property::<JsString>(
+				ASN1_OBJECT_TYPE_KEY,
+				env.create_string(ASN1Struct::TYPE)?,
+			)?;
+
+			let mut js_field_names = env.create_array_with_length(val.0.len())?;
+			let mut js_contains = env.create_object()?;
+			for (index, asn1_data) in val.0.into_iter().enumerate() {
+				let field_name = format!("field_{index}");
+				js_field_names.set_element(index as u32, env.create_string(&field_name)?)?;
+				js_contains.set_named_property::<JsUnknown>(
+					&field_name,
+					get_js_unknown_from_asn1_data(env, asn1_data)?,
+				)?;
+			}
+
+			obj.set_named_property::<JsObject>(ASN1_OBJECT_FIELD_NAMES_KEY, js_field_names)?;
+			obj.set_named_property::<JsObject>(ASN1_OBJECT_VALUE_KEY, js_contains)?;
+		}
 	};
 
 	Ok(obj)

src/constants.rs

@@ -76,6 +76,8 @@ pub enum ASN1Object {
 	Date(ASN1Date),
 	#[rasn(tag(universal, 3))]
 	BitString(ASN1RawBitString),
+	#[rasn(tag(universal, 16))]
+	Struct(ASN1Struct),
 	#[rasn(tag(context, 0))]
 	Context(ASN1Context),
 }
@@ -164,6 +166,23 @@ pub struct ASN1BitString {
 	pub unused_bits: Option<u8>,
 }
 
+/// ASN1 Struct represented as a sequence of ASN1Data values.
+#[derive(AsnType, Decode, Encode, Clone, Eq, PartialEq, Debug)]
+#[rasn(delegate)]
+pub struct ASN1Struct(pub Vec<ASN1Data>);
+
+/// Shim to surface ASN1Struct in generated TypeScript declarations only.
+#[napi(object, js_name = "ASN1Struct")]
+#[allow(dead_code)]
+pub struct ASN1StructShim {
+	#[napi(ts_type = "'struct'")]
+	pub r#type: &'static str,
+	#[napi(js_name = "fieldNames")]
+	pub field_names: Option<Vec<String>>,
+	#[napi(ts_type = "Record<string, ASN1AnyJS>")]
+	pub contains: JsUnknown,
+}
+
 /// Get an oid as u32 words from a canonically named identifier.
 fn get_oid_from_name<T: AsRef<str>>(name: T) -> Result<&'static [u32]> {
 	if let Some(oid) = NAME_TO_OID_MAP.get(name.as_ref()) {
@@ -200,6 +219,7 @@ fn get_name_from_oid_string<T: AsRef<str>>(oid: T) -> Result<&'static str> {
 pub trait TypedObject<'a> {
 	const TYPE: &'a str;
 
+	#[allow(dead_code)]
 	fn get_type() -> &'a str {
 		Self::TYPE
 	}
@@ -306,6 +326,7 @@ type_object!(ASN1Set, "set");
 type_object!(ASN1String, "string");
 type_object!(ASN1Date, "date");
 type_object!(ASN1ContextTag, "context");
+type_object!(ASN1Struct, "struct");
 
 impl Encode for ASN1RawBitString {
 	fn encode_with_tag<E: Encoder>(&self, encoder: &mut E, tag: Tag) -> Result<(), E::Error> {
@@ -563,6 +584,7 @@ impl Encode for ASN1Data {
 				ASN1Object::Date(date) => date.encode(encoder),
 				ASN1Object::BitString(bs) => bs.encode(encoder),
 				ASN1Object::Context(context) => context.encode(encoder),
+				ASN1Object::Struct(struct_value) => struct_value.encode(encoder),
 			},
 			ASN1Data::Utf8String(string) => string.encode_with_tag(encoder, Tag::UTF8_STRING),
 			ASN1Data::UtcTime(date) => date.encode(encoder),
@@ -638,6 +660,73 @@ impl TryFrom<JsObject> for ASN1RawBitString {
 	}
 }
 
+impl TryFrom<JsObject> for ASN1Struct {
+	type Error = Error;
+
+	fn try_from(object: JsObject) -> Result<Self, Self::Error> {
+		if !object.has_named_property(ASN1_OBJECT_CONTAINS_KEY)? {
+			bail!(ASN1NAPIError::UnknownObject);
+		}
+
+		let contains = object.get_named_property::<JsObject>(ASN1_OBJECT_CONTAINS_KEY)?;
+		let mut ordered_names = Vec::new();
+
+		if object.has_named_property(ASN1_OBJECT_FIELD_NAMES_KEY)? {
+			let js_field_names =
+				object.get_named_property::<JsObject>(ASN1_OBJECT_FIELD_NAMES_KEY)?;
+			let len = js_field_names.get_array_length()?;
+			for index in 0..len {
+				ordered_names.push(
+					js_field_names
+						.get_element::<JsString>(index)?
+						.into_utf8()?
+						.as_str()?
+						.to_string(),
+				);
+			}
+		}
+
+		let property_names = contains.get_property_names()?;
+		let len = property_names.get_array_length()?;
+		let mut discovered = Vec::with_capacity(len as usize);
+		for index in 0..len {
+			discovered.push(
+				property_names
+					.get_element::<JsString>(index)?
+					.into_utf8()?
+					.as_str()?
+					.to_string(),
+			);
+		}
+
+		if ordered_names.is_empty() {
+			ordered_names = discovered.clone();
+		} else {
+			for name in discovered {
+				if !ordered_names.iter().any(|existing| existing == &name) {
+					ordered_names.push(name);
+				}
+			}
+		}
+
+		let mut values = Vec::new();
+		for field_name in ordered_names {
+			if !contains.has_named_property(&field_name)? {
+				continue;
+			}
+
+			let field_value = contains.get_named_property::<JsUnknown>(&field_name)?;
+			if field_value.get_type()? == ValueType::Undefined {
+				continue;
+			}
+
+			values.push(ASN1Data::try_from(field_value)?);
+		}
+
+		Ok(ASN1Struct(values))
+	}
+}
+
 impl TryFrom<ASN1OID> for ObjectIdentifier {
 	type Error = Error;
 
@@ -876,6 +965,7 @@ impl TryFrom<JsObject> for ASN1Object {
 				ASN1Date::TYPE => ASN1Object::Date(ASN1Date::try_from(obj)?),
 				ASN1BitString::TYPE => ASN1Object::BitString(ASN1RawBitString::try_from(obj)?),
 				ASN1ContextTag::TYPE => ASN1Object::Context(ASN1Context::try_from(obj)?),
+				ASN1Struct::TYPE => ASN1Object::Struct(ASN1Struct::try_from(obj)?),
 				_ => bail!(ASN1NAPIError::UnknownFieldProperty),
 			})
 		} else {

src/lib.rs

@@ -18,7 +18,7 @@ use crate::{
 	constants::{ASN1_OBJECT_DATE_KEY, ASN1_OBJECT_KIND_KEY, ASN1_OBJECT_TYPE_KEY},
 	get_big_int_from_integer, get_js_big_int_from_big_int, get_js_obj_from_asn_data,
 	get_js_obj_from_asn_object,
-	objects::{ASN1Date, ASN1Object, ASN1RawBitString, TypedObject, ASN1OID},
+	objects::{ASN1Date, ASN1Object, ASN1RawBitString, ASN1Struct, TypedObject, ASN1OID},
 	utils::{
 		get_array_buffer_from_js, get_array_from_js, get_asn_date_type_from_js_unknown,
 		get_asn_string_type_from_js_unknown, get_big_int_from_js, get_boolean_from_js,
@@ -245,7 +245,20 @@ impl TryFrom<JsUnknown> for ASN1Data {
 			ValueType::Object if value.is_buffer()? => ASN1Data::Bytes(get_buffer_from_js(value)?),
 			ValueType::Object if value.is_date()? => get_asn_date_type_from_js_unknown(value)?,
 			ValueType::Object if value.is_array()? => ASN1Data::Array(get_array_from_js(value)?),
-			ValueType::Object => ASN1Data::Object(ASN1Object::try_from(value)?),
+			ValueType::Object => {
+				let object = value.coerce_to_object()?;
+				if let Ok(object_type) = object.get_named_property::<JsString>(ASN1_OBJECT_TYPE_KEY)
+				{
+					let object_type = object_type.into_utf8()?.as_str()?.to_string();
+					if object_type == ASN1Struct::TYPE {
+						return Ok(ASN1Data::Object(ASN1Object::Struct(ASN1Struct::try_from(
+							object,
+						)?)));
+					}
+				}
+
+				ASN1Data::Object(ASN1Object::try_from(object.into_unknown())?)
+			}
 			ValueType::Undefined => ASN1Data::Undefined,
 			_ => ASN1Data::Unknown(Any::new(get_buffer_from_js(value)?)),
 		})

src/objects.rs

@@ -0,0 +1,114 @@
+import test from 'ava'
+
+import * as lib from '..'
+
+type StructScenario = {
+	readonly description: string
+	readonly input: lib.ASN1Struct
+	readonly normalized: lib.ASN1Struct
+	readonly expected: ArrayBuffer
+}
+
+const STRUCT_CASES: StructScenario[] = [
+	{
+		description: 'struct with optional integer present',
+		input: {
+			type: 'struct',
+			contains: { a: 1n, b: 'Test' },
+		},
+		normalized: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { a: 1n, b: 'Test' },
+		},
+		expected: new Uint8Array([
+			0x30, 0x09, 0x02, 0x01, 0x01, 0x13, 0x04, 0x54, 0x65, 0x73, 0x74,
+		]).buffer,
+	},
+	{
+		description: 'struct with only the required string field',
+		input: {
+			type: 'struct',
+			contains: { b: 'Test' },
+		},
+		normalized: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { b: 'Test' },
+		},
+		expected: new Uint8Array([0x30, 0x06, 0x13, 0x04, 0x54, 0x65, 0x73, 0x74]).buffer,
+	},
+	{
+		description: 'struct already containing field names and both fields',
+		input: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { a: 1n, b: 'Test' },
+		},
+		normalized: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { a: 1n, b: 'Test' },
+		},
+		expected: new Uint8Array([
+			0x30, 0x09, 0x02, 0x01, 0x01, 0x13, 0x04, 0x54, 0x65, 0x73, 0x74,
+		]).buffer,
+	},
+	{
+		description: 'struct already containing field names and only required field',
+		input: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { b: 'Test' },
+		},
+		normalized: {
+			type: 'struct',
+			fieldNames: ['a', 'b'],
+			contains: { b: 'Test' },
+		},
+		expected: new Uint8Array([0x30, 0x06, 0x13, 0x04, 0x54, 0x65, 0x73, 0x74]).buffer,
+	},
+]
+
+const STRUCT_IN_CONTEXT_CASES: Array<{
+	readonly input: lib.ASN1ContextTag
+	readonly normalized: lib.ASN1ContextTag
+	readonly expected: ArrayBuffer
+}> = [
+	{
+		input: {
+			type: 'context',
+			kind: 'implicit',
+			value: 3,
+			contains: {
+				type: 'struct',
+				contains: { a: 1n, b: 'Test' },
+			},
+		},
+		normalized: {
+			type: 'context',
+			kind: 'implicit',
+			value: 3,
+			contains: {
+				type: 'struct',
+				fieldNames: ['a', 'b'],
+				contains: { a: 1n, b: 'Test' },
+			},
+		},
+		expected: new Uint8Array([
+			0x83, 0x09, 0x02, 0x01, 0x01, 0x13, 0x04, 0x54, 0x65, 0x73, 0x74,
+		]).buffer,
+	},
+]
+
+test('JS ASN1Struct to ASN1 conversion matches schema-driven expectations', (t) => {
+	STRUCT_CASES.forEach(({ description, normalized, expected }) => {
+		t.deepEqual(lib.JStoASN1(normalized).toBER(), expected, description)
+	})
+})
+
+test('JS ASN1Struct context tag encoding matches schema-driven expectations', (t) => {
+	STRUCT_IN_CONTEXT_CASES.forEach(({ normalized, expected }) => {
+		t.deepEqual(lib.JStoASN1(normalized).toBER(), expected)
+	})
+})