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