doc/news.rst

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