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