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
|
/* 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/. */
/**
* nsIAutoCompleteResult and nsILoginAutoCompleteSearch implementations for saved logins.
*/
"use strict";
const EXPORTED_SYMBOLS = ["LoginAutoComplete", "LoginAutoCompleteResult"];
const { XPCOMUtils } = ChromeUtils.importESModule(
"resource://gre/modules/XPCOMUtils.sys.mjs"
);
const lazy = {};
XPCOMUtils.defineLazyModuleGetters(lazy, {
InsecurePasswordUtils: "resource://gre/modules/InsecurePasswordUtils.jsm",
LoginFormFactory: "resource://gre/modules/LoginFormFactory.jsm",
LoginHelper: "resource://gre/modules/LoginHelper.jsm",
LoginManagerChild: "resource://gre/modules/LoginManagerChild.jsm",
NewPasswordModel: "resource://gre/modules/NewPasswordModel.jsm",
});
XPCOMUtils.defineLazyServiceGetter(
lazy,
"formFillController",
"@mozilla.org/satchel/form-fill-controller;1",
Ci.nsIFormFillController
);
XPCOMUtils.defineLazyGetter(lazy, "log", () => {
return lazy.LoginHelper.createLogger("LoginAutoComplete");
});
XPCOMUtils.defineLazyGetter(lazy, "passwordMgrBundle", () => {
return Services.strings.createBundle(
"chrome://passwordmgr/locale/passwordmgr.properties"
);
});
XPCOMUtils.defineLazyGetter(lazy, "dateAndTimeFormatter", () => {
return new Services.intl.DateTimeFormat(undefined, {
dateStyle: "medium",
});
});
function loginSort(formHostPort, a, b) {
let maybeHostPortA = lazy.LoginHelper.maybeGetHostPortForURL(a.origin);
let maybeHostPortB = lazy.LoginHelper.maybeGetHostPortForURL(b.origin);
if (formHostPort == maybeHostPortA && formHostPort != maybeHostPortB) {
return -1;
}
if (formHostPort != maybeHostPortA && formHostPort == maybeHostPortB) {
return 1;
}
if (a.httpRealm !== b.httpRealm) {
// Sort HTTP auth. logins after form logins for the same origin.
if (b.httpRealm === null) {
return 1;
}
if (a.httpRealm === null) {
return -1;
}
}
let userA = a.username.toLowerCase();
let userB = b.username.toLowerCase();
if (userA < userB) {
return -1;
}
if (userA > userB) {
return 1;
}
return 0;
}
function findDuplicates(loginList) {
let seen = new Set();
let duplicates = new Set();
for (let login of loginList) {
if (seen.has(login.username)) {
duplicates.add(login.username);
}
seen.add(login.username);
}
return duplicates;
}
function getLocalizedString(key, ...formatArgs) {
if (formatArgs.length) {
return lazy.passwordMgrBundle.formatStringFromName(key, formatArgs);
}
return lazy.passwordMgrBundle.GetStringFromName(key);
}
class AutocompleteItem {
constructor(style) {
this.comment = "";
this.style = style;
this.value = "";
}
removeFromStorage() {
/* Do nothing by default */
}
}
// This item shows icon, title & subtitle.
// Once selected it will send fillMessageName with fillMessageData
// to LoginManagerParent and response will be used to fill into the field.
class GenericAutocompleteItem extends AutocompleteItem {
constructor(icon, title, subtitle, fillMessageName, fillMessageData) {
super("generic");
this.comment = JSON.stringify({
icon,
title,
subtitle,
fillMessageName,
fillMessageData,
});
}
}
class InsecureLoginFormAutocompleteItem extends AutocompleteItem {
constructor() {
super("insecureWarning");
this.label = getLocalizedString(
"insecureFieldWarningDescription2",
getLocalizedString("insecureFieldWarningLearnMore")
);
}
}
class LoginAutocompleteItem extends AutocompleteItem {
login;
#actor;
constructor(
login,
hasBeenTypePassword,
duplicateUsernames,
actor,
isOriginMatched
) {
super("loginWithOrigin");
this.login = login.QueryInterface(Ci.nsILoginMetaInfo);
this.#actor = actor;
const isDuplicateUsername =
login.username && duplicateUsernames.has(login.username);
let username = login.username
? login.username
: getLocalizedString("noUsername");
// If login is empty or duplicated we want to append a modification date to it.
if (!login.username || isDuplicateUsername) {
const time = lazy.dateAndTimeFormatter.format(
new Date(login.timePasswordChanged)
);
username = getLocalizedString("loginHostAge", username, time);
}
this.label = username;
this.value = hasBeenTypePassword ? login.password : login.username;
this.comment = JSON.stringify({
guid: login.guid,
login,
isDuplicateUsername,
isOriginMatched,
comment:
isOriginMatched && login.httpRealm === null
? getLocalizedString("displaySameOrigin")
: login.displayOrigin,
});
}
removeFromStorage() {
if (this.#actor) {
let vanilla = lazy.LoginHelper.loginToVanillaObject(this.login);
this.#actor.sendAsyncMessage("PasswordManager:removeLogin", {
login: vanilla,
});
} else {
Services.logins.removeLogin(this.login);
}
}
}
class GeneratedPasswordAutocompleteItem extends AutocompleteItem {
constructor(generatedPassword, willAutoSaveGeneratedPassword) {
super("generatedPassword");
this.label = getLocalizedString("useASecurelyGeneratedPassword");
this.value = generatedPassword;
this.comment = JSON.stringify({
generatedPassword,
willAutoSaveGeneratedPassword,
});
}
}
class ImportableLearnMoreAutocompleteItem extends AutocompleteItem {
constructor() {
super("importableLearnMore");
this.comment = JSON.stringify({
fillMessageName: "PasswordManager:OpenImportableLearnMore",
});
}
}
class ImportableLoginsAutocompleteItem extends AutocompleteItem {
#actor;
constructor(browserId, hostname, actor) {
super("importableLogins");
this.label = browserId;
this.comment = JSON.stringify({
hostname,
fillMessageName: "PasswordManager:HandleImportable",
fillMessageData: {
browserId,
},
});
this.#actor = actor;
// This is sent for every item (re)shown, but the parent will debounce to
// reduce the count by 1 total.
this.#actor.sendAsyncMessage(
"PasswordManager:decreaseSuggestImportCount",
1
);
}
removeFromStorage() {
this.#actor.sendAsyncMessage(
"PasswordManager:decreaseSuggestImportCount",
100
);
}
}
class LoginsFooterAutocompleteItem extends AutocompleteItem {
constructor(formHostname, telemetryEventData) {
super("loginsFooter");
this.label = getLocalizedString("viewSavedLogins.label");
// The comment field of `loginsFooter` results have many additional pieces of
// information for telemetry purposes. After bug 1555209, this information
// can be passed to the parent process outside of nsIAutoCompleteResult APIs
// so we won't need this hack.
this.comment = JSON.stringify({
telemetryEventData,
formHostname,
fillMessageName: "PasswordManager:OpenPreferences",
fillMessageData: {
entryPoint: "autocomplete",
},
});
}
}
// nsIAutoCompleteResult implementation
class LoginAutoCompleteResult {
#rows = [];
constructor(
aSearchString,
matchingLogins,
autocompleteItems,
formOrigin,
{
generatedPassword,
willAutoSaveGeneratedPassword,
importable,
isSecure,
actor,
hasBeenTypePassword,
hostname,
telemetryEventData,
}
) {
let hidingFooterOnPWFieldAutoOpened = false;
const importableBrowsers =
importable?.state === "import" && importable?.browsers;
function isFooterEnabled() {
// We need to check LoginHelper.enabled here since the insecure warning should
// appear even if pwmgr is disabled but the footer should never appear in that case.
if (
!lazy.LoginHelper.showAutoCompleteFooter ||
!lazy.LoginHelper.enabled
) {
return false;
}
// Don't show the footer on non-empty password fields as it's not providing
// value and only adding noise since a password was already filled.
if (hasBeenTypePassword && aSearchString && !generatedPassword) {
lazy.log.debug("Hiding footer: non-empty password field");
return false;
}
if (
!autocompleteItems?.length &&
!importableBrowsers &&
!matchingLogins.length &&
!generatedPassword &&
hasBeenTypePassword &&
lazy.formFillController.passwordPopupAutomaticallyOpened
) {
hidingFooterOnPWFieldAutoOpened = true;
lazy.log.debug(
"Hiding footer: no logins and the popup was opened upon focus of the pw. field"
);
return false;
}
return true;
}
this.searchString = aSearchString;
// Insecure field warning comes first.
if (!isSecure) {
this.#rows.push(new InsecureLoginFormAutocompleteItem());
}
// Saved login items
let formHostPort = lazy.LoginHelper.maybeGetHostPortForURL(formOrigin);
let logins = matchingLogins.sort(loginSort.bind(null, formHostPort));
let duplicateUsernames = findDuplicates(matchingLogins);
for (let login of logins) {
let item = new LoginAutocompleteItem(
login,
hasBeenTypePassword,
duplicateUsernames,
actor,
lazy.LoginHelper.isOriginMatching(login.origin, formOrigin, {
schemeUpgrades: lazy.LoginHelper.schemeUpgrades,
})
);
this.#rows.push(item);
}
// The footer comes last if it's enabled
if (isFooterEnabled()) {
if (autocompleteItems) {
this.#rows.push(
...autocompleteItems.map(
item =>
new GenericAutocompleteItem(
item.icon,
item.title,
item.subtitle,
item.fillMessageName,
item.fillMessageData
)
)
);
}
if (generatedPassword) {
this.#rows.push(
new GeneratedPasswordAutocompleteItem(
generatedPassword,
willAutoSaveGeneratedPassword
)
);
}
// Suggest importing logins if there are none found.
if (!logins.length && importableBrowsers) {
this.#rows.push(
...importableBrowsers.map(
browserId =>
new ImportableLoginsAutocompleteItem(browserId, hostname, actor)
)
);
this.#rows.push(new ImportableLearnMoreAutocompleteItem());
}
// If we have anything in autocomplete, then add "View Saved Logins"
this.#rows.push(
new LoginsFooterAutocompleteItem(hostname, telemetryEventData)
);
}
// Determine the result code and default index.
if (this.matchCount > 0) {
this.searchResult = Ci.nsIAutoCompleteResult.RESULT_SUCCESS;
this.defaultIndex = 0;
} else if (hidingFooterOnPWFieldAutoOpened) {
// We use a failure result so that the empty results aren't re-used for when
// the user tries to manually open the popup (we want the footer in that case).
this.searchResult = Ci.nsIAutoCompleteResult.RESULT_FAILURE;
this.defaultIndex = -1;
}
}
QueryInterface = ChromeUtils.generateQI([
"nsIAutoCompleteResult",
"nsISupportsWeakReference",
]);
/**
* Accessed via .wrappedJSObject
* @private
*/
get logins() {
return this.#rows
.filter(item => item instanceof LoginAutocompleteItem)
.map(item => item.login);
}
// Allow autoCompleteSearch to get at the JS object so it can
// modify some readonly properties for internal use.
get wrappedJSObject() {
return this;
}
// Interfaces from idl...
searchString = null;
searchResult = Ci.nsIAutoCompleteResult.RESULT_NOMATCH;
defaultIndex = -1;
errorDescription = "";
get matchCount() {
return this.#rows.length;
}
#throwOnBadIndex(index) {
if (index < 0 || index >= this.matchCount) {
throw new Error("Index out of range.");
}
}
getValueAt(index) {
this.#throwOnBadIndex(index);
return this.#rows[index].value;
}
getLabelAt(index) {
this.#throwOnBadIndex(index);
return this.#rows[index].label;
}
getCommentAt(index) {
this.#throwOnBadIndex(index);
return this.#rows[index].comment;
}
getStyleAt(index) {
this.#throwOnBadIndex(index);
return this.#rows[index].style;
}
getImageAt(index) {
this.#throwOnBadIndex(index);
return "";
}
getFinalCompleteValueAt(index) {
return this.getValueAt(index);
}
isRemovableAt(index) {
this.#throwOnBadIndex(index);
return true;
}
removeValueAt(index) {
this.#throwOnBadIndex(index);
let [removedItem] = this.#rows.splice(index, 1);
if (this.defaultIndex > this.#rows.length) {
this.defaultIndex--;
}
removedItem.removeFromStorage();
}
}
class LoginAutoComplete {
// HTMLInputElement to number, the element's new-password heuristic confidence score
#cachedNewPasswordScore = new WeakMap();
#autoCompleteLookupPromise = null;
classID = Components.ID("{2bdac17c-53f1-4896-a521-682ccdeef3a8}");
QueryInterface = ChromeUtils.generateQI(["nsILoginAutoCompleteSearch"]);
/**
* Yuck. This is called directly by satchel:
* nsFormFillController::StartSearch()
* [toolkit/components/satchel/nsFormFillController.cpp]
*
* We really ought to have a simple way for code to register an
* auto-complete provider, and not have satchel calling pwmgr directly.
*
* @param {string} aSearchString The value typed in the field.
* @param {nsIAutoCompleteResult} aPreviousResult
* @param {HTMLInputElement} aElement
* @param {nsIFormAutoCompleteObserver} aCallback
*/
startSearch(aSearchString, aPreviousResult, aElement, aCallback) {
let { isNullPrincipal } = aElement.nodePrincipal;
if (
aElement.nodePrincipal.schemeIs("about") ||
aElement.nodePrincipal.isSystemPrincipal
) {
// Don't show autocomplete results for about: pages.
// XXX: Don't we need to call the callback here?
return;
}
let searchStartTimeMS = Services.telemetry.msSystemNow();
// Show the insecure login warning in the passwords field on null principal documents.
// Avoid loading InsecurePasswordUtils.jsm in a sandboxed document (e.g. an ad. frame) if we
// already know it has a null principal and will therefore get the insecure autocomplete
// treatment.
// InsecurePasswordUtils doesn't handle the null principal case as not secure because we don't
// want the same treatment:
// * The web console warnings will be confusing (as they're primarily about http:) and not very
// useful if the developer intentionally sandboxed the document.
// * The site identity insecure field warning would require LoginManagerChild being loaded and
// listening to some of the DOM events we're ignoring in null principal documents. For memory
// reasons it's better to not load LMC at all for these sandboxed frames. Also, if the top-
// document is sandboxing a document, it probably doesn't want that sandboxed document to be
// able to affect the identity icon in the address bar by adding a password field.
let form = lazy.LoginFormFactory.createFromField(aElement);
let isSecure =
!isNullPrincipal && lazy.InsecurePasswordUtils.isFormSecure(form);
let { hasBeenTypePassword } = aElement;
let hostname = aElement.ownerDocument.documentURIObject.host;
let formOrigin = lazy.LoginHelper.getLoginOrigin(
aElement.ownerDocument.documentURI
);
let loginManagerActor = lazy.LoginManagerChild.forWindow(
aElement.ownerGlobal
);
let completeSearch = async autoCompleteLookupPromise => {
// Assign to the member synchronously before awaiting the Promise.
this.#autoCompleteLookupPromise = autoCompleteLookupPromise;
let {
generatedPassword,
importable,
logins,
autocompleteItems,
willAutoSaveGeneratedPassword,
} = await autoCompleteLookupPromise;
// If the search was canceled before we got our
// results, don't bother reporting them.
// N.B. This check must occur after the `await` above for it to be
// effective.
if (this.#autoCompleteLookupPromise !== autoCompleteLookupPromise) {
lazy.log.debug("Ignoring result from previous search.");
return;
}
let telemetryEventData = {
acFieldName: aElement.getAutocompleteInfo().fieldName,
hadPrevious: !!aPreviousResult,
typeWasPassword: aElement.hasBeenTypePassword,
fieldType: aElement.type,
searchStartTimeMS,
stringLength: aSearchString.length,
};
this.#autoCompleteLookupPromise = null;
let results = new LoginAutoCompleteResult(
aSearchString,
logins,
autocompleteItems,
formOrigin,
{
generatedPassword,
willAutoSaveGeneratedPassword,
importable,
actor: loginManagerActor,
isSecure,
hasBeenTypePassword,
hostname,
telemetryEventData,
}
);
aCallback.onSearchCompletion(results);
};
if (isNullPrincipal) {
// Don't search login storage when the field has a null principal as we don't want to fill
// logins for the `location` in this case.
completeSearch(Promise.resolve({ logins: [] }));
return;
}
if (
hasBeenTypePassword &&
aSearchString &&
!loginManagerActor.isPasswordGenerationForcedOn(aElement)
) {
// Return empty result on password fields with password already filled,
// unless password generation was forced.
completeSearch(Promise.resolve({ logins: [] }));
return;
}
if (!lazy.LoginHelper.enabled) {
completeSearch(Promise.resolve({ logins: [] }));
return;
}
let previousResult;
if (aPreviousResult) {
previousResult = {
searchString: aPreviousResult.searchString,
logins: lazy.LoginHelper.loginsToVanillaObjects(
aPreviousResult.wrappedJSObject.logins
),
};
} else {
previousResult = null;
}
let acLookupPromise = this.#requestAutoCompleteResultsFromParent({
searchString: aSearchString,
previousResult,
inputElement: aElement,
form,
hasBeenTypePassword,
});
completeSearch(acLookupPromise).catch(lazy.log.error.bind(lazy.log));
}
stopSearch() {
this.#autoCompleteLookupPromise = null;
}
async #requestAutoCompleteResultsFromParent({
searchString,
previousResult,
inputElement,
form,
hasBeenTypePassword,
}) {
let actionOrigin = lazy.LoginHelper.getFormActionOrigin(form);
let autocompleteInfo = inputElement.getAutocompleteInfo();
let loginManagerActor = lazy.LoginManagerChild.forWindow(
inputElement.ownerGlobal
);
let forcePasswordGeneration = false;
let isProbablyANewPasswordField = false;
if (hasBeenTypePassword) {
forcePasswordGeneration = loginManagerActor.isPasswordGenerationForcedOn(
inputElement
);
// Run the Fathom model only if the password field does not have the
// autocomplete="new-password" attribute.
isProbablyANewPasswordField =
autocompleteInfo.fieldName == "new-password" ||
this.isProbablyANewPasswordField(inputElement);
}
const scenario = loginManagerActor.getScenario(inputElement);
const messageData = {
actionOrigin,
searchString,
previousResult,
forcePasswordGeneration,
hasBeenTypePassword,
isProbablyANewPasswordField,
scenarioName: scenario?.constructor.name,
};
if (lazy.LoginHelper.showAutoCompleteFooter) {
gAutoCompleteListener.init();
}
lazy.log.debug("LoginAutoComplete search:", {
forcePasswordGeneration,
hasBeenTypePassword,
isProbablyANewPasswordField,
searchStringLength: searchString.length,
});
let result = await loginManagerActor.sendQuery(
"PasswordManager:autoCompleteLogins",
messageData
);
return {
generatedPassword: result.generatedPassword,
importable: result.importable,
autocompleteItems: result.autocompleteItems,
logins: lazy.LoginHelper.vanillaObjectsToLogins(result.logins),
willAutoSaveGeneratedPassword: result.willAutoSaveGeneratedPassword,
};
}
isProbablyANewPasswordField(inputElement) {
const threshold = lazy.LoginHelper.generationConfidenceThreshold;
if (threshold == -1) {
// Fathom is disabled
return false;
}
let score = this.#cachedNewPasswordScore.get(inputElement);
if (score) {
return score >= threshold;
}
const { rules, type } = lazy.NewPasswordModel;
const results = rules.against(inputElement);
score = results.get(inputElement).scoreFor(type);
this.#cachedNewPasswordScore.set(inputElement, score);
return score >= threshold;
}
}
let gAutoCompleteListener = {
added: false,
fillRequestId: 0,
init() {
if (!this.added) {
Services.obs.addObserver(this, "autocomplete-will-enter-text");
this.added = true;
}
},
async observe(subject, topic, data) {
switch (topic) {
case "autocomplete-will-enter-text": {
await this.sendFillRequestToLoginManagerParent(subject, data);
break;
}
}
},
async sendFillRequestToLoginManagerParent(input, comment) {
if (!comment) {
return;
}
if (input != lazy.formFillController.controller.input) {
return;
}
const { fillMessageName, fillMessageData } = JSON.parse(comment ?? "{}");
if (!fillMessageName) {
return;
}
this.fillRequestId++;
const fillRequestId = this.fillRequestId;
const child = lazy.LoginManagerChild.forWindow(
input.focusedInput.ownerGlobal
);
const value = await child.sendQuery(fillMessageName, fillMessageData ?? {});
// skip fill if another fill operation started during await
if (fillRequestId != this.fillRequestId) {
return;
}
if (typeof value !== "string") {
return;
}
// If LoginManagerParent returned a string to fill, we must do it here because
// nsAutoCompleteController.cpp already finished it's work before we finished await.
input.textValue = value;
input.selectTextRange(value.length, value.length);
},
};
|