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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// This is a kinto-specific test...
Services.prefs.setBoolPref("webextensions.storage.sync.kinto", true);
do_get_profile(); // so we can use FxAccounts
const { HttpServer } = ChromeUtils.import("resource://testing-common/httpd.js");
const { CommonUtils } = ChromeUtils.importESModule(
"resource://services-common/utils.sys.mjs"
);
const {
ExtensionStorageSyncKinto: ExtensionStorageSync,
KintoStorageTestUtils: {
cleanUpForContext,
CollectionKeyEncryptionRemoteTransformer,
CryptoCollection,
idToKey,
keyToId,
KeyRingEncryptionRemoteTransformer,
},
} = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionStorageSyncKinto.sys.mjs"
);
const { BulkKeyBundle } = ChromeUtils.importESModule(
"resource://services-sync/keys.sys.mjs"
);
const { FxAccountsKeys } = ChromeUtils.importESModule(
"resource://gre/modules/FxAccountsKeys.sys.mjs"
);
const { Utils } = ChromeUtils.importESModule(
"resource://services-sync/util.sys.mjs"
);
const { createAppInfo, promiseStartupManager } = AddonTestUtils;
AddonTestUtils.init(this);
createAppInfo("xpcshell@tests.mozilla.org", "XPCShell", "1", "69");
function handleCannedResponse(cannedResponse, request, response) {
response.setStatusLine(
null,
cannedResponse.status.status,
cannedResponse.status.statusText
);
// send the headers
for (let headerLine of cannedResponse.sampleHeaders) {
let headerElements = headerLine.split(":");
response.setHeader(headerElements[0], headerElements[1].trimLeft());
}
response.setHeader("Date", new Date().toUTCString());
response.write(cannedResponse.responseBody);
}
function collectionPath(collectionId) {
return `/buckets/default/collections/${collectionId}`;
}
function collectionRecordsPath(collectionId) {
return `/buckets/default/collections/${collectionId}/records`;
}
class KintoServer {
constructor() {
// Set up an HTTP Server
this.httpServer = new HttpServer();
this.httpServer.start(-1);
// Set<Object> corresponding to records that might be served.
// The format of these objects is defined in the documentation for #addRecord.
this.records = [];
// Collections that we have set up access to (see `installCollection`).
this.collections = new Set();
// ETag to serve with responses
this.etag = 1;
this.port = this.httpServer.identity.primaryPort;
// POST requests we receive from the client go here
this.posts = [];
// DELETEd buckets will go here.
this.deletedBuckets = [];
// Anything in here will force the next POST to generate a conflict
this.conflicts = [];
// If this is true, reject the next request with a 401
this.rejectNextAuthResponse = false;
this.failedAuths = [];
this.installConfigPath();
this.installBatchPath();
this.installCatchAll();
}
clearPosts() {
this.posts = [];
}
getPosts() {
return this.posts;
}
getDeletedBuckets() {
return this.deletedBuckets;
}
rejectNextAuthWith(response) {
this.rejectNextAuthResponse = response;
}
checkAuth(request, response) {
equal(request.getHeader("Authorization"), "Bearer some-access-token");
if (this.rejectNextAuthResponse) {
response.setStatusLine(null, 401, "Unauthorized");
response.write(this.rejectNextAuthResponse);
this.rejectNextAuthResponse = false;
this.failedAuths.push(request);
return true;
}
return false;
}
installConfigPath() {
const configPath = "/v1/";
const responseBody = JSON.stringify({
settings: { batch_max_requests: 25 },
url: `http://localhost:${this.port}/v1/`,
documentation: "https://kinto.readthedocs.org/",
version: "1.5.1",
commit: "cbc6f58",
hello: "kinto",
});
const configResponse = {
sampleHeaders: [
"Access-Control-Allow-Origin: *",
"Access-Control-Expose-Headers: Retry-After, Content-Length, Alert, Backoff",
"Content-Type: application/json; charset=UTF-8",
"Server: waitress",
],
status: { status: 200, statusText: "OK" },
responseBody: responseBody,
};
function handleGetConfig(request, response) {
if (request.method != "GET") {
dump(`ARGH, got ${request.method}\n`);
}
return handleCannedResponse(configResponse, request, response);
}
this.httpServer.registerPathHandler(configPath, handleGetConfig);
}
installBatchPath() {
const batchPath = "/v1/batch";
function handlePost(request, response) {
if (this.checkAuth(request, response)) {
return;
}
let bodyStr = CommonUtils.readBytesFromInputStream(
request.bodyInputStream
);
let body = JSON.parse(bodyStr);
let defaults = body.defaults;
for (let req of body.requests) {
let headers = Object.assign(
{},
(defaults && defaults.headers) || {},
req.headers
);
this.posts.push(Object.assign({}, req, { headers }));
}
response.setStatusLine(null, 200, "OK");
response.setHeader("Content-Type", "application/json; charset=UTF-8");
response.setHeader("Date", new Date().toUTCString());
let postResponse = {
responses: body.requests.map(req => {
let oneBody;
if (req.method == "DELETE") {
let id = req.path.match(
/^\/buckets\/default\/collections\/.+\/records\/(.+)$/
)[1];
oneBody = {
data: {
deleted: true,
id: id,
last_modified: this.etag,
},
};
} else {
oneBody = {
data: Object.assign({}, req.body.data, {
last_modified: this.etag,
}),
permissions: [],
};
}
return {
path: req.path,
status: 201, // FIXME -- only for new posts??
headers: { ETag: 3000 }, // FIXME???
body: oneBody,
};
}),
};
if (this.conflicts.length) {
const nextConflict = this.conflicts.shift();
if (!nextConflict.transient) {
this.records.push(nextConflict);
}
const { data } = nextConflict;
postResponse = {
responses: body.requests.map(req => {
return {
path: req.path,
status: 412,
headers: { ETag: this.etag }, // is this correct??
body: {
details: {
existing: data,
},
},
};
}),
};
}
response.write(JSON.stringify(postResponse));
// "sampleHeaders": [
// "Access-Control-Allow-Origin: *",
// "Access-Control-Expose-Headers: Retry-After, Content-Length, Alert, Backoff",
// "Server: waitress",
// "Etag: \"4000\""
// ],
}
this.httpServer.registerPathHandler(batchPath, handlePost.bind(this));
}
installCatchAll() {
this.httpServer.registerPathHandler("/", (request, response) => {
dump(
`got request: ${request.method}:${request.path}?${request.queryString}\n`
);
dump(
`${CommonUtils.readBytesFromInputStream(request.bodyInputStream)}\n`
);
});
}
/**
* Add a record to those that can be served by this server.
*
* @param {object} properties An object describing the record that
* should be served. The properties of this object are:
* - collectionId {string} This record should only be served if a
* request is for this collection.
* - predicate {Function} If present, this record should only be served if the
* predicate returns true. The predicate will be called with
* {request: Request, response: Response, since: number, server: KintoServer}.
* - data {string} The record to serve.
* - conflict {boolean} If present and true, this record is added to
* "conflicts" and won't be served, but will cause a conflict on
* the next push.
*/
addRecord(properties) {
if (!properties.conflict) {
this.records.push(properties);
} else {
this.conflicts.push(properties);
}
this.installCollection(properties.collectionId);
}
/**
* Tell the server to set up a route for this collection.
*
* This will automatically be called for any collection to which you `addRecord`.
*
* @param {string} collectionId the collection whose route we
* should set up.
*/
installCollection(collectionId) {
if (this.collections.has(collectionId)) {
return;
}
this.collections.add(collectionId);
const remoteCollectionPath =
"/v1" + collectionPath(encodeURIComponent(collectionId));
this.httpServer.registerPathHandler(
remoteCollectionPath,
this.handleGetCollection.bind(this, collectionId)
);
const remoteRecordsPath =
"/v1" + collectionRecordsPath(encodeURIComponent(collectionId));
this.httpServer.registerPathHandler(
remoteRecordsPath,
this.handleGetRecords.bind(this, collectionId)
);
}
handleGetCollection(collectionId, request, response) {
if (this.checkAuth(request, response)) {
return;
}
response.setStatusLine(null, 200, "OK");
response.setHeader("Content-Type", "application/json; charset=UTF-8");
response.setHeader("Date", new Date().toUTCString());
response.write(
JSON.stringify({
data: {
id: collectionId,
},
})
);
}
handleGetRecords(collectionId, request, response) {
if (this.checkAuth(request, response)) {
return;
}
if (request.method != "GET") {
do_throw(`only GET is supported on ${request.path}`);
}
let sinceMatch = request.queryString.match(/(^|&)_since=(\d+)/);
let since = sinceMatch && parseInt(sinceMatch[2], 10);
response.setStatusLine(null, 200, "OK");
response.setHeader("Content-Type", "application/json; charset=UTF-8");
response.setHeader("Date", new Date().toUTCString());
response.setHeader("ETag", this.etag.toString());
const records = this.records
.filter(properties => {
if (properties.collectionId != collectionId) {
return false;
}
if (properties.predicate) {
const predAllowed = properties.predicate({
request: request,
response: response,
since: since,
server: this,
});
if (!predAllowed) {
return false;
}
}
return true;
})
.map(properties => properties.data);
const body = JSON.stringify({
data: records,
});
response.write(body);
}
installDeleteBucket() {
this.httpServer.registerPrefixHandler(
"/v1/buckets/",
(request, response) => {
if (request.method != "DELETE") {
dump(
`got a non-delete action on bucket: ${request.method} ${request.path}\n`
);
return;
}
const noPrefix = request.path.slice("/v1/buckets/".length);
const [bucket, afterBucket] = noPrefix.split("/", 1);
if (afterBucket && afterBucket != "") {
dump(
`got a delete for a non-bucket: ${request.method} ${request.path}\n`
);
}
this.deletedBuckets.push(bucket);
// Fake like this actually deletes the records.
this.records = [];
response.write(
JSON.stringify({
data: {
deleted: true,
last_modified: 1475161309026,
id: "b09f1618-d789-302d-696e-74ec53ee18a8", // FIXME
},
})
);
}
);
}
// Utility function to install a keyring at the start of a test.
async installKeyRing(fxaService, keysData, salts, etag, properties) {
const keysRecord = {
id: "keys",
keys: keysData,
salts: salts,
last_modified: etag,
};
this.etag = etag;
const transformer = new KeyRingEncryptionRemoteTransformer(fxaService);
return this.encryptAndAddRecord(
transformer,
Object.assign({}, properties, {
collectionId: "storage-sync-crypto",
data: keysRecord,
})
);
}
encryptAndAddRecord(transformer, properties) {
return transformer.encode(properties.data).then(encrypted => {
this.addRecord(Object.assign({}, properties, { data: encrypted }));
});
}
stop() {
this.httpServer.stop(() => {});
}
}
/**
* Predicate that represents a record appearing at some time.
* Requests with "_since" before this time should see this record,
* unless the server itself isn't at this time yet (etag is before
* this time).
*
* Requests with _since after this time shouldn't see this record any
* more, since it hasn't changed after this time.
*
* @param {int} startTime the etag at which time this record should
* start being available (and thus, the predicate should start
* returning true)
* @returns {Function}
*/
function appearsAt(startTime) {
return function ({ since, server }) {
return since < startTime && startTime < server.etag;
};
}
// Run a block of code with access to a KintoServer.
async function withServer(f) {
let server = new KintoServer();
// Point the sync.storage client to use the test server we've just started.
Services.prefs.setCharPref(
"webextensions.storage.sync.serverURL",
`http://localhost:${server.port}/v1`
);
try {
await f(server);
} finally {
server.stop();
}
}
// Run a block of code with access to both a sync context and a
// KintoServer. This is meant as a workaround for eslint's refusal to
// let me have 5 nested callbacks.
async function withContextAndServer(f) {
await withSyncContext(async function (context) {
await withServer(async function (server) {
await f(context, server);
});
});
}
// Run a block of code with fxa mocked out to return a specific user.
// Calls the given function with an ExtensionStorageSync instance that
// was constructed using a mocked FxAccounts instance.
async function withSignedInUser(user, f) {
let fxaServiceMock = {
getSignedInUser() {
return Promise.resolve({ uid: user.uid });
},
getOAuthToken() {
return Promise.resolve("some-access-token");
},
checkAccountStatus() {
return Promise.resolve(true);
},
removeCachedOAuthToken() {
return Promise.resolve();
},
keys: {
getKeyForScope(scope) {
return Promise.resolve({ ...user.scopedKeys[scope] });
},
kidAsHex(jwk) {
return new FxAccountsKeys({}).kidAsHex(jwk);
},
},
};
let telemetryMock = {
_calls: [],
_histograms: {},
scalarSet(name, value) {
this._calls.push({ method: "scalarSet", name, value });
},
keyedScalarSet(name, key, value) {
this._calls.push({ method: "keyedScalarSet", name, key, value });
},
getKeyedHistogramById(name) {
let self = this;
return {
add(key, value) {
if (!self._histograms[name]) {
self._histograms[name] = [];
}
self._histograms[name].push(value);
},
};
},
};
let extensionStorageSync = new ExtensionStorageSync(
fxaServiceMock,
telemetryMock
);
await f(extensionStorageSync, fxaServiceMock);
}
// Some assertions that make it easier to write tests about what was
// posted and when.
// Assert that a post in a batch was made with the correct access token.
// This should be true of all requests, so this is usually called from
// another assertion.
function assertAuthenticatedPost(post) {
equal(post.headers.Authorization, "Bearer some-access-token");
}
// Assert that this post was made with the correct request headers to
// create a new resource while protecting against someone else
// creating it at the same time (in other words, "If-None-Match: *").
// Also calls assertAuthenticatedPost(post).
function assertPostedNewRecord(post) {
assertAuthenticatedPost(post);
equal(post.headers["If-None-Match"], "*");
}
// Assert that this post was made with the correct request headers to
// update an existing resource while protecting against concurrent
// modification (in other words, `If-Match: "${etag}"`).
// Also calls assertAuthenticatedPost(post).
function assertPostedUpdatedRecord(post, since) {
assertAuthenticatedPost(post);
equal(post.headers["If-Match"], `"${since}"`);
}
// Assert that this post was an encrypted keyring, and produce the
// decrypted body. Sanity check the body while we're here.
const assertPostedEncryptedKeys = async function (fxaService, post) {
equal(post.path, collectionRecordsPath("storage-sync-crypto") + "/keys");
let body = await new KeyRingEncryptionRemoteTransformer(fxaService).decode(
post.body.data
);
ok(body.keys, `keys object should be present in decoded body`);
ok(body.keys.default, `keys object should have a default key`);
ok(body.salts, `salts object should be present in decoded body`);
return body;
};
// assertEqual, but for keyring[extensionId] == key.
function assertKeyRingKey(keyRing, extensionId, expectedKey, message) {
if (!message) {
message = `expected keyring's key for ${extensionId} to match ${expectedKey.keyPairB64}`;
}
ok(
keyRing.hasKeysFor([extensionId]),
`expected keyring to have a key for ${extensionId}\n`
);
deepEqual(
keyRing.keyForCollection(extensionId).keyPairB64,
expectedKey.keyPairB64,
message
);
}
// Assert that this post was posted for a given extension.
const assertExtensionRecord = async function (
fxaService,
post,
extension,
key
) {
const extensionId = extension.id;
const cryptoCollection = new CryptoCollection(fxaService);
const hashedId =
"id-" +
(await cryptoCollection.hashWithExtensionSalt(keyToId(key), extensionId));
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
const transformer = new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
);
equal(
post.path,
`${collectionRecordsPath(collectionId)}/${hashedId}`,
"decrypted data should be posted to path corresponding to its key"
);
let decoded = await transformer.decode(post.body.data);
equal(
decoded.key,
key,
"decrypted data should have a key attribute corresponding to the extension data key"
);
return decoded;
};
// Tests using this ID will share keys in local storage, so be careful.
const defaultExtensionId = "{13bdde76-4dc7-11e6-9bdc-54ee758d6342}";
const defaultExtension = { id: defaultExtensionId };
const loggedInUser = {
uid: "0123456789abcdef0123456789abcdef",
scopedKeys: {
"sync:addon_storage": {
kid: "1234567890123-I1DLqPztWi-647HxgLr4YPePZUK-975wn9qWzT49yAA",
k: "Y_kFdXfAS7u58MP9hbXUAytg4T7cH43TCb9DBdZvLMMS3eFs5GAhpJb3E5UNCmxWbOGBUhpEcm576Xz1d7MbMQ",
kty: "oct",
},
},
oauthTokens: {
"sync:addon_storage": {
token: "some-access-token",
},
},
};
function uuid() {
const uuidgen = Services.uuid;
return uuidgen.generateUUID().toString();
}
add_task(async function test_setup() {
await promiseStartupManager();
});
add_task(async function test_single_initialization() {
// Check if we're calling openConnection too often.
const { FirefoxAdapter } = ChromeUtils.importESModule(
"resource://services-common/kinto-storage-adapter.sys.mjs"
);
const origOpenConnection = FirefoxAdapter.openConnection;
let callCount = 0;
FirefoxAdapter.openConnection = function (...args) {
++callCount;
return origOpenConnection.apply(this, args);
};
function background() {
let promises = ["foo", "bar", "baz", "quux"].map(key =>
browser.storage.sync.get(key)
);
Promise.all(promises).then(() =>
browser.test.notifyPass("initialize once")
);
}
try {
let extension = ExtensionTestUtils.loadExtension({
manifest: {
permissions: ["storage"],
},
background: `(${background})()`,
});
await extension.startup();
await extension.awaitFinish("initialize once");
await extension.unload();
equal(
callCount,
1,
"Initialized FirefoxAdapter connection and Kinto exactly once"
);
} finally {
FirefoxAdapter.openConnection = origOpenConnection;
}
});
add_task(async function test_key_to_id() {
equal(keyToId("foo"), "key-foo");
equal(keyToId("my-new-key"), "key-my_2D_new_2D_key");
equal(keyToId(""), "key-");
equal(keyToId("™"), "key-_2122_");
equal(keyToId("\b"), "key-_8_");
equal(keyToId("abc\ndef"), "key-abc_A_def");
equal(keyToId("Kinto's fancy_string"), "key-Kinto_27_s_20_fancy_5F_string");
const KEYS = ["foo", "my-new-key", "", "Kinto's fancy_string", "™", "\b"];
for (let key of KEYS) {
equal(idToKey(keyToId(key)), key);
}
equal(idToKey("hi"), null);
equal(idToKey("-key-hi"), null);
equal(idToKey("key--abcd"), null);
equal(idToKey("key-%"), null);
equal(idToKey("key-_HI"), null);
equal(idToKey("key-_HI_"), null);
equal(idToKey("key-"), "");
equal(idToKey("key-1"), "1");
equal(idToKey("key-_2D_"), "-");
});
add_task(async function test_extension_id_to_collection_id() {
const extensionId = "{9419cce6-5435-11e6-84bf-54ee758d6342}";
// FIXME: this doesn't actually require the signed in user, but the
// extensionIdToCollectionId method exists on CryptoCollection,
// which needs an fxaService to be instantiated.
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
// Fake a static keyring since the server doesn't exist.
const salt = "Scgx8RJ8Y0rxMGFYArUiKeawlW+0zJyFmtTDvro9qPo=";
const cryptoCollection = new CryptoCollection(fxaService);
await cryptoCollection._setSalt(extensionId, salt);
equal(
await cryptoCollection.extensionIdToCollectionId(extensionId),
"ext-0_QHA1P93_yJoj7ONisrR0lW6uN4PZ3Ii-rT-QOjtvo"
);
}
);
});
add_task(async function ensureCanSync_clearAll() {
// A test extension that will not have any active context around
// but it is returned from a call to AddonManager.getExtensionsByType.
const extensionId = "test-wipe-on-enabled-and-synced@mochi.test";
const testExtension = ExtensionTestUtils.loadExtension({
useAddonManager: "temporary",
manifest: {
permissions: ["storage"],
browser_specific_settings: { gecko: { id: extensionId } },
},
});
await testExtension.startup();
// Retrieve the Extension class instance from the test extension.
const { extension } = testExtension;
// Another test extension that will have an active extension context.
const extensionId2 = "test-wipe-on-active-context@mochi.test";
const extension2 = { id: extensionId2 };
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
async function assertSetAndGetData(extension, data) {
await extensionStorageSync.set(extension, data, context);
let storedData = await extensionStorageSync.get(
extension,
Object.keys(data),
context
);
const extId = extensionId;
deepEqual(
storedData,
data,
`${extId} should get back the data we set`
);
}
async function assertDataCleared(extension, keys) {
const storedData = await extensionStorageSync.get(
extension,
keys,
context
);
deepEqual(
storedData,
{},
`${extension.id} should have lost the data`
);
}
server.installCollection("storage-sync-crypto");
server.etag = 1000;
let newKeys = await extensionStorageSync.ensureCanSync([
extensionId,
extensionId2,
]);
ok(
newKeys.hasKeysFor([extensionId]),
`key isn't present for ${extensionId}`
);
ok(
newKeys.hasKeysFor([extensionId2]),
`key isn't present for ${extensionId2}`
);
let posts = server.getPosts();
equal(posts.length, 1);
assertPostedNewRecord(posts[0]);
await assertSetAndGetData(extension, { "my-key": 1 });
await assertSetAndGetData(extension2, { "my-key": 2 });
// Call cleanup for the first extension, to double check it has
// been wiped out even without an active extension context.
cleanUpForContext(extension, context);
// clear everything.
await extensionStorageSync.clearAll();
// Assert that the data is gone for both the extensions.
await assertDataCleared(extension, ["my-key"]);
await assertDataCleared(extension2, ["my-key"]);
// should have been no posts caused by the clear.
posts = server.getPosts();
equal(posts.length, 1);
}
);
});
await testExtension.unload();
});
add_task(async function ensureCanSync_posts_new_keys() {
const extensionId = uuid();
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
server.installCollection("storage-sync-crypto");
server.etag = 1000;
let newKeys = await extensionStorageSync.ensureCanSync([extensionId]);
ok(
newKeys.hasKeysFor([extensionId]),
`key isn't present for ${extensionId}`
);
let posts = server.getPosts();
equal(posts.length, 1);
const post = posts[0];
assertPostedNewRecord(post);
const body = await assertPostedEncryptedKeys(fxaService, post);
const oldSalt = body.salts[extensionId];
ok(
body.keys.collections[extensionId],
`keys object should have a key for ${extensionId}`
);
ok(oldSalt, `salts object should have a salt for ${extensionId}`);
// Try adding another key to make sure that the first post was
// OK, even on a new profile.
await extensionStorageSync.cryptoCollection._clear();
server.clearPosts();
// Restore the first posted keyring, but add a last_modified date
const firstPostedKeyring = Object.assign({}, post.body.data, {
last_modified: server.etag,
});
server.addRecord({
data: firstPostedKeyring,
collectionId: "storage-sync-crypto",
predicate: appearsAt(250),
});
const extensionId2 = uuid();
newKeys = await extensionStorageSync.ensureCanSync([extensionId2]);
ok(
newKeys.hasKeysFor([extensionId]),
`didn't forget key for ${extensionId}`
);
ok(
newKeys.hasKeysFor([extensionId2]),
`new key generated for ${extensionId2}`
);
posts = server.getPosts();
equal(posts.length, 1);
const newPost = posts[posts.length - 1];
const newBody = await assertPostedEncryptedKeys(fxaService, newPost);
ok(
newBody.keys.collections[extensionId],
`keys object should have a key for ${extensionId}`
);
ok(
newBody.keys.collections[extensionId2],
`keys object should have a key for ${extensionId2}`
);
ok(
newBody.salts[extensionId],
`salts object should have a key for ${extensionId}`
);
ok(
newBody.salts[extensionId2],
`salts object should have a key for ${extensionId2}`
);
equal(
oldSalt,
newBody.salts[extensionId],
`old salt should be preserved in post`
);
}
);
});
});
add_task(async function ensureCanSync_pulls_key() {
// ensureCanSync is implemented by adding a key to our local record
// and doing a sync. This means that if the same key exists
// remotely, we get a "conflict". Ensure that we handle this
// correctly -- we keep the server key (since presumably it's
// already been used to encrypt records) and we don't wipe out other
// collections' keys.
const extensionId = uuid();
const extensionId2 = uuid();
const extensionOnlyKey = uuid();
const extensionOnlySalt = uuid();
const DEFAULT_KEY = new BulkKeyBundle("[default]");
await DEFAULT_KEY.generateRandom();
const RANDOM_KEY = new BulkKeyBundle(extensionId);
await RANDOM_KEY.generateRandom();
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
// FIXME: generating a random salt probably shouldn't require a CryptoCollection?
const cryptoCollection = new CryptoCollection(fxaService);
const RANDOM_SALT = cryptoCollection.getNewSalt();
await extensionStorageSync.cryptoCollection._clear();
const keysData = {
default: DEFAULT_KEY.keyPairB64,
collections: {
[extensionId]: RANDOM_KEY.keyPairB64,
},
};
const saltData = {
[extensionId]: RANDOM_SALT,
};
await server.installKeyRing(fxaService, keysData, saltData, 950, {
predicate: appearsAt(900),
});
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
assertKeyRingKey(collectionKeys, extensionId, RANDOM_KEY);
let posts = server.getPosts();
equal(
posts.length,
0,
"ensureCanSync shouldn't push when the server keyring has the right key"
);
// Another client generates a key for extensionId2
const newKey = new BulkKeyBundle(extensionId2);
await newKey.generateRandom();
keysData.collections[extensionId2] = newKey.keyPairB64;
saltData[extensionId2] = cryptoCollection.getNewSalt();
await server.installKeyRing(fxaService, keysData, saltData, 1050, {
predicate: appearsAt(1000),
});
let newCollectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
extensionId2,
]);
assertKeyRingKey(newCollectionKeys, extensionId2, newKey);
assertKeyRingKey(
newCollectionKeys,
extensionId,
RANDOM_KEY,
`ensureCanSync shouldn't lose the old key for ${extensionId}`
);
posts = server.getPosts();
equal(
posts.length,
0,
"ensureCanSync shouldn't push when updating keys"
);
// Another client generates a key, but not a salt, for extensionOnlyKey
const onlyKey = new BulkKeyBundle(extensionOnlyKey);
await onlyKey.generateRandom();
keysData.collections[extensionOnlyKey] = onlyKey.keyPairB64;
await server.installKeyRing(fxaService, keysData, saltData, 1150, {
predicate: appearsAt(1100),
});
let withNewKey = await extensionStorageSync.ensureCanSync([
extensionId,
extensionOnlyKey,
]);
dump(`got ${JSON.stringify(withNewKey.asWBO().cleartext)}\n`);
assertKeyRingKey(withNewKey, extensionOnlyKey, onlyKey);
assertKeyRingKey(
withNewKey,
extensionId,
RANDOM_KEY,
`ensureCanSync shouldn't lose the old key for ${extensionId}`
);
posts = server.getPosts();
equal(
posts.length,
1,
"ensureCanSync should push when generating a new salt"
);
const withNewKeyRecord = await assertPostedEncryptedKeys(
fxaService,
posts[0]
);
// We don't a priori know what the new salt is
dump(`${JSON.stringify(withNewKeyRecord)}\n`);
ok(
withNewKeyRecord.salts[extensionOnlyKey],
`ensureCanSync should generate a salt for an extension that only had a key`
);
// Another client generates a key, but not a salt, for extensionOnlyKey
const newSalt = cryptoCollection.getNewSalt();
saltData[extensionOnlySalt] = newSalt;
await server.installKeyRing(fxaService, keysData, saltData, 1250, {
predicate: appearsAt(1200),
});
let withOnlySaltKey = await extensionStorageSync.ensureCanSync([
extensionId,
extensionOnlySalt,
]);
assertKeyRingKey(
withOnlySaltKey,
extensionId,
RANDOM_KEY,
`ensureCanSync shouldn't lose the old key for ${extensionId}`
);
// We don't a priori know what the new key is
ok(
withOnlySaltKey.hasKeysFor([extensionOnlySalt]),
`ensureCanSync generated a key for an extension that only had a salt`
);
posts = server.getPosts();
equal(
posts.length,
2,
"ensureCanSync should push when generating a new key"
);
const withNewSaltRecord = await assertPostedEncryptedKeys(
fxaService,
posts[1]
);
equal(
withNewSaltRecord.salts[extensionOnlySalt],
newSalt,
"ensureCanSync should keep the existing salt when generating only a key"
);
}
);
});
});
add_task(async function ensureCanSync_handles_conflicts() {
// Syncing is done through a pull followed by a push of any merged
// changes. Accordingly, the only way to have a "true" conflict --
// i.e. with the server rejecting a change -- is if
// someone pushes changes between our pull and our push. Ensure that
// if this happens, we still behave sensibly (keep the remote key).
const extensionId = uuid();
const DEFAULT_KEY = new BulkKeyBundle("[default]");
await DEFAULT_KEY.generateRandom();
const RANDOM_KEY = new BulkKeyBundle(extensionId);
await RANDOM_KEY.generateRandom();
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
// FIXME: generating salts probably shouldn't rely on a CryptoCollection
const cryptoCollection = new CryptoCollection(fxaService);
const RANDOM_SALT = cryptoCollection.getNewSalt();
const keysData = {
default: DEFAULT_KEY.keyPairB64,
collections: {
[extensionId]: RANDOM_KEY.keyPairB64,
},
};
const saltData = {
[extensionId]: RANDOM_SALT,
};
await server.installKeyRing(fxaService, keysData, saltData, 765, {
conflict: true,
});
await extensionStorageSync.cryptoCollection._clear();
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
assertKeyRingKey(
collectionKeys,
extensionId,
RANDOM_KEY,
`syncing keyring should keep the server key for ${extensionId}`
);
let posts = server.getPosts();
equal(
posts.length,
1,
"syncing keyring should have tried to post a keyring"
);
const failedPost = posts[0];
assertPostedNewRecord(failedPost);
let body = await assertPostedEncryptedKeys(fxaService, failedPost);
// This key will be the one the client generated locally, so
// we don't know what its value will be
ok(
body.keys.collections[extensionId],
`decrypted failed post should have a key for ${extensionId}`
);
notEqual(
body.keys.collections[extensionId],
RANDOM_KEY.keyPairB64,
`decrypted failed post should have a randomly-generated key for ${extensionId}`
);
}
);
});
});
add_task(async function ensureCanSync_handles_deleted_conflicts() {
// A keyring can be deleted, and this changes the format of the 412
// Conflict response from the Kinto server. Make sure we handle it correctly.
const extensionId = uuid();
const extensionId2 = uuid();
await withContextAndServer(async function (context, server) {
server.installCollection("storage-sync-crypto");
server.installDeleteBucket();
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
server.etag = 700;
await extensionStorageSync.cryptoCollection._clear();
// Generate keys that we can check for later.
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
const extensionKey = collectionKeys.keyForCollection(extensionId);
server.clearPosts();
// This is the response that the Kinto server return when the
// keyring has been deleted.
server.addRecord({
collectionId: "storage-sync-crypto",
conflict: true,
transient: true,
data: null,
etag: 765,
});
// Try to add a new extension to trigger a sync of the keyring.
let collectionKeys2 = await extensionStorageSync.ensureCanSync([
extensionId2,
]);
assertKeyRingKey(
collectionKeys2,
extensionId,
extensionKey,
`syncing keyring should keep our local key for ${extensionId}`
);
deepEqual(
server.getDeletedBuckets(),
["default"],
"Kinto server should have been wiped when keyring was thrown away"
);
let posts = server.getPosts();
equal(
posts.length,
2,
"syncing keyring should have tried to post a keyring twice"
);
// The first post got a conflict.
const failedPost = posts[0];
assertPostedUpdatedRecord(failedPost, 700);
let body = await assertPostedEncryptedKeys(fxaService, failedPost);
deepEqual(
body.keys.collections[extensionId],
extensionKey.keyPairB64,
`decrypted failed post should have the key for ${extensionId}`
);
// The second post was after the wipe, and succeeded.
const afterWipePost = posts[1];
assertPostedNewRecord(afterWipePost);
let afterWipeBody = await assertPostedEncryptedKeys(
fxaService,
afterWipePost
);
deepEqual(
afterWipeBody.keys.collections[extensionId],
extensionKey.keyPairB64,
`decrypted new post should have preserved the key for ${extensionId}`
);
}
);
});
});
add_task(async function ensureCanSync_handles_flushes() {
// See Bug 1359879 and Bug 1350088. One of the ways that 1359879 presents is
// as 1350088. This seems to be the symptom that results when the user had
// two devices, one of which was not syncing at the time the keyring was
// lost. Ensure we can recover for these users as well.
const extensionId = uuid();
const extensionId2 = uuid();
await withContextAndServer(async function (context, server) {
server.installCollection("storage-sync-crypto");
server.installDeleteBucket();
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
server.etag = 700;
// Generate keys that we can check for later.
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
const extensionKey = collectionKeys.keyForCollection(extensionId);
server.clearPosts();
// last_modified is new, but there is no data.
server.etag = 800;
// Try to add a new extension to trigger a sync of the keyring.
let collectionKeys2 = await extensionStorageSync.ensureCanSync([
extensionId2,
]);
assertKeyRingKey(
collectionKeys2,
extensionId,
extensionKey,
`syncing keyring should keep our local key for ${extensionId}`
);
deepEqual(
server.getDeletedBuckets(),
["default"],
"Kinto server should have been wiped when keyring was thrown away"
);
let posts = server.getPosts();
equal(
posts.length,
1,
"syncing keyring should have tried to post a keyring once"
);
const post = posts[0];
assertPostedNewRecord(post);
let postBody = await assertPostedEncryptedKeys(fxaService, post);
deepEqual(
postBody.keys.collections[extensionId],
extensionKey.keyPairB64,
`decrypted new post should have preserved the key for ${extensionId}`
);
}
);
});
});
add_task(async function checkSyncKeyRing_reuploads_keys() {
// Verify that when keys are present, they are reuploaded with the
// new kbHash when we call touchKeys().
const extensionId = uuid();
let extensionKey, extensionSalt;
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
server.installCollection("storage-sync-crypto");
server.etag = 765;
await extensionStorageSync.cryptoCollection._clear();
// Do an `ensureCanSync` to generate some keys.
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
ok(
collectionKeys.hasKeysFor([extensionId]),
`ensureCanSync should return a keyring that has a key for ${extensionId}`
);
extensionKey = collectionKeys.keyForCollection(extensionId).keyPairB64;
equal(
server.getPosts().length,
1,
"generating a key that doesn't exist on the server should post it"
);
const body = await assertPostedEncryptedKeys(
fxaService,
server.getPosts()[0]
);
extensionSalt = body.salts[extensionId];
}
);
// The user changes their password. This is their new kbHash, with
// the last character changed.
const newUser = Object.assign({}, loggedInUser, {
scopedKeys: {
"sync:addon_storage": {
kid: "1234567890123-I1DLqPztWi-647HxgLr4YPePZUK-975wn9qWzT49yAE",
k: "Y_kFdXfAS7u58MP9hbXUAytg4T7cH43TCb9DBdZvLMMS3eFs5GAhpJb3E5UNCmxWbOGBUhpEcm576Xz1d7MbMA",
kty: "oct",
},
},
});
let postedKeys;
await withSignedInUser(
newUser,
async function (extensionStorageSync, fxaService) {
await extensionStorageSync.checkSyncKeyRing();
let posts = server.getPosts();
equal(
posts.length,
2,
"when kBHash changes, checkSyncKeyRing should post the keyring reencrypted with the new kBHash"
);
postedKeys = posts[1];
assertPostedUpdatedRecord(postedKeys, 765);
let body = await assertPostedEncryptedKeys(fxaService, postedKeys);
deepEqual(
body.keys.collections[extensionId],
extensionKey,
`the posted keyring should have the same key for ${extensionId} as the old one`
);
deepEqual(
body.salts[extensionId],
extensionSalt,
`the posted keyring should have the same salt for ${extensionId} as the old one`
);
}
);
// Verify that with the old kBHash, we can't decrypt the record.
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
let error;
try {
await new KeyRingEncryptionRemoteTransformer(fxaService).decode(
postedKeys.body.data
);
} catch (e) {
error = e;
}
ok(error, "decrypting the keyring with the old kBHash should fail");
ok(
Utils.isHMACMismatch(error) ||
KeyRingEncryptionRemoteTransformer.isOutdatedKB(error),
"decrypting the keyring with the old kBHash should throw an HMAC mismatch"
);
}
);
});
});
add_task(async function checkSyncKeyRing_overwrites_on_conflict() {
// If there is already a record on the server that was encrypted
// with a different kbHash, we wipe the server, clear sync state, and
// overwrite it with our keys.
const extensionId = uuid();
let extensionKey;
await withSyncContext(async function (context) {
await withServer(async function (server) {
// The old device has this kbHash, which is very similar to the
// current kbHash but with the last character changed.
const oldUser = Object.assign({}, loggedInUser, {
scopedKeys: {
"sync:addon_storage": {
kid: "1234567890123-I1DLqPztWi-647HxgLr4YPePZUK-975wn9qWzT49yAE",
k: "Y_kFdXfAS7u58MP9hbXUAytg4T7cH43TCb9DBdZvLMMS3eFs5GAhpJb3E5UNCmxWbOGBUhpEcm576Xz1d7MbMA",
kty: "oct",
},
},
});
server.installDeleteBucket();
await withSignedInUser(
oldUser,
async function (extensionStorageSync, fxaService) {
await server.installKeyRing(fxaService, {}, {}, 765);
}
);
// Now we have this new user with a different kbHash.
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
await extensionStorageSync.cryptoCollection._clear();
// Do an `ensureCanSync` to generate some keys.
// This will try to sync, notice that the record is
// undecryptable, and clear the server.
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
ok(
collectionKeys.hasKeysFor([extensionId]),
`ensureCanSync should always return a keyring with a key for ${extensionId}`
);
extensionKey =
collectionKeys.keyForCollection(extensionId).keyPairB64;
deepEqual(
server.getDeletedBuckets(),
["default"],
"Kinto server should have been wiped when keyring was thrown away"
);
let posts = server.getPosts();
equal(posts.length, 1, "new keyring should have been uploaded");
const postedKeys = posts[0];
// The POST was to an empty server, so etag shouldn't be respected
equal(
postedKeys.headers.Authorization,
"Bearer some-access-token",
"keyring upload should be authorized"
);
equal(
postedKeys.headers["If-None-Match"],
"*",
"keyring upload should be to empty Kinto server"
);
equal(
postedKeys.path,
collectionRecordsPath("storage-sync-crypto") + "/keys",
"keyring upload should be to keyring path"
);
let body = await new KeyRingEncryptionRemoteTransformer(
fxaService
).decode(postedKeys.body.data);
ok(body.uuid, "new keyring should have a UUID");
equal(typeof body.uuid, "string", "keyring UUIDs should be strings");
notEqual(
body.uuid,
"abcd",
"new keyring should not have the same UUID as previous keyring"
);
ok(body.keys, "new keyring should have a keys attribute");
ok(body.keys.default, "new keyring should have a default key");
// We should keep the extension key that was in our uploaded version.
deepEqual(
extensionKey,
body.keys.collections[extensionId],
"ensureCanSync should have returned keyring with the same key that was uploaded"
);
// This should be a no-op; the keys were uploaded as part of ensurekeysfor
await extensionStorageSync.checkSyncKeyRing();
equal(
server.getPosts().length,
1,
"checkSyncKeyRing should not need to post keys after they were reuploaded"
);
}
);
});
});
});
add_task(async function checkSyncKeyRing_flushes_on_uuid_change() {
// If we can decrypt the record, but the UUID has changed, that
// means another client has wiped the server and reuploaded a
// keyring, so reset sync state and reupload everything.
const extensionId = uuid();
const extension = { id: extensionId };
await withSyncContext(async function (context) {
await withServer(async function (server) {
server.installCollection("storage-sync-crypto");
server.installDeleteBucket();
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
const transformer = new KeyRingEncryptionRemoteTransformer(
fxaService
);
await extensionStorageSync.cryptoCollection._clear();
// Do an `ensureCanSync` to get access to keys and salt.
let collectionKeys = await extensionStorageSync.ensureCanSync([
extensionId,
]);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
server.installCollection(collectionId);
ok(
collectionKeys.hasKeysFor([extensionId]),
`ensureCanSync should always return a keyring that has a key for ${extensionId}`
);
const extensionKey =
collectionKeys.keyForCollection(extensionId).keyPairB64;
// Set something to make sure that it gets re-uploaded when
// uuid changes.
await extensionStorageSync.set(extension, { "my-key": 5 }, context);
await extensionStorageSync.syncAll();
let posts = server.getPosts();
equal(
posts.length,
2,
"should have posted a new keyring and an extension datum"
);
const postedKeys = posts[0];
equal(
postedKeys.path,
collectionRecordsPath("storage-sync-crypto") + "/keys",
"should have posted keyring to /keys"
);
let body = await transformer.decode(postedKeys.body.data);
ok(body.uuid, "keyring should have a UUID");
ok(body.keys, "keyring should have a keys attribute");
ok(body.keys.default, "keyring should have a default key");
ok(
body.salts[extensionId],
`keyring should have a salt for ${extensionId}`
);
const extensionSalt = body.salts[extensionId];
deepEqual(
extensionKey,
body.keys.collections[extensionId],
"new keyring should have the same key that we uploaded"
);
// Another client comes along and replaces the UUID.
// In real life, this would mean changing the keys too, but
// this test verifies that just changing the UUID is enough.
const newKeyRingData = Object.assign({}, body, {
uuid: "abcd",
// Technically, last_modified should be served outside the
// object, but the transformer will pass it through in
// either direction, so this is OK.
last_modified: 765,
});
server.etag = 1000;
await server.encryptAndAddRecord(transformer, {
collectionId: "storage-sync-crypto",
data: newKeyRingData,
predicate: appearsAt(800),
});
// Fake adding another extension just so that the keyring will
// really get synced.
const newExtension = uuid();
const newKeyRing = await extensionStorageSync.ensureCanSync([
newExtension,
]);
// This should have detected the UUID change and flushed everything.
// The keyring should, however, be the same, since we just
// changed the UUID of the previously POSTed one.
deepEqual(
newKeyRing.keyForCollection(extensionId).keyPairB64,
extensionKey,
"ensureCanSync should have pulled down a new keyring with the same keys"
);
// Syncing should reupload the data for the extension.
await extensionStorageSync.syncAll();
posts = server.getPosts();
equal(
posts.length,
4,
"should have posted keyring for new extension and reuploaded extension data"
);
const finalKeyRingPost = posts[2];
const reuploadedPost = posts[3];
equal(
finalKeyRingPost.path,
collectionRecordsPath("storage-sync-crypto") + "/keys",
"keyring for new extension should have been posted to /keys"
);
let finalKeyRing = await transformer.decode(
finalKeyRingPost.body.data
);
equal(
finalKeyRing.uuid,
"abcd",
"newly uploaded keyring should preserve UUID from replacement keyring"
);
deepEqual(
finalKeyRing.salts[extensionId],
extensionSalt,
"newly uploaded keyring should preserve salts from existing salts"
);
// Confirm that the data got reuploaded
let reuploadedData = await assertExtensionRecord(
fxaService,
reuploadedPost,
extension,
"my-key"
);
equal(
reuploadedData.data,
5,
"extension data should have a data attribute corresponding to the extension data value"
);
}
);
});
});
});
add_task(async function test_storage_sync_pulls_changes() {
const extensionId = defaultExtensionId;
const extension = defaultExtension;
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
server.installCollection("storage-sync-crypto");
let calls = [];
await extensionStorageSync.addOnChangedListener(
extension,
function () {
calls.push(arguments);
},
context
);
await extensionStorageSync.ensureCanSync([extensionId]);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
let transformer = new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
);
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 6,
},
predicate: appearsAt(850),
});
server.etag = 900;
await extensionStorageSync.syncAll();
const remoteValue = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(
remoteValue,
6,
"ExtensionStorageSync.get() returns value retrieved from sync"
);
equal(calls.length, 1, "syncing calls on-changed listener");
deepEqual(calls[0][0], { "remote-key": { newValue: 6 } });
calls = [];
// Syncing again doesn't do anything
await extensionStorageSync.syncAll();
equal(
calls.length,
0,
"syncing again shouldn't call on-changed listener"
);
// Updating the server causes us to pull down the new value
server.etag = 1000;
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 7,
},
predicate: appearsAt(950),
});
await extensionStorageSync.syncAll();
const remoteValue2 = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(
remoteValue2,
7,
"ExtensionStorageSync.get() returns value updated from sync"
);
equal(calls.length, 1, "syncing calls on-changed listener on update");
deepEqual(calls[0][0], { "remote-key": { oldValue: 6, newValue: 7 } });
}
);
});
});
// Tests that an enabled extension which have been synced before it is going
// to be synced on ExtensionStorageSync.syncAll even if there is no active
// context that is currently using the API.
add_task(async function test_storage_sync_on_no_active_context() {
const extensionId = "sync@mochi.test";
const extension = ExtensionTestUtils.loadExtension({
useAddonManager: "temporary",
manifest: {
permissions: ["storage"],
browser_specific_settings: { gecko: { id: extensionId } },
},
files: {
"ext-page.html": `<!DOCTYPE html>
<html>
<head>
<script src="ext-page.js"></script>
</head>
</html>
`,
"ext-page.js": function () {
const { browser } = this;
browser.test.onMessage.addListener(async msg => {
if (msg === "get-sync-data") {
browser.test.sendMessage(
"get-sync-data:done",
await browser.storage.sync.get(["remote-key"])
);
}
});
},
},
});
await extension.startup();
await withServer(async server => {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
server.installCollection("storage-sync-crypto");
await extensionStorageSync.ensureCanSync([extensionId]);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
let transformer = new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
);
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 6,
},
predicate: appearsAt(850),
});
server.etag = 1000;
await extensionStorageSync.syncAll();
}
);
});
const extPage = await ExtensionTestUtils.loadContentPage(
`moz-extension://${extension.uuid}/ext-page.html`,
{ extension }
);
await extension.sendMessage("get-sync-data");
const res = await extension.awaitMessage("get-sync-data:done");
Assert.deepEqual(res, { "remote-key": 6 }, "Got the expected sync data");
await extPage.close();
await extension.unload();
});
add_task(async function test_storage_sync_pushes_changes() {
// FIXME: This test relies on the fact that previous tests pushed
// keys and salts for the default extension ID
const extension = defaultExtension;
const extensionId = defaultExtensionId;
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
server.installCollection(collectionId);
server.installCollection("storage-sync-crypto");
server.etag = 1000;
await extensionStorageSync.set(extension, { "my-key": 5 }, context);
// install this AFTER we set the key to 5...
let calls = [];
extensionStorageSync.addOnChangedListener(
extension,
function () {
calls.push(arguments);
},
context
);
await extensionStorageSync.syncAll();
const localValue = (
await extensionStorageSync.get(extension, "my-key", context)
)["my-key"];
equal(
localValue,
5,
"pushing an ExtensionStorageSync value shouldn't change local value"
);
const hashedId =
"id-" +
(await cryptoCollection.hashWithExtensionSalt(
"key-my_2D_key",
extensionId
));
let posts = server.getPosts();
// FIXME: Keys were pushed in a previous test
equal(
posts.length,
1,
"pushing a value should cause a post to the server"
);
const post = posts[0];
assertPostedNewRecord(post);
equal(
post.path,
`${collectionRecordsPath(collectionId)}/${hashedId}`,
"pushing a value should have a path corresponding to its id"
);
const encrypted = post.body.data;
ok(
encrypted.ciphertext,
"pushing a value should post an encrypted record"
);
ok(
!encrypted.data,
"pushing a value should not have any plaintext data"
);
equal(
encrypted.id,
hashedId,
"pushing a value should use a kinto-friendly record ID"
);
const record = await assertExtensionRecord(
fxaService,
post,
extension,
"my-key"
);
equal(
record.data,
5,
"when decrypted, a pushed value should have a data field corresponding to its storage.sync value"
);
equal(
record.id,
"key-my_2D_key",
"when decrypted, a pushed value should have an id field corresponding to its record ID"
);
equal(
calls.length,
0,
"pushing a value shouldn't call the on-changed listener"
);
await extensionStorageSync.set(extension, { "my-key": 6 }, context);
await extensionStorageSync.syncAll();
// Doesn't push keys because keys were pushed by a previous test.
posts = server.getPosts();
equal(posts.length, 2, "updating a value should trigger another push");
const updatePost = posts[1];
assertPostedUpdatedRecord(updatePost, 1000);
equal(
updatePost.path,
`${collectionRecordsPath(collectionId)}/${hashedId}`,
"pushing an updated value should go to the same path"
);
const updateEncrypted = updatePost.body.data;
ok(
updateEncrypted.ciphertext,
"pushing an updated value should still be encrypted"
);
ok(
!updateEncrypted.data,
"pushing an updated value should not have any plaintext visible"
);
equal(
updateEncrypted.id,
hashedId,
"pushing an updated value should maintain the same ID"
);
}
);
});
});
add_task(async function test_storage_sync_retries_failed_auth() {
const extensionId = uuid();
const extension = { id: extensionId };
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
server.installCollection("storage-sync-crypto");
await extensionStorageSync.ensureCanSync([extensionId]);
await extensionStorageSync.set(extension, { "my-key": 5 }, context);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
let transformer = new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
);
// Put a remote record just to verify that eventually we succeeded
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 6,
},
predicate: appearsAt(850),
});
server.etag = 900;
// This is a typical response from a production stack if your
// bearer token is bad.
server.rejectNextAuthWith(
'{"code": 401, "errno": 104, "error": "Unauthorized", "message": "Please authenticate yourself to use this endpoint"}'
);
await extensionStorageSync.syncAll();
equal(server.failedAuths.length, 1, "an auth was failed");
const remoteValue = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(
remoteValue,
6,
"ExtensionStorageSync.get() returns value retrieved from sync"
);
// Try again with an emptier JSON body to make sure this still
// works with a less-cooperative server.
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 7,
},
predicate: appearsAt(950),
});
server.etag = 1000;
// Need to write a JSON response.
// kinto.js 9.0.2 doesn't throw unless there's json.
// See https://github.com/Kinto/kinto-http.js/issues/192.
server.rejectNextAuthWith("{}");
await extensionStorageSync.syncAll();
equal(server.failedAuths.length, 2, "an auth was failed");
const newRemoteValue = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(
newRemoteValue,
7,
"ExtensionStorageSync.get() returns value retrieved from sync"
);
}
);
});
});
add_task(async function test_storage_sync_pulls_conflicts() {
const extensionId = uuid();
const extension = { id: extensionId };
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
server.installCollection("storage-sync-crypto");
await extensionStorageSync.ensureCanSync([extensionId]);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
let transformer = new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
);
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 6,
},
predicate: appearsAt(850),
});
server.etag = 900;
await extensionStorageSync.set(extension, { "remote-key": 8 }, context);
let calls = [];
await extensionStorageSync.addOnChangedListener(
extension,
function () {
calls.push(arguments);
},
context
);
await extensionStorageSync.syncAll();
const remoteValue = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(remoteValue, 8, "locally set value overrides remote value");
equal(calls.length, 1, "conflicts manifest in on-changed listener");
deepEqual(calls[0][0], { "remote-key": { newValue: 8 } });
calls = [];
// Syncing again doesn't do anything
await extensionStorageSync.syncAll();
equal(
calls.length,
0,
"syncing again shouldn't call on-changed listener"
);
// Updating the server causes us to pull down the new value
server.etag = 1000;
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-remote_2D_key",
key: "remote-key",
data: 7,
},
predicate: appearsAt(950),
});
await extensionStorageSync.syncAll();
const remoteValue2 = (
await extensionStorageSync.get(extension, "remote-key", context)
)["remote-key"];
equal(
remoteValue2,
7,
"conflicts do not prevent retrieval of new values"
);
equal(calls.length, 1, "syncing calls on-changed listener on update");
deepEqual(calls[0][0], { "remote-key": { oldValue: 8, newValue: 7 } });
}
);
});
});
add_task(async function test_storage_sync_pulls_deletes() {
const extension = defaultExtension;
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
defaultExtensionId
);
server.installCollection(collectionId);
server.installCollection("storage-sync-crypto");
await extensionStorageSync.set(extension, { "my-key": 5 }, context);
await extensionStorageSync.syncAll();
server.clearPosts();
let calls = [];
await extensionStorageSync.addOnChangedListener(
extension,
function () {
calls.push(arguments);
},
context
);
const transformer = new CollectionKeyEncryptionRemoteTransformer(
new CryptoCollection(fxaService),
await cryptoCollection.getKeyRing(),
extension.id
);
await server.encryptAndAddRecord(transformer, {
collectionId,
data: {
id: "key-my_2D_key",
data: 6,
_status: "deleted",
},
});
await extensionStorageSync.syncAll();
const remoteValues = await extensionStorageSync.get(
extension,
"my-key",
context
);
ok(
!remoteValues["my-key"],
"ExtensionStorageSync.get() shows value was deleted by sync"
);
equal(
server.getPosts().length,
0,
"pulling the delete shouldn't cause posts"
);
equal(calls.length, 1, "syncing calls on-changed listener");
deepEqual(calls[0][0], { "my-key": { oldValue: 5 } });
calls = [];
// Syncing again doesn't do anything
await extensionStorageSync.syncAll();
equal(
calls.length,
0,
"syncing again shouldn't call on-changed listener"
);
}
);
});
});
add_task(async function test_storage_sync_pushes_deletes() {
const extensionId = uuid();
const extension = { id: extensionId };
await withContextAndServer(async function (context, server) {
await withSignedInUser(
loggedInUser,
async function (extensionStorageSync, fxaService) {
const cryptoCollection = new CryptoCollection(fxaService);
await cryptoCollection._clear();
await cryptoCollection._setSalt(
extensionId,
cryptoCollection.getNewSalt()
);
const collectionId = await cryptoCollection.extensionIdToCollectionId(
extensionId
);
server.installCollection(collectionId);
server.installCollection("storage-sync-crypto");
server.etag = 1000;
await extensionStorageSync.set(extension, { "my-key": 5 }, context);
let calls = [];
extensionStorageSync.addOnChangedListener(
extension,
function () {
calls.push(arguments);
},
context
);
await extensionStorageSync.syncAll();
let posts = server.getPosts();
equal(
posts.length,
2,
"pushing a non-deleted value should post keys and post the value to the server"
);
await extensionStorageSync.remove(extension, ["my-key"], context);
equal(
calls.length,
1,
"deleting a value should call the on-changed listener"
);
await extensionStorageSync.syncAll();
equal(
calls.length,
1,
"pushing a deleted value shouldn't call the on-changed listener"
);
// Doesn't push keys because keys were pushed by a previous test.
const hashedId =
"id-" +
(await cryptoCollection.hashWithExtensionSalt(
"key-my_2D_key",
extensionId
));
posts = server.getPosts();
equal(posts.length, 3, "deleting a value should trigger another push");
const post = posts[2];
assertPostedUpdatedRecord(post, 1000);
equal(
post.path,
`${collectionRecordsPath(collectionId)}/${hashedId}`,
"pushing a deleted value should go to the same path"
);
ok(post.method, "PUT");
ok(
post.body.data.ciphertext,
"deleting a value should have an encrypted body"
);
const decoded = await new CollectionKeyEncryptionRemoteTransformer(
cryptoCollection,
await cryptoCollection.getKeyRing(),
extensionId
).decode(post.body.data);
equal(decoded._status, "deleted");
// Ideally, we'd check that decoded.deleted is not true, because
// the encrypted record shouldn't have it, but the decoder will
// add it when it sees _status == deleted
}
);
});
});
// Some sync tests shared between implementations.
add_task(test_config_flag_needed);
add_task(test_sync_reloading_extensions_works);
add_task(function test_storage_sync() {
return runWithPrefs([[STORAGE_SYNC_PREF, true]], () =>
test_background_page_storage("sync")
);
});
add_task(test_storage_sync_requires_real_id);
add_task(function test_storage_sync_with_bytes_in_use() {
return runWithPrefs([[STORAGE_SYNC_PREF, true]], () =>
test_background_storage_area_with_bytes_in_use("sync", false)
);
});
add_task(function test_storage_onChanged_event_page() {
return runWithPrefs([[STORAGE_SYNC_PREF, true]], () =>
test_storage_change_event_page("sync")
);
});
|