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

3
4
5
 * Minor changes
   - Avoid invoking overridable methods from constructors.

Karsten Loesing's avatar
Karsten Loesing committed
6

Karsten Loesing's avatar
Karsten Loesing committed
7
# Changes in version 2.10.0 - 2020-01-15
8
9
10

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

12
13
14
 * Minor changes
   - Fix a NullPointerException when parsing an invalid crypto block
     starting with "-----END " rather than "-----BEGIN ".
15
16
   - Properly parse an authority's hostname from the "dir-source" line
     in a v2 network status.
17

Karsten Loesing's avatar
Karsten Loesing committed
18

19
20
21
22
# 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
23
24


Karsten Loesing's avatar
Karsten Loesing committed
25
# Changes in version 2.9.0 - 2019-11-01
Karsten Loesing's avatar
Karsten Loesing committed
26

27
28
29
 * Medium changes
   - Make NetworkStatusEntryImpl#parseSLine thread-safe.

Karsten Loesing's avatar
Karsten Loesing committed
30

Karsten Loesing's avatar
Karsten Loesing committed
31
# Changes in version 2.8.0 - 2019-10-18
32
33
34
35
36
37
38

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


Karsten Loesing's avatar
Karsten Loesing committed
39
# Changes in version 2.7.0 - 2019-09-06
40
41
42
43
44
45
46
47
48
49
50

 * 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.
51
   - Remove Cobertura from the build process.
52
   - Add new SnowflakeStats descriptor type.
53
54


Karsten Loesing's avatar
Karsten Loesing committed
55
# Changes in version 2.6.2 - 2019-05-29
56
57
58
59
60

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


Karsten Loesing's avatar
Karsten Loesing committed
61
# Changes in version 2.6.1 - 2019-05-03
62
63
64
65
66

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


Karsten Loesing's avatar
Karsten Loesing committed
67
# Changes in version 2.6.0 - 2019-04-29
68
69

 * Medium changes
Karsten Loesing's avatar
Karsten Loesing committed
70
   - Stop signing jar files.
71
72
73
   - Add new BandwidthFile descriptor for parsed bandwidth files.


Karsten Loesing's avatar
Karsten Loesing committed
74
# Changes in version 2.5.0 - 2018-09-25
75
76
77
78
79
80
81

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

82
83
84
 * Minor changes
   - Make DescriptorCollector resume previously aborted downloads.

85

Karsten Loesing's avatar
Karsten Loesing committed
86
# Changes in version 2.4.0 - 2018-05-23
Karsten Loesing's avatar
Karsten Loesing committed
87
88
89
90
91
92
93

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

96
97
98
99
 * Medium changes
   - Replace ServerDescriptor#getHiddenServiceDirVersions with
     ServerDescriptor#isHiddenServiceDir, because Tor has never
     supported versions in the hidden-service-dir descriptor line.
100
101
102
   - Add support for reading web server logs contained in tarballs by
     providing file names of both the tarball and of contained files
     to WebServerAccessLog.
103
104

 * Minor changes
105
106
   - Override logLines() method from LogDescriptor in
     WebServerAccessLog.
107
108
   - Use 1-minute connect and read timeouts for fetching CollecTor's
     index.json.
109
110


111
# Changes in version 2.2.0 - 2018-02-26
112
113
114
115
116

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

117
118
119
 * Minor changes
   - Add log message reporting progress reading tarballs.

120

Karsten Loesing's avatar
Karsten Loesing committed
121
# Changes in version 2.1.1 - 2017-10-09
122

Karsten Loesing's avatar
Karsten Loesing committed
123
 * Minor changes
124
125
126
127
   - 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
128
# Changes in version 2.1.0 - 2017-09-15
129
130
131
132
133

 * 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
134
   - Update to Java 8.
135

136
137
138
 * Minor changes
   - Retain trailing newline in Torperf results.

139

Karsten Loesing's avatar
Karsten Loesing committed
140
# Changes in version 2.0.0 - 2017-06-28
141

Karsten Loesing's avatar
Karsten Loesing committed
142
143
144
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
145
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
146
147
148
   - 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
149

150
151
152
 * Minor changes
   - Replace custom ImplementationNotAccessibleException thrown by
     DescriptorSourceFactory with generic RuntimeException.
iwakeh's avatar
iwakeh committed
153
   - Rename jar files and release tarball to start with "metrics-lib".
154
155


Karsten Loesing's avatar
Karsten Loesing committed
156
# Changes in version 1.9.0 - 2017-06-21
157

158
159
160
161
162
163
164
165
166
167
168
169
 * 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.
170
171
172
   - 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.
173

174
175
176
177
178
179
 * Minor changes
   - Fix a bug where NetworkStatusEntry's getMicrodescriptorDigests()
     and getMicrodescriptorDigestsSha256Base64() return hex strings
     rather than base64 strings.


180
181
182
183
184
185
# 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
186
187


Karsten Loesing's avatar
Karsten Loesing committed
188
189
190
191
192
# 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
193
194


Karsten Loesing's avatar
Karsten Loesing committed
195
# Changes in version 1.8.0 - 2017-06-07
196

197
198
199
200
201
 * Medium changes
   - Store raw descriptor contents as offset and length into a
     referenced byte[], rather than copying contents into a separate
     byte[] per descriptor.

202
203
204
205
 * 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.
206
   - Simplify and avoid repetition in parse helper methods.
207
208
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
209
   - Move descriptor digest computation to DescriptorImpl.
210
211
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
212
213
214
215
   - 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.
216
217


Karsten Loesing's avatar
Karsten Loesing committed
218
# Changes in version 1.7.0 - 2017-05-17
219

Karsten Loesing's avatar
Karsten Loesing committed
220
 * Medium changes
221
222
   - Fix a bug where unrecognized lines in extra-info descriptors
     below crypto blocks were silently skipped.
223
   - Add support for six new key-value pairs added by OnionPerf.
224
225
   - Fix a bug where DescriptorIndexCollector would not delete
     extraneous local files if remote paths start with /.
226
   - Add previously missing method to obtain the digest of a vote.
Karsten Loesing's avatar
Karsten Loesing committed
227
   - Deprecate setFailUnrecognizedDescriptorLines() in
228
229
230
     DescriptorParser and DescriptorReader and refer to
     getUnrecognizedLines() in Descriptor if applications really need
     to fail descriptors containing unrecognized lines.
231
   - Parse "padding-counts" lines in extra-info descriptors.
232

233
234
235
 * Minor changes
   - Accept extra arguments in statistics-related extra-info
     descriptor lines, as permitted by dir-spec.txt.
236
   - Streamline digest method names.
237

238

Karsten Loesing's avatar
Karsten Loesing committed
239
# Changes in version 1.6.0 - 2017-02-17
240

241
242
243
244
 * Major changes
   - Deprecate DescriptorDownloader in favor of the much more widely
     used DescriptorCollector.

245
246
247
248
 * 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
249
250
251
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
252
253
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
254
255
256
257
   - 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.
258
259
260
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
261
   - Parse "shared-rand-.*" lines in consensuses and votes.
262
263
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
264
265


Karsten Loesing's avatar
Karsten Loesing committed
266
# Changes in version 1.5.0 - 2016-10-19
267

268
269
270
271
272
273
 * 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.

274
275
276
277
 * Minor changes
   - Avoid running into an IOException and logging a warning for it.


Karsten Loesing's avatar
Karsten Loesing committed
278
# Changes in version 1.4.0 - 2016-08-31
279

280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 * 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.

295
 * Minor changes
296
297
   - Include resource files in src/*/resources/ in the release
     tarball.
298
   - Move executable, source, and javadoc jar to generated/dist/.
299
300


301
302
303
304
305
306
307
# 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
308
# Changes in version 1.3.0 - 2016-07-06
309
310
311

 * Medium changes
   - Parse "package" lines in consensuses and votes.
312
313
314
315
316
317
318
319
   - 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.
320
   - Parse "tunnelled-dir-server" lines in server descriptors.
321

322
323
324
325
 * Minor changes
   - Stop reporting "-----END .*-----" lines in v2 network statuses as
     unrecognized.

326

Karsten Loesing's avatar
Karsten Loesing committed
327
# Changes in version 1.2.0 - 2016-05-31
328
329
330
331

 * Medium changes
   - Include the hostname in directory source entries of consensuses
     and votes.
332
   - Also accept \r\n as newline in Torperf results files.
333
334
   - Make unrecognized keys of Torperf results available together with
     the corresponding values, rather than just the whole line.
335
336
   - In Torperf results, recognize all percentiles of expected bytes
     read for 0 <= x <= 100 rather than just x = { 10, 20, ..., 90 }.
337
338
   - Rename properties for overriding default descriptor source
     implementation classes.
339
   - Actually return the signing key digest in network status votes.
340
   - Parse crypto parts in network status votes.
341
342
   - Document all public parts in org.torproject.descriptor and add
     an Ant target to generate Javadocs.
343

344
345
346
 * Minor changes
   - Include a Torperf results line with more than one unrecognized
     key only once in the unrecognized lines.
347
348
   - Make "consensus-methods" line optional in network statuses votes,
     which would mean that only method 1 is supported.
349
350
   - Stop reporting "-----END .*-----" lines in directory key
     certificates as unrecognized.
Karsten Loesing's avatar
Karsten Loesing committed
351
   - Add code used for benchmarking.
352

353

Karsten Loesing's avatar
Karsten Loesing committed
354
# Changes in version 1.1.0 - 2015-12-28
355
356

 * Medium changes
357
358
359
360
361
362
   - 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
363
364
365
366
367
   - 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.
368
369
370
371
372
373
   - 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.
374
375
376
377
378
   - 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.
379
   - Support hidden-service statistics in extra-info descriptors.
380
381
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
382

383
384
385
386
 * Minor changes
   - Start using Java 7 features like the diamond operator and switch
     on String, and use StringBuilder correctly in many places.

387

Karsten Loesing's avatar
Karsten Loesing committed
388
# Changes in version 1.0.0 - 2015-12-05
Karsten Loesing's avatar
Karsten Loesing committed
389
390

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