doc/news.rst

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