doc/news.rst

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