CHANGELOG.md 10.3 KB
Newer Older
Karsten Loesing's avatar
Karsten Loesing committed
1
# Changes in version 2.0.0 - 2017-06-28
2

Karsten Loesing's avatar
Karsten Loesing committed
3
4
5
 * Major changes
   - Always use UTF-8 as charset rather than using the platform's
     default charset.
Karsten Loesing's avatar
Karsten Loesing committed
6
   - Remove all code that was deprecated in 1.x versions.
Karsten Loesing's avatar
Karsten Loesing committed
7
8
9
   - 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
10

11
12
13
 * Minor changes
   - Replace custom ImplementationNotAccessibleException thrown by
     DescriptorSourceFactory with generic RuntimeException.
iwakeh's avatar
iwakeh committed
14
   - Rename jar files and release tarball to start with "metrics-lib".
15
16


Karsten Loesing's avatar
Karsten Loesing committed
17
# Changes in version 1.9.0 - 2017-06-21
18

19
20
21
22
23
24
25
26
27
28
29
30
 * 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.
31
32
33
   - 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.
34

35
36
37
38
39
40
 * Minor changes
   - Fix a bug where NetworkStatusEntry's getMicrodescriptorDigests()
     and getMicrodescriptorDigestsSha256Base64() return hex strings
     rather than base64 strings.


41
42
43
44
45
46
# 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
47
48


Karsten Loesing's avatar
Karsten Loesing committed
49
50
51
52
53
# 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
54
55


Karsten Loesing's avatar
Karsten Loesing committed
56
# Changes in version 1.8.0 - 2017-06-07
57

58
59
60
61
62
 * Medium changes
   - Store raw descriptor contents as offset and length into a
     referenced byte[], rather than copying contents into a separate
     byte[] per descriptor.

63
64
65
66
 * 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.
67
   - Simplify and avoid repetition in parse helper methods.
68
69
   - Fix a bug where Microdescriptor's getDigestSha256Base64() returns
     a hex string rather than a base64 string.
70
   - Move descriptor digest computation to DescriptorImpl.
71
72
   - Fix a bug in digest computation by making sure that the
     descriptor string actually contains the end token.
73
74
75
76
   - 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.
77
78


Karsten Loesing's avatar
Karsten Loesing committed
79
# Changes in version 1.7.0 - 2017-05-17
80

Karsten Loesing's avatar
Karsten Loesing committed
81
 * Medium changes
82
83
   - Fix a bug where unrecognized lines in extra-info descriptors
     below crypto blocks were silently skipped.
84
   - Add support for six new key-value pairs added by OnionPerf.
85
86
   - Fix a bug where DescriptorIndexCollector would not delete
     extraneous local files if remote paths start with /.
87
   - Add previously missing method to obtain the digest of a vote.
Karsten Loesing's avatar
Karsten Loesing committed
88
   - Deprecate setFailUnrecognizedDescriptorLines() in
89
90
91
     DescriptorParser and DescriptorReader and refer to
     getUnrecognizedLines() in Descriptor if applications really need
     to fail descriptors containing unrecognized lines.
92
   - Parse "padding-counts" lines in extra-info descriptors.
93

94
95
96
 * Minor changes
   - Accept extra arguments in statistics-related extra-info
     descriptor lines, as permitted by dir-spec.txt.
97
   - Streamline digest method names.
98

99

Karsten Loesing's avatar
Karsten Loesing committed
100
# Changes in version 1.6.0 - 2017-02-17
101

102
103
104
105
 * Major changes
   - Deprecate DescriptorDownloader in favor of the much more widely
     used DescriptorCollector.

106
107
108
109
 * 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
110
111
112
   - Unify the build process by adding git-submodule metrics-base in
     src/build and removing all centralized parts of the build
     process.
113
114
   - Avoid deleting extraneous local descriptor files when collecting
     descriptors from CollecTor.
115
116
117
118
   - 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.
119
120
121
   - Parse "proto" lines in server descriptors, "pr" lines in status
     entries, and "(recommended|required)-(client|relay)-protocols"
     lines in consensuses and votes.
122
   - Parse "shared-rand-.*" lines in consensuses and votes.
123
124
   - Deprecate DescriptorCollectorImpl now that
     DescriptorIndexCollector is the default.
125
126


Karsten Loesing's avatar
Karsten Loesing committed
127
# Changes in version 1.5.0 - 2016-10-19
128

129
130
131
132
133
134
 * 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.

135
136
137
138
 * Minor changes
   - Avoid running into an IOException and logging a warning for it.


Karsten Loesing's avatar
Karsten Loesing committed
139
# Changes in version 1.4.0 - 2016-08-31
140

141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 * 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.

156
 * Minor changes
157
158
   - Include resource files in src/*/resources/ in the release
     tarball.
159
   - Move executable, source, and javadoc jar to generated/dist/.
160
161


162
163
164
165
166
167
168
# 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
169
# Changes in version 1.3.0 - 2016-07-06
170
171
172

 * Medium changes
   - Parse "package" lines in consensuses and votes.
173
174
175
176
177
178
179
180
   - 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.
181
   - Parse "tunnelled-dir-server" lines in server descriptors.
182

183
184
185
186
 * Minor changes
   - Stop reporting "-----END .*-----" lines in v2 network statuses as
     unrecognized.

187

Karsten Loesing's avatar
Karsten Loesing committed
188
# Changes in version 1.2.0 - 2016-05-31
189
190
191
192

 * Medium changes
   - Include the hostname in directory source entries of consensuses
     and votes.
193
   - Also accept \r\n as newline in Torperf results files.
194
195
   - Make unrecognized keys of Torperf results available together with
     the corresponding values, rather than just the whole line.
196
197
   - In Torperf results, recognize all percentiles of expected bytes
     read for 0 <= x <= 100 rather than just x = { 10, 20, ..., 90 }.
198
199
   - Rename properties for overriding default descriptor source
     implementation classes.
200
   - Actually return the signing key digest in network status votes.
201
   - Parse crypto parts in network status votes.
202
203
   - Document all public parts in org.torproject.descriptor and add
     an Ant target to generate Javadocs.
204

205
206
207
 * Minor changes
   - Include a Torperf results line with more than one unrecognized
     key only once in the unrecognized lines.
208
209
   - Make "consensus-methods" line optional in network statuses votes,
     which would mean that only method 1 is supported.
210
211
   - Stop reporting "-----END .*-----" lines in directory key
     certificates as unrecognized.
Karsten Loesing's avatar
Karsten Loesing committed
212
   - Add code used for benchmarking.
213

214

Karsten Loesing's avatar
Karsten Loesing committed
215
# Changes in version 1.1.0 - 2015-12-28
216
217

 * Medium changes
218
219
220
221
222
223
   - 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
224
225
226
227
228
   - 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.
229
230
231
232
233
234
   - 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.
235
236
237
238
239
   - 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.
240
   - Support hidden-service statistics in extra-info descriptors.
241
242
   - Support onion-key and ntor-onion-key cross certificates in server
     descriptors.
243

244
245
246
247
 * Minor changes
   - Start using Java 7 features like the diamond operator and switch
     on String, and use StringBuilder correctly in many places.

248

Karsten Loesing's avatar
Karsten Loesing committed
249
# Changes in version 1.0.0 - 2015-12-05
Karsten Loesing's avatar
Karsten Loesing committed
250
251

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