doc/news.rst

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