summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/mochitest/test_ext_identity.html
blob: 7aa590ec221e0b792fa963123fcb62e21ff92a7e (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
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
<!DOCTYPE HTML>
<html>
<head>
  <title>Test for WebExtension Identity</title>
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script src="head.js"></script>
  <link rel="stylesheet" href="/tests/SimpleTest/test.css">
</head>
<body>

<script type="text/javascript">
"use strict";

add_task(async function setup() {
  await SpecialPowers.pushPrefEnv({
    set: [
      ["extensions.webextensions.identity.redirectDomain", "example.com"],
      // Disable the network cache first-party partition during this
      // test (TODO: look more closely to how that is affecting the intermittency
      // of this test on MacOS, see Bug 1626482).
      ["privacy.partition.network_state", false],
    ],
  });
});

add_task(async function test_noPermission() {
  let extension = ExtensionTestUtils.loadExtension({
    background() {
      browser.test.assertEq(
        undefined,
        browser.identity,
        "No identity api without permission"
      );
      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_getRedirectURL() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["identity", "https://example.com/"],
    },
    async background() {
      let redirect_base =
        "https://35b64b676900f491c00e7f618d43f7040e88422e.example.com/";
      await browser.test.assertEq(
        redirect_base,
        browser.identity.getRedirectURL(),
        "redirect url ok"
      );
      await browser.test.assertEq(
        redirect_base,
        browser.identity.getRedirectURL(""),
        "redirect url ok"
      );
      await browser.test.assertEq(
        redirect_base + "foobar",
        browser.identity.getRedirectURL("foobar"),
        "redirect url ok"
      );
      await browser.test.assertEq(
        redirect_base + "callback",
        browser.identity.getRedirectURL("/callback"),
        "redirect url ok"
      );
      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_badAuthURI() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["identity", "https://example.com/"],
    },
    async background() {
      for (let url of [
        "foobar",
        "about:addons",
        "about:blank",
        "ftp://example.com/test",
      ]) {
        await browser.test.assertThrows(
          () => {
            browser.identity.launchWebAuthFlow({ interactive: true, url });
          },
          /Type error for parameter details/,
          "details.url is invalid"
        );
      }

      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_badRequestURI() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["identity", "https://example.com/"],
    },
    async background() {
      let base_uri =
        "https://example.com/tests/toolkit/components/extensions/test/mochitest/";
      let url = `${base_uri}?redirect_uri=badrobot}`;
      await browser.test.assertRejects(
        browser.identity.launchWebAuthFlow({ interactive: true, url }),
        "redirect_uri is invalid",
        "invalid redirect url"
      );
      url = `${base_uri}?redirect_uri=https://somesite.com`;
      await browser.test.assertRejects(
        browser.identity.launchWebAuthFlow({ interactive: true, url }),
        "redirect_uri not allowed",
        "invalid redirect url"
      );
      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function background_launchWebAuthFlow_requires_interaction() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["identity", "https://example.com/"],
    },
    async background() {
      let base_uri =
        "https://example.com/tests/toolkit/components/extensions/test/mochitest/";
      let url = `${base_uri}?redirect_uri=${browser.identity.getRedirectURL(
        "redirect"
      )}`;
      await browser.test.assertRejects(
        browser.identity.launchWebAuthFlow({ interactive: false, url }),
        "Requires user interaction",
        "Rejects on required user interaction"
      );
      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

function background_launchWebAuthFlow({
  interactive = false,
  path = "redirect_auto.sjs",
  params = {},
  redirect = true,
  useRedirectUri = true,
} = {}) {
  let uri_path = useRedirectUri ? "identity_cb" : "";
  let expected_redirect = `https://35b64b676900f491c00e7f618d43f7040e88422e.example.com/${uri_path}`;
  let base_uri =
    "https://example.com/tests/toolkit/components/extensions/test/mochitest/";
  let redirect_uri = browser.identity.getRedirectURL(
    useRedirectUri ? uri_path : undefined
  );
  browser.test.assertEq(
    expected_redirect,
    redirect_uri,
    "expected redirect uri matches hash"
  );
  let url = `${base_uri}${path}`;
  if (useRedirectUri) {
    params.redirect_uri = redirect_uri;
  } else {
    // We kind of fake it with the redirect url that would normally be configured
    // in the oauth service.  This does still test that the identity service falls back
    // to the extensions redirect url.
    params.default_redirect = expected_redirect;
  }
  if (!redirect) {
    params.no_redirect = 1;
  }
  let query = [];
  for (let [param, value] of Object.entries(params)) {
    query.push(`${param}=${encodeURIComponent(value)}`);
  }
  url = `${url}?${query.join("&")}`;

  // Ensure we do not start the actual request for the redirect url.  In the case
  // of a 303 POST redirect we are getting a request started.
  let watchRedirectRequest = () => {};
  if (params.post !== 303) {
    watchRedirectRequest = details => {
      if (details.url.startsWith(expected_redirect)) {
        browser.test.fail(`onBeforeRequest called for redirect url: ${JSON.stringify(details)}`);
      }
    };

    browser.webRequest.onBeforeRequest.addListener(
      watchRedirectRequest,
      {
        urls: [
          "https://35b64b676900f491c00e7f618d43f7040e88422e.example.com/*",
        ],
      }
    );
  }

  browser.identity
    .launchWebAuthFlow({ interactive, url })
    .then(redirectURL => {
      browser.test.assertTrue(
        redirectURL.startsWith(redirect_uri),
        `correct redirect url ${redirectURL}`
      );
      if (redirect) {
        let url = new URL(redirectURL);
        browser.test.assertEq(
          "here ya go",
          url.searchParams.get("access_token"),
          "Handled auto redirection"
        );
      }
    })
    .catch(error => {
      if (redirect) {
        browser.test.fail(error.message);
      } else {
        browser.test.assertEq(
          "Requires user interaction",
          error.message,
          "Auth page loaded, interaction required."
        );
      }
    }).then(() => {
      browser.webRequest.onBeforeRequest.removeListener(watchRedirectRequest);
      browser.test.sendMessage("done");
    });
}

// Tests the situation where the oauth provider has already granted access and
// simply redirects the oauth client to provide the access key or code.
add_task(async function test_autoRedirect() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["webRequest", "identity", "https://*.example.com/*"],
    },
    background: `(${background_launchWebAuthFlow})()`,
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_autoRedirect_noRedirectURI() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["webRequest", "identity", "https://*.example.com/*"],
    },
    background: `(${background_launchWebAuthFlow})({useRedirectUri: false})`,
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

// Tests the situation where the oauth provider has not granted access and interactive=false
add_task(async function test_noRedirect() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["webRequest", "identity", "https://*.example.com/*"],
    },
    background: `(${background_launchWebAuthFlow})({redirect: false})`,
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

// Tests the situation where the oauth provider must show a window where
// presumably the user interacts, then the redirect occurs and access key or
// code is provided.  We bypass any real interaction, but want the window to
// open and result in a redirect.
add_task(async function test_interaction() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["webRequest", "identity", "https://*.example.com/*"],
    },
    background: `(${background_launchWebAuthFlow})({interactive: true, path: "oauth.html"})`,
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

// Tests the situation where the oauth provider redirects with a 303.
add_task(async function test_auto303Redirect() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["webRequest", "identity", "https://*.example.com/*"],
    },
    background: `(${background_launchWebAuthFlow})({interactive: true, path: "oauth.html", params: {post: 303, server_uri: "redirect_auto.sjs"}})`,
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_loopbackRedirectURI() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "identity@mozilla.org",
        },
      },
      permissions: ["identity"],
    },
    async background() {
      let redirectURL = "http://127.0.0.1/mozoauth2/35b64b676900f491c00e7f618d43f7040e88422e";
      let actualRedirect = await browser.identity.launchWebAuthFlow({
        interactive: true,
        url: `https://example.com/tests/toolkit/components/extensions/test/mochitest/oauth.html?redirect_uri=${encodeURIComponent(redirectURL)}`
      }).catch(error => {
        browser.test.fail(error.message)
      });
      browser.test.assertTrue(
        actualRedirect.startsWith(redirectURL),
        "Expected redirect url to be loopback address"
      )
      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});
</script>

</body>
</html>