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