doc/news.rst

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