summaryrefslogtreecommitdiffstats
path: root/dom/security/test/unit/test_deserialization_format_before_100.js
blob: a21ae4838ac17bd9382b65c7eb294e0d8ce70341 (plain)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const ReferrerInfo = Components.Constructor(
  "@mozilla.org/referrer-info;1",
  "nsIReferrerInfo",
  "init"
);

async function runTest(setupFunc, expected) {
  let objectOutStream = Cc["@mozilla.org/binaryoutputstream;1"].createInstance(
    Ci.nsIObjectOutputStream
  );
  let pipe = Cc["@mozilla.org/pipe;1"].createInstance(Ci.nsIPipe);
  pipe.init(
    false /* non-blocking input */,
    false /* non-blocking output */,
    0 /* segment size */,
    0 /* max segments */
  );
  objectOutStream.setOutputStream(pipe.outputStream);

  setupFunc(objectOutStream);

  let objectInStream = Cc["@mozilla.org/binaryinputstream;1"].createInstance(
    Ci.nsIObjectInputStream
  );
  objectInStream.setInputStream(pipe.inputStream);

  let referrerInfo = new ReferrerInfo(Ci.nsIReferrerInfo.EMPTY);
  try {
    referrerInfo.read(objectInStream);
  } catch (e) {
    Assert.ok(false, "Shouldn't fail when deserializing.");
    return;
  }

  Assert.ok(true, "Successfully deserialize the referrerInfo.");

  let { referrerPolicy, sendReferrer, computedReferrerSpec } = expected;
  Assert.equal(
    referrerInfo.referrerPolicy,
    referrerPolicy,
    "The referrerInfo has the expected referrer policy."
  );

  Assert.equal(
    referrerInfo.sendReferrer,
    sendReferrer,
    "The referrerInfo has the expected sendReferrer value."
  );

  if (computedReferrerSpec) {
    Assert.equal(
      referrerInfo.computedReferrerSpec,
      computedReferrerSpec,
      "The referrerInfo has the expected computedReferrerSpec value."
    );
  }
}

// Test deserializing referrer info with the old format.
add_task(async function test_deserializeOldReferrerInfo() {
  // Test with a regular old format.
  await runTest(
    stream => {
      // Write to the output stream with the old format.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.writeBoolean(false); // sendReferrer
      stream.writeBoolean(false); // isComputed
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: false,
    }
  );

  // Test with an old format with `sendReferrer` is true.
  await runTest(
    stream => {
      // Write to the output stream with the old format.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.writeBoolean(true); // sendReferrer
      stream.writeBoolean(false); // isComputed
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: true,
    }
  );

  // Test with an old format with a computed Referrer.
  await runTest(
    stream => {
      // Write to the output stream with the old format with a string.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.writeBoolean(false); // sendReferrer
      stream.writeBoolean(true); // isComputed
      stream.writeStringZ("https://example.com/"); // computedReferrer
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: false,
      computedReferrerSpec: "https://example.com/",
    }
  );

  // Test with an old format with a computed Referrer and sendReferrer as true.
  await runTest(
    stream => {
      // Write to the output stream with the old format with a string.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.writeBoolean(true); // sendReferrer
      stream.writeBoolean(true); // isComputed
      stream.writeStringZ("https://example.com/"); // computedReferrer
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: true,
      computedReferrerSpec: "https://example.com/",
    }
  );
});

// Test deserializing referrer info with the current format.
add_task(async function test_deserializeReferrerInfo() {
  // Test with a current format.
  await runTest(
    stream => {
      // Write to the output stream with the new format.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // original policy
      stream.writeBoolean(false); // sendReferrer
      stream.writeBoolean(false); // isComputed
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: false,
    }
  );

  // Test with a current format with sendReferrer as true.
  await runTest(
    stream => {
      // Write to the output stream with the new format.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // original policy
      stream.writeBoolean(true); // sendReferrer
      stream.writeBoolean(false); // isComputed
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: true,
    }
  );

  // Test with a current format with a computedReferrer.
  await runTest(
    stream => {
      // Write to the output stream with the new format with a string.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // original policy
      stream.writeBoolean(false); // sendReferrer
      stream.writeBoolean(true); // isComputed
      stream.writeStringZ("https://example.com/"); // computedReferrer
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: false,
      computedReferrerSpec: "https://example.com/",
    }
  );

  // Test with a current format with a computedReferrer and sendReferrer as true.
  await runTest(
    stream => {
      // Write to the output stream with the new format with a string.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // policy
      stream.write32(Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN); // original policy
      stream.writeBoolean(true); // sendReferrer
      stream.writeBoolean(true); // isComputed
      stream.writeStringZ("https://example.com/"); // computedReferrer
      stream.writeBoolean(true); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.STRICT_ORIGIN_WHEN_CROSS_ORIGIN,
      sendReferrer: true,
      computedReferrerSpec: "https://example.com/",
    }
  );

  // Test with a current format that the tailing bytes are all zero.
  await runTest(
    stream => {
      // Write to the output stream with the new format with a string.
      stream.writeBoolean(true); // nonNull
      stream.writeStringZ("https://example.com/"); // spec
      stream.write32(Ci.nsIReferrerInfo.EMPTY); // policy
      stream.write32(Ci.nsIReferrerInfo.EMPTY); // original policy
      stream.writeBoolean(false); // sendReferrer
      stream.writeBoolean(false); // isComputed
      stream.writeBoolean(false); // initialized
      stream.writeBoolean(false); // overridePolicyByDefault
    },
    {
      referrerPolicy: Ci.nsIReferrerInfo.EMPTY,
      sendReferrer: false,
    }
  );
});