CHANGELOG.md 15.3 KB
Newer Older
1
2
3
4
5
# Changes in version 2.13.0 - 2020-??-??

 * Medium changes
   - 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
6

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

Karsten Loesing's avatar
Karsten Loesing committed
11

Karsten Loesing's avatar
Karsten Loesing committed
12
13
14
15
16
# 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
17
18


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

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

Karsten Loesing's avatar
Karsten Loesing committed
25

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

28
29
30
31
 * 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
32

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

 * 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
40

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

Karsten Loesing's avatar
Karsten Loesing committed
46

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

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

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

Karsten Loesing's avatar
Karsten Loesing committed
58

59
60
61
62
# 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
63
64


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

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

Karsten Loesing's avatar
Karsten Loesing committed
70

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

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


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

 * 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.
91
   - Remove Cobertura from the build process.
92
   - Add new SnowflakeStats descriptor type.
93
94


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

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


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

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


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

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


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

 * 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.

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

125

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

 * 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
134
# Changes in version 2.3.0 - 2018-04-18
135

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

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


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

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

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

160

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

Karsten Loesing's avatar
Karsten Loesing committed
163
 * Minor changes
164
165
166
167
   - 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
168
# Changes in version 2.1.0 - 2017-09-15
169
170
171
172
173

 * 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
174
   - Update to Java 8.
175

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

179

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

Karsten Loesing's avatar
Karsten Loesing committed
182
183
184
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
185
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
186
187
188
   - 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
189

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


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

198
199
200
201
202
203
204
205
206
207
208
209
 * 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.
210
211
212
   - 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.
213

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


220
221
222
223
224
225
# 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
226
227


Karsten Loesing's avatar
Karsten Loesing committed
228
229
230
231
232
# 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
233
234


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

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

242
243
244
245
 * 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.
246
   - Simplify and avoid repetition in parse helper methods.
247
248
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
249
   - Move descriptor digest computation to DescriptorImpl.
250
251
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
252
253
254
255
   - 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.
256
257


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

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

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

278

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

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

285
286
287
288
 * 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
289
290
291
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
292
293
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
294
295
296
297
   - 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.
298
299
300
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
301
   - Parse "shared-rand-.*" lines in consensuses and votes.
302
303
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
304
305


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

308
309
310
311
312
313
 * 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.

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


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

320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 * 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.

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


341
342
343
344
345
346
347
# 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
348
# Changes in version 1.3.0 - 2016-07-06
349
350
351

 * Medium changes
   - Parse "package" lines in consensuses and votes.
352
353
354
355
356
357
358
359
   - 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.
360
   - Parse "tunnelled-dir-server" lines in server descriptors.
361

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

366

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

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

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

393

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

 * Medium changes
397
398
399
400
401
402
   - 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
403
404
405
406
407
   - 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.
408
409
410
411
412
413
   - 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.
414
415
416
417
418
   - 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.
419
   - Support hidden-service statistics in extra-info descriptors.
420
421
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
422

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

427

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

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