CHANGELOG.md 14.6 KB
Newer Older
Karsten Loesing's avatar
Karsten Loesing committed
1
2
3
# Changes in version 2.??.? - 2020-??-??


Karsten Loesing's avatar
Karsten Loesing committed
4
# Changes in version 2.11.0 - 2020-04-13
Karsten Loesing's avatar
Karsten Loesing committed
5
6
7
8
9
10

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

12
13
 * Minor changes
   - Avoid invoking overridable methods from constructors.
14
   - Make all descriptor instances serializable.
15
   - Simplify logging configuration.
16

Karsten Loesing's avatar
Karsten Loesing committed
17

Karsten Loesing's avatar
Karsten Loesing committed
18
# Changes in version 2.10.0 - 2020-01-15
19
20
21

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

23
24
25
 * Minor changes
   - Fix a NullPointerException when parsing an invalid crypto block
     starting with "-----END " rather than "-----BEGIN ".
26
27
   - Properly parse an authority's hostname from the "dir-source" line
     in a v2 network status.
28

Karsten Loesing's avatar
Karsten Loesing committed
29

30
31
32
33
# 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
34
35


Karsten Loesing's avatar
Karsten Loesing committed
36
# Changes in version 2.9.0 - 2019-11-01
Karsten Loesing's avatar
Karsten Loesing committed
37

38
39
40
 * Medium changes
   - Make NetworkStatusEntryImpl#parseSLine thread-safe.

Karsten Loesing's avatar
Karsten Loesing committed
41

Karsten Loesing's avatar
Karsten Loesing committed
42
# Changes in version 2.8.0 - 2019-10-18
43
44
45
46
47
48
49

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


Karsten Loesing's avatar
Karsten Loesing committed
50
# Changes in version 2.7.0 - 2019-09-06
51
52
53
54
55
56
57
58
59
60
61

 * 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.
62
   - Remove Cobertura from the build process.
63
   - Add new SnowflakeStats descriptor type.
64
65


Karsten Loesing's avatar
Karsten Loesing committed
66
# Changes in version 2.6.2 - 2019-05-29
67
68
69
70
71

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


Karsten Loesing's avatar
Karsten Loesing committed
72
# Changes in version 2.6.1 - 2019-05-03
73
74
75
76
77

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


Karsten Loesing's avatar
Karsten Loesing committed
78
# Changes in version 2.6.0 - 2019-04-29
79
80

 * Medium changes
Karsten Loesing's avatar
Karsten Loesing committed
81
   - Stop signing jar files.
82
83
84
   - Add new BandwidthFile descriptor for parsed bandwidth files.


Karsten Loesing's avatar
Karsten Loesing committed
85
# Changes in version 2.5.0 - 2018-09-25
86
87
88
89
90
91
92

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

93
94
95
 * Minor changes
   - Make DescriptorCollector resume previously aborted downloads.

96

Karsten Loesing's avatar
Karsten Loesing committed
97
# Changes in version 2.4.0 - 2018-05-23
Karsten Loesing's avatar
Karsten Loesing committed
98
99
100
101
102
103
104

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

107
108
109
110
 * Medium changes
   - Replace ServerDescriptor#getHiddenServiceDirVersions with
     ServerDescriptor#isHiddenServiceDir, because Tor has never
     supported versions in the hidden-service-dir descriptor line.
111
112
113
   - Add support for reading web server logs contained in tarballs by
     providing file names of both the tarball and of contained files
     to WebServerAccessLog.
114
115

 * Minor changes
116
117
   - Override logLines() method from LogDescriptor in
     WebServerAccessLog.
118
119
   - Use 1-minute connect and read timeouts for fetching CollecTor's
     index.json.
120
121


122
# Changes in version 2.2.0 - 2018-02-26
123
124
125
126
127

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

128
129
130
 * Minor changes
   - Add log message reporting progress reading tarballs.

131

Karsten Loesing's avatar
Karsten Loesing committed
132
# Changes in version 2.1.1 - 2017-10-09
133

Karsten Loesing's avatar
Karsten Loesing committed
134
 * Minor changes
135
136
137
138
   - 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
139
# Changes in version 2.1.0 - 2017-09-15
140
141
142
143
144

 * 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
145
   - Update to Java 8.
146

147
148
149
 * Minor changes
   - Retain trailing newline in Torperf results.

150

Karsten Loesing's avatar
Karsten Loesing committed
151
# Changes in version 2.0.0 - 2017-06-28
152

Karsten Loesing's avatar
Karsten Loesing committed
153
154
155
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
156
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
157
158
159
   - 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
160

161
162
163
 * Minor changes
   - Replace custom ImplementationNotAccessibleException thrown by
     DescriptorSourceFactory with generic RuntimeException.
iwakeh's avatar
iwakeh committed
164
   - Rename jar files and release tarball to start with "metrics-lib".
165
166


Karsten Loesing's avatar
Karsten Loesing committed
167
# Changes in version 1.9.0 - 2017-06-21
168

169
170
171
172
173
174
175
176
177
178
179
180
 * 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.
181
182
183
   - 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.
184

185
186
187
188
189
190
 * Minor changes
   - Fix a bug where NetworkStatusEntry's getMicrodescriptorDigests()
     and getMicrodescriptorDigestsSha256Base64() return hex strings
     rather than base64 strings.


191
192
193
194
195
196
# 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
197
198


Karsten Loesing's avatar
Karsten Loesing committed
199
200
201
202
203
# 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
204
205


Karsten Loesing's avatar
Karsten Loesing committed
206
# Changes in version 1.8.0 - 2017-06-07
207

208
209
210
211
212
 * Medium changes
   - Store raw descriptor contents as offset and length into a
     referenced byte[], rather than copying contents into a separate
     byte[] per descriptor.

213
214
215
216
 * 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.
217
   - Simplify and avoid repetition in parse helper methods.
218
219
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
220
   - Move descriptor digest computation to DescriptorImpl.
221
222
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
223
224
225
226
   - 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.
227
228


Karsten Loesing's avatar
Karsten Loesing committed
229
# Changes in version 1.7.0 - 2017-05-17
230

Karsten Loesing's avatar
Karsten Loesing committed
231
 * Medium changes
232
233
   - Fix a bug where unrecognized lines in extra-info descriptors
     below crypto blocks were silently skipped.
234
   - Add support for six new key-value pairs added by OnionPerf.
235
236
   - Fix a bug where DescriptorIndexCollector would not delete
     extraneous local files if remote paths start with /.
237
   - Add previously missing method to obtain the digest of a vote.
Karsten Loesing's avatar
Karsten Loesing committed
238
   - Deprecate setFailUnrecognizedDescriptorLines() in
239
240
241
     DescriptorParser and DescriptorReader and refer to
     getUnrecognizedLines() in Descriptor if applications really need
     to fail descriptors containing unrecognized lines.
242
   - Parse "padding-counts" lines in extra-info descriptors.
243

244
245
246
 * Minor changes
   - Accept extra arguments in statistics-related extra-info
     descriptor lines, as permitted by dir-spec.txt.
247
   - Streamline digest method names.
248

249

Karsten Loesing's avatar
Karsten Loesing committed
250
# Changes in version 1.6.0 - 2017-02-17
251

252
253
254
255
 * Major changes
   - Deprecate DescriptorDownloader in favor of the much more widely
     used DescriptorCollector.

256
257
258
259
 * 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
260
261
262
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
263
264
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
265
266
267
268
   - 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.
269
270
271
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
272
   - Parse "shared-rand-.*" lines in consensuses and votes.
273
274
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
275
276


Karsten Loesing's avatar
Karsten Loesing committed
277
# Changes in version 1.5.0 - 2016-10-19
278

279
280
281
282
283
284
 * 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.

285
286
287
288
 * Minor changes
   - Avoid running into an IOException and logging a warning for it.


Karsten Loesing's avatar
Karsten Loesing committed
289
# Changes in version 1.4.0 - 2016-08-31
290

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 * 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.

306
 * Minor changes
307
308
   - Include resource files in src/*/resources/ in the release
     tarball.
309
   - Move executable, source, and javadoc jar to generated/dist/.
310
311


312
313
314
315
316
317
318
# 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
319
# Changes in version 1.3.0 - 2016-07-06
320
321
322

 * Medium changes
   - Parse "package" lines in consensuses and votes.
323
324
325
326
327
328
329
330
   - 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.
331
   - Parse "tunnelled-dir-server" lines in server descriptors.
332

333
334
335
336
 * Minor changes
   - Stop reporting "-----END .*-----" lines in v2 network statuses as
     unrecognized.

337

Karsten Loesing's avatar
Karsten Loesing committed
338
# Changes in version 1.2.0 - 2016-05-31
339
340
341
342

 * Medium changes
   - Include the hostname in directory source entries of consensuses
     and votes.
343
   - Also accept \r\n as newline in Torperf results files.
344
345
   - Make unrecognized keys of Torperf results available together with
     the corresponding values, rather than just the whole line.
346
347
   - In Torperf results, recognize all percentiles of expected bytes
     read for 0 <= x <= 100 rather than just x = { 10, 20, ..., 90 }.
348
349
   - Rename properties for overriding default descriptor source
     implementation classes.
350
   - Actually return the signing key digest in network status votes.
351
   - Parse crypto parts in network status votes.
352
353
   - Document all public parts in org.torproject.descriptor and add
     an Ant target to generate Javadocs.
354

355
356
357
 * Minor changes
   - Include a Torperf results line with more than one unrecognized
     key only once in the unrecognized lines.
358
359
   - Make "consensus-methods" line optional in network statuses votes,
     which would mean that only method 1 is supported.
360
361
   - Stop reporting "-----END .*-----" lines in directory key
     certificates as unrecognized.
Karsten Loesing's avatar
Karsten Loesing committed
362
   - Add code used for benchmarking.
363

364

Karsten Loesing's avatar
Karsten Loesing committed
365
# Changes in version 1.1.0 - 2015-12-28
366
367

 * Medium changes
368
369
370
371
372
373
   - 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
374
375
376
377
378
   - 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.
379
380
381
382
383
384
   - 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.
385
386
387
388
389
   - 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.
390
   - Support hidden-service statistics in extra-info descriptors.
391
392
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
393

394
395
396
397
 * Minor changes
   - Start using Java 7 features like the diamond operator and switch
     on String, and use StringBuilder correctly in many places.

398

Karsten Loesing's avatar
Karsten Loesing committed
399
# Changes in version 1.0.0 - 2015-12-05
Karsten Loesing's avatar
Karsten Loesing committed
400
401

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