doc/news.rst

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