doc/news.rst

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