ASN.1 SDK 快速入门

ASN.1 SDK 提供统一的命令行工作流，将 ASN.1 规范编译为 C、C++、Java、C# 和 Go 源代码。本指南涵盖安装、许可证激活、项目设置和编译。

1. 安装

SDK 需要 Java 17 或更高版本。从下载页面下载 SDK 压缩包并解压：

unzip asn1-sdk-3.14.15.zip
cd asn1-sdk-3.14.15

发行版包含 asndt 命令行工具、核心库和编译器插件：

bin/
  asndt.sh    # Linux/macOS
  asndt.bat   # Windows
lib/
  core/       # SDK 核心 JAR
  plugins/    # 编译器插件 JAR

将 bin/ 目录添加到 PATH 环境变量中，即可在任意目录下调用 asndt 命令：

export PATH=/path/to/asn1-sdk-3.14.15/bin:$PATH   # Linux/macOS
:: Windows: 将 bin\ 目录添加到系统 PATH 中

2. 激活许可证

从免费试用页面申请评估许可证。获得许可证密钥后，通过交互式命令激活：

asndt license

选择激活许可证，选择目标编译器，然后粘贴密钥。许可证存储在您的用户配置文件中，适用于所有项目。

3. 创建项目

创建新的 ASN.1 项目骨架：

asndt create MyProject

这会创建：

MyProject/
  asn1.avn    # 项目配置
  src/        # 放置 ASN.1 源文件
  build/      # 生成输出

4. MyHTTP 示例

将以下 ASN.1 模块保存为 MyProject/src/MyHTTP.asn。此示例改编自 W3C HTTP-NG：

MyHTTP DEFINITIONS
AUTOMATIC TAGS ::=
BEGIN
   GetRequest ::= SEQUENCE {
      header-only   BOOLEAN,
      lock          BOOLEAN,
      accept-types  AcceptTypes,
      url           Url,
      ...,
      timestamp     GeneralizedTime
   }
   AcceptTypes ::= SET {
      standards   BIT STRING { html(0), plain-text(1), gif(2), jpeg(3) } (SIZE(4)) OPTIONAL,
      others      SEQUENCE OF VisibleString (SIZE(4)) OPTIONAL
   }
   Url ::= VisibleString (FROM("a".."z"|"A".."Z"|"0".."9"|"./-_~%#"))
   myRequest GetRequest ::= {
      header-only  TRUE,
      lock         FALSE,
      accept-types {
         standards { html, plain-text }
      },
      url          "www.asnlab.org",
      timestamp    "20121221121221Z"
   }
END

5. 配置和编译

编辑 MyProject/asn1.avn 以启用目标编译器。在下面选择目标编程语言查看配置语法和代码集成：

C 配置

在 asn1.avn 中添加 C 编译器配置块：

compilers {
    {
        id "asncc",
        language "c",
        options {
            output-folder "c",
            mapping {
                integer automatic,
                real automatic,
                size-of-int 4,
                size-of-long 8,
                size-of-xlong 8
            }
        }
    }
}

编译：

asndt compile MyProject

集成

生成的输出位于 MyProject/build/c/。将 .c 和 .h 文件包含在构建中，并链接 C 运行时库。生成的代码提供 encode_* 和 decode_* 函数，接受编码规则常量（BER、DER、UPER、APER、OER、XER、JER）。

C++ 配置

在 asn1.avn 中添加 C++ 编译器配置块：

compilers {
    {
        id "asncpp",
        language "c++",
        options {
            output-folder "c++",
            mapping {
                integer automatic,
                real automatic,
                choice union
            },
            cpp-standard cpp17,
            nullable-member shared-pointer
        }
    }
}

编译：

asndt compile MyProject

集成

生成的输出位于 MyProject/build/c++/。将 .cpp 和 .h 文件包含在构建中，并链接 C++ 运行时库。生成的类型提供 encode 和 decode 方法，接受编码规则常量。

Java 配置

在 asn1.avn 中添加 Java 编译器配置块：

compilers {
    {
        id "asnjc",
        language "java",
        options {
            output-folder "java",
            mapping {
                integer automatic,
                enumerated automatic,
                real double,
                list automatic
            },
            package-prefix "com.example"
        }
    }
}

编译：

asndt compile MyProject

集成

生成的输出位于 MyProject/build/java/，包名由模块名称派生。将 asnrt JAR 添加到类路径中。生成的类型提供 encode 和 decode 方法，接受 EncodingRules 常量。

C# 配置

在 asn1.avn 中添加 C# 编译器配置块：

compilers {
    {
        id "asncsc",
        language "c#",
        options {
            output-folder "c#",
            mapping {
                integer automatic,
                real double
            },
            namespace-prefix "MyCompany.Protocols"
        }
    }
}

编译：

asndt compile MyProject

集成

生成的输出位于 MyProject/build/c#/。在 .NET 项目中添加对 C# 运行时库的引用。生成的类型提供 Encode 和 Decode 方法，接受编码规则常量。

Go 配置

在 asn1.avn 中添加 Go 编译器配置块：

compilers {
    {
        id "asngc",
        language "go",
        options {
            output-folder "go",
            mapping {
                integer automatic-int64,
                real automatic
            }
        }
    }
}

编译：

asndt compile MyProject

集成

生成的输出位于 MyProject/build/go/。在模块中导入生成的 Go 包和 Go 运行时库。生成的类型提供 Encode 和 Decode 方法，接受编码规则常量。

需要帮助？

如果遇到任何问题，欢迎发送邮件至 sales@asnlab.org 联系我们的支持团队。