doc/news.rst

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