CHANGELOG.md 13.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Changes in version 2.7.0 - 2019-0?-??

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


Karsten Loesing's avatar
Karsten Loesing committed
15
# Changes in version 2.6.2 - 2019-05-29
16
17
18
19
20

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


Karsten Loesing's avatar
Karsten Loesing committed
21
# Changes in version 2.6.1 - 2019-05-03
22
23
24
25
26

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


Karsten Loesing's avatar
Karsten Loesing committed
27
# Changes in version 2.6.0 - 2019-04-29
28
29

 * Medium changes
Karsten Loesing's avatar
Karsten Loesing committed
30
   - Stop signing jar files.
31
32
33
   - Add new BandwidthFile descriptor for parsed bandwidth files.


Karsten Loesing's avatar
Karsten Loesing committed
34
# Changes in version 2.5.0 - 2018-09-25
35
36
37
38
39
40
41

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

42
43
44
 * Minor changes
   - Make DescriptorCollector resume previously aborted downloads.

45

Karsten Loesing's avatar
Karsten Loesing committed
46
# Changes in version 2.4.0 - 2018-05-23
Karsten Loesing's avatar
Karsten Loesing committed
47
48
49
50
51
52
53

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

56
57
58
59
 * Medium changes
   - Replace ServerDescriptor#getHiddenServiceDirVersions with
     ServerDescriptor#isHiddenServiceDir, because Tor has never
     supported versions in the hidden-service-dir descriptor line.
60
61
62
   - Add support for reading web server logs contained in tarballs by
     providing file names of both the tarball and of contained files
     to WebServerAccessLog.
63
64

 * Minor changes
65
66
   - Override logLines() method from LogDescriptor in
     WebServerAccessLog.
67
68
   - Use 1-minute connect and read timeouts for fetching CollecTor's
     index.json.
69
70


71
# Changes in version 2.2.0 - 2018-02-26
72
73
74
75
76

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

77
78
79
 * Minor changes
   - Add log message reporting progress reading tarballs.

80

Karsten Loesing's avatar
Karsten Loesing committed
81
# Changes in version 2.1.1 - 2017-10-09
82

Karsten Loesing's avatar
Karsten Loesing committed
83
 * Minor changes
84
85
86
87
   - 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
88
# Changes in version 2.1.0 - 2017-09-15
89
90
91
92
93

 * 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
94
   - Update to Java 8.
95

96
97
98
 * Minor changes
   - Retain trailing newline in Torperf results.

99

Karsten Loesing's avatar
Karsten Loesing committed
100
# Changes in version 2.0.0 - 2017-06-28
101

Karsten Loesing's avatar
Karsten Loesing committed
102
103
104
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
105
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
106
107
108
   - 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
109

110
111
112
 * Minor changes
   - Replace custom ImplementationNotAccessibleException thrown by
     DescriptorSourceFactory with generic RuntimeException.
iwakeh's avatar
iwakeh committed
113
   - Rename jar files and release tarball to start with "metrics-lib".
114
115


Karsten Loesing's avatar
Karsten Loesing committed
116
# Changes in version 1.9.0 - 2017-06-21
117

118
119
120
121
122
123
124
125
126
127
128
129
 * 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.
130
131
132
   - 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.
133

134
135
136
137
138
139
 * Minor changes
   - Fix a bug where NetworkStatusEntry's getMicrodescriptorDigests()
     and getMicrodescriptorDigestsSha256Base64() return hex strings
     rather than base64 strings.


140
141
142
143
144
145
# 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
146
147


Karsten Loesing's avatar
Karsten Loesing committed
148
149
150
151
152
# 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
153
154


Karsten Loesing's avatar
Karsten Loesing committed
155
# Changes in version 1.8.0 - 2017-06-07
156

157
158
159
160
161
 * Medium changes
   - Store raw descriptor contents as offset and length into a
     referenced byte[], rather than copying contents into a separate
     byte[] per descriptor.

162
163
164
165
 * 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.
166
   - Simplify and avoid repetition in parse helper methods.
167
168
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
169
   - Move descriptor digest computation to DescriptorImpl.
170
171
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
172
173
174
175
   - 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.
176
177


Karsten Loesing's avatar
Karsten Loesing committed
178
# Changes in version 1.7.0 - 2017-05-17
179

Karsten Loesing's avatar
Karsten Loesing committed
180
 * Medium changes
181
182
   - Fix a bug where unrecognized lines in extra-info descriptors
     below crypto blocks were silently skipped.
183
   - Add support for six new key-value pairs added by OnionPerf.
184
185
   - Fix a bug where DescriptorIndexCollector would not delete
     extraneous local files if remote paths start with /.
186
   - Add previously missing method to obtain the digest of a vote.
Karsten Loesing's avatar
Karsten Loesing committed
187
   - Deprecate setFailUnrecognizedDescriptorLines() in
188
189
190
     DescriptorParser and DescriptorReader and refer to
     getUnrecognizedLines() in Descriptor if applications really need
     to fail descriptors containing unrecognized lines.
191
   - Parse "padding-counts" lines in extra-info descriptors.
192

193
194
195
 * Minor changes
   - Accept extra arguments in statistics-related extra-info
     descriptor lines, as permitted by dir-spec.txt.
196
   - Streamline digest method names.
197

198

Karsten Loesing's avatar
Karsten Loesing committed
199
# Changes in version 1.6.0 - 2017-02-17
200

201
202
203
204
 * Major changes
   - Deprecate DescriptorDownloader in favor of the much more widely
     used DescriptorCollector.

205
206
207
208
 * 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
209
210
211
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
212
213
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
214
215
216
217
   - 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.
218
219
220
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
221
   - Parse "shared-rand-.*" lines in consensuses and votes.
222
223
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
224
225


Karsten Loesing's avatar
Karsten Loesing committed
226
# Changes in version 1.5.0 - 2016-10-19
227

228
229
230
231
232
233
 * 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.

234
235
236
237
 * Minor changes
   - Avoid running into an IOException and logging a warning for it.


Karsten Loesing's avatar
Karsten Loesing committed
238
# Changes in version 1.4.0 - 2016-08-31
239

240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 * 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.

255
 * Minor changes
256
257
   - Include resource files in src/*/resources/ in the release
     tarball.
258
   - Move executable, source, and javadoc jar to generated/dist/.
259
260


261
262
263
264
265
266
267
# 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
268
# Changes in version 1.3.0 - 2016-07-06
269
270
271

 * Medium changes
   - Parse "package" lines in consensuses and votes.
272
273
274
275
276
277
278
279
   - 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.
280
   - Parse "tunnelled-dir-server" lines in server descriptors.
281

282
283
284
285
 * Minor changes
   - Stop reporting "-----END .*-----" lines in v2 network statuses as
     unrecognized.

286

Karsten Loesing's avatar
Karsten Loesing committed
287
# Changes in version 1.2.0 - 2016-05-31
288
289
290
291

 * Medium changes
   - Include the hostname in directory source entries of consensuses
     and votes.
292
   - Also accept \r\n as newline in Torperf results files.
293
294
   - Make unrecognized keys of Torperf results available together with
     the corresponding values, rather than just the whole line.
295
296
   - In Torperf results, recognize all percentiles of expected bytes
     read for 0 <= x <= 100 rather than just x = { 10, 20, ..., 90 }.
297
298
   - Rename properties for overriding default descriptor source
     implementation classes.
299
   - Actually return the signing key digest in network status votes.
300
   - Parse crypto parts in network status votes.
301
302
   - Document all public parts in org.torproject.descriptor and add
     an Ant target to generate Javadocs.
303

304
305
306
 * Minor changes
   - Include a Torperf results line with more than one unrecognized
     key only once in the unrecognized lines.
307
308
   - Make "consensus-methods" line optional in network statuses votes,
     which would mean that only method 1 is supported.
309
310
   - Stop reporting "-----END .*-----" lines in directory key
     certificates as unrecognized.
Karsten Loesing's avatar
Karsten Loesing committed
311
   - Add code used for benchmarking.
312

313

Karsten Loesing's avatar
Karsten Loesing committed
314
# Changes in version 1.1.0 - 2015-12-28
315
316

 * Medium changes
317
318
319
320
321
322
   - 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
323
324
325
326
327
   - 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.
328
329
330
331
332
333
   - 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.
334
335
336
337
338
   - 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.
339
   - Support hidden-service statistics in extra-info descriptors.
340
341
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
342

343
344
345
346
 * Minor changes
   - Start using Java 7 features like the diamond operator and switch
     on String, and use StringBuilder correctly in many places.

347

Karsten Loesing's avatar
Karsten Loesing committed
348
# Changes in version 1.0.0 - 2015-12-05
Karsten Loesing's avatar
Karsten Loesing committed
349
350

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