doc/news.rst

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