doc/news.rst

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