doc/news.rst

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