doc/news.rst

   1 News
   2 ====
   3
   4 .. _release4.6:
   5
   6 4.6
   7 ---
   8 * Added `COMPLI <https://github.com/YuryStrozhevsky/asn1-test-suite>`__
   9   ASN.1:2008 test suite. PyDERASN passes it (except for REAL values),
  10   but it is more strict sometimes and aimed to be compliant with X.690-201508
  11
  12 .. _release4.5:
  13
  14 4.5
  15 ---
  16 * ``ctx`` parameter can be safely used in .decode() and won't be muted
  17 * PP nametuple contains reference to the ASN1Obj itself
  18 * ``colonize_hex`` function useful for pretty printing
  19 * Integer values are also pretty printed in hexadecimal form
  20
  21 .. _release4.4:
  22
  23 4.4
  24 ---
  25 * All errors are inherited from ASN1Error class
  26 * NumericString/PrintableString has ``allowable_chars`` property holding
  27   all allowed characters
  28
  29 .. _release4.3:
  30
  31 4.3
  32 ---
  33 * Fix NumericString: space is allowed character
  34 * Strict PrintableString sanitizing
  35
  36 .. _release4.2:
  37
  38 4.2
  39 ---
  40 * Removed ``lenindef``, ``ber_encoded`` attributes from the Choice --
  41   they must be taken from underlying value, as Choice does not have its
  42   own encoding
  43 * Do not yield extra EOC PP for Any, having indefinite length encoding
  44   and containing autodecoded DEFINED BY value
  45
  46 .. _release4.1:
  47
  48 4.1
  49 ---
  50 * ``bered`` attribute, meaning if object has BER-specific encoding, is
  51   renamed to ``ber_encoded``
  52 * ``bered`` attribute is replace with property showing if any of
  53   underlying values are BER-encoded. If value has length indefinite
  54   encoded explicit tag, value, if value contains BER-related encoding,
  55   or if it contains other objects that are ``bered``, then it is ``bered``
  56
  57 .. _release4.0:
  58
  59 4.0
  60 ---
  61 * Default value is checked also for Sets, not for Sequences only
  62 * **Incompatible** change: defaulted values in Sequence/Set are always
  63   strictly checked, unless ``allow_default_values`` context option is
  64   set. ``strict_default_existence`` option disappeared
  65 * Strict Set/Set Of's values ordering check
  66
  67 .. _release3.14:
  68
  69 3.14
  70 ----
  71 * Additional encoding validness check: explicit tag must contain exactly
  72   one object inside. Throw DecodeError otherwise
  73 * ``allow_expl_oob`` context and command-line options allow skipping of
  74   that check
  75
  76 .. _release3.13:
  77
  78 3.13
  79 ----
  80 * DecodeError's decode paths are separated with ``:``, instead of ``.``,
  81   because of colliding with dots in OIDs
  82 * Ability to print element decode paths with ``--print-decode-path``
  83   command line option (and corresponding keyword argument)
  84 * Ability to print tree's branch specified with ``--decode-path-only``
  85
  86 .. _release3.12:
  87
  88 3.12
  89 ----
  90 * Fix possible uncaught TypeError in Py2 with zero bytes inside the value
  91 * Fix SequenceOf/SetOf raising BoundsError instead of DecodeError
  92
  93 .. _release3.11:
  94
  95 3.11
  96 ----
  97 * Fix uncaught UTCTime/GeneralizedTime decode error when dealing with
  98   non ASCII-encoded values
  99
 100 .. _release3.10:
 101
 102 3.10
 103 ----
 104 * Fix long-standing bug with explicitly tagged objects inside the
 105   Choice. If Choice had explicitly tagged value, then its ``.tlvlen``
 106   reports the size without taking value's explicit tag in advance
 107 * Add ``.fulllen`` and ``.fulloffset`` properties for all objects
 108
 109 .. _release3.9:
 110
 111 3.9
 112 ---
 113 * SEQUENCE's values are printed with field's name. Previously there was
 114   the following output::
 115
 116     AlgorithmIdentifier SEQUENCE[OBJECT IDENTIFIER 1.3.14.3.2.26, [UNIV 5] ANY 0500 OPTIONAL]
 117
 118   now it is::
 119
 120     AlgorithmIdentifier SEQUENCE[algorithm: OBJECT IDENTIFIER 1.3.14.3.2.26; parameters: [UNIV 5] ANY 0500 OPTIONAL]
 121 * Fixed EOC (Unicode character) repr printing issues under Python2
 122
 123 .. _release3.8:
 124
 125 3.8
 126 ---
 127 BER's EOC is explicitly shown during pprinting. Following notation::
 128
 129       15-2 [0,0,1576]-4  . content: [0] EXPLICIT [UNIV 16] ANY
 130
 131 is replaced with::
 132
 133       15-2∞ [0,0,1576]∞  . content: [0] EXPLICIT [UNIV 16] ANY
 134     [...]
 135     1587    [1,1,   0]   . content:  BER EOC
 136     1589    [1,1,   0]   . content: EXPLICIT BER EOC
 137
 138 .. _release3.7:
 139
 140 3.7
 141 ---
 142 * BER decoding support
 143 * BitString's ''H notation support
 144 * ``termcolor`` package is included in the tarball
 145
 146 .. _release3.6:
 147
 148 3.6
 149 ---
 150 * Ability to set values during Sequence initialization
 151
 152 .. _release3.5:
 153
 154 3.5
 155 ---
 156 * Fix TagMismatch exception completeness during Choice and Set decoding.
 157   Previously we will loose offset and decode_path information about
 158   concrete TagMismatched entity
 159
 160 .. _release3.4:
 161
 162 3.4
 163 ---
 164 * Strict NumericString's value sanitation
 165 * Invalid encoding in string types will raise ``DecodeError`` exception,
 166   instead of ``Unicode*Error``
 167 * Fixed DecodePathDefBy workability with Python 2.x
 168
 169 .. _release3.3:
 170
 171 3.3
 172 ---
 173 * Fix nasty BitString decoding bug: it could fail when data follows
 174   encoded BitString value. There weren't any problems when BitString is
 175   at the end of Sequence
 176
 177 .. _release3.2:
 178
 179 3.2
 180 ---
 181 * Slightly corrected colours, now visible on white background
 182
 183 .. _release3.1:
 184
 185 3.1
 186 ---
 187 * Fix bug related to DecodeError showing with DecodePathDefBy entities
 188 * Respect ``NO_COLOR`` environment variable
 189
 190 .. _release3.0:
 191
 192 3.0
 193 ---
 194 * :py:func:`pyderasn.decode_path_defby` is replaced with
 195   :py:class:`pyderasn.DecodePathDefBy`
 196 * Ability to turn colourized terminal output by calling
 197   ``pprint(..., with_colours=True)``. You will need
 198   `termcolor package <https://pypi.org/project/termcolor/>`__
 199
 200 .. _release2.1:
 201
 202 2.1
 203 ---
 204 * Fixed invalid offset calculation when dealing with DEFINED BY objects
 205   having explicit tags
 206
 207 .. _release2.0:
 208
 209 2.0
 210 ---
 211 * BIT STRINGs can also be :ref:`DEFINED BY <definedby>`
 212 * Decoding process can be governed with optional :ref:`ctx <ctx>`
 213   keyword argument to ``decode()`` method
 214 * :ref:`defines_by_path <defines_by_path_ctx>` option is now
 215   :ref:`decode context <ctx>` option, not a keyword argument
 216 * Ability to do ``strict validation``
 217   of defaulted values met in sequence, raising an exception
 218
 219 .. _release1.6:
 220
 221 1.6
 222 ---
 223 Ability to skip specified number of bytes (``--skip``) in command line
 224 utility.
 225
 226 .. _release1.5:
 227
 228 1.5
 229 ---
 230 * Generic decoder's scheme and pretty printer
 231   (:py:func:`pyderasn.generic_decoder`) can be used in libraries
 232 * Ability to specify :ref:`defines_by_path <defines_by_path_ctx>`
 233   during command line invocation
 234
 235 .. _release1.4:
 236
 237 1.4
 238 ---
 239 Ability to automatically decode :ref:`DEFINED BY <definedby>` fields
 240 inside SEQUENCEs.
 241
 242 .. _release1.3:
 243
 244 1.3
 245 ---
 246 Removed ``__lt__``/``__eq__`` from base class, as pylint likes it.
 247
 248 .. _release1.2:
 249
 250 1.2
 251 ---
 252 Full rich comparison operators added.
 253
 254
 255 .. _release1.1:
 256
 257 1.1
 258 ---
 259 Trivial README addition.
 260
 261 .. _release1.0:
 262
 263 1.0
 264 ---
 265 Initial release.