Pyasn1 - README

Python 的 ASN.1 库

这是一个免费开源的 ASN.1 类型和编解码器实现，作为 Python 包。最初是为了支持特定协议（SNMP）而编写的，后来进行了通用化，使其适用于基于 ASN.1 规范的各种协议。

注意： 该包现由 Christian Heimes 和 Simon Pichugin 在 https://github.com/pyasn1/pyasn1 项目中维护。

特性

ASN.1 类型（X.208）的通用实现
符合标准的 BER/CER/DER 编解码器
可以操作序列化数据的流
从 Python 类型导出/导入 ASN.1 结构
100% Python，兼容 Python 3.8+
线程安全
贡献的 ASN.1 编译器 Asn1ate

为什么使用 pyasn1

ASN.1 解决了数据序列化问题。这个解决方案是由智慧的古人很久以前设计的。那时，他们没有奢侈地浪费比特。因此，ASN.1 的设计旨在将具有无限复杂性的数据结构序列化成紧凑且高效的处理数据的东西。

这也许可以解释为什么许多网络协议和文件格式仍然依赖于这个 30 多年前的技术。包括许多重要的互联网协议和文件格式。

有相当多的书籍涵盖了 ASN.1 的主题。Olivier Dubuisson 的《异构系统间的通信》是互联网上免费提供的优质书籍之一。

pyasn1 包旨在帮助 Python 程序员在舒适的 Python 环境中处理网络协议和文件格式。该工具努力捕捉相当复杂的 ASN.1 系统的所有方面，并将其以 Python 的方式表示出来。

如何使用 pyasn1

使用 pyasn1，您可以从 ASN.1 数据结构构建 Python 对象。例如，以下 ASN.1 数据结构：

Record ::= SEQUENCE {
  id        INTEGER,
  room  [0] INTEGER OPTIONAL,
  house [1] INTEGER DEFAULT 0
}

可以用 pyasn1 这样表示：

class Record(Sequence):
    componentType = NamedTypes(
        NamedType('id', Integer()),
        OptionalNamedType(
            'room', Integer().subtype(
                implicitTag=Tag(tagClassContext, tagFormatSimple, 0)
            )
        ),
        DefaultedNamedType(
            'house', Integer(0).subtype(
                implicitTag=Tag(tagClassContext, tagFormatSimple, 1)
            )
        )
    )

ASN.1 的精神在于将抽象的数据描述转化为特定编程语言的形式。一旦您用 Python 表示了 ASN.1 数据结构，您就可以像使用类似的 Python 类型一样使用它（例如，ASN.1 SET 类似于 Python 的 dict，SET OF 类似于 list）：

>>> record = Record()
>>> record['id'] = 123
>>> record['room'] = 321
>>> str(record)
Record:
 id=123
 room=321
>>>

ASN.1 的部分威力来自于其序列化功能。您可以序列化您的数据结构并通过网络发送。

>>> from pyasn1.codec.der.encoder import encode
>>> substrate = encode(record)
>>> hexdump(substrate)
00000: 30 07 02 01 7B 80 02 01 41

反过来，您可以将从网络接收或从文件读取的序列化 ASN.1 内容转换为 Python 对象，然后可以对其进行内省、修改、编码并发送回去。

>>> from pyasn1.codec.der.decoder import decode
>>> received_record, rest_of_substrate = decode(substrate, asn1Spec=Record())
>>>
>>> for field in received_record:
>>>    print('{} is {}'.format(field, received_record[field]))
id is 123
room is 321
house is 0
>>>
>>> record == received_record
True
>>> received_record.update(room=123)
>>> substrate = encode(received_record)
>>> hexdump(substrate)
00000: 30 06 02 01 7B 80 01 7B

pyasn1 类努力模仿其 Python 原型（例如，int、list、dict 等）。但 ASN.1 类型表现出更复杂行为。为了让 Pythonista 更轻松，他们可以将 pyasn1 类转换为 Python 内置类型：

>>> from pyasn1.codec.native.encoder import encode
>>> encode(record)
{'id': 123, 'room': 321, 'house': 0}

反之亦然——您可以从 Python 对象树初始化 ASN.1 结构：

>>> from pyasn1.codec.native.decoder import decode
>>> record = decode({'id': 123, 'room': 321, 'house': 0}, asn1Spec=Record())
>>> str(record)
Record:
 id=123
 room=321
>>>

由于 ASN.1 的设计，序列化编解码器与数据对象是解耦的，因此您可以将每个 ASN.1 对象转换为多种不同的序列化形式。目前，pyasn1 支持 BER、DER、CER 和 Python 内置编解码器。极度紧凑的 PER 编码预计将在即将发布的 pyasn1 版本中引入。

有关 pyasn1 API 的更多信息，请参阅文档。不同协议和文件格式的编译 ASN.1 模块可以在 pyasn1-modules 仓库中找到。

如何获取 pyasn1

pyasn1 包根据 2 句柄 BSD 许可证的条款和条件分发。源代码可作为 GitHub 仓库免费获得。

您可以 `pip install pyasn1` 或从 PyPI 下载。

如果出现任何不符合预期的情况，请在 GitHub 上打开一个 issue，或将您的问题发布到 Stack Overflow，或尝试浏览 pyasn1 邮件列表存档。