CHANGELOG.md 15.4 KB
Newer Older
Karsten Loesing's avatar
Karsten Loesing committed
1
# Changes in version 2.13.0 - 2020-05-16
2
3

 * Medium changes
Karsten Loesing's avatar
Karsten Loesing committed
4
   - Parse OnionPerf analysis results format version 2.0.
5
6
   - Extend Torperf results to provide partial download times for 10,
     20, 50, 100, 200, and 500 KiB as well as 1, 2, and 5 MiB.
Karsten Loesing's avatar
Karsten Loesing committed
7

8
9
10
11
 * Minor changes
   - Include previously unknown error codes in Torperf results
     converted from OnionPerf analysis files.

Karsten Loesing's avatar
Karsten Loesing committed
12

Karsten Loesing's avatar
Karsten Loesing committed
13
14
15
16
17
# Changes in version 2.12.2 - 2020-04-30

 * Minor changes
   - Change the order of detecting descriptor types by content and/
     file name.
Karsten Loesing's avatar
Karsten Loesing committed
18
19


Karsten Loesing's avatar
Karsten Loesing committed
20
# Changes in version 2.12.1 - 2020-04-30
Karsten Loesing's avatar
Karsten Loesing committed
21

22
23
24
25
 * Minor changes
   - Change back how we treat xz-compressed files by leaving
     decompression to descriptor implementations.

Karsten Loesing's avatar
Karsten Loesing committed
26

Karsten Loesing's avatar
Karsten Loesing committed
27
# Changes in version 2.12.0 - 2020-04-30
Karsten Loesing's avatar
Karsten Loesing committed
28

29
30
31
32
 * Medium changes
   - Add parsing support for OnionPerf analysis files by converting
     and returning contained transfers as Torperf results.

Karsten Loesing's avatar
Karsten Loesing committed
33

Karsten Loesing's avatar
Karsten Loesing committed
34
# Changes in version 2.11.0 - 2020-04-13
Karsten Loesing's avatar
Karsten Loesing committed
35
36
37
38
39
40

 * Medium changes
   - Compute bandwidth file digests.
   - Parse bandwidth file header and bandwidth file digest in votes.
   - Parse bridge distribution requests in bridge server descriptors.
   - Parse authority fingerprint in bridge network statuses.
Karsten Loesing's avatar
Karsten Loesing committed
41

42
43
 * Minor changes
   - Avoid invoking overridable methods from constructors.
44
   - Make all descriptor instances serializable.
45
   - Simplify logging configuration.
46

Karsten Loesing's avatar
Karsten Loesing committed
47

Karsten Loesing's avatar
Karsten Loesing committed
48
# Changes in version 2.10.0 - 2020-01-15
49
50
51

 * Medium changes
   - Parse three newly added lines in snowflake statistics files.
Karsten Loesing's avatar
Karsten Loesing committed
52

53
54
55
 * Minor changes
   - Fix a NullPointerException when parsing an invalid crypto block
     starting with "-----END " rather than "-----BEGIN ".
56
57
   - Properly parse an authority's hostname from the "dir-source" line
     in a v2 network status.
58

Karsten Loesing's avatar
Karsten Loesing committed
59

60
61
62
63
# Changes in version 2.9.1 - 2019-11-09

 * Minor changes
   - Do not fail when processing index.json files with unknown fields.
Karsten Loesing's avatar
Karsten Loesing committed
64
65


Karsten Loesing's avatar
Karsten Loesing committed
66
# Changes in version 2.9.0 - 2019-11-01
Karsten Loesing's avatar
Karsten Loesing committed
67

68
69
70
 * Medium changes
   - Make NetworkStatusEntryImpl#parseSLine thread-safe.

Karsten Loesing's avatar
Karsten Loesing committed
71

Karsten Loesing's avatar
Karsten Loesing committed
72
# Changes in version 2.8.0 - 2019-10-18
73
74
75
76
77
78
79

 * Medium changes
   - Extend DescriptorReader#readDescriptors to support .gz-compressed
     files.
   - Add new BridgedbMetrics descriptor type.


Karsten Loesing's avatar
Karsten Loesing committed
80
# Changes in version 2.7.0 - 2019-09-06
81
82
83
84
85
86
87
88
89
90
91

 * Medium changes
   - Use Ivy for resolving external dependencies rather than relying
     on files found in Debian stable packages. Requires installing Ivy
     (using `apt-get install ivy`, `brew install ivy`, or similar) and
     running `ant resolve` (or `ant -lib /usr/share/java resolve`).
     Retrieved files are then copied to the `lib/` directory, except
     for dependencies on other metrics libraries that still need to be
     copied to the `lib/` directory manually. Current dependency
     versions resolved by Ivy are the same as in Debian stretch with
     few exceptions.
92
   - Remove Cobertura from the build process.
93
   - Add new SnowflakeStats descriptor type.
94
95


Karsten Loesing's avatar
Karsten Loesing committed
96
# Changes in version 2.6.2 - 2019-05-29
97
98
99
100
101

 * Medium changes
   - Recognize bandwidth files with @type annotation.


Karsten Loesing's avatar
Karsten Loesing committed
102
# Changes in version 2.6.1 - 2019-05-03
103
104
105
106
107

 * Medium changes
   - Fix a bug in recognizing descriptors as bandwidth files.


Karsten Loesing's avatar
Karsten Loesing committed
108
# Changes in version 2.6.0 - 2019-04-29
109
110

 * Medium changes
Karsten Loesing's avatar
Karsten Loesing committed
111
   - Stop signing jar files.
112
113
114
   - Add new BandwidthFile descriptor for parsed bandwidth files.


Karsten Loesing's avatar
Karsten Loesing committed
115
# Changes in version 2.5.0 - 2018-09-25
116
117
118
119
120
121
122

 * Medium changes
   - Go back to using Apache Commons Codec as base64 and hexadecimal
     codec rather than using JAXB which won't be available anymore
     after upgrading from Java 8 to 9. Applications must provide
     Apache Commons Codec 1.10 as dependency.

123
124
125
 * Minor changes
   - Make DescriptorCollector resume previously aborted downloads.

126

Karsten Loesing's avatar
Karsten Loesing committed
127
# Changes in version 2.4.0 - 2018-05-23
Karsten Loesing's avatar
Karsten Loesing committed
128
129
130
131
132
133
134

 * Medium changes
   - Replace Gson with Jackson. Applications must provide Jackson
     2.8.6 or compatible as dependency and do not need to provide Gson
     as dependency anymore.


Karsten Loesing's avatar
Karsten Loesing committed
135
# Changes in version 2.3.0 - 2018-04-18
136

137
138
139
140
 * Medium changes
   - Replace ServerDescriptor#getHiddenServiceDirVersions with
     ServerDescriptor#isHiddenServiceDir, because Tor has never
     supported versions in the hidden-service-dir descriptor line.
141
142
143
   - Add support for reading web server logs contained in tarballs by
     providing file names of both the tarball and of contained files
     to WebServerAccessLog.
144
145

 * Minor changes
146
147
   - Override logLines() method from LogDescriptor in
     WebServerAccessLog.
148
149
   - Use 1-minute connect and read timeouts for fetching CollecTor's
     index.json.
150
151


152
# Changes in version 2.2.0 - 2018-02-26
153
154
155
156
157

 * Major changes
   - Add new descriptor type WebServerAccessLog to parse web server
     access logs.

158
159
160
 * Minor changes
   - Add log message reporting progress reading tarballs.

161

Karsten Loesing's avatar
Karsten Loesing committed
162
# Changes in version 2.1.1 - 2017-10-09
163

Karsten Loesing's avatar
Karsten Loesing committed
164
 * Minor changes
165
166
167
168
   - Add new optional "build_revision" field to index.json with the
     Git revision supplied by the calling software.


Karsten Loesing's avatar
Karsten Loesing committed
169
# Changes in version 2.1.0 - 2017-09-15
170
171
172
173
174

 * Major changes
   - Update dependencies to versions available in Debian stretch:
     Apache Commons Compress 1.13, Apache Commons Lang 3.5, Google
     Gson 2.4, JUnit 4.12, Logback 1.1.9, SLF4J 1.7.22, and XZ 1.6.
Karsten Loesing's avatar
Karsten Loesing committed
175
   - Update to Java 8.
176

177
178
179
 * Minor changes
   - Retain trailing newline in Torperf results.

180

Karsten Loesing's avatar
Karsten Loesing committed
181
# Changes in version 2.0.0 - 2017-06-28
182

Karsten Loesing's avatar
Karsten Loesing committed
183
184
185
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
186
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
187
188
189
   - Remove previously non-deprecated but internally unused
     parseDescriptors(byte[], String)) method that returned a List and
     threw DescriptorParseException.
Karsten Loesing's avatar
Karsten Loesing committed
190

191
192
193
 * Minor changes
   - Replace custom ImplementationNotAccessibleException thrown by
     DescriptorSourceFactory with generic RuntimeException.
iwakeh's avatar
iwakeh committed
194
   - Rename jar files and release tarball to start with "metrics-lib".
195
196


Karsten Loesing's avatar
Karsten Loesing committed
197
# Changes in version 1.9.0 - 2017-06-21
198

199
200
201
202
203
204
205
206
207
208
209
210
 * Major changes
   - Simplify DescriptorReader by returning Descriptor instances
     rather than DescriptorFile instances containing Descriptors,
     deprecate DescriptorFile, and add a File reference to Descriptor.
   - Introduce a new UnparseableDescriptor to be returned by
     DescriptorParser and DescriptorReader if a descriptor cannot be
     parsed, as opposed to throwing a DescriptorParseException or
     skipping the entire descriptor file, respectively.

 * Medium changes
   - Let DescriptorParser return an Iterable instead of a List, which
     prepares parsing large descriptor files descriptor by descriptor.
211
212
213
   - Add new method to retrieve the raw descriptor length, rather than
     forcing applications to request (a copy of) raw descriptor bytes
     only to determine the raw descriptor length.
214

215
216
217
218
219
220
 * Minor changes
   - Fix a bug where NetworkStatusEntry's getMicrodescriptorDigests()
     and getMicrodescriptorDigestsSha256Base64() return hex strings
     rather than base64 strings.


221
222
223
224
225
226
# Changes in version 1.8.2 - 2017-06-16

 * Medium changes
   - Fix a regression where any DescriptorParseException thrown while
     parsing a descriptor is encapsulated and rethrown as
     RuntimeException.
Karsten Loesing's avatar
Karsten Loesing committed
227
228


Karsten Loesing's avatar
Karsten Loesing committed
229
230
231
232
233
# Changes in version 1.8.1 - 2017-06-08

 * Medium changes
   - Fix a regression in parsing microdescriptors and version 1
     directories introduced in 1.8.0.
Karsten Loesing's avatar
Karsten Loesing committed
234
235


Karsten Loesing's avatar
Karsten Loesing committed
236
# Changes in version 1.8.0 - 2017-06-07
237

238
239
240
241
242
 * Medium changes
   - Store raw descriptor contents as offset and length into a
     referenced byte[], rather than copying contents into a separate
     byte[] per descriptor.

243
244
245
246
 * Minor changes
   - Turn keyword strings into enums and use the appropriate enum sets
     and maps to avoid repeating string literals and to use more speedy
     collection types.
247
   - Simplify and avoid repetition in parse helper methods.
248
249
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
250
   - Move descriptor digest computation to DescriptorImpl.
251
252
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
253
254
255
256
   - Fix a bug where both RelayDirectoryImpl and all NetworkStatusImpl
     subclasses fail to get indexes right if parts of raw descriptor
     strings contain non-ASCII chars.  In practice, this only affects
     version 1 directories which were last archived in 2007.
257
258


Karsten Loesing's avatar
Karsten Loesing committed
259
# Changes in version 1.7.0 - 2017-05-17
260

Karsten Loesing's avatar
Karsten Loesing committed
261
 * Medium changes
262
263
   - Fix a bug where unrecognized lines in extra-info descriptors
     below crypto blocks were silently skipped.
264
   - Add support for six new key-value pairs added by OnionPerf.
265
266
   - Fix a bug where DescriptorIndexCollector would not delete
     extraneous local files if remote paths start with /.
267
   - Add previously missing method to obtain the digest of a vote.
Karsten Loesing's avatar
Karsten Loesing committed
268
   - Deprecate setFailUnrecognizedDescriptorLines() in
269
270
271
     DescriptorParser and DescriptorReader and refer to
     getUnrecognizedLines() in Descriptor if applications really need
     to fail descriptors containing unrecognized lines.
272
   - Parse "padding-counts" lines in extra-info descriptors.
273

274
275
276
 * Minor changes
   - Accept extra arguments in statistics-related extra-info
     descriptor lines, as permitted by dir-spec.txt.
277
   - Streamline digest method names.
278

279

Karsten Loesing's avatar
Karsten Loesing committed
280
# Changes in version 1.6.0 - 2017-02-17
281

282
283
284
285
 * Major changes
   - Deprecate DescriptorDownloader in favor of the much more widely
     used DescriptorCollector.

286
287
288
289
 * Medium changes
   - Add two methods for loading and saving a parse history file in
     the descriptor reader to avoid situations where applications fail
     after all descriptors are read but before they are all processed.
iwakeh's avatar
iwakeh committed
290
291
292
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
293
294
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
295
296
297
298
   - Turn the descriptor reader thread into a daemon thread, so that
     the application can decide at any time to stop consuming
     descriptors without having to worry about the reader thread not
     being done.
299
300
301
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
302
   - Parse "shared-rand-.*" lines in consensuses and votes.
303
304
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
305
306


Karsten Loesing's avatar
Karsten Loesing committed
307
# Changes in version 1.5.0 - 2016-10-19
308

309
310
311
312
313
314
 * Major changes
   - Make the DescriptorCollector implementation that uses CollecTor's
     index.json file to determine which descriptor files to fetch the
     new default.  Applications must provide gson-2.2.4.jar or higher
     as dependency.

315
316
317
318
 * Minor changes
   - Avoid running into an IOException and logging a warning for it.


Karsten Loesing's avatar
Karsten Loesing committed
319
# Changes in version 1.4.0 - 2016-08-31
320

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 * Major changes
   - Add the Simple Logging Facade for Java (slf4j) for logging
     support rather than printing warnings to stderr.  Applications
     must provide slf4j-api-1.7.7.jar or higher as dependency and can
     optionally provide a compatible logging framework of their choice
     (java.util.logging, logback, log4j).

 * Medium changes
   - Add an alpha version of a DescriptorCollector implementation that
     is not enabled by default and that uses CollecTor's index.json
     file to determine which descriptor files to fetch.  Applications
     can enable this implementation by providing gson-2.2.4.jar or
     higher as dependency and setting property descriptor.collector to
     org.torproject.descriptor.index.DescriptorIndexCollector.

336
 * Minor changes
337
338
   - Include resource files in src/*/resources/ in the release
     tarball.
339
   - Move executable, source, and javadoc jar to generated/dist/.
340
341


342
343
344
345
346
347
348
# Changes in version 1.3.1 - 2016-08-01

 * Medium changes
   - Adapt to CollecTor's new date format to make DescriptorCollector
     work again.


Karsten Loesing's avatar
Karsten Loesing committed
349
# Changes in version 1.3.0 - 2016-07-06
350
351
352

 * Medium changes
   - Parse "package" lines in consensuses and votes.
353
354
355
356
357
358
359
360
   - Support more than one "directory-signature" line in a vote, which
     may become relevant when authorities start signing votes using
     more than one algorithm.
   - Provide directory signatures in consensuses and votes in a list
     rather than a map to support multiple signatures made using the
     same identity key digest but different algorithms.
   - Be more lenient about digest lengths in directory signatures
     which may be longer or shorter than 20 bytes.
361
   - Parse "tunnelled-dir-server" lines in server descriptors.
362

363
364
365
366
 * Minor changes
   - Stop reporting "-----END .*-----" lines in v2 network statuses as
     unrecognized.

367

Karsten Loesing's avatar
Karsten Loesing committed
368
# Changes in version 1.2.0 - 2016-05-31
369
370
371
372

 * Medium changes
   - Include the hostname in directory source entries of consensuses
     and votes.
373
   - Also accept \r\n as newline in Torperf results files.
374
375
   - Make unrecognized keys of Torperf results available together with
     the corresponding values, rather than just the whole line.
376
377
   - In Torperf results, recognize all percentiles of expected bytes
     read for 0 <= x <= 100 rather than just x = { 10, 20, ..., 90 }.
378
379
   - Rename properties for overriding default descriptor source
     implementation classes.
380
   - Actually return the signing key digest in network status votes.
381
   - Parse crypto parts in network status votes.
382
383
   - Document all public parts in org.torproject.descriptor and add
     an Ant target to generate Javadocs.
384

385
386
387
 * Minor changes
   - Include a Torperf results line with more than one unrecognized
     key only once in the unrecognized lines.
388
389
   - Make "consensus-methods" line optional in network statuses votes,
     which would mean that only method 1 is supported.
390
391
   - Stop reporting "-----END .*-----" lines in directory key
     certificates as unrecognized.
Karsten Loesing's avatar
Karsten Loesing committed
392
   - Add code used for benchmarking.
393

394

Karsten Loesing's avatar
Karsten Loesing committed
395
# Changes in version 1.1.0 - 2015-12-28
396
397

 * Medium changes
398
399
400
401
402
403
   - Parse flag thresholds in bridge network statuses, and parse the
     "ignoring-advertised-bws" flag threshold in relay network status
     votes.
   - Support parsing of .xz-compressed tarballs using Apache Commons
     Compress and XZ for Java.  Applications only need to add XZ for
     Java as dependency if they want to parse .xz-compressed tarballs.
iwakeh's avatar
iwakeh committed
404
405
406
407
408
   - Introduce a new ExitList.Entry type for exit list entries instead
     of the ExitListEntry type which is now deprecated.  The main
     difference between the two is that ExitList.Entry can hold more
     than one exit address and scan time which were previously parsed
     as multiple ExitListEntry instances.
409
410
411
412
413
414
   - Introduce four new types to distinguish between relay and bridge
     descriptors: RelayServerDescriptor, RelayExtraInfoDescriptor,
     BridgeServerDescriptor, and BridgeExtraInfoDescriptor.  The
     existing types, ServerDescriptor and ExtraInfoDescriptor, are
     still usable and will not be deprecated, because applications may
     not care whether a relay or a bridge published a descriptor.
415
416
417
418
419
   - Support Ed25519 certificates, Ed25519 master keys, SHA-256
     digests, and Ed25519 signatures thereof in server descriptors and
     extra-info descriptors, and support Ed25519 master keys in votes.
   - Include RSA-1024 signatures of SHA-1 digests of extra-info
     descriptors, which were parsed and discarded before.
420
   - Support hidden-service statistics in extra-info descriptors.
421
422
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
423

424
425
426
427
 * Minor changes
   - Start using Java 7 features like the diamond operator and switch
     on String, and use StringBuilder correctly in many places.

428

Karsten Loesing's avatar
Karsten Loesing committed
429
# Changes in version 1.0.0 - 2015-12-05
Karsten Loesing's avatar
Karsten Loesing committed
430
431

 * Major changes
432
433
   - This is the initial release after four years of development.
     Happy 4th birthday!
Karsten Loesing's avatar
Karsten Loesing committed
434