]> Cypherpunks.ru repositories - pyderasn.git/blobdiff - doc/features.rst
Raise copyright years
[pyderasn.git] / doc / features.rst
index c83b64c22da7539583eceb1f38db13db6a8ebc46..5cfabee47b787f79e0072d6c33ee7fffa6dc13cf 100644 (file)
@@ -3,15 +3,17 @@
 Features
 ========
 
-* BER/CER/DER decoding, DER encoding
+* BER/CER/DER decoding, strict DER validation, DER/CER encoding
 * Basic ASN.1 data types (X.208): BOOLEAN, INTEGER, BIT STRING, OCTET
   STRING, NULL, OBJECT IDENTIFIER, ENUMERATED, all strings, UTCTime,
   GeneralizedTime, CHOICE, ANY, SEQUENCE (OF), SET (OF)
 * Size :ref:`constraints <bounds>` checking
 * Working with sequences as high level data objects with ability to
   (un)marshall them
-* Python 2.7/3.5/3.6 compatibility
+* Python 3.5+ compatibility (2.7 dropped in version 9.0)
 * Aimed to be complaint with `X.690-201508 <https://www.itu.int/rec/T-REC-X.690-201508-I/en>`__
+* Streaming decoding and encoding capabilities, allowing working with
+  very small memory footprint
 
 Why yet another library? `pyasn1 <http://snmplabs.com/pyasn1/>`__
 had all of this a long time ago. PyDERASN resembles it in many ways. In
@@ -20,7 +22,6 @@ practice it should be relatively easy to convert ``pyasn1``'s code to
 Also there is `asn1crypto <https://github.com/wbond/asn1crypto>`__.
 
 * Small, simple and trying to be reviewable code. Just a single file
-  with `six <https://pypi.org/project/six/>`__ dependency
 * Ability to know :ref:`exact decoded <decoding>` objects offsets and
   lengths inside the binary
 * Automatic decoding of :ref:`DEFINED BY <definedby>` fields
@@ -36,6 +37,15 @@ Also there is `asn1crypto <https://github.com/wbond/asn1crypto>`__.
   structures allow BER encoding for the whole message, except for
   ``SignedAttributes`` -- you can easily verify your CMS satisfies that
   requirement
+* Ability to use mmap-ed files, memoryviews, iterators, 2-pass DER
+  encoding mode and CER encoder dealing with the writer, giving ability
+  to create huge ASN.1 encoded files with very little memory footprint
+* Ability to decode files in event generation mode, without the need to
+  keep all the data and decoded structures (that takes huge quantity of
+  memory in all known ASN.1 libraries) in the memory
+* ``__slots__``, ``copy.copy()`` friendliness
+* Workability with ``pickle``
+* `Cython <https://cython.org/>`__ compatibility
 * Extensive and comprehensive
   `hypothesis <https://hypothesis.readthedocs.io/en/master/>`__
   driven tests coverage. It also has been fuzzed with
@@ -49,17 +59,20 @@ Also there is `asn1crypto <https://github.com/wbond/asn1crypto>`__.
   automatically set required tags)
 * Descriptive errors, like ``pyderasn.DecodeError: UTCTime
   (tbsCertificate:validity:notAfter:utcTime) (at 328) invalid UTCTime format``
-* ``__slots__``, ``copy.copy()`` friendliness
-* Workability with ``pickle``
-* `Cython <https://cython.org/>`__ compatibility
 * Could be significantly :ref:`faster <performance>` and have lower memory usage
 * :ref:`Pretty printer <pprinting>` and
   :ref:`command-line decoder <cmdline>`, that could
   conveniently replace utilities like either ``dumpasn1`` or
   ``openssl asn1parse``
 
-  .. figure:: pprinting.png
+  .. figure:: pprinting.webp
      :alt: Pretty printing example output
 
      An example of pretty printed X.509 certificate with automatically
      parsed DEFINED BY fields.
+* :ref:`ASN.1 browser <browser>`
+
+  .. figure:: browser.webp
+     :alt: ASN.1 browser example
+
+     An example of browser running.