doc/news.rst

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