doc/news.rst

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