doc/news.rst

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