1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
// This test ensures that the nsIUrlClassifierHashCompleter works as expected
// and simulates an HTTP server to provide completions.
//
// In order to test completions, each group of completions sent as one request
// to the HTTP server is called a completion set. There is currently not
// support for multiple requests being sent to the server at once, in this test.
// This tests makes a request for each element of |completionSets|, waits for
// a response and then moves to the next element.
// Each element of |completionSets| is an array of completions, and each
// completion is an object with the properties:
// hash: complete hash for the completion. Automatically right-padded
// to be COMPLETE_LENGTH.
// expectCompletion: boolean indicating whether the server should respond
// with a full hash.
// forceServerError: boolean indicating whether the server should respond
// with a 503.
// table: name of the table that the hash corresponds to. Only needs to be set
// if a completion is expected.
// chunkId: positive integer corresponding to the chunk that the hash belongs
// to. Only needs to be set if a completion is expected.
// multipleCompletions: boolean indicating whether the server should respond
// with more than one full hash. If this is set to true
// then |expectCompletion| must also be set to true and
// |hash| must have the same prefix as all |completions|.
// completions: an array of completions (objects with a hash, table and
// chunkId property as described above). This property is only
// used when |multipleCompletions| is set to true.
// Basic prefixes with 2/3 completions.
var basicCompletionSet = [
{
hash: "abcdefgh",
expectCompletion: true,
table: "test",
chunkId: 1234,
},
{
hash: "1234",
expectCompletion: false,
},
{
hash: "\u0000\u0000\u000012312",
expectCompletion: true,
table: "test",
chunkId: 1234,
},
];
// 3 prefixes with 0 completions to test HashCompleter handling a 204 status.
var falseCompletionSet = [
{
hash: "1234",
expectCompletion: false,
},
{
hash: "",
expectCompletion: false,
},
{
hash: "abc",
expectCompletion: false,
},
];
// The current implementation (as of Mar 2011) sometimes sends duplicate
// entries to HashCompleter and even expects responses for duplicated entries.
var dupedCompletionSet = [
{
hash: "1234",
expectCompletion: true,
table: "test",
chunkId: 1,
},
{
hash: "5678",
expectCompletion: false,
table: "test2",
chunkId: 2,
},
{
hash: "1234",
expectCompletion: true,
table: "test",
chunkId: 1,
},
{
hash: "5678",
expectCompletion: false,
table: "test2",
chunkId: 2,
},
];
// It is possible for a hash completion request to return with multiple
// completions, the HashCompleter should return all of these.
var multipleResponsesCompletionSet = [
{
hash: "1234",
expectCompletion: true,
multipleCompletions: true,
completions: [
{
hash: "123456",
table: "test1",
chunkId: 3,
},
{
hash: "123478",
table: "test2",
chunkId: 4,
},
],
},
];
function buildCompletionRequest(aCompletionSet) {
let prefixes = [];
let prefixSet = new Set();
aCompletionSet.forEach(s => {
let prefix = s.hash.substring(0, 4);
if (prefixSet.has(prefix)) {
return;
}
prefixSet.add(prefix);
prefixes.push(prefix);
});
return 4 + ":" + 4 * prefixes.length + "\n" + prefixes.join("");
}
function parseCompletionRequest(aRequest) {
// Format: [partial_length]:[num_of_prefix * partial_length]\n[prefixes_data]
let tokens = /(\d):(\d+)/.exec(aRequest);
if (tokens.length < 3) {
dump("Request format error.");
return null;
}
let partialLength = parseInt(tokens[1]);
let payloadStart =
tokens[1].length + // partial length
1 + // ':'
tokens[2].length + // payload length
1; // '\n'
let prefixSet = [];
for (let i = payloadStart; i < aRequest.length; i += partialLength) {
let prefix = aRequest.substr(i, partialLength);
if (prefix.length !== partialLength) {
dump("Header info not correct: " + aRequest.substr(0, payloadStart));
return null;
}
prefixSet.push(prefix);
}
prefixSet.sort();
return prefixSet;
}
// Compare the requests in string format.
function compareCompletionRequest(aRequest1, aRequest2) {
let prefixSet1 = parseCompletionRequest(aRequest1);
let prefixSet2 = parseCompletionRequest(aRequest2);
return equal(JSON.stringify(prefixSet1), JSON.stringify(prefixSet2));
}
// The fifth completion set is added at runtime by getRandomCompletionSet.
// Each completion in the set only has one response and its purpose is to
// provide an easy way to test the HashCompleter handling an arbitrarily large
// completion set (determined by SIZE_OF_RANDOM_SET).
const SIZE_OF_RANDOM_SET = 16;
function getRandomCompletionSet(forceServerError) {
let completionSet = [];
let hashPrefixes = [];
let seed = Math.floor(Math.random() * Math.pow(2, 32));
dump("Using seed of " + seed + " for random completion set.\n");
let rand = new LFSRgenerator(seed);
for (let i = 0; i < SIZE_OF_RANDOM_SET; i++) {
let completion = {
expectCompletion: false,
forceServerError: false,
_finished: false,
};
// Generate a random 256 bit hash. First we get a random number and then
// convert it to a string.
let hash;
let prefix;
do {
hash = "";
let length = 1 + rand.nextNum(5);
for (let j = 0; j < length; j++) {
hash += String.fromCharCode(rand.nextNum(8));
}
prefix = hash.substring(0, 4);
} while (hashPrefixes.includes(prefix));
hashPrefixes.push(prefix);
completion.hash = hash;
if (!forceServerError) {
completion.expectCompletion = rand.nextNum(1) == 1;
} else {
completion.forceServerError = true;
}
if (completion.expectCompletion) {
// Generate a random alpha-numeric string of length start with "test" for the
// table name.
completion.table = "test" + rand.nextNum(31).toString(36);
completion.chunkId = rand.nextNum(16);
}
completionSet.push(completion);
}
return completionSet;
}
var completionSets = [
basicCompletionSet,
falseCompletionSet,
dupedCompletionSet,
multipleResponsesCompletionSet,
];
var currentCompletionSet = -1;
var finishedCompletions = 0;
const SERVER_PATH = "/hash-completer";
var server;
// Completion hashes are automatically right-padded with null chars to have a
// length of COMPLETE_LENGTH.
// Taken from nsUrlClassifierDBService.h
const COMPLETE_LENGTH = 32;
var completer = Cc["@mozilla.org/url-classifier/hashcompleter;1"].getService(
Ci.nsIUrlClassifierHashCompleter
);
var gethashUrl;
// Expected highest completion set for which the server sends a response.
var expectedMaxServerCompletionSet = 0;
var maxServerCompletionSet = 0;
function run_test() {
// This test case exercises the backoff functionality so we can't leave it disabled.
Services.prefs.setBoolPref(
"browser.safebrowsing.provider.test.disableBackoff",
false
);
// Generate a random completion set that return successful responses.
completionSets.push(getRandomCompletionSet(false));
// We backoff after receiving an error, so requests shouldn't reach the
// server after that.
expectedMaxServerCompletionSet = completionSets.length;
// Generate some completion sets that return 503s.
for (let j = 0; j < 10; ++j) {
completionSets.push(getRandomCompletionSet(true));
}
// Fix up the completions before running the test.
for (let completionSet of completionSets) {
for (let completion of completionSet) {
// Pad the right of each |hash| so that the length is COMPLETE_LENGTH.
if (completion.multipleCompletions) {
for (let responseCompletion of completion.completions) {
let numChars = COMPLETE_LENGTH - responseCompletion.hash.length;
responseCompletion.hash += new Array(numChars + 1).join("\u0000");
}
} else {
let numChars = COMPLETE_LENGTH - completion.hash.length;
completion.hash += new Array(numChars + 1).join("\u0000");
}
}
}
do_test_pending();
server = new HttpServer();
server.registerPathHandler(SERVER_PATH, hashCompleterServer);
server.start(-1);
const SERVER_PORT = server.identity.primaryPort;
gethashUrl = "http://localhost:" + SERVER_PORT + SERVER_PATH;
runNextCompletion();
}
function runNextCompletion() {
// The server relies on currentCompletionSet to send the correct response, so
// don't increment it until we start the new set of callbacks.
currentCompletionSet++;
if (currentCompletionSet >= completionSets.length) {
finish();
return;
}
dump(
"Now on completion set index " +
currentCompletionSet +
", length " +
completionSets[currentCompletionSet].length +
"\n"
);
// Number of finished completions for this set.
finishedCompletions = 0;
for (let completion of completionSets[currentCompletionSet]) {
completer.complete(
completion.hash.substring(0, 4),
gethashUrl,
"test-phish-shavar", // Could be arbitrary v2 table name.
new callback(completion)
);
}
}
function hashCompleterServer(aRequest, aResponse) {
let stream = aRequest.bodyInputStream;
let wrapperStream = Cc["@mozilla.org/binaryinputstream;1"].createInstance(
Ci.nsIBinaryInputStream
);
wrapperStream.setInputStream(stream);
let len = stream.available();
let data = wrapperStream.readBytes(len);
// Check if we got the expected completion request.
let expectedRequest = buildCompletionRequest(
completionSets[currentCompletionSet]
);
compareCompletionRequest(data, expectedRequest);
// To avoid a response with duplicate hash completions, we keep track of all
// completed hash prefixes so far.
let completedHashes = [];
let responseText = "";
function responseForCompletion(x) {
return x.table + ":" + x.chunkId + ":" + x.hash.length + "\n" + x.hash;
}
// As per the spec, a server should response with a 204 if there are no
// full-length hashes that match the prefixes.
let httpStatus = 204;
for (let completion of completionSets[currentCompletionSet]) {
if (
completion.expectCompletion &&
!completedHashes.includes(completion.hash)
) {
completedHashes.push(completion.hash);
if (completion.multipleCompletions) {
responseText += completion.completions
.map(responseForCompletion)
.join("");
} else {
responseText += responseForCompletion(completion);
}
}
if (completion.forceServerError) {
httpStatus = 503;
}
}
dump("Server sending response for " + currentCompletionSet + "\n");
maxServerCompletionSet = currentCompletionSet;
if (responseText && httpStatus != 503) {
aResponse.write(responseText);
} else {
aResponse.setStatusLine(null, httpStatus, null);
}
}
function callback(completion) {
this._completion = completion;
}
callback.prototype = {
completionV2: function completionV2(hash, table, chunkId) {
Assert.ok(this._completion.expectCompletion);
if (this._completion.multipleCompletions) {
for (let completion of this._completion.completions) {
if (completion.hash == hash) {
Assert.equal(JSON.stringify(hash), JSON.stringify(completion.hash));
Assert.equal(table, completion.table);
Assert.equal(chunkId, completion.chunkId);
completion._completed = true;
if (this._completion.completions.every(x => x._completed)) {
this._completed = true;
}
break;
}
}
} else {
// Hashes are not actually strings and can contain arbitrary data.
Assert.equal(JSON.stringify(hash), JSON.stringify(this._completion.hash));
Assert.equal(table, this._completion.table);
Assert.equal(chunkId, this._completion.chunkId);
this._completed = true;
}
},
completionFinished: function completionFinished() {
finishedCompletions++;
Assert.equal(!!this._completion.expectCompletion, !!this._completed);
this._completion._finished = true;
// currentCompletionSet can mutate before all of the callbacks are complete.
if (
currentCompletionSet < completionSets.length &&
finishedCompletions == completionSets[currentCompletionSet].length
) {
runNextCompletion();
}
},
};
function finish() {
Services.prefs.clearUserPref(
"browser.safebrowsing.provider.test.disableBackoff"
);
Assert.equal(expectedMaxServerCompletionSet, maxServerCompletionSet);
server.stop(function () {
do_test_finished();
});
}
|