doc/news.rst

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