doc/news.rst

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