@peculiar/asn1-schema

@peculiar/asn1-schema

Decorators and helper APIs for declaring ASN.1 schemas in TypeScript.

This is the core package used by the schema modules in this repository. It lets you describe DER structures with decorators and convert them with AsnConvert, AsnParser, and AsnSerializer.

Installation

npm install @peculiar/asn1-schema

Overview

Abstract Syntax Notation One (ASN.1) is widely used across X.509, PKCS, CMS, OCSP, and related standards. This package keeps those mappings declarative and type-friendly by attaching schema metadata directly to classes.

TypeScript Example

import {
  AsnConvert,
  AsnProp,
  AsnPropTypes,
  AsnType,
  AsnTypeTypes,
} from "@peculiar/asn1-schema";

@AsnType({ type: AsnTypeTypes.Sequence })
class BasicConstraints {
  @AsnProp({ type: AsnPropTypes.Boolean, defaultValue: false })
  public cA = false;
}

const basicConstraints = new BasicConstraints();
basicConstraints.cA = true;

const encoded = AsnConvert.serialize(basicConstraints);
const decoded = AsnConvert.parse(encoded, BasicConstraints);

console.log(decoded.cA);

Related Links

• Decorators overview
• ASN.1 playground

Similar packages

Other packages similar to @peculiar/asn1-schema

asn1js

asn1js is a JavaScript library for encoding and decoding ASN.1 data structures. It provides a low-level API for working with ASN.1, making it more flexible but also more complex compared to @peculiar/asn1-schema, which offers a higher-level, decorator-based approach.

asn1

asn1 is a library for encoding and decoding ASN.1 data structures in JavaScript. It is similar to node-asn1 but provides a more comprehensive set of features for working with ASN.1, though it lacks the decorator-based schema definition found in @peculiar/asn1-schema.