doc/news.rst

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