]> Cypherpunks.ru repositories - pyderasn.git/blobdiff - doc/news.rst
mmap-ed memoryview support
[pyderasn.git] / doc / news.rst
index 24977ab78c9961b0010665c274c8b13069fb3432..7e110786a3ff064d001a0a00c2e920f34558c833 100644 (file)
@@ -1,6 +1,228 @@
 News
 ====
 
+.. _release7.0:
+
+7.0
+---
+* Fixed invalid behaviour where SET OF allowed multiple objects with the
+  same tag to be successfully decoded
+* Fixed possibly invalid SET DER encoding where objects were not sorted
+  by tag, but by encoded representation
+* ``Any`` does not allow empty data value now. Now it checks if it has
+  valid ASN.1 tag
+* ``Any`` allows an ordinary ``Obj`` storing, without its forceful
+  encoded representation storage
+* Initial support for so called ``evgen_mode``: event generation mode,
+  where no in-memory objects storing happens, giving ability to process
+  ASN.1 data without fully parsing it first
+* Initial experimental CER encoding mode, allowing streaming encoding of
+  the data directly to some writeable object
+* Ability to use mmap-ed memoryviews to skip files loading to memory
+
+.. _release6.3:
+
+6.3
+---
+* Fixed workability under Python 3.5. Previously only 2.7 and 3.6
+  versions were tested
+
+.. _release6.2:
+
+6.2
+---
+* Python ``int()``'s accepts even more various non-decimal characters
+  than expected. Make validation fully strict in UTCTime and
+  GeneralizedTime, without relying on ``int()``
+
+.. _release6.1:
+
+6.1
+---
+* UTCTime and GeneralizedTime allowed values to have plus sign in them,
+  passing int() check successfully. Prohibit that incorrect behaviour
+* UTCTime and GeneralizedTime BER decoding support
+* Faster UTCTime and GeneralizedTime decoding, and slightly better
+  overall performance
+* Workability under Cython
+* Explicitly Check that all ObjectIdentifier arcs are non-negative
+
+.. _release6.0:
+
+6.0
+---
+* ``.copy()`` method removed: ``copy.copy()`` is preferred way to copy
+  objects now
+* Copies made previously with ``.copy()`` lacked ``.defined`` field,
+  now they are not
+* All objects are friendly to ``pickle`` libraries
+* PrintableString has ``allow_asterisk`` and ``allow_ampersand``
+  properties
+* ``.hexencode()``, ``.hexdecode()`` and ``.hexdecod()`` methods
+  appeared, working with hexadecimal encoded data
+
+.. _release5.6:
+
+5.6
+---
+* Convenient ``.decod()`` method, that raises if tail is not empty
+* Control characters (like newlines) of text fields in pprinted output
+  are escaped
+* Ability to allow asterisk and ampersand characters
+  (``allow_asterisk``, ``allow_ampersand`` kwargs) in PrintableString,
+  that unfortunately could be met in X.509 certificates
+
+.. _release5.5:
+
+5.5
+---
+* PEP-396 compatible module's ``__version__``
+
+.. _release5.4:
+
+5.4
+---
+* Do not shadow underlying DecodeError during decoding of optional
+  sequence's field
+
+.. _release5.3:
+
+5.3
+---
+* Forbid any later GNU GPL version autousage (project's licence now is
+  GNU LGPLv3 only)
+* Fix ``defines_by_path`` context option usage example
+
+.. _release5.2:
+
+5.2
+---
+* Fix fallbacked ``colored()`` function workability,
+  if no ``termcolor`` is installed
+
+.. _release5.1:
+
+5.1
+---
+* Fix empty ``--oids`` workability
+
+.. _release5.0:
+
+5.0
+---
+* Ability to specify multiple OID mappings for pprinted output
+  (``oids`` keyword argument is renamed to ``oid_maps``)
+
+.. _release4.9:
+
+4.9
+---
+* Minor decode speed improvements
+* Much faster UTCTime/GeneralizedTime decoders
+* Stricter UTCTime/GeneralizedTime DER encoding check: trailing zeroes
+  are forbidden
+* Valid DER encoding of GeneralizedTime with microseconds: no trailing
+  zeroes appended
+
+.. _release4.7:
+
+4.7
+---
+* ObjectIdentifier has ``ber_encoded`` set to True, if non-normalized
+  arc encoding is met
+* Preserve BER-related attributes during ``copy()``
+
+.. _release4.6:
+
+4.6
+---
+* Added `COMPLI <https://github.com/YuryStrozhevsky/asn1-test-suite>`__
+  ASN.1:2008 test suite. PyDERASN passes it (except for REAL values),
+  but it is more strict sometimes and aimed to be compliant with X.690-201508
+* Check for arc values normalization in ObjectIdentifier.
+  Forbid non-normalized in DER encoding
+
+.. _release4.5:
+
+4.5
+---
+* ``ctx`` parameter can be safely used in .decode() and won't be muted
+* PP nametuple contains reference to the ASN1Obj itself
+* ``colonize_hex`` function useful for pretty printing
+* Integer values are also pretty printed in hexadecimal form
+
+.. _release4.4:
+
+4.4
+---
+* All errors are inherited from ASN1Error class
+* NumericString/PrintableString has ``allowable_chars`` property holding
+  all allowed characters
+
+.. _release4.3:
+
+4.3
+---
+* Fix NumericString: space is allowed character
+* Strict PrintableString sanitizing
+
+.. _release4.2:
+
+4.2
+---
+* Removed ``lenindef``, ``ber_encoded`` attributes from the Choice --
+  they must be taken from underlying value, as Choice does not have its
+  own encoding
+* Do not yield extra EOC PP for Any, having indefinite length encoding
+  and containing autodecoded DEFINED BY value
+
+.. _release4.1:
+
+4.1
+---
+* ``bered`` attribute, meaning if object has BER-specific encoding, is
+  renamed to ``ber_encoded``
+* ``bered`` attribute is replace with property showing if any of
+  underlying values are BER-encoded. If value has length indefinite
+  encoded explicit tag, value, if value contains BER-related encoding,
+  or if it contains other objects that are ``bered``, then it is ``bered``
+
+.. _release4.0:
+
+4.0
+---
+* Default value is checked also for Sets, not for Sequences only
+* **Incompatible** change: defaulted values in Sequence/Set are always
+  strictly checked, unless ``allow_default_values`` context option is
+  set. ``strict_default_existence`` option disappeared
+* Strict Set/Set Of's values ordering check
+
+.. _release3.14:
+
+3.14
+----
+* Additional encoding validness check: explicit tag must contain exactly
+  one object inside. Throw DecodeError otherwise
+* ``allow_expl_oob`` context and command-line options allow skipping of
+  that check
+
+.. _release3.13:
+
+3.13
+----
+* DecodeError's decode paths are separated with ``:``, instead of ``.``,
+  because of colliding with dots in OIDs
+* Ability to print element decode paths with ``--print-decode-path``
+  command line option (and corresponding keyword argument)
+* Ability to print tree's branch specified with ``--decode-path-only``
+
+.. _release3.12:
+
+3.12
+----
+* Fix possible uncaught TypeError in Py2 with zero bytes inside the value
+* Fix SequenceOf/SetOf raising BoundsError instead of DecodeError
+
 .. _release3.11:
 
 3.11
@@ -124,7 +346,7 @@ is replaced with::
   keyword argument to ``decode()`` method
 * :ref:`defines_by_path <defines_by_path_ctx>` option is now
   :ref:`decode context <ctx>` option, not a keyword argument
-* Ability to do :ref:`strict validation <strict_default_existence_ctx>`
+* Ability to do ``strict validation``
   of defaulted values met in sequence, raising an exception
 
 .. _release1.6:
@@ -138,7 +360,7 @@ utility.
 
 1.5
 ---
-* Generic decoder's scheme and pretty printer
+* Generic decoder's schema and pretty printer
   (:py:func:`pyderasn.generic_decoder`) can be used in libraries
 * Ability to specify :ref:`defines_by_path <defines_by_path_ctx>`
   during command line invocation