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