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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
/* exported testCookies */
function* testCookies(options) {
// Changing the options object is a bit of a hack, but it allows us to easily
// pass an expiration date to the background script.
options.expiry = Date.now() / 1000 + 3600;
async function background(backgroundOptions) {
// Ask the parent scope to change some cookies we may or may not have
// permission for.
let awaitChanges = new Promise(resolve => {
browser.test.onMessage.addListener(msg => {
browser.test.assertEq("cookies-changed", msg, "browser.test.onMessage");
resolve();
});
});
let changed = [];
browser.cookies.onChanged.addListener(event => {
changed.push(`${event.cookie.name}:${event.cause}`);
});
browser.test.sendMessage("change-cookies");
// Try to access some cookies in various ways.
let {url, domain, secure} = backgroundOptions;
let failures = 0;
let tallyFailure = error => {
failures++;
};
try {
await awaitChanges;
let cookie = await browser.cookies.get({url, name: "foo"});
browser.test.assertEq(backgroundOptions.shouldPass, cookie != null, "should pass == get cookie");
let cookies = await browser.cookies.getAll({domain});
if (backgroundOptions.shouldPass) {
browser.test.assertEq(2, cookies.length, "expected number of cookies");
} else {
browser.test.assertEq(0, cookies.length, "expected number of cookies");
}
await Promise.all([
browser.cookies.set({url, domain, secure, name: "foo", "value": "baz", expirationDate: backgroundOptions.expiry}).catch(tallyFailure),
browser.cookies.set({url, domain, secure, name: "bar", "value": "quux", expirationDate: backgroundOptions.expiry}).catch(tallyFailure),
browser.cookies.remove({url, name: "deleted"}),
]);
if (backgroundOptions.shouldPass) {
// The order of eviction events isn't guaranteed, so just check that
// it's there somewhere.
let evicted = changed.indexOf("evicted:evicted");
if (evicted < 0) {
browser.test.fail("got no eviction event");
} else {
browser.test.succeed("got eviction event");
changed.splice(evicted, 1);
}
browser.test.assertEq("x:explicit,x:overwrite,x:explicit,x:explicit,foo:overwrite,foo:explicit,bar:explicit,deleted:explicit",
changed.join(","), "expected changes");
} else {
browser.test.assertEq("", changed.join(","), "expected no changes");
}
if (!(backgroundOptions.shouldPass || backgroundOptions.shouldWrite)) {
browser.test.assertEq(2, failures, "Expected failures");
} else {
browser.test.assertEq(0, failures, "Expected no failures");
}
browser.test.notifyPass("cookie-permissions");
} catch (error) {
browser.test.fail(`Error: ${error} :: ${error.stack}`);
browser.test.notifyFail("cookie-permissions");
}
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
"permissions": options.permissions,
},
background: `(${background})(${JSON.stringify(options)})`,
});
let cookieSvc = SpecialPowers.Services.cookies;
let domain = options.domain.replace(/^\.?/, ".");
// This will be evicted after we add a fourth cookie.
cookieSvc.add(domain, "/", "evicted", "bar", options.secure, false, false, options.expiry);
// This will be modified by the background script.
cookieSvc.add(domain, "/", "foo", "bar", options.secure, false, false, options.expiry);
// This will be deleted by the background script.
cookieSvc.add(domain, "/", "deleted", "bar", options.secure, false, false, options.expiry);
yield extension.startup();
yield extension.awaitMessage("change-cookies");
cookieSvc.add(domain, "/", "x", "y", options.secure, false, false, options.expiry);
cookieSvc.add(domain, "/", "x", "z", options.secure, false, false, options.expiry);
cookieSvc.remove(domain, "x", "/", false, {});
extension.sendMessage("cookies-changed");
yield extension.awaitFinish("cookie-permissions");
yield extension.unload();
function getCookies(host) {
let cookies = [];
let enum_ = cookieSvc.getCookiesFromHost(host, {});
while (enum_.hasMoreElements()) {
cookies.push(enum_.getNext().QueryInterface(SpecialPowers.Ci.nsICookie2));
}
return cookies.sort((a, b) => String.localeCompare(a.name, b.name));
}
let cookies = getCookies(options.domain);
info(`Cookies: ${cookies.map(c => `${c.name}=${c.value}`)}`);
if (options.shouldPass) {
is(cookies.length, 2, "expected two cookies for host");
is(cookies[0].name, "bar", "correct cookie name");
is(cookies[0].value, "quux", "correct cookie value");
is(cookies[1].name, "foo", "correct cookie name");
is(cookies[1].value, "baz", "correct cookie value");
} else if (options.shouldWrite) {
// Note: |shouldWrite| applies only when |shouldPass| is false.
// This is necessary because, unfortunately, websites (and therefore web
// extensions) are allowed to write some cookies which they're not allowed
// to read.
is(cookies.length, 3, "expected three cookies for host");
is(cookies[0].name, "bar", "correct cookie name");
is(cookies[0].value, "quux", "correct cookie value");
is(cookies[1].name, "deleted", "correct cookie name");
is(cookies[2].name, "foo", "correct cookie name");
is(cookies[2].value, "baz", "correct cookie value");
} else {
is(cookies.length, 2, "expected two cookies for host");
is(cookies[0].name, "deleted", "correct second cookie name");
is(cookies[1].name, "foo", "correct cookie name");
is(cookies[1].value, "bar", "correct cookie value");
}
for (let cookie of cookies) {
cookieSvc.remove(cookie.host, cookie.name, "/", false, {});
}
// Make sure we don't silently poison subsequent tests if something goes wrong.
is(getCookies(options.domain).length, 0, "cookies cleared");
}
|