Source code
Revision control
Copy as Markdown
Other Tools
/* 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,
/* global gSubDialog, LoginHelper */
import { Preferences } from "chrome://global/content/preferences/Preferences.mjs";
import { SettingGroupManager } from "chrome://browser/content/preferences/config/SettingGroupManager.mjs";
const XPCOMUtils = ChromeUtils.importESModule(
"resource://gre/modules/XPCOMUtils.sys.mjs"
).XPCOMUtils;
const FormAutofill = ChromeUtils.importESModule(
"resource://autofill/FormAutofill.sys.mjs"
).FormAutofill;
const FormAutofillUtils = ChromeUtils.importESModule(
"resource://gre/modules/shared/FormAutofillUtils.sys.mjs"
).FormAutofillUtils;
const { AppConstants } = ChromeUtils.importESModule(
"resource://gre/modules/AppConstants.sys.mjs"
);
const lazy = XPCOMUtils.declareLazy({
AppConstants: "resource://gre/modules/AppConstants.sys.mjs",
OSKeyStore: "resource://gre/modules/OSKeyStore.sys.mjs",
LoginHelper: "resource://gre/modules/LoginHelper.sys.mjs",
FormAutofillPreferences:
"resource://autofill/FormAutofillPreferences.sys.mjs",
});
ChromeUtils.defineLazyGetter(lazy, "AboutLoginsL10n", () => {
return new Localization(["branding/brand.ftl", "browser/aboutLogins.ftl"]);
});
export class PasswordSettingHelpers {
/**
* Displays a dialog in which the user can view and modify the list of sites
* where passwords are never saved.
*/
static showPasswordExceptions() {
let params = {
blockVisible: true,
sessionVisible: false,
allowVisible: false,
hideStatusColumn: true,
prefilledHost: "",
permissionType: "login-saving",
};
gSubDialog.open(
"chrome://browser/content/preferences/dialogs/permissions.xhtml",
undefined,
params
);
}
/**
* Shows the sites where the user has saved passwords and the associated login
* information.
*/
static showPasswords() {
let loginManager = window.windowGlobalChild.getActor("LoginManager");
loginManager.sendAsyncMessage("PasswordManager:OpenPreferences", {
entryPoint: "Preferences",
});
}
/**
* Displays a dialog in which the primary password may be changed.
*/
static async changeMasterPassword() {
// Require OS authentication before the user can set a Primary Password.
if (!LoginHelper.isPrimaryPasswordSet() && LoginHelper.getOSAuthEnabled()) {
// Uses primary-password-os-auth-dialog-message-win and
// primary-password-os-auth-dialog-message-macosx via concatenation:
let messageId =
"primary-password-os-auth-dialog-message-" + lazy.AppConstants.platform;
let [messageText, captionText] = await document.l10n.formatMessages([
{ id: messageId },
{ id: "master-password-os-auth-dialog-caption" },
]);
let win = Services.wm.getMostRecentBrowserWindow();
// Note on Glean collection: because OSKeyStore.ensureLoggedIn() is not wrapped in
// verifyOSAuth(), it will be documenting "success" for unsupported platforms
// and won't record "fail_error", only "fail_user_canceled"
let loggedIn = await lazy.OSKeyStore.ensureLoggedIn(
messageText.value,
captionText.value,
win,
false
);
const result = loggedIn.authenticated ? "success" : "fail_user_canceled";
Glean.pwmgr.promptShownOsReauth.record({
trigger: "toggle_pref_primary_password",
result,
});
if (!loggedIn.authenticated) {
return;
}
}
gSubDialog.open("chrome://mozapps/content/preferences/changemp.xhtml", {
features: "resizable=no",
closingCallback: () => {
Services.obs.notifyObservers(null, "passwordmgr-primary-pw-changed");
PasswordSettingHelpers._initMasterPasswordUI();
},
});
}
/**
* Displays the "remove master password" dialog to allow the user to remove
* the current master password. When the dialog is dismissed, master password
* UI is automatically updated.
*/
static async _removeMasterPassword() {
const fipsUtils = Cc["@mozilla.org/security/fipsutils;1"].getService(
Ci.nsIFIPSUtils
);
if (fipsUtils.isFIPSEnabled) {
let title = document.getElementById("fips-title").textContent;
let desc = document.getElementById("fips-desc").textContent;
Services.prompt.alert(window, title, desc);
PasswordSettingHelpers._initMasterPasswordUI();
} else {
gSubDialog.open("chrome://mozapps/content/preferences/removemp.xhtml", {
closingCallback: () => {
Services.obs.notifyObservers(null, "passwordmgr-primary-pw-changed");
PasswordSettingHelpers._initMasterPasswordUI();
},
});
}
}
/**
* Initializes master password UI: the "use master password" checkbox, selects
* the master password button to show, and enables/disables it as necessary.
* The master password is controlled by various bits of NSS functionality, so
* the UI for it can't be controlled by the normal preference bindings.
*/
static _initMasterPasswordUI() {
var noMP = !LoginHelper.isPrimaryPasswordSet();
var button = document.getElementById("changeMasterPassword");
button.disabled = noMP;
var checkbox = document.getElementById("useMasterPassword");
checkbox.checked = !noMP;
checkbox.disabled =
(noMP && !Services.policies.isAllowed("createMasterPassword")) ||
(!noMP && !Services.policies.isAllowed("removeMasterPassword"));
}
}
const MANAGE_ADDRESSES_URL =
const MANAGE_CREDITCARDS_URL =
const {
MANAGE_ADDRESSES_L10N_IDS,
EDIT_ADDRESS_L10N_IDS,
MANAGE_CREDITCARDS_L10N_IDS,
EDIT_CREDITCARD_L10N_IDS,
} = FormAutofillUtils;
const { ENABLED_AUTOFILL_ADDRESSES_PREF, ENABLED_AUTOFILL_CREDITCARDS_PREF } =
FormAutofill;
const FORM_AUTOFILL_CONFIG = {
payments: {
l10nId: "payments-group",
headingLevel: 2,
subcategory: "payment-methods-autofill credit-card-autofill",
items: [
{
id: "saveAndFillPayments",
l10nId: "autofill-payment-methods-checkbox-message-2",
supportPage: "credit-card-autofill",
items: [
{
id: "requireOSAuthForPayments",
l10nId: "autofill-reauth-payment-methods-checkbox-2",
supportPage:
"credit-card-autofill#w_require-authentication-for-autofill",
},
],
},
{
id: "savedPaymentsButton",
l10nId: "autofill-payment-methods-manage-payments-button",
control: "moz-box-button",
controlAttrs: {
"search-l10n-ids": MANAGE_CREDITCARDS_L10N_IDS.concat(
EDIT_CREDITCARD_L10N_IDS
).join(","),
},
},
],
},
addresses: {
l10nId: "addresses-group",
headingLevel: 2,
subcategory: "addresses-autofill address-autofill",
items: [
{
id: "saveAndFillAddresses",
l10nId: "autofill-addresses-checkbox-message",
supportPage: "automatically-fill-your-address-web-forms",
},
{
id: "savedAddressesButton",
l10nId: "autofill-addresses-manage-addresses-button",
control: "moz-box-button",
controlAttrs: {
"search-l10n-ids": MANAGE_ADDRESSES_L10N_IDS.concat(
EDIT_ADDRESS_L10N_IDS
).join(","),
},
},
],
},
};
Preferences.addAll([
// Credit cards and addresses
{ id: ENABLED_AUTOFILL_ADDRESSES_PREF, type: "bool" },
{ id: ENABLED_AUTOFILL_CREDITCARDS_PREF, type: "bool" },
{
id: "extensions.formautofill.creditCards.os-auth.locked.enabled",
type: "bool",
},
// Windows SSO
{ id: "network.http.windows-sso.enabled", type: "bool" },
// Passwords
{ id: "signon.rememberSignons", type: "bool" },
{ id: "signon.generation.enabled", type: "bool" },
{ id: "signon.autofillForms", type: "bool" },
{ id: "signon.management.page.breach-alerts.enabled", type: "bool" },
{ id: "signon.firefoxRelay.feature", type: "string" },
]);
Preferences.addSetting({
id: "saveAndFillAddresses",
pref: ENABLED_AUTOFILL_ADDRESSES_PREF,
visible: () => FormAutofill.isAutofillAddressesAvailable,
});
Preferences.addSetting({
id: "savedAddressesButton",
pref: null,
visible: () => FormAutofill.isAutofillAddressesAvailable,
onUserClick: e => {
e.preventDefault();
if (Services.prefs.getBoolPref("browser.settings-redesign.enabled")) {
window.gotoPref("paneManageAddresses");
} else {
window.gSubDialog.open(MANAGE_ADDRESSES_URL);
}
},
});
Preferences.addSetting({
id: "saveAndFillPayments",
pref: ENABLED_AUTOFILL_CREDITCARDS_PREF,
visible: () => FormAutofill.isAutofillCreditCardsAvailable,
});
Preferences.addSetting({
id: "savedPaymentsButton",
pref: null,
visible: () => FormAutofill.isAutofillCreditCardsAvailable,
onUserClick: e => {
e.preventDefault();
if (Services.prefs.getBoolPref("browser.settings-redesign.enabled")) {
window.gotoPref("paneManagePayments");
} else {
window.gSubDialog.open(MANAGE_CREDITCARDS_URL);
}
},
});
Preferences.addSetting({
id: "requireOSAuthForPayments",
visible: () => lazy.OSKeyStore.canReauth(),
get: () => FormAutofillUtils.getOSAuthEnabled(),
async set(checked) {
await lazy.FormAutofillPreferences.trySetOSAuthEnabled(window, checked);
// Trigger change event to keep checkbox UI in sync with pref value
Services.obs.notifyObservers(null, "OSAuthEnabledChange");
},
setup: emitChange => {
Services.obs.addObserver(emitChange, "OSAuthEnabledChange");
return () => Services.obs.removeObserver(emitChange, "OSAuthEnabledChange");
},
});
Preferences.addSetting({
id: "payment-item",
async onUserClick(e) {
const action = e.target.getAttribute("action");
const guid = e.target.getAttribute("guid");
if (action === "remove") {
let [title, confirmLabel, cancelLabel] = await document.l10n.formatValues(
[
{ id: "payments-delete-payment-prompt-title" },
{ id: "payments-delete-payment-prompt-confirm-button" },
{ id: "payments-delete-payment-prompt-cancel-button" },
]
);
lazy.FormAutofillPreferences.prototype.openRemovePaymentDialog(
guid,
window.browsingContext.topChromeWindow.browsingContext,
title,
confirmLabel,
cancelLabel
);
} else if (action === "edit") {
lazy.FormAutofillPreferences.prototype.openEditCreditCardDialog(
guid,
window
);
}
},
});
Preferences.addSetting({
id: "add-payment-button",
deps: ["saveAndFillPayments"],
setup: (emitChange, _, setting) => {
function updateDepsAndChange() {
setting._deps = null;
emitChange();
}
Services.obs.addObserver(
updateDepsAndChange,
"formautofill-preferences-initialized"
);
return () =>
Services.obs.removeObserver(
updateDepsAndChange,
"formautofill-preferences-initialized"
);
},
onUserClick: () => {
window.gSubDialog.open(
);
},
disabled: ({ saveAndFillPayments }) => !saveAndFillPayments?.value,
});
Preferences.addSetting({
id: "payments-list-header",
});
Preferences.addSetting({
id: "no-payments-stored",
});
Preferences.addSetting(
class extends Preferences.AsyncSetting {
static id = "payments-list";
/** @type {Promise<any[]>} */
paymentMethods;
beforeRefresh() {
this.paymentMethods = this.getPaymentMethods();
}
async getPaymentMethods() {
await lazy.FormAutofillPreferences.prototype.initializePaymentsStorage();
return lazy.FormAutofillPreferences.prototype.makePaymentsListItems();
}
async getControlConfig() {
return {
items: await this.paymentMethods,
};
}
async visible() {
return Boolean((await this.paymentMethods).length);
}
setup() {
Services.obs.addObserver(this.emitChange, "formautofill-storage-changed");
return () =>
Services.obs.removeObserver(
this.emitChange,
"formautofill-storage-changed"
);
}
}
);
Preferences.addSetting({
/** @type {{ _removeAddressDialogStrings: string[] } & SettingConfig} */
id: "address-item",
_removeAddressDialogStrings: [],
onUserClick(e) {
const action = e.target.getAttribute("action");
const guid = e.target.getAttribute("guid");
if (action === "remove") {
let [title, confirmLabel, cancelLabel] = this._removeAddressDialogStrings;
lazy.FormAutofillPreferences.prototype.openRemoveAddressDialog(
guid,
window.browsingContext.topChromeWindow.browsingContext,
title,
confirmLabel,
cancelLabel
);
} else if (action === "edit") {
lazy.FormAutofillPreferences.prototype.openEditAddressDialog(
guid,
window
);
}
},
setup(emitChange) {
document.l10n
.formatValues([
{ id: "addresses-delete-address-prompt-title" },
{ id: "addresses-delete-address-prompt-confirm-button" },
{ id: "addresses-delete-address-prompt-cancel-button" },
])
.then(val => (this._removeAddressDialogStrings = val))
.then(emitChange);
},
disabled() {
return !!this._removeAddressDialogStrings.length;
},
});
Preferences.addSetting({
id: "add-address-button",
deps: ["saveAndFillAddresses"],
setup: (emitChange, _, setting) => {
function updateDepsAndChange() {
setting._deps = null;
emitChange();
}
Services.obs.addObserver(
updateDepsAndChange,
"formautofill-preferences-initialized"
);
return () =>
Services.obs.removeObserver(
updateDepsAndChange,
"formautofill-preferences-initialized"
);
},
onUserClick: () => {
lazy.FormAutofillPreferences.prototype.openEditAddressDialog(
undefined,
window
);
},
disabled: ({ saveAndFillAddresses }) => !saveAndFillAddresses?.value,
});
Preferences.addSetting({
id: "addresses-list-header",
});
Preferences.addSetting({
id: "no-addresses-stored",
});
Preferences.addSetting(
class extends Preferences.AsyncSetting {
static id = "addresses-list";
/** @type {Promise<any[]>} */
addresses;
beforeRefresh() {
this.addresses = this.getAddresses();
}
async getAddresses() {
await lazy.FormAutofillPreferences.prototype.initializeAddressesStorage();
return lazy.FormAutofillPreferences.prototype.makeAddressesListItems();
}
async getControlConfig() {
return {
items: await this.addresses,
};
}
async visible() {
return Boolean((await this.addresses).length);
}
setup() {
Services.obs.addObserver(this.emitChange, "formautofill-storage-changed");
return () =>
Services.obs.removeObserver(
this.emitChange,
"formautofill-storage-changed"
);
}
}
);
Preferences.addSetting({
id: "savePasswords",
pref: "signon.rememberSignons",
controllingExtensionInfo: {
storeId: "services.passwordSavingEnabled",
l10nId: "extension-controlling-password-saving",
},
});
Preferences.addSetting({
id: "managePasswordExceptions",
onUserClick: () => {
PasswordSettingHelpers.showPasswordExceptions();
},
});
Preferences.addSetting({
id: "fillUsernameAndPasswords",
pref: "signon.autofillForms",
});
Preferences.addSetting({
id: "suggestStrongPasswords",
pref: "signon.generation.enabled",
visible: () => Services.prefs.getBoolPref("signon.generation.available"),
});
Preferences.addSetting({
id: "requireOSAuthForPasswords",
visible: () => lazy.OSKeyStore.canReauth(),
get: () => lazy.LoginHelper.getOSAuthEnabled(),
async set(checked) {
const [messageText, captionText] = await Promise.all([
lazy.AboutLoginsL10n.formatValue("about-logins-os-auth-dialog-message"),
lazy.AboutLoginsL10n.formatValue("about-logins-os-auth-dialog-caption"),
]);
await lazy.LoginHelper.trySetOSAuthEnabled(
window,
checked,
messageText,
captionText
);
// Trigger change event to keep checkbox UI in sync with pref value
Services.obs.notifyObservers(null, "PasswordsOSAuthEnabledChange");
},
setup: emitChange => {
Services.obs.addObserver(emitChange, "PasswordsOSAuthEnabledChange");
return () =>
Services.obs.removeObserver(emitChange, "PasswordsOSAuthEnabledChange");
},
});
Preferences.addSetting({
id: "allowWindowSSO",
pref: "network.http.windows-sso.enabled",
visible: () => AppConstants.platform === "win",
});
Preferences.addSetting({
id: "manageSavedPasswords",
onUserClick: () => {
PasswordSettingHelpers.showPasswords();
},
});
Preferences.addSetting({
id: "additionalProtectionsGroup",
});
Preferences.addSetting({
id: "primaryPasswordNotSet",
setup(emitChange) {
const topic = "passwordmgr-primary-pw-changed";
Services.obs.addObserver(emitChange, topic);
return () => Services.obs.removeObserver(emitChange, topic);
},
visible: () => {
return !lazy.LoginHelper.isPrimaryPasswordSet();
},
});
Preferences.addSetting({
id: "usePrimaryPassword",
deps: ["primaryPasswordNotSet"],
});
Preferences.addSetting({
id: "addPrimaryPassword",
deps: ["primaryPasswordNotSet"],
onUserClick: () => {
PasswordSettingHelpers.changeMasterPassword();
},
disabled: () => {
return !Services.policies.isAllowed("createMasterPassword");
},
});
Preferences.addSetting({
id: "primaryPasswordSet",
setup(emitChange) {
const topic = "passwordmgr-primary-pw-changed";
Services.obs.addObserver(emitChange, topic);
return () => Services.obs.removeObserver(emitChange, topic);
},
visible: () => {
return lazy.LoginHelper.isPrimaryPasswordSet();
},
});
Preferences.addSetting({
id: "statusPrimaryPassword",
deps: ["primaryPasswordSet"],
onUserClick: e => {
if (e.target.localName == "moz-button") {
PasswordSettingHelpers._removeMasterPassword();
}
},
getControlConfig(config) {
config.options[0].controlAttrs = {
...config.options[0].controlAttrs,
...(!Services.policies.isAllowed("removeMasterPassword")
? { disabled: "" }
: {}),
};
return config;
},
});
Preferences.addSetting({
id: "changePrimaryPassword",
deps: ["primaryPasswordSet"],
onUserClick: () => {
PasswordSettingHelpers.changeMasterPassword();
},
});
Preferences.addSetting({
id: "breachAlerts",
pref: "signon.management.page.breach-alerts.enabled",
});
SettingGroupManager.registerGroups({
passwords: {
inProgress: true,
id: "passwordsGroup",
l10nId: "forms-passwords-header",
headingLevel: 2,
items: [
{
id: "savePasswords",
l10nId: "forms-ask-to-save-passwords",
items: [
{
id: "managePasswordExceptions",
l10nId: "forms-manage-password-exceptions",
control: "moz-box-button",
controlAttrs: {
"search-l10n-ids":
"permissions-address,permissions-exceptions-saved-passwords-window.title,permissions-exceptions-saved-passwords-desc,",
},
},
{
id: "fillUsernameAndPasswords",
l10nId: "forms-fill-usernames-and-passwords-2",
controlAttrs: {
"search-l10n-ids": "forms-saved-passwords-searchkeywords",
},
},
{
id: "suggestStrongPasswords",
l10nId: "forms-suggest-passwords",
supportPage: "how-generate-secure-password-firefox",
},
],
},
{
id: "requireOSAuthForPasswords",
l10nId: "forms-os-reauth-2",
},
{
id: "allowWindowSSO",
l10nId: "forms-windows-sso",
supportPage: "windows-sso",
},
{
id: "manageSavedPasswords",
l10nId: "forms-saved-passwords-2",
control: "moz-box-link",
},
{
id: "additionalProtectionsGroup",
l10nId: "forms-additional-protections-header",
control: "moz-fieldset",
controlAttrs: {
headingLevel: 2,
},
items: [
{
id: "primaryPasswordNotSet",
control: "moz-box-group",
items: [
{
id: "usePrimaryPassword",
l10nId: "forms-primary-pw-use-2",
control: "moz-box-item",
supportPage: "primary-password-stored-logins",
},
{
id: "addPrimaryPassword",
l10nId: "forms-primary-pw-set",
control: "moz-box-button",
},
],
},
{
id: "primaryPasswordSet",
control: "moz-box-group",
items: [
{
id: "statusPrimaryPassword",
l10nId: "forms-primary-pw-on",
control: "moz-box-item",
controlAttrs: {
iconsrc: "chrome://global/skin/icons/check-filled.svg",
},
options: [
{
id: "turnOffPrimaryPassword",
l10nId: "forms-primary-pw-turn-off",
control: "moz-button",
slot: "actions",
},
],
},
{
id: "changePrimaryPassword",
l10nId: "forms-primary-pw-change-2",
control: "moz-box-button",
},
],
},
{
id: "breachAlerts",
l10nId: "forms-breach-alerts",
supportPage: "lockwise-alerts",
},
],
},
],
},
managePayments: {
items: [
{
id: "add-payment-button",
control: "moz-button",
l10nId: "autofill-payment-methods-add-button",
},
{
id: "payments-list",
control: "moz-box-group",
controlAttrs: {
type: "list",
},
},
],
},
manageAddresses: {
items: [
{
id: "add-address-button",
control: "moz-button",
l10nId: "autofill-addresses-add-button",
},
{
id: "addresses-list",
control: "moz-box-group",
controlAttrs: {
type: "list",
},
},
],
},
});
SettingGroupManager.registerGroups(FORM_AUTOFILL_CONFIG);
Services.obs.notifyObservers(window, "passwordsAutofill-pane-loaded");