[tbb-commits] [Git][tpo/applications/tor-browser][tor-browser-115.2.1esr-13.0-1] 25 commits: fixup! Bug 40933: Add tor-launcher functionality
Pier Angelo Vendrame (@pierov)
git at gitlab.torproject.org
Thu Sep 14 17:12:58 UTC 2023
Pier Angelo Vendrame pushed to branch tor-browser-115.2.1esr-13.0-1 at The Tor Project / Applications / Tor Browser
Commits:
acebcc4c by Pier Angelo Vendrame at 2023-09-14T19:11:10+02:00
fixup! Bug 40933: Add tor-launcher functionality
Deleted old stuff, unified TorController with ControlSocket, simplified
everything (e.g., do not use the dispatcher anymore, just call stuff
directly or use a much simpler map).
- - - - -
96edc001 by Pier Angelo Vendrame at 2023-09-14T19:11:11+02:00
fixup! Bug 40933: Add tor-launcher functionality
Use `#` instead of `_` for private things here and there, to make
reviewing the changes easier.
- - - - -
a2eebe17 by Pier Angelo Vendrame at 2023-09-14T19:11:12+02:00
fixup! Bug 40933: Add tor-launcher functionality
Shuffle code here and there, so that it's feasible to check that
nothing actually changed with `git diff --color-moved`.
- - - - -
545ab0f1 by Pier Angelo Vendrame at 2023-09-14T19:11:12+02:00
fixup! Bug 40933: Add tor-launcher functionality
Further refactors/improvements.
- - - - -
fb7bb380 by Pier Angelo Vendrame at 2023-09-14T19:11:13+02:00
fixup! Bug 40597: Implement TorSettings module
Workaround for a race condition.
- - - - -
ae07f248 by Pier Angelo Vendrame at 2023-09-14T19:11:13+02:00
fixup! Bug 40933: Add tor-launcher functionality
Refactored the settings reading, the first connection and events setup.
- - - - -
dc538277 by Pier Angelo Vendrame at 2023-09-14T19:11:14+02:00
fixup! Bug 27476: Implement about:torconnect captive portal within Tor Browser
Fixed another race condition and moved to ES modules while I was
touching this code.
- - - - -
52144e2b by Pier Angelo Vendrame at 2023-09-14T19:11:14+02:00
fixup! Bug 40933: Add tor-launcher functionality
Moved the control port parsing for asynchronous events from TorProvider
to TorControlPort.
- - - - -
d5c6fb9e by Pier Angelo Vendrame at 2023-09-14T19:11:15+02:00
fixup! Bug 40933: Add tor-launcher functionality
Bug 41986: Fix the control port password handling
- - - - -
f28fe46a by Pier Angelo Vendrame at 2023-09-14T19:11:15+02:00
fixup! Bug 40933: Add tor-launcher functionality
- - - - -
5dd564d5 by Pier Angelo Vendrame at 2023-09-14T19:11:16+02:00
fixup! Bug 40933: Add tor-launcher functionality
Second chunk of changes requested during the review.
- - - - -
ebd23167 by Pier Angelo Vendrame at 2023-09-14T19:11:16+02:00
fixup! Add TorStrings module for localization
Marked tor_controlconn_failed as a 12.5-only
- - - - -
44347a46 by Pier Angelo Vendrame at 2023-09-14T19:11:17+02:00
fixup! Bug 40933: Add tor-launcher functionality
Change the provider buidler to make build async and other fixes.
- - - - -
700bbaba by Pier Angelo Vendrame at 2023-09-14T19:11:17+02:00
fixup! Bug 40597: Implement TorSettings module
The provider building is now async.
- - - - -
d8c5d36e by Pier Angelo Vendrame at 2023-09-14T19:11:17+02:00
fixup! Bug 30237: Add v3 onion services client authentication prompt
The provider building is now async.
- - - - -
47a17382 by Pier Angelo Vendrame at 2023-09-14T19:11:18+02:00
fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#connection
The provider building is now async.
- - - - -
8d5ec618 by Pier Angelo Vendrame at 2023-09-14T19:11:18+02:00
fixup! Bug 3455: Add DomainIsolator, for isolating circuit by domain.
The provider building is now async.
- - - - -
11e651cc by Pier Angelo Vendrame at 2023-09-14T19:11:19+02:00
fixup! Bug 41668: Tweaks to the Base Browser updater for Tor Browser
The provider building is now async.
- - - - -
7019179e by Pier Angelo Vendrame at 2023-09-14T19:11:19+02:00
fixup! Bug 30237: Add v3 onion services client authentication prompt
Fix possible race conditions on the busy state.
- - - - -
491b730b by Pier Angelo Vendrame at 2023-09-14T19:11:20+02:00
fixup! Bug 40933: Add tor-launcher functionality
Make the restart case stronger.
- - - - -
a4f54a1d by Pier Angelo Vendrame at 2023-09-14T19:11:20+02:00
fixup! Bug 40933: Add tor-launcher functionality
Move the restart to the ProviderBuilder.
- - - - -
f291f9b4 by Pier Angelo Vendrame at 2023-09-14T19:11:21+02:00
fixup! Bug 40597: Implement TorSettings module
Set the state back to Configure when the tor process exits, and disable
qiuckstart.
We should also show the "Not Connected" pill again.
- - - - -
255fd5d3 by henry at 2023-09-14T19:11:21+02:00
fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#connection
Added some error handling for the cases in which the Tor provider
failed to build.
- - - - -
725d46c1 by Pier Angelo Vendrame at 2023-09-14T19:11:22+02:00
fixup! Bug 30237: Add v3 onion services client authentication prompt
Re-build the provider every time we need it, since it might change now.
- - - - -
00986a07 by Pier Angelo Vendrame at 2023-09-14T19:11:22+02:00
fixup! Bug 40933: Add tor-launcher functionality
Addressed more requests from the review, and added documentation.
- - - - -
23 changed files:
- browser/components/BrowserGlue.sys.mjs
- browser/components/onionservices/content/authPrompt.js
- browser/components/onionservices/content/savedKeysDialog.js
- − browser/components/torconnect/TorConnectChild.jsm
- + browser/components/torconnect/TorConnectChild.sys.mjs
- browser/components/torconnect/TorConnectParent.jsm → browser/components/torconnect/TorConnectParent.sys.mjs
- browser/components/torconnect/moz.build
- browser/components/torpreferences/content/connectionPane.js
- browser/components/torpreferences/content/torLogDialog.jsm
- browser/modules/Moat.sys.mjs
- browser/modules/TorConnect.sys.mjs
- browser/modules/TorSettings.sys.mjs
- toolkit/components/tor-launcher/TorBootstrapRequest.sys.mjs
- toolkit/components/tor-launcher/TorControlPort.sys.mjs
- toolkit/components/tor-launcher/TorDomainIsolator.sys.mjs
- toolkit/components/tor-launcher/TorLauncherUtil.sys.mjs
- toolkit/components/tor-launcher/TorParsers.sys.mjs
- toolkit/components/tor-launcher/TorProcess.sys.mjs
- toolkit/components/tor-launcher/TorProvider.sys.mjs
- toolkit/components/tor-launcher/TorProviderBuilder.sys.mjs
- toolkit/components/tor-launcher/TorStartupService.sys.mjs
- toolkit/mozapps/update/UpdateService.sys.mjs
- toolkit/torbutton/chrome/locale/en-US/torlauncher.properties
Changes:
=====================================
browser/components/BrowserGlue.sys.mjs
=====================================
@@ -67,6 +67,7 @@ ChromeUtils.defineESModuleGetters(lazy, {
"resource://messaging-system/lib/SpecialMessageActions.sys.mjs",
TRRRacer: "resource:///modules/TRRPerformance.sys.mjs",
TelemetryUtils: "resource://gre/modules/TelemetryUtils.sys.mjs",
+ TorProviderBuilder: "resource://gre/modules/TorProviderBuilder.sys.mjs",
UIState: "resource://services-sync/UIState.sys.mjs",
UrlbarPrefs: "resource:///modules/UrlbarPrefs.sys.mjs",
WebChannel: "resource://gre/modules/WebChannel.sys.mjs",
@@ -772,10 +773,10 @@ let JSWINDOWACTORS = {
TorConnect: {
parent: {
- moduleURI: "resource:///modules/TorConnectParent.jsm",
+ esModuleURI: "resource:///actors/TorConnectParent.sys.mjs",
},
child: {
- moduleURI: "resource:///modules/TorConnectChild.jsm",
+ esModuleURI: "resource:///actors/TorConnectChild.sys.mjs",
events: {
DOMWindowCreated: {},
},
@@ -1750,6 +1751,8 @@ BrowserGlue.prototype = {
lazy.DragDropFilter.init();
+ lazy.TorProviderBuilder.firstWindowLoaded();
+
this._firstWindowTelemetry(aWindow);
this._firstWindowLoaded();
=====================================
browser/components/onionservices/content/authPrompt.js
=====================================
@@ -179,12 +179,12 @@ const OnionAuthPrompt = (function () {
},
async _onDone() {
- let keyElem = this._getKeyElement();
+ const keyElem = this._getKeyElement();
if (!keyElem) {
return;
}
- let base64key = this._keyToBase64(keyElem.value);
+ const base64key = this._keyToBase64(keyElem.value);
if (!base64key) {
this._showWarning(TorStrings.onionServices.authPrompt.invalidKey);
return;
@@ -192,8 +192,7 @@ const OnionAuthPrompt = (function () {
this._prompt.remove();
- // Use Torbutton's controller module to add the private key to Tor.
- let controllerFailureMsg =
+ const controllerFailureMsg =
TorStrings.onionServices.authPrompt.failedToSetKey;
try {
// ^(subdomain.)*onionserviceid.onion$ (case-insensitive)
@@ -204,29 +203,19 @@ const OnionAuthPrompt = (function () {
.match(onionServiceIdRegExp)
.groups.onionServiceId.toLowerCase();
- let checkboxElem = this._getCheckboxElement();
- let isPermanent = checkboxElem && checkboxElem.checked;
- TorProviderBuilder.build()
- .onionAuthAdd(onionServiceId, base64key, isPermanent)
- .then(aResponse => {
- // Success! Reload the page.
- this._browser.sendMessageToActor(
- "Browser:Reload",
- {},
- "BrowserTab"
- );
- })
- .catch(aError => {
- if (aError.torMessage) {
- this.show(aError.torMessage);
- } else {
- console.error(controllerFailureMsg, aError);
- this.show(controllerFailureMsg);
- }
- });
+ const checkboxElem = this._getCheckboxElement();
+ const isPermanent = checkboxElem && checkboxElem.checked;
+ const provider = await TorProviderBuilder.build();
+ await provider.onionAuthAdd(onionServiceId, base64key, isPermanent);
+ // Success! Reload the page.
+ this._browser.sendMessageToActor("Browser:Reload", {}, "BrowserTab");
} catch (e) {
- console.error(controllerFailureMsg, e);
- this.show(controllerFailureMsg);
+ if (e.torMessage) {
+ this.show(e.torMessage);
+ } else {
+ console.error(controllerFailureMsg, e);
+ this.show(controllerFailureMsg);
+ }
}
},
=====================================
browser/components/onionservices/content/savedKeysDialog.js
=====================================
@@ -26,42 +26,46 @@ var gOnionServicesSavedKeysDialog = {
},
_tree: undefined,
- _isBusy: false, // true when loading data, deleting a key, etc.
+ _busyCount: 0,
+ get _isBusy() {
+ // true when loading data, deleting a key, etc.
+ return this._busyCount > 0;
+ },
// Public functions (called from outside this file).
async deleteSelectedKeys() {
- this._setBusyState(true);
-
- const indexesToDelete = [];
- const count = this._tree.view.selection.getRangeCount();
- for (let i = 0; i < count; ++i) {
- const minObj = {};
- const maxObj = {};
- this._tree.view.selection.getRangeAt(i, minObj, maxObj);
- for (let idx = minObj.value; idx <= maxObj.value; ++idx) {
- indexesToDelete.push(idx);
+ this._withBusy(async () => {
+ const indexesToDelete = [];
+ const count = this._tree.view.selection.getRangeCount();
+ for (let i = 0; i < count; ++i) {
+ const minObj = {};
+ const maxObj = {};
+ this._tree.view.selection.getRangeAt(i, minObj, maxObj);
+ for (let idx = minObj.value; idx <= maxObj.value; ++idx) {
+ indexesToDelete.push(idx);
+ }
}
- }
- if (indexesToDelete.length) {
- const controllerFailureMsg =
- TorStrings.onionServices.authPreferences.failedToRemoveKey;
- try {
- // Remove in reverse index order to avoid issues caused by index changes.
- for (let i = indexesToDelete.length - 1; i >= 0; --i) {
- await this._deleteOneKey(indexesToDelete[i]);
- }
- } catch (e) {
- console.error("Removing a saved key failed", e);
- if (e.torMessage) {
- this._showError(e.torMessage);
- } else {
- this._showError(controllerFailureMsg);
+ if (indexesToDelete.length) {
+ const controllerFailureMsg =
+ TorStrings.onionServices.authPreferences.failedToRemoveKey;
+ const provider = await TorProviderBuilder.build();
+ try {
+ // Remove in reverse index order to avoid issues caused by index
+ // changes.
+ for (let i = indexesToDelete.length - 1; i >= 0; --i) {
+ await this._deleteOneKey(provider, indexesToDelete[i]);
+ }
+ } catch (e) {
+ console.error("Removing a saved key failed", e);
+ if (e.torMessage) {
+ this._showError(e.torMessage);
+ } else {
+ this._showError(controllerFailureMsg);
+ }
}
}
- }
-
- this._setBusyState(false);
+ });
},
async deleteAllKeys() {
@@ -84,16 +88,12 @@ var gOnionServicesSavedKeysDialog = {
},
async _init() {
- await this._populateXUL();
-
+ this._populateXUL();
window.addEventListener("keypress", this._onWindowKeyPress.bind(this));
-
- // We don't use await here because we want _loadSavedKeys() to run
- // in the background and not block loading of this dialog.
this._loadSavedKeys();
},
- async _populateXUL() {
+ _populateXUL() {
const dialog = document.querySelector(this.selector.dialog);
const authPrefStrings = TorStrings.onionServices.authPreferences;
dialog.setAttribute("title", authPrefStrings.dialogTitle);
@@ -119,56 +119,68 @@ var gOnionServicesSavedKeysDialog = {
async _loadSavedKeys() {
const controllerFailureMsg =
TorStrings.onionServices.authPreferences.failedToGetKeys;
- this._setBusyState(true);
-
- try {
- this._tree.view = this;
-
- const keyInfoList = await TorProviderBuilder.build().onionAuthViewKeys();
- if (keyInfoList) {
- // Filter out temporary keys.
- this._keyInfoList = keyInfoList.filter(aKeyInfo =>
- aKeyInfo.flags?.includes("Permanent")
- );
- // Sort by the .onion address.
- this._keyInfoList.sort((aObj1, aObj2) => {
- const hsAddr1 = aObj1.address.toLowerCase();
- const hsAddr2 = aObj2.address.toLowerCase();
- if (hsAddr1 < hsAddr2) {
- return -1;
- }
- return hsAddr1 > hsAddr2 ? 1 : 0;
- });
- }
+ this._withBusy(async () => {
+ try {
+ this._tree.view = this;
+
+ const provider = await TorProviderBuilder.build();
+ const keyInfoList = await provider.onionAuthViewKeys();
+ if (keyInfoList) {
+ // Filter out temporary keys.
+ this._keyInfoList = keyInfoList.filter(aKeyInfo =>
+ aKeyInfo.flags?.includes("Permanent")
+ );
+ // Sort by the .onion address.
+ this._keyInfoList.sort((aObj1, aObj2) => {
+ const hsAddr1 = aObj1.address.toLowerCase();
+ const hsAddr2 = aObj2.address.toLowerCase();
+ if (hsAddr1 < hsAddr2) {
+ return -1;
+ }
+ return hsAddr1 > hsAddr2 ? 1 : 0;
+ });
+ }
- // Render the tree content.
- this._tree.rowCountChanged(0, this.rowCount);
- } catch (e) {
- if (e.torMessage) {
- this._showError(e.torMessage);
- } else {
- this._showError(controllerFailureMsg);
+ // Render the tree content.
+ this._tree.rowCountChanged(0, this.rowCount);
+ } catch (e) {
+ if (e.torMessage) {
+ this._showError(e.torMessage);
+ } else {
+ this._showError(controllerFailureMsg);
+ }
}
- }
-
- this._setBusyState(false);
+ });
},
// This method may throw; callers should catch errors.
- async _deleteOneKey(aIndex) {
+ async _deleteOneKey(provider, aIndex) {
const keyInfoObj = this._keyInfoList[aIndex];
- await TorProviderBuilder.build().onionAuthRemove(keyInfoObj.address);
+ await provider.onionAuthRemove(keyInfoObj.address);
this._tree.view.selection.clearRange(aIndex, aIndex);
this._keyInfoList.splice(aIndex, 1);
this._tree.rowCountChanged(aIndex + 1, -1);
},
- _setBusyState(aIsBusy) {
- this._isBusy = aIsBusy;
- this.updateButtonsState();
+ async _withBusy(func) {
+ this._busyCount++;
+ if (this._busyCount === 1) {
+ this.updateButtonsState();
+ }
+ try {
+ await func();
+ } finally {
+ this._busyCount--;
+ if (this._busyCount === 0) {
+ this.updateButtonsState();
+ }
+ }
},
_onWindowKeyPress(event) {
+ if (this._isBusy) {
+ return;
+ }
if (event.keyCode === KeyEvent.DOM_VK_ESCAPE) {
window.close();
} else if (event.keyCode === KeyEvent.DOM_VK_DELETE) {
=====================================
browser/components/torconnect/TorConnectChild.jsm deleted
=====================================
@@ -1,9 +0,0 @@
-// Copyright (c) 2021, The Tor Project, Inc.
-
-var EXPORTED_SYMBOLS = ["TorConnectChild"];
-
-const { RemotePageChild } = ChromeUtils.import(
- "resource://gre/actors/RemotePageChild.jsm"
-);
-
-class TorConnectChild extends RemotePageChild {}
=====================================
browser/components/torconnect/TorConnectChild.sys.mjs
=====================================
@@ -0,0 +1,5 @@
+// Copyright (c) 2021, The Tor Project, Inc.
+
+import { RemotePageChild } from "resource://gre/actors/RemotePageChild.sys.mjs";
+
+export class TorConnectChild extends RemotePageChild {}
=====================================
browser/components/torconnect/TorConnectParent.jsm → browser/components/torconnect/TorConnectParent.sys.mjs
=====================================
@@ -1,14 +1,17 @@
// Copyright (c) 2021, The Tor Project, Inc.
-var EXPORTED_SYMBOLS = ["TorConnectParent"];
-
-const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { TorStrings } = ChromeUtils.import("resource:///modules/TorStrings.jsm");
-const { InternetStatus, TorConnect, TorConnectTopics, TorConnectState } =
- ChromeUtils.import("resource:///modules/TorConnect.jsm");
-const { TorSettings, TorSettingsTopics, TorSettingsData } = ChromeUtils.import(
- "resource:///modules/TorSettings.jsm"
-);
+import {
+ InternetStatus,
+ TorConnect,
+ TorConnectTopics,
+ TorConnectState,
+} from "resource:///modules/TorConnect.sys.mjs";
+import {
+ TorSettings,
+ TorSettingsTopics,
+ TorSettingsData,
+} from "resource:///modules/TorSettings.sys.mjs";
const BroadcastTopic = "about-torconnect:broadcast";
@@ -17,7 +20,7 @@ This object is basically a marshalling interface between the TorConnect module
and a particular about:torconnect page
*/
-class TorConnectParent extends JSWindowActorParent {
+export class TorConnectParent extends JSWindowActorParent {
constructor(...args) {
super(...args);
@@ -35,10 +38,20 @@ class TorConnectParent extends JSWindowActorParent {
DetectedLocation: TorConnect.detectedLocation,
ShowViewLog: TorConnect.logHasWarningOrError,
HasEverFailed: TorConnect.hasEverFailed,
- QuickStartEnabled: TorSettings.quickstart.enabled,
UIState: TorConnect.uiState,
};
+ // Workaround for a race condition, but we should fix it asap.
+ // about:torconnect is loaded before TorSettings is actually initialized.
+ // The getter might throw and the page not loaded correctly as a result.
+ // Silence any warning for now, but we should really fix it.
+ // See also tor-browser#41921.
+ try {
+ this.state.QuickStartEnabled = TorSettings.quickstart.enabled;
+ } catch (e) {
+ this.state.QuickStartEnabled = false;
+ }
+
// JSWindowActiveParent derived objects cannot observe directly, so create a member
// object to do our observing for us
//
@@ -84,6 +97,16 @@ class TorConnectParent extends JSWindowActorParent {
self.state.ShowViewLog = true;
break;
}
+ case TorSettingsTopics.Ready: {
+ if (
+ self.state.QuickStartEnabled !== TorSettings.quickstart.enabled
+ ) {
+ self.state.QuickStartEnabled = TorSettings.quickstart.enabled;
+ } else {
+ return;
+ }
+ break;
+ }
case TorSettingsTopics.SettingChanged: {
if (aData === TorSettingsData.QuickStartEnabled) {
self.state.QuickStartEnabled = obj.value;
@@ -107,6 +130,7 @@ class TorConnectParent extends JSWindowActorParent {
const topic = TorConnectTopics[key];
Services.obs.addObserver(this.torConnectObserver, topic);
}
+ Services.obs.addObserver(this.torConnectObserver, TorSettingsTopics.Ready);
Services.obs.addObserver(
this.torConnectObserver,
TorSettingsTopics.SettingChanged
@@ -130,6 +154,10 @@ class TorConnectParent extends JSWindowActorParent {
const topic = TorConnectTopics[key];
Services.obs.removeObserver(this.torConnectObserver, topic);
}
+ Services.obs.removeObserver(
+ this.torConnectObserver,
+ TorSettingsTopics.Ready
+ );
Services.obs.removeObserver(
this.torConnectObserver,
TorSettingsTopics.SettingChanged
=====================================
browser/components/torconnect/moz.build
=====================================
@@ -1,6 +1,6 @@
-JAR_MANIFESTS += ['jar.mn']
+JAR_MANIFESTS += ["jar.mn"]
-EXTRA_JS_MODULES += [
- 'TorConnectChild.jsm',
- 'TorConnectParent.jsm',
+FINAL_TARGET_FILES.actors += [
+ "TorConnectChild.sys.mjs",
+ "TorConnectParent.sys.mjs",
]
=====================================
browser/components/torpreferences/content/connectionPane.js
=====================================
@@ -153,8 +153,16 @@ const gConnectionPane = (function () {
// populate xul with strings and cache the relevant elements
_populateXUL() {
// saves tor settings to disk when navigate away from about:preferences
- window.addEventListener("blur", val => {
- TorProviderBuilder.build().flushSettings();
+ window.addEventListener("blur", async () => {
+ try {
+ // Build a new provider each time because this might be called also
+ // when closing the browser (if about:preferences was open), maybe
+ // when the provider was already uninitialized.
+ const provider = await TorProviderBuilder.build();
+ provider.flushSettings();
+ } catch (e) {
+ console.warn("Could not save the tor settings.", e);
+ }
});
document
@@ -746,11 +754,17 @@ const gConnectionPane = (function () {
placeholder.replaceWith(...cards);
this._checkBridgeCardsHeight();
};
- this._checkConnectedBridge = () => {
+ this._checkConnectedBridge = async () => {
// TODO: We could make sure TorSettings is in sync by monitoring also
// changes of settings. At that point, we could query it, instead of
// doing a query over the control port.
- const bridge = TorProviderBuilder.build().currentBridge;
+ let bridge = null;
+ try {
+ const provider = await TorProviderBuilder.build();
+ bridge = provider.currentBridge;
+ } catch (e) {
+ console.warn("Could not get current bridge", e);
+ }
if (bridge?.fingerprint !== this._currentBridgeId) {
this._currentBridgeId = bridge?.fingerprint ?? null;
this._updateConnectedBridges();
=====================================
browser/components/torpreferences/content/torLogDialog.jsm
=====================================
@@ -26,7 +26,7 @@ class TorLogDialog {
};
}
- _populateXUL(aDialog) {
+ async _populateXUL(aDialog) {
this._dialog = aDialog;
const dialogWin = this._dialog.parentElement;
dialogWin.setAttribute("title", TorStrings.settings.torLogDialogTitle);
@@ -56,7 +56,12 @@ class TorLogDialog {
}, RESTORE_TIME);
});
- this._logTextarea.value = TorProviderBuilder.build().getLog();
+ // A waiting state should not be needed at this point.
+ // Also, we probably cannot even arrive here if the provider failed to
+ // initialize, otherwise we could use a try/catch, and write the exception
+ // text in the logs, instead.
+ const provider = await TorProviderBuilder.build();
+ this._logTextarea.value = provider.getLog();
}
init(window, aDialog) {
=====================================
browser/modules/Moat.sys.mjs
=====================================
@@ -46,9 +46,8 @@ class MeekTransport {
try {
// figure out which pluggable transport to use
const supportedTransports = ["meek", "meek_lite"];
- const proxy = (
- await lazy.TorProviderBuilder.build().getPluggableTransports()
- ).find(
+ const provider = await lazy.TorProviderBuilder.build();
+ const proxy = (await provider.getPluggableTransports()).find(
pt =>
pt.type === "exec" &&
supportedTransports.some(t => pt.transports.includes(t))
=====================================
browser/modules/TorConnect.sys.mjs
=====================================
@@ -9,7 +9,6 @@ const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
MoatRPC: "resource:///modules/Moat.sys.mjs",
TorBootstrapRequest: "resource://gre/modules/TorBootstrapRequest.sys.mjs",
- TorProviderBuilder: "resource://gre/modules/TorProviderBuilder.sys.mjs",
});
// TODO: Should we move this to the about:torconnect actor?
@@ -19,6 +18,7 @@ ChromeUtils.defineModuleGetter(
"resource:///modules/BrowserWindowTracker.jsm"
);
+import { TorLauncherUtil } from "resource://gre/modules/TorLauncherUtil.sys.mjs";
import {
TorSettings,
TorSettingsTopics,
@@ -91,15 +91,15 @@ export const TorConnectState = Object.freeze({
│ │ │ │ │
└─┼─────▶ │ │ │
│ └──────────────────────────────────────────────────────────┘ │
- │ │ ▲ │
- │ │ beginAutoBootstrap() │ cancelBootstrap() │
- │ ▼ │ │
- │ ┌───────────────────────┐ │ │
- └────── │ AutoBootstrapping │ ─┘ │
- └───────────────────────┘ │
- │ │
- │ │
- ▼ │
+ │ │ ▲ ▲ │
+ │ │ beginAutoBootstrap() │ cancelBootstrap() │ │
+ │ ▼ │ │ │
+ │ ┌───────────────────────┐ │ │ │
+ └────── │ AutoBootstrapping │ ─┘ │ │
+ └───────────────────────┘ │ │
+ │ │ │
+ │ ┌────────────────────────────────┘ │
+ ▼ │ │
┌───────────────────────┐ │
│ Bootstrapped │ ◀───────────────────────────────────┘
└───────────────────────┘
@@ -145,8 +145,8 @@ const TorConnectStateTransitions = Object.freeze(
],
],
[TorConnectState.Error, [TorConnectState.Configuring]],
+ [TorConnectState.Bootstrapped, [TorConnectState.Configuring]],
// terminal states
- [TorConnectState.Bootstrapped, []],
[TorConnectState.Disabled, []],
])
);
@@ -703,8 +703,13 @@ export const TorConnect = (() => {
// bootstrapped failed for all potential settings, so reset daemon to use original
TorSettings.setSettings(this.originalSettings);
- await TorSettings.applySettings();
+ // The original settings should be good, so we save them to
+ // preferences before trying to apply them, as it might fail
+ // if the actual problem is with the connection to the control
+ // port.
+ // FIXME: We should handle this case in a better way.
TorSettings.saveToPrefs();
+ await TorSettings.applySettings();
// only explicitly change state here if something else has not transitioned us
if (!this.transitioning) {
@@ -718,6 +723,8 @@ export const TorConnect = (() => {
// restore original settings in case of error
try {
TorSettings.setSettings(this.originalSettings);
+ // As above
+ TorSettings.saveToPrefs();
await TorSettings.applySettings();
} catch (errRestore) {
console.log(
@@ -733,12 +740,19 @@ export const TorConnect = (() => {
TorConnect._countryCodes =
await this.mrpc.circumvention_countries();
}
- TorConnect._changeState(
- TorConnectState.Error,
- err?.message,
- err?.details,
- true
- );
+ if (!this.transitioning) {
+ TorConnect._changeState(
+ TorConnectState.Error,
+ err?.message,
+ err?.details,
+ true
+ );
+ } else {
+ console.error(
+ "TorConnect: Received AutoBootstrapping error after transitioning",
+ err
+ );
+ }
} finally {
// important to uninit MoatRPC object or else the pt process will live as long as tor-browser
this.mrpc?.uninit();
@@ -751,7 +765,11 @@ export const TorConnect = (() => {
TorConnectState.Bootstrapped,
new StateCallback(TorConnectState.Bootstrapped, async function () {
await new Promise((resolve, reject) => {
- // on_transition not defined because no way to leave Bootstrapped state
+ // We may need to leave the bootstrapped state if the tor daemon
+ // exits (if it is restarted, we will have to bootstrap again).
+ this.on_transition = nextState => {
+ resolve();
+ };
// notify observers of bootstrap completion
Services.obs.notifyObservers(
null,
@@ -895,6 +913,25 @@ export const TorConnect = (() => {
this._logHasWarningOrError = true;
break;
}
+ case TorTopics.ProcessExited: {
+ // Treat a failure as a possibly broken configuration.
+ // So, prevent quickstart at the next start.
+ Services.prefs.setBoolPref(TorLauncherPrefs.prompt_at_startup, true);
+ switch (this._state) {
+ case TorConnectState.Bootstrapping:
+ case TorConnectState.AutoBootstrapping:
+ case TorConnectState.Bootstrapped:
+ // If we are in the bootstrap or auto bootstrap, we could go
+ // through the error phase (and eventually we might do it, if some
+ // transition calls fail). However, this would start the
+ // connection assist, so we go directly to configuring.
+ // FIXME: Find a better way to handle this.
+ this._changeState(TorConnectState.Configuring);
+ break;
+ // Other states naturally resolve in configuration.
+ }
+ break;
+ }
default:
// ignore
break;
@@ -911,7 +948,10 @@ export const TorConnect = (() => {
* @type {boolean}
*/
get enabled() {
- return lazy.TorProviderBuilder.build().ownsTorDaemon;
+ // FIXME: This is called before the TorProvider is ready.
+ // As a matter of fact, at the moment it is equivalent to the following
+ // line, but this might become a problem in the future.
+ return TorLauncherUtil.shouldStartAndOwnTor;
},
get shouldShowTorConnect() {
=====================================
browser/modules/TorSettings.sys.mjs
=====================================
@@ -5,6 +5,7 @@
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
+ TorLauncherUtil: "resource://gre/modules/TorLauncherUtil.sys.mjs",
TorProviderBuilder: "resource://gre/modules/TorProviderBuilder.sys.mjs",
TorProviderTopics: "resource://gre/modules/TorProviderBuilder.sys.mjs",
});
@@ -273,9 +274,10 @@ export const TorSettings = (() => {
},
/* load or init our settings, and register observers */
- init() {
- const provider = lazy.TorProviderBuilder.build();
- if (provider.ownsTorDaemon) {
+ async init() {
+ // TODO: We could use a shared promise, and wait for it to be fullfilled
+ // instead of Service.obs.
+ if (lazy.TorLauncherUtil.shouldStartAndOwnTor) {
// if the settings branch exists, load settings from prefs
if (Services.prefs.getBoolPref(TorSettingsPrefs.enabled, false)) {
this.loadFromPrefs();
@@ -285,9 +287,12 @@ export const TorSettings = (() => {
}
Services.obs.addObserver(this, lazy.TorProviderTopics.ProcessIsReady);
- if (provider.isRunning) {
- this.handleProcessReady();
- }
+ try {
+ const provider = await lazy.TorProviderBuilder.build();
+ if (provider.isRunning) {
+ this.handleProcessReady();
+ }
+ } catch {}
}
},
@@ -559,7 +564,8 @@ export const TorSettings = (() => {
}
/* Push to Tor */
- await lazy.TorProviderBuilder.build().writeSettings(settingsMap);
+ const provider = await lazy.TorProviderBuilder.build();
+ await provider.writeSettings(settingsMap);
return this;
},
=====================================
toolkit/components/tor-launcher/TorBootstrapRequest.sys.mjs
=====================================
@@ -26,11 +26,6 @@ export class TorBootstrapRequest {
#bootstrapPromiseResolve = null;
#bootstrapPromise = null;
#timeoutID = null;
- #provider = null;
-
- constructor() {
- this.#provider = TorProviderBuilder.build();
- }
observe(subject, topic, data) {
const obj = subject?.wrappedJSObject;
@@ -85,10 +80,14 @@ export class TorBootstrapRequest {
}, this.timeout);
}
- // wait for bootstrapping to begin and maybe handle error
- this.#provider.connect().catch(err => {
- this.#stop(err.message, "");
- });
+ // Wait for bootstrapping to begin and maybe handle error.
+ // Notice that we do not resolve the promise here in case of success, but
+ // we do it from the BootstrapStatus observer.
+ TorProviderBuilder.build()
+ .then(provider => provider.connect())
+ .catch(err => {
+ this.#stop(err.message, err.torMessage);
+ });
}).finally(() => {
// and remove ourselves once bootstrap is resolved
Services.obs.removeObserver(this, TorTopics.BootstrapStatus);
@@ -111,8 +110,15 @@ export class TorBootstrapRequest {
this.#timeoutID = null;
}
+ let provider;
+ try {
+ provider = await TorProviderBuilder.build();
+ } catch {
+ // This was probably the error that lead to stop in the first place.
+ // No need to continue propagating it.
+ }
try {
- await this.#provider.stopBootstrap();
+ await provider?.stopBootstrap();
} catch (e) {
console.error("Failed to stop the bootstrap.", e);
if (!message) {
=====================================
toolkit/components/tor-launcher/TorControlPort.sys.mjs
=====================================
@@ -1,43 +1,16 @@
-import { TorParsers } from "resource://gre/modules/TorParsers.sys.mjs";
-
-/**
- * @callback MessageCallback A callback to receive messages from the control
- * port.
- * @param {string} message The message to handle
- */
-/**
- * @callback RemoveCallback A function used to remove a previously registered
- * callback.
- */
+/* 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/. */
-class CallbackDispatcher {
- #callbackPairs = [];
+import { ConsoleAPI } from "resource://gre/modules/Console.sys.mjs";
- /**
- * Register a callback to handle a certain type of responses.
- *
- * @param {RegExp} regex The regex that tells which messages the callback
- * wants to handle.
- * @param {MessageCallback} callback The function to call
- * @returns {RemoveCallback} A function to remove the just added callback
- */
- addCallback(regex, callback) {
- this.#callbackPairs.push([regex, callback]);
- }
+import { TorParsers } from "resource://gre/modules/TorParsers.sys.mjs";
- /**
- * Push a certain message to all the callbacks whose regex matches it.
- *
- * @param {string} message The message to push to the callbacks
- */
- pushMessage(message) {
- for (const [regex, callback] of this.#callbackPairs) {
- if (message.match(regex)) {
- callback(message);
- }
- }
- }
-}
+const logger = new ConsoleAPI({
+ maxLogLevel: "warn",
+ maxLogLevelPref: "browser.tor_provider.cp_log_level",
+ prefix: "TorControlPort",
+});
/**
* A wrapper around XPCOM sockets and buffers to handle streams in a standard
@@ -273,13 +246,38 @@ class AsyncSocket {
* @property {Function} reject The function to reject the promise associated to
* the command
*/
-
+/**
+ * The ID of a circuit.
+ * From control-spec.txt:
+ * CircuitID = 1*16 IDChar
+ * IDChar = ALPHA / DIGIT
+ * Currently, Tor only uses digits, but this may change.
+ *
+ * @typedef {string} CircuitID
+ */
+/**
+ * The ID of a stream.
+ * From control-spec.txt:
+ * CircuitID = 1*16 IDChar
+ * IDChar = ALPHA / DIGIT
+ * Currently, Tor only uses digits, but this may change.
+ *
+ * @typedef {string} StreamID
+ */
+/**
+ * The fingerprint of a node.
+ * From control-spec.txt:
+ * Fingerprint = "$" 40*HEXDIG
+ * However, we do not keep the $ in our structures.
+ *
+ * @typedef {string} NodeFingerprint
+ */
/**
* @typedef {object} Bridge
* @property {string} transport The transport of the bridge, or vanilla if not
* specified.
* @property {string} addr The IP address and port of the bridge
- * @property {string} id The fingerprint of the bridge
+ * @property {NodeFingerprint} id The fingerprint of the bridge
* @property {string} args Optional arguments passed to the bridge
*/
/**
@@ -303,13 +301,9 @@ class AsyncSocket {
* @property {string} Flags Additional flags, such as Permanent
*/
/**
- * @callback EventFilterCallback
- * @param {any} data Either a raw string, or already parsed data
- * @returns {boolean}
- */
-/**
- * @callback EventCallback
- * @param {any} data Either a raw string, or already parsed data
+ * @callback EventCallback A callback to receive messages from the control
+ * port.
+ * @param {string} message The message to handle
*/
class TorError extends Error {
@@ -324,7 +318,7 @@ class TorError extends Error {
}
}
-class ControlSocket {
+export class TorController {
/**
* The socket to write to the control port.
*
@@ -332,19 +326,6 @@ class ControlSocket {
*/
#socket;
- /**
- * The dispatcher used for the data we receive over the control port.
- *
- * @type {CallbackDispatcher}
- */
- #mainDispatcher = new CallbackDispatcher();
- /**
- * A secondary dispatcher used only to dispatch aynchronous events.
- *
- * @type {CallbackDispatcher}
- */
- #notificationDispatcher = new CallbackDispatcher();
-
/**
* Data we received on a read but that was not a complete line (missing a
* final CRLF). We will prepend it to the next read.
@@ -365,24 +346,59 @@ class ControlSocket {
*/
#commandQueue = [];
- constructor(asyncSocket) {
- this.#socket = asyncSocket;
+ /**
+ * The event handler.
+ *
+ * @type {TorEventHandler}
+ */
+ #eventHandler;
- // #mainDispatcher pushes only async notifications (650) to
- // #notificationDispatcher
- this.#mainDispatcher.addCallback(
- /^650/,
- this.#handleNotification.bind(this)
- );
- // callback for handling responses and errors
- this.#mainDispatcher.addCallback(
- /^[245]\d\d/,
- this.#handleCommandReply.bind(this)
+ /**
+ * Connect to a control port over a Unix socket.
+ * Not available on Windows.
+ *
+ * @param {nsIFile} ipcFile The path to the Unix socket to connect to
+ * @param {TorEventHandler} eventHandler The event handler to use for
+ * asynchronous notifications
+ */
+ static fromIpcFile(ipcFile, eventHandler) {
+ return new TorController(AsyncSocket.fromIpcFile(ipcFile), eventHandler);
+ }
+
+ /**
+ * Connect to a control port over a TCP socket.
+ *
+ * @param {string} host The hostname to connect to
+ * @param {number} port The port to connect the to
+ * @param {TorEventHandler} eventHandler The event handler to use for
+ * asynchronous notifications
+ */
+ static fromSocketAddress(host, port, eventHandler) {
+ return new TorController(
+ AsyncSocket.fromSocketAddress(host, port),
+ eventHandler
);
+ }
+ /**
+ * Construct the controller and start the message pump.
+ * The class should not be constructed directly, but through static methods.
+ * However, this is public because JavaScript does not support private
+ * constructors.
+ *
+ * @private
+ * @param {AsyncSocket} socket The socket to use
+ * @param {TorEventHandler} eventHandler The event handler to use for
+ * asynchronous notifications
+ */
+ constructor(socket, eventHandler) {
+ this.#socket = socket;
+ this.#eventHandler = eventHandler;
this.#startMessagePump();
}
+ // Socket and communication handling
+
/**
* Return the next line in the queue. If there is not any, block until one is
* read (or until a communication error happens, including the underlying
@@ -463,6 +479,24 @@ class ControlSocket {
return message.join("\r\n");
}
+ /**
+ * Handles a message that was received as a reply to a command (i.e., all the
+ * messages that are not async notification messages starting with 650).
+ *
+ * @param {string} message The message to handle
+ */
+ #handleCommandReply(message) {
+ const cmd = this.#commandQueue.shift();
+ // We resolve also for messages that are failures for sure. The commands
+ // should always check the output.
+ cmd.resolve(message);
+
+ // send next command if one is available
+ if (this.#commandQueue.length) {
+ this.#writeNextCommand();
+ }
+ }
+
/**
* Read messages on the socket and routed them to a dispatcher until the
* socket is open or some error happens (including the underlying socket being
@@ -475,14 +509,25 @@ class ControlSocket {
// condition becoming false.
while (this.#socket) {
const message = await this.#readMessage();
- // log("controlPort >> " + message);
- this.#mainDispatcher.pushMessage(message);
+ try {
+ if (message.startsWith("650")) {
+ this.#handleNotification(message);
+ } else {
+ this.#handleCommandReply(message);
+ }
+ } catch (err) {
+ // E.g., if a notification handler fails. Without this internal
+ // try/catch we risk of closing the connection while not actually
+ // needed.
+ logger.error("Caught an exception while handling a message", err);
+ }
}
} catch (err) {
+ logger.debug("Caught an exception, closing the control port", err);
try {
this.#close(err);
} catch (ec) {
- console.error(
+ logger.error(
"Caught another error while closing the control socket.",
ec
);
@@ -497,7 +542,6 @@ class ControlSocket {
*/
#writeNextCommand() {
const cmd = this.#commandQueue[0];
- // log("controlPort << " + cmd.commandString);
this.#socket.write(`${cmd.commandString}\r\n`).catch(cmd.reject);
}
@@ -508,12 +552,11 @@ class ControlSocket {
* needs to handle multi-line messages.
*
* @param {string} commandString
- * @returns {Promise<string>} The message sent by the control port. It will
- * always start with 2xx. In case of other codes the function will throw,
- * instead. This means that the return value will never be an empty string
- * (even though it will not include the final CRLF).
+ * @returns {Promise<string>} The message sent by the control port. The return
+ * value should never be an empty string (even though it will not include the
+ * final CRLF).
*/
- async sendCommand(commandString) {
+ async #sendCommand(commandString) {
if (!this.#socket) {
throw new Error("ControlSocket not open");
}
@@ -534,42 +577,16 @@ class ControlSocket {
}
/**
- * Handles a message starting with 2xx, 4xx, or 5xx.
- * This function should be used only as a callback for the main dispatcher.
- *
- * @param {string} message The message to handle
- */
- #handleCommandReply(message) {
- const cmd = this.#commandQueue.shift();
- if (message[0] === "2") {
- cmd.resolve(message);
- } else if (message.match(/^[45]/)) {
- cmd.reject(new TorError(cmd.commandString, message));
- } else {
- // This should never happen, as the dispatcher should filter the messages
- // already.
- cmd.reject(
- new Error(`Received unexpected message:\n----\n${message}\n----`)
- );
- }
-
- // send next command if one is available
- if (this.#commandQueue.length) {
- this.#writeNextCommand();
- }
- }
-
- /**
- * Re-route an event message to the notification dispatcher.
- * This function should be used only as a callback for the main dispatcher.
+ * Send a simple command whose response is expected to be simply a "250 OK".
+ * The function will not return a reply, but will throw if an unexpected one
+ * is received.
*
- * @param {string} message The message received on the control port
+ * @param {string} command The command to send
*/
- #handleNotification(message) {
- try {
- this.#notificationDispatcher.pushMessage(message);
- } catch (e) {
- console.error("An event watcher threw", e);
+ async #sendCommandSimple(command) {
+ const reply = await this.#sendCommand(command);
+ if (!/^250 OK\s*$/i.test(reply)) {
+ throw new TorError(command, reply);
}
}
@@ -581,6 +598,7 @@ class ControlSocket {
* rejection reason to the commands that are still queued.
*/
#close(reason) {
+ logger.info("Closing the control port", reason);
const error = new Error(
"The control socket has been closed" +
(reason ? `: ${reason.message}` : "")
@@ -604,98 +622,29 @@ class ControlSocket {
this.#close(null);
}
- /**
- * Register an event watcher.
- *
- * @param {RegExp} regex The regex to filter on messages to receive
- * @param {MessageCallback} callback The callback for the messages
- */
- addNotificationCallback(regex, callback) {
- this.#notificationDispatcher.addCallback(regex, callback);
- }
-
/**
* Tells whether the underlying socket is still open.
*/
get isOpen() {
return !!this.#socket;
}
-}
-
-class TorController {
- /**
- * The control socket
- *
- * @type {ControlSocket}
- */
- #socket;
-
- /**
- * Builds a new TorController.
- *
- * @param {AsyncSocket} socket The socket to communicate to the control port
- */
- constructor(socket) {
- this.#socket = new ControlSocket(socket);
- }
-
- /**
- * Tells whether the underlying socket is open.
- *
- * @returns {boolean}
- */
- get isOpen() {
- return this.#socket.isOpen;
- }
-
- /**
- * Close the underlying socket.
- */
- close() {
- this.#socket.close();
- }
-
- /**
- * Send a command over the control port.
- * TODO: Make this function private, and force the operations to go through
- * specialized methods.
- *
- * @param {string} cmd The command to send
- * @returns {Promise<string>} A 2xx response obtained from the control port.
- * For other codes, this function will throw. The returned string will never
- * be empty.
- */
- async sendCommand(cmd) {
- return this.#socket.sendCommand(cmd);
- }
-
- /**
- * Send a simple command whose response is expected to be simply a "250 OK".
- * The function will not return a reply, but will throw if an unexpected one
- * is received.
- *
- * @param {string} command The command to send
- */
- async #sendCommandSimple(command) {
- const reply = await this.sendCommand(command);
- if (!/^250 OK\s*$/i.test(reply)) {
- throw new TorError(command, reply);
- }
- }
/**
* Authenticate to the tor daemon.
* Notice that a failure in the authentication makes the connection close.
*
- * @param {string} password The password for the control port.
+ * @param {Uint8Array} password The password for the control port, as an array
+ * of bytes
*/
async authenticate(password) {
- if (password) {
- this.#expectString(password, "password");
- }
- await this.#sendCommandSimple(`authenticate ${password || ""}`);
+ const passwordString = Array.from(password ?? [], b =>
+ b.toString(16).padStart(2, "0")
+ ).join("");
+ await this.#sendCommandSimple(`authenticate ${passwordString}`);
}
+ // Information
+
/**
* Sends a GETINFO for a single key.
* control-spec.txt says "one ReplyLine is sent for each requested value", so,
@@ -713,10 +662,10 @@ class TorController {
async #getInfo(key) {
this.#expectString(key);
const cmd = `GETINFO ${key}`;
- const reply = await this.sendCommand(cmd);
+ const reply = await this.#sendCommand(cmd);
const match =
reply.match(/^250-([^=]+)=(.*)$/m) ||
- reply.match(/^250\+([^=]+)=([\s\S]*?)^\.\r?\n^250 OK\s*$/m);
+ reply.match(/^250\+([^=]+)=\r?\n(.*?)\r?\n^\.\r?\n^250 OK\s*$/ms);
if (!match || match[1] !== key) {
throw new TorError(cmd, reply);
}
@@ -777,6 +726,17 @@ class TorController {
return this.#getInfo(`ip-to-country/${ip}`);
}
+ /**
+ * Ask Tor a list of circuits.
+ *
+ * @returns {string[]} An array with a string for each line
+ */
+ async getCircuits() {
+ const circuits = await this.#getInfo("circuit-status");
+ // TODO: Do more parsing once we move the event parsing to this class!
+ return circuits.split(/\r?\n/);
+ }
+
// Configuration
/**
@@ -805,7 +765,7 @@ class TorController {
throw new Error("The key can be composed only of letters and numbers.");
}
const cmd = `GETCONF ${key}`;
- const reply = await this.sendCommand(cmd);
+ const reply = await this.#sendCommand(cmd);
// From control-spec.txt: a 'default' value semantically different from an
// empty string will not have an equal sign, just `250 $key`.
const defaultRe = new RegExp(`^250[-\\s]${key}$`, "gim");
@@ -924,7 +884,7 @@ class TorController {
*/
async onionAuthViewKeys() {
const cmd = "onion_client_auth_view";
- const message = await this.sendCommand(cmd);
+ const message = await this.#sendCommand(cmd);
// Either `250-CLIENT`, or `250 OK` if no keys are available.
if (!message.startsWith("250")) {
throw new TorError(cmd, message);
@@ -964,7 +924,7 @@ class TorController {
if (isPermanent) {
cmd += " Flags=Permanent";
}
- const reply = await this.sendCommand(cmd);
+ const reply = await this.#sendCommand(cmd);
const status = reply.substring(0, 3);
if (status !== "250" && status !== "251" && status !== "252") {
throw new TorError(cmd, reply);
@@ -980,7 +940,7 @@ class TorController {
async onionAuthRemove(address) {
this.#expectString(address, "address");
const cmd = `onion_client_auth_remove ${address}`;
- const reply = await this.sendCommand(cmd);
+ const reply = await this.#sendCommand(cmd);
const status = reply.substring(0, 3);
if (status !== "250" && status !== "251") {
throw new TorError(cmd, reply);
@@ -1035,19 +995,77 @@ class TorController {
}
/**
- * Watches for a particular type of asynchronous event.
- * Notice: we only observe `"650" SP...` events, currently (no `650+...` or
- * `650-...` events).
- * Also, you need to enable the events in the control port with SETEVENTS,
- * first.
+ * Parse an asynchronous event and pass the data to the relative handler.
+ * Only single-line messages are currently supported.
*
- * @param {string} type The event type to catch
- * @param {EventCallback} callback The callback that will handle the event
+ * @param {string} message The message received on the control port. It should
+ * starts with `"650" SP`.
*/
- watchEvent(type, callback) {
- this.#expectString(type, "type");
- const start = `650 ${type}`;
- this.#socket.addNotificationCallback(new RegExp(`^${start}`), callback);
+ #handleNotification(message) {
+ if (!this.#eventHandler) {
+ return;
+ }
+ const data = message.match(/^650\s+(?<type>\S+)\s*(?<data>.*)?/);
+ if (!data) {
+ return;
+ }
+ switch (data.groups.type) {
+ case "STATUS_CLIENT":
+ let status;
+ try {
+ status = this.#parseBootstrapStatus(data.groups.data);
+ } catch (e) {
+ // Probably, a non bootstrap client status
+ logger.debug(`Failed to parse STATUS_CLIENT: ${data.groups.data}`, e);
+ break;
+ }
+ this.#eventHandler.onBootstrapStatus(status);
+ break;
+ case "CIRC":
+ const builtEvent =
+ /^(?<ID>[a-zA-Z0-9]{1,16})\sBUILT\s(?<Path>(,?\$([0-9a-fA-F]{40})(?:~[a-zA-Z0-9]{1,19})?)+)/.exec(
+ data.groups.data
+ );
+ const closedEvent = /^(?<ID>[a-zA-Z0-9]{1,16})\sCLOSED/.exec(
+ data.groups.data
+ );
+ if (builtEvent) {
+ const fp = /\$([0-9a-fA-F]{40})/g;
+ const nodes = Array.from(builtEvent.groups.Path.matchAll(fp), g =>
+ g[1].toUpperCase()
+ );
+ // In some cases, we might already receive SOCKS credentials in the
+ // line. However, this might be a problem with onion services: we get
+ // also a 4-hop circuit that we likely do not want to show to the
+ // user, especially because it is used only temporarily, and it would
+ // need a technical explaination.
+ // const credentials = this.#parseCredentials(data.groups.data);
+ this.#eventHandler.onCircuitBuilt(builtEvent.groups.ID, nodes);
+ } else if (closedEvent) {
+ this.#eventHandler.onCircuitClosed(closedEvent.groups.ID);
+ }
+ break;
+ case "STREAM":
+ const succeeedEvent =
+ /^(?<StreamID>[a-zA-Z0-9]{1,16})\sSUCCEEDED\s(?<CircuitID>[a-zA-Z0-9]{1,16})/.exec(
+ data.groups.data
+ );
+ if (succeeedEvent) {
+ const credentials = this.#parseCredentials(data.groups.data);
+ this.#eventHandler.onStreamSucceeded(
+ succeeedEvent.groups.StreamID,
+ succeeedEvent.groups.CircuitID,
+ credentials?.username ?? null,
+ credentials?.password ?? null
+ );
+ }
+ break;
+ case "NOTICE":
+ case "WARN":
+ case "ERR":
+ this.#eventHandler.onLogMessage(data.groups.type, data.groups.data);
+ break;
+ }
}
// Other helpers
@@ -1092,6 +1110,24 @@ class TorController {
}
}
+ /**
+ * Check if a STREAM or CIRC response line contains SOCKS_USERNAME and
+ * SOCKS_PASSWORD.
+ *
+ * @param {string} line The circ or stream line to check
+ * @returns {object?} The credentials, or null if not found
+ */
+ #parseCredentials(line) {
+ const username = /SOCKS_USERNAME=("(?:[^"\\]|\\.)*")/.exec(line);
+ const password = /SOCKS_PASSWORD=("(?:[^"\\]|\\.)*")/.exec(line);
+ return username && password
+ ? {
+ username: TorParsers.unescapeString(username[1]),
+ password: TorParsers.unescapeString(password[1]),
+ }
+ : null;
+ }
+
/**
* Return an object with all the matches that are in the form `key="value"` or
* `key=value`. The values will be unescaped, but no additional parsing will
@@ -1112,67 +1148,54 @@ class TorController {
}
}
-const controlPortInfo = {};
-
/**
- * Sets Tor control port connection parameters to be used in future calls to
- * the controller() function.
+ * @typedef {object} TorEventHandler
+ * The event handler interface.
+ * The controller owner can implement this methods to receive asynchronous
+ * notifications from the controller.
*
- * Example:
- * configureControlPortModule(undefined, "127.0.0.1", 9151, "MyPassw0rd");
+ * @property {OnBootstrapStatus} onBootstrapStatus Called when a bootstrap
+ * status is received (i.e., a STATUS_CLIENT event with a BOOTSTRAP action)
+ * @property {OnLogMessage} onLogMessage Called when a log message is received
+ * (i.e., a NOTICE, WARN or ERR notification)
+ * @property {OnCircuitBuilt} onCircuitBuilt Called when a circuit is built
+ * (i.e., a CIRC event with a BUILT status)
+ * @property {OnCircuitClosed} onCircuitClosed Called when a circuit is closed
+ * (i.e., a CIRC event with a CLOSED status)
+ * @property {OnStreamSucceeded} onStreamSucceeded Called when a stream receives
+ * a reply (i.e., a STREAM event with a SUCCEEDED status)
+ */
+/**
+ * @callback OnBootstrapStatus
*
- * @param {nsIFile?} ipcFile An optional file to use to communicate to the
- * control port on Unix platforms
- * @param {string?} host The hostname to connect to the control port. Mutually
- * exclusive with ipcFile
- * @param {integer?} port The port number of the control port. To be used only
- * with host. The default is 9151.
- * @param {string} password The password of the control port in clear text.
+ * @param {object} status An object with the bootstrap information. Its keys
+ * depend on what the arguments sent by the tor daemon
*/
-export function configureControlPortModule(ipcFile, host, port, password) {
- controlPortInfo.ipcFile = ipcFile;
- controlPortInfo.host = host;
- controlPortInfo.port = port || 9151;
- controlPortInfo.password = password;
-}
-
/**
- * Instantiates and returns a controller object that is connected and
- * authenticated to a Tor ControlPort using the connection parameters
- * provided in the most recent call to configureControlPortModule().
+ * @callback OnLogMessage
*
- * Example:
- * // Get a new controller
- * let c = await controller();
- * // Send command and receive a `250` reply or an error message:
- * let replyPromise = await c.getInfo("ip-to-country/16.16.16.16");
- * // Close the controller permanently
- * c.close();
+ * @param {string} type The type of message (NOTICE, WARNING, ERR, etc...)
+ * @param {string} message The actual log message
+ */
+/**
+ * @callback OnCircuitBuilt
+ *
+ * @param {CircuitID} id The id of the circuit that has been built
+ * @param {NodeFingerprint[]} nodes The onion routers composing the circuit
+ */
+/**
+ * @callback OnCircuitClosed
+ *
+ * @param {CircuitID} id The id of the circuit that has been closed
+ */
+/**
+ * @callback OnStreamSucceeded
+ *
+ * @param {StreamID} streamId The id of the stream that switched to the succeeded
+ * state
+ * @param {CircuitID} circuitId The id of the circuit the stream is using
+ * @param {string?} username The SOCKS username associated to the stream, or
+ * null if not available
+ * @param {string?} username The SOCKS password associated to the stream, or
+ * null if not available
*/
-export async function controller() {
- if (!controlPortInfo.ipcFile && !controlPortInfo.host) {
- throw new Error("Please call configureControlPortModule first");
- }
- let socket;
- if (controlPortInfo.ipcFile) {
- socket = AsyncSocket.fromIpcFile(controlPortInfo.ipcFile);
- } else {
- socket = AsyncSocket.fromSocketAddress(
- controlPortInfo.host,
- controlPortInfo.port
- );
- }
- const controller = new TorController(socket);
- try {
- await controller.authenticate(controlPortInfo.password);
- } catch (e) {
- try {
- controller.close();
- } catch (ec) {
- // TODO: Use a custom logger?
- console.error("Cannot close the socket", ec);
- }
- throw e;
- }
- return controller;
-}
=====================================
toolkit/components/tor-launcher/TorDomainIsolator.sys.mjs
=====================================
@@ -136,8 +136,11 @@ class TorDomainIsolatorImpl {
init() {
logger.info("Setup circuit isolation by domain and user context");
- if (Services.prefs.getBoolPref(NON_TOR_PROXY_PREF)) {
+ if (Services.prefs.getBoolPref(NON_TOR_PROXY_PREF, false)) {
this.#isolationEnabled = false;
+ logger.info(
+ `The domain isolation will not be enabled because of ${NON_TOR_PROXY_PREF}.`
+ );
}
this.#setupProxyFilter();
@@ -257,7 +260,8 @@ class TorDomainIsolatorImpl {
);
this.clearIsolation();
try {
- await lazy.TorProviderBuilder.build().newnym();
+ const provider = await lazy.TorProviderBuilder.build();
+ await provider.newnym();
} catch (e) {
logger.error("Could not send the newnym command", e);
// TODO: What UX to use here? See tor-browser#41708
@@ -305,7 +309,9 @@ class TorDomainIsolatorImpl {
try {
const searchParams = new URLSearchParams(loadingPrincipalURI.query);
if (searchParams.has("url")) {
- firstPartyDomain = Services.eTLD.getSchemelessSite(Services.io.newURI(searchParams.get("url")));
+ firstPartyDomain = Services.eTLD.getSchemelessSite(
+ Services.io.newURI(searchParams.get("url"))
+ );
}
} catch (e) {
logger.error("Failed to get first party domain for about:reader", e);
@@ -562,10 +568,9 @@ class TorDomainIsolatorImpl {
return;
}
+ const provider = await lazy.TorProviderBuilder.build();
data = await Promise.all(
- circuit.map(fingerprint =>
- lazy.TorProviderBuilder.build().getNodeInfo(fingerprint)
- )
+ circuit.map(fingerprint => provider.getNodeInfo(fingerprint))
);
this.#knownCircuits.set(id, data);
// We know that something changed, but we cannot know if anyone is
@@ -673,7 +678,9 @@ function getDomainForBrowser(browser) {
try {
const searchParams = new URLSearchParams(documentURI.query);
if (searchParams.has("url")) {
- fpd = Services.eTLD.getSchemelessSite(Services.io.newURI(searchParams.get("url")));
+ fpd = Services.eTLD.getSchemelessSite(
+ Services.io.newURI(searchParams.get("url"))
+ );
}
} catch (e) {
logger.error("Failed to get first party domain for about:reader", e);
=====================================
toolkit/components/tor-launcher/TorLauncherUtil.sys.mjs
=====================================
@@ -366,6 +366,38 @@ export const TorLauncherUtil = Object.freeze({
return btnIndex === 0;
},
+ /**
+ * Ask the user whether they desire to restart tor.
+ *
+ * @param {boolean} initError If we could connect to the control port at
+ * least once and we are showing this prompt because the tor process exited
+ * suddenly, we will display a different message
+ * @returns {boolean} true if the user asked to restart tor
+ */
+ showRestartPrompt(initError) {
+ let s;
+ if (initError) {
+ const key = "tor_exited_during_startup";
+ s = this.getLocalizedString(key);
+ } else {
+ // tor exited suddenly, so configuration should be okay
+ s =
+ this.getLocalizedString("tor_exited") +
+ "\n\n" +
+ this.getLocalizedString("tor_exited2");
+ }
+ const defaultBtnLabel = this.getLocalizedString("restart_tor");
+ let cancelBtnLabel = "OK";
+ try {
+ const kSysBundleURI = "chrome://global/locale/commonDialogs.properties";
+ const sysBundle = Services.strings.createBundle(kSysBundleURI);
+ cancelBtnLabel = sysBundle.GetStringFromName(cancelBtnLabel);
+ } catch (e) {
+ console.warn("Could not localize the cancel button", e);
+ }
+ return this.showConfirm(null, s, defaultBtnLabel, cancelBtnLabel);
+ },
+
// Localized Strings
// TODO: Switch to fluent also these ones.
@@ -503,10 +535,6 @@ export const TorLauncherUtil = Object.freeze({
*/
getPreferredSocksConfiguration() {
if (Services.env.exists("TOR_TRANSPROXY")) {
- Services.prefs.setBoolPref("network.proxy.socks_remote_dns", false);
- Services.prefs.setIntPref("network.proxy.type", 0);
- Services.prefs.setIntPref("network.proxy.socks_port", 0);
- Services.prefs.setCharPref("network.proxy.socks", "");
return { transproxy: true };
}
@@ -576,6 +604,10 @@ export const TorLauncherUtil = Object.freeze({
setProxyConfiguration(socksPortInfo) {
if (socksPortInfo.transproxy) {
+ Services.prefs.setBoolPref("network.proxy.socks_remote_dns", false);
+ Services.prefs.setIntPref("network.proxy.type", 0);
+ Services.prefs.setIntPref("network.proxy.socks_port", 0);
+ Services.prefs.setCharPref("network.proxy.socks", "");
return;
}
=====================================
toolkit/components/tor-launcher/TorParsers.sys.mjs
=====================================
@@ -6,171 +6,6 @@ export const TorStatuses = Object.freeze({
});
export const TorParsers = Object.freeze({
- commandSucceeded(aReply) {
- return aReply?.statusCode === TorStatuses.OK;
- },
-
- // parseReply() understands simple GETCONF and GETINFO replies.
- parseReply(aCmd, aKey, aReply) {
- if (!aCmd || !aKey || !aReply || !aReply.lineArray?.length) {
- return [];
- }
-
- const lcKey = aKey.toLowerCase();
- const prefix = lcKey + "=";
- const prefixLen = prefix.length;
- const tmpArray = [];
- for (const line of aReply.lineArray) {
- var lcLine = line.toLowerCase();
- if (lcLine === lcKey) {
- tmpArray.push("");
- } else if (lcLine.indexOf(prefix) !== 0) {
- console.warn(`Unexpected ${aCmd} response: ${line}`);
- } else {
- try {
- let s = this.unescapeString(line.substring(prefixLen));
- tmpArray.push(s);
- } catch (e) {
- console.warn(
- `Error while unescaping the response of ${aCmd}: ${line}`,
- e
- );
- }
- }
- }
-
- return tmpArray;
- },
-
- // Returns false if more lines are needed. The first time, callers
- // should pass an empty aReplyObj.
- // Parsing errors are indicated by aReplyObj._parseError = true.
- parseReplyLine(aLine, aReplyObj) {
- if (!aLine || !aReplyObj) {
- return false;
- }
-
- if (!("_parseError" in aReplyObj)) {
- aReplyObj.statusCode = 0;
- aReplyObj.lineArray = [];
- aReplyObj._parseError = false;
- }
-
- if (aLine.length < 4) {
- console.error("Unexpected response: ", aLine);
- aReplyObj._parseError = true;
- return true;
- }
-
- // TODO: handle + separators (data)
- aReplyObj.statusCode = parseInt(aLine.substring(0, 3), 10);
- const s = aLine.length < 5 ? "" : aLine.substring(4);
- // Include all lines except simple "250 OK" ones.
- if (aReplyObj.statusCode !== TorStatuses.OK || s !== "OK") {
- aReplyObj.lineArray.push(s);
- }
-
- return aLine.charAt(3) === " ";
- },
-
- // Split aStr at spaces, accounting for quoted values.
- // Returns an array of strings.
- splitReplyLine(aStr) {
- // Notice: the original function did not check for escaped quotes.
- return aStr
- .split('"')
- .flatMap((token, index) => {
- const inQuotedStr = index % 2 === 1;
- return inQuotedStr ? `"${token}"` : token.split(" ");
- })
- .filter(s => s);
- },
-
- // Helper function for converting a raw controller response into a parsed object.
- parseCommandResponse(reply) {
- if (!reply) {
- return {};
- }
- const lines = reply.split("\r\n");
- const rv = {};
- for (const line of lines) {
- if (this.parseReplyLine(line, rv) || rv._parseError) {
- break;
- }
- }
- return rv;
- },
-
- // If successful, returns a JS object with these fields:
- // status.TYPE -- "NOTICE" or "WARN"
- // status.PROGRESS -- integer
- // status.TAG -- string
- // status.SUMMARY -- string
- // status.WARNING -- string (optional)
- // status.REASON -- string (optional)
- // status.COUNT -- integer (optional)
- // status.RECOMMENDATION -- string (optional)
- // status.HOSTADDR -- string (optional)
- // Returns null upon failure.
- parseBootstrapStatus(aStatusMsg) {
- if (!aStatusMsg || !aStatusMsg.length) {
- return null;
- }
-
- let sawBootstrap = false;
- const statusObj = {};
- statusObj.TYPE = "NOTICE";
-
- // The following code assumes that this is a one-line response.
- for (const tokenAndVal of this.splitReplyLine(aStatusMsg)) {
- let token, val;
- const idx = tokenAndVal.indexOf("=");
- if (idx < 0) {
- token = tokenAndVal;
- } else {
- token = tokenAndVal.substring(0, idx);
- try {
- val = TorParsers.unescapeString(tokenAndVal.substring(idx + 1));
- } catch (e) {
- console.debug("Could not parse the token value", e);
- }
- if (!val) {
- // skip this token/value pair.
- continue;
- }
- }
-
- switch (token) {
- case "BOOTSTRAP":
- sawBootstrap = true;
- break;
- case "WARN":
- case "NOTICE":
- case "ERR":
- statusObj.TYPE = token;
- break;
- case "COUNT":
- case "PROGRESS":
- statusObj[token] = parseInt(val, 10);
- break;
- default:
- statusObj[token] = val;
- break;
- }
- }
-
- if (!sawBootstrap) {
- if (statusObj.TYPE === "NOTICE") {
- console.info(aStatusMsg);
- } else {
- console.warn(aStatusMsg);
- }
- return null;
- }
-
- return statusObj;
- },
-
// Escape non-ASCII characters for use within the Tor Control protocol.
// Based on Vidalia's src/common/stringutil.cpp:string_escape().
// Returns the new string.
=====================================
toolkit/components/tor-launcher/TorProcess.sys.mjs
=====================================
@@ -37,12 +37,11 @@ export class TorProcess {
#didConnectToTorControlPort = false;
onExit = exitCode => {};
- onRestart = () => {};
constructor(controlSettings, socksSettings) {
if (
controlSettings &&
- !controlSettings.password &&
+ !controlSettings.password?.length &&
!controlSettings.cookieFilePath
) {
throw new Error("Unauthenticated control port is not supported");
@@ -204,43 +203,22 @@ export class TorProcess {
#processExitedUnexpectedly(exitCode) {
this.#subprocess = null;
this.#status = TorProcessStatus.Exited;
-
- // TODO: Move this logic somewhere else?
- let s;
+ // FIXME: We can probably drop #didConnectToTorControlPort and use only one
+ // callback. Then we can let the provider actually distinguish between the
+ // cases.
if (!this.#didConnectToTorControlPort) {
- // tor might be misconfigured, becauser we could never connect to it
- const key = "tor_exited_during_startup";
- s = lazy.TorLauncherUtil.getLocalizedString(key);
- } else {
- // tor exited suddenly, so configuration should be okay
- s =
- lazy.TorLauncherUtil.getLocalizedString("tor_exited") +
- "\n\n" +
- lazy.TorLauncherUtil.getLocalizedString("tor_exited2");
- }
- logger.info(s);
- const defaultBtnLabel =
- lazy.TorLauncherUtil.getLocalizedString("restart_tor");
- let cancelBtnLabel = "OK";
- try {
- const kSysBundleURI = "chrome://global/locale/commonDialogs.properties";
- const sysBundle = Services.strings.createBundle(kSysBundleURI);
- cancelBtnLabel = sysBundle.GetStringFromName(cancelBtnLabel);
- } catch (e) {
- logger.warn("Could not localize the cancel button", e);
- }
-
- const restart = lazy.TorLauncherUtil.showConfirm(
- null,
- s,
- defaultBtnLabel,
- cancelBtnLabel
- );
- if (restart) {
- this.start().then(this.onRestart);
- } else {
+ logger.warn("Tor exited before we could connect to its control port.");
+ // tor might be misconfigured, because we could never connect to it.
+ // Two instances of Tor Browser trying to use the same port numbers is
+ // also a typical scenario for this.
+ // This might happen very early, before the browser UI is actually
+ // available. So, we will tell the process owner that the process exited,
+ // without trying to restart it.
this.onExit(exitCode);
+ return;
}
+ logger.warn("Tor exited suddenly.");
+ this.onExit(exitCode);
}
#makeArgs() {
@@ -318,7 +296,7 @@ export class TorProcess {
this.#args.push("+__ControlPort", controlPortArg);
}
- if (this.#controlSettings.password) {
+ if (this.#controlSettings.password?.length) {
this.#args.push(
"HashedControlPassword",
this.#hashPassword(this.#controlSettings.password)
@@ -357,36 +335,43 @@ export class TorProcess {
}
}
- // Based on Vidalia's TorSettings::hashPassword().
- #hashPassword(aHexPassword) {
- if (!aHexPassword) {
- return null;
- }
+ /**
+ * Hash a password to then pass it to Tor as a command line argument.
+ * Based on Vidalia's TorSettings::hashPassword().
+ *
+ * @param {Uint8Array} password The password, as an array of bytes
+ */
+ #hashPassword(password) {
+ // The password has already been checked by the caller.
// Generate a random, 8 byte salt value.
const salt = Array.from(crypto.getRandomValues(new Uint8Array(8)));
- // Convert hex-encoded password to an array of bytes.
- const password = [];
- for (let i = 0; i < aHexPassword.length; i += 2) {
- password.push(parseInt(aHexPassword.substring(i, i + 2), 16));
- }
-
// Run through the S2K algorithm and convert to a string.
const toHex = v => v.toString(16).padStart(2, "0");
const arrayToHex = aArray => aArray.map(toHex).join("");
const kCodedCount = 96;
- const hashVal = this.#cryptoSecretToKey(password, salt, kCodedCount);
+ const hashVal = this.#cryptoSecretToKey(
+ Array.from(password),
+ salt,
+ kCodedCount
+ );
return "16:" + arrayToHex(salt) + toHex(kCodedCount) + arrayToHex(hashVal);
}
- // #cryptoSecretToKey() is similar to Vidalia's crypto_secret_to_key().
- // It generates and returns a hash of aPassword by following the iterated
- // and salted S2K algorithm (see RFC 2440 section 3.6.1.3).
- // See also https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/control-spec.txt#L3824.
- // Returns an array of bytes.
- #cryptoSecretToKey(aPassword, aSalt, aCodedCount) {
- const inputArray = aSalt.concat(aPassword);
+ /**
+ * Generates and return a hash of a password by following the iterated and
+ * salted S2K algorithm (see RFC 2440 section 3.6.1.3).
+ * See also https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/control-spec.txt#L3824.
+ * #cryptoSecretToKey() is similar to Vidalia's crypto_secret_to_key().
+ *
+ * @param {Array} password The password to hash, as an array of bytes
+ * @param {Array} salt The salt to use for the hash, as an array of bytes
+ * @param {number} codedCount The counter, coded as specified in RFC 2440
+ * @returns {Array} The hash of the password, as an array of bytes
+ */
+ #cryptoSecretToKey(password, salt, codedCount) {
+ const inputArray = salt.concat(password);
// Subtle crypto only has the final digest, and does not allow incremental
// updates.
@@ -395,7 +380,7 @@ export class TorProcess {
);
hasher.init(hasher.SHA1);
const kEXPBIAS = 6;
- let count = (16 + (aCodedCount & 15)) << ((aCodedCount >> 4) + kEXPBIAS);
+ let count = (16 + (codedCount & 15)) << ((codedCount >> 4) + kEXPBIAS);
while (count > 0) {
if (count > inputArray.length) {
hasher.update(inputArray, inputArray.length);
=====================================
toolkit/components/tor-launcher/TorProvider.sys.mjs
=====================================
@@ -2,21 +2,17 @@
* 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/. */
-import { setTimeout, clearTimeout } from "resource://gre/modules/Timer.sys.mjs";
+import { clearTimeout, setTimeout } from "resource://gre/modules/Timer.sys.mjs";
import { ConsoleAPI } from "resource://gre/modules/Console.sys.mjs";
import { TorLauncherUtil } from "resource://gre/modules/TorLauncherUtil.sys.mjs";
-import {
- TorParsers,
- TorStatuses,
-} from "resource://gre/modules/TorParsers.sys.mjs";
+import { TorParsers } from "resource://gre/modules/TorParsers.sys.mjs";
import { TorProviderTopics } from "resource://gre/modules/TorProviderBuilder.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
- controller: "resource://gre/modules/TorControlPort.sys.mjs",
- configureControlPortModule: "resource://gre/modules/TorControlPort.sys.mjs",
FileUtils: "resource://gre/modules/FileUtils.sys.mjs",
+ TorController: "resource://gre/modules/TorControlPort.sys.mjs",
TorProcess: "resource://gre/modules/TorProcess.sys.mjs",
});
@@ -27,20 +23,23 @@ const logger = new ConsoleAPI({
});
/**
- * From control-spec.txt:
- * CircuitID = 1*16 IDChar
- * IDChar = ALPHA / DIGIT
- * Currently, Tor only uses digits, but this may change.
- *
- * @typedef {string} CircuitID
+ * @typedef {object} ControlPortSettings An object with the settings to use for
+ * the control port. All the entries are optional, but an authentication
+ * mechanism and a communication method must be specified.
+ * @property {Uint8Array=} password The clear text password as an array of
+ * bytes. It must always be defined, unless cookieFilePath is
+ * @property {string=} cookieFilePath The path to the cookie file to use for
+ * authentication
+ * @property {nsIFile=} ipcFile The nsIFile object with the path to a Unix
+ * socket to use for control socket
+ * @property {string=} host The host to connect for a TCP control port
+ * @property {number=} port The port number to use for a TCP control port
*/
/**
- * The fingerprint of a node.
- * From control-spec.txt:
- * Fingerprint = "$" 40*HEXDIG
- * However, we do not keep the $ in our structures.
- *
- * @typedef {string} NodeFingerprint
+ * @typedef {object} LogEntry An object with a log message
+ * @property {Date} date The date at which we received the message
+ * @property {string} type The message level
+ * @property {string} msg The message
*/
/**
* Stores the data associated with a circuit node.
@@ -57,15 +56,13 @@ const logger = new ConsoleAPI({
*/
const Preferences = Object.freeze({
+ ControlUseIpc: "extensions.torlauncher.control_port_use_ipc",
+ ControlHost: "extensions.torlauncher.control_host",
+ ControlPort: "extensions.torlauncher.control_port",
+ MaxLogEntries: "extensions.torlauncher.max_tor_log_entries",
PromptAtStartup: "extensions.torlauncher.prompt_at_startup",
});
-const ControlConnTimings = Object.freeze({
- initialDelayMS: 25, // Wait 25ms after the process has started, before trying to connect
- maxRetryMS: 10000, // Retry at most every 10 seconds
- timeoutMS: 5 * 60 * 1000, // Wait at most 5 minutes for tor to start
-});
-
/**
* This is a Tor provider for the C Tor daemon.
*
@@ -73,61 +70,169 @@ const ControlConnTimings = Object.freeze({
* In the former case, it also takes its ownership by default.
*/
export class TorProvider {
- #inited = false;
+ /**
+ * The control port settings.
+ *
+ * @type {ControlPortSettings?}
+ */
+ #controlPortSettings = null;
+ /**
+ * An instance of the tor controller.
+ * We take for granted that if it is not null, we connected to it and managed
+ * to authenticate.
+ * Public methods can use the #controller getter, which will throw an
+ * exception whenever the control port is not open.
+ *
+ * @type {TorController?}
+ */
+ #controlConnection = null;
+ /**
+ * A helper that can be used to get the control port connection and assert it
+ * is open and it can be used.
+ * If this is not the case, this getter will throw.
+ *
+ * @returns {TorController}
+ */
+ get #controller() {
+ if (!this.#controlConnection?.isOpen) {
+ throw new Error("Control port connection not available.");
+ }
+ return this.#controlConnection;
+ }
+ /**
+ * A function that can be called to cancel the current connection attempt.
+ */
+ #cancelConnection = () => {};
- // Maintain a map of tor settings set by Tor Browser so that we don't
- // repeatedly set the same key/values over and over.
- // This map contains string keys to primitives or array values.
- #settingsCache = new Map();
+ /**
+ * The tor process we launched.
+ *
+ * @type {TorProcess}
+ */
+ #torProcess = null;
- #controlPort = null;
- #controlHost = null;
- #controlIPCFile = null; // An nsIFile if using IPC for control port.
- #controlPassword = null; // JS string that contains hex-encoded password.
- #SOCKSPortInfo = null; // An object that contains ipcFile, host, port.
+ /**
+ * The logs we received over the control port.
+ * We store a finite number of log entries which can be configured with
+ * extensions.torlauncher.max_tor_log_entries.
+ *
+ * @type {LogEntry[]}
+ */
+ #logs = [];
- #controlConnection = null; // This is cached and reused.
+ #isBootstrapDone = false;
+ /**
+ * Keep the last warning to avoid broadcasting an async warning if it is the
+ * same one as the last broadcast.
+ */
+ #lastWarning = {};
- // Public methods
+ /**
+ * Stores the nodes of a circuit. Keys are cicuit IDs, and values are the node
+ * fingerprints.
+ *
+ * Theoretically, we could hook this map up to the new identity notification,
+ * but in practice it does not work. Tor pre-builds circuits, and the NEWNYM
+ * signal does not affect them. So, we might end up using a circuit that was
+ * built before the new identity but not yet used. If we cleaned the map, we
+ * risked of not having the data about it.
+ *
+ * @type {Map<CircuitID, NodeFingerprint[]>}
+ */
+ #circuits = new Map();
+ /**
+ * The last used bridge, or null if bridges are not in use or if it was not
+ * possible to detect the bridge. This needs the user to have specified bridge
+ * lines with fingerprints to work.
+ *
+ * @type {NodeFingerprint?}
+ */
+ #currentBridge = null;
+ /**
+ * Maintain a map of tor settings set by Tor Browser so that we don't
+ * repeatedly set the same key/values over and over.
+ * This map contains string keys to primitives or array values.
+ *
+ * @type {Map<string, any>}
+ */
+ #settingsCache = new Map();
+
+ /**
+ * Starts a new tor process and connect to its control port, or connect to the
+ * control port of an existing tor daemon.
+ */
async init() {
- if (this.#inited) {
- return;
+ logger.debug("Initializing the Tor provider.");
+
+ const socksSettings = TorLauncherUtil.getPreferredSocksConfiguration();
+ logger.debug("Requested SOCKS configuration", socksSettings);
+
+ try {
+ await this.#setControlPortConfiguration();
+ } catch (e) {
+ logger.error("We do not have a control port configuration", e);
+ throw e;
}
- this.#inited = true;
- Services.obs.addObserver(this, TorProviderTopics.ProcessExited);
- Services.obs.addObserver(this, TorProviderTopics.ProcessRestarted);
+ if (socksSettings.transproxy) {
+ logger.info("Transparent proxy required, not starting a Tor daemon.");
+ } else if (this.ownsTorDaemon) {
+ try {
+ await this.#startDaemon(socksSettings);
+ } catch (e) {
+ logger.error("Failed to start the tor daemon", e);
+ throw e;
+ }
+ } else {
+ logger.debug(
+ "Not starting a tor daemon because we were requested not to."
+ );
+ }
+
+ try {
+ await this.#firstConnection();
+ } catch (e) {
+ logger.error("Cannot connect to the control port", e);
+ throw e;
+ }
- await this.#setSockets();
+ // We do not customize SOCKS settings, at least for now.
+ TorLauncherUtil.setProxyConfiguration(socksSettings);
- this._monitorInit();
+ logger.info("The Tor provider is ready.");
- logger.debug("TorProvider initialized");
+ logger.debug(`Notifying ${TorProviderTopics.ProcessIsReady}`);
+ Services.obs.notifyObservers(null, TorProviderTopics.ProcessIsReady);
}
+ /**
+ * Close the connection to the tor daemon.
+ * When Tor is started by Tor Browser, it is configured to exit when the
+ * control connection is closed. Therefore, as a matter of facts, calling this
+ * function also makes the child Tor instance stop.
+ */
uninit() {
- Services.obs.removeObserver(this, TorProviderTopics.ProcessExited);
- Services.obs.removeObserver(this, TorProviderTopics.ProcessRestarted);
- this.#closeConnection();
- this._monitorUninit();
- }
+ logger.debug("Uninitializing the Tor provider.");
- observe(subject, topic, data) {
- if (topic === TorProviderTopics.ProcessExited) {
- this.#closeConnection();
- } else if (topic === TorProviderTopics.ProcessRestarted) {
- this.#reconnect();
+ if (this.#torProcess) {
+ this.#torProcess.forget();
+ this.#torProcess.onExit = () => {};
+ this.#torProcess = null;
}
+
+ this.#closeConnection("Uninitializing the provider.");
}
- // takes a Map containing tor settings
- // throws on error
- async writeSettings(aSettingsObj) {
+ // Provider API
+
+ async writeSettings(settingsObj) {
+ // TODO: Move the translation from settings object to settings understood by
+ // tor here.
const entries =
- aSettingsObj instanceof Map
- ? Array.from(aSettingsObj.entries())
- : Object.entries(aSettingsObj);
+ settingsObj instanceof Map
+ ? Array.from(settingsObj.entries())
+ : Object.entries(settingsObj);
// only write settings that have changed
const newSettings = entries.filter(([setting, value]) => {
if (!this.#settingsCache.has(setting)) {
@@ -150,8 +255,7 @@ export class TorProvider {
// only write if new setting to save
if (newSettings.length) {
- const conn = await this.#getConnection();
- await conn.setConf(Object.fromEntries(newSettings));
+ await this.#controller.setConf(Object.fromEntries(newSettings));
// save settings to cache after successfully writing to Tor
for (const [setting, value] of newSettings) {
@@ -160,49 +264,76 @@ export class TorProvider {
}
}
- // writes current tor settings to disk
async flushSettings() {
- const conn = await this.#getConnection();
- await conn.flushSettings();
+ await this.#controller.flushSettings();
}
+ /**
+ * Start the bootstrap process.
+ */
async connect() {
- const conn = await this.#getConnection();
- await conn.setNetworkEnabled(true);
- this.clearBootstrapError();
+ await this.#controller.setNetworkEnabled(true);
+ this.#lastWarning = {};
this.retrieveBootstrapStatus();
}
+ /**
+ * Stop the bootstrap process.
+ */
async stopBootstrap() {
- // Tell tor to disable use of the network; this should stop the bootstrap
- // process.
- const conn = await this.#getConnection();
- await conn.setNetworkEnabled(false);
+ // Tell tor to disable use of the network; this should stop the bootstrap.
+ await this.#controller.setNetworkEnabled(false);
// We are not interested in waiting for this, nor in **catching its error**,
// so we do not await this. We just want to be notified when the bootstrap
// status is actually updated through observers.
this.retrieveBootstrapStatus();
}
+ /**
+ * Ask Tor to swtich to new circuits and clear the DNS cache.
+ */
async newnym() {
- const conn = await this.#getConnection();
- await conn.newnym();
+ await this.#controller.newnym();
}
+ /**
+ * Get the bridges Tor has been configured with.
+ *
+ * @returns {Bridge[]} The configured bridges
+ */
async getBridges() {
- const conn = await this.#getConnection();
// Ideally, we would not need this function, because we should be the one
// setting them with TorSettings. However, TorSettings is not notified of
// change of settings. So, asking tor directly with the control connection
// is the most reliable way of getting the configured bridges, at the
// moment. Also, we are using this for the circuit display, which should
// work also when we are not configuring the tor daemon, but just using it.
- return conn.getBridges();
+ return this.#controller.getBridges();
}
+ /**
+ * Get the configured pluggable transports.
+ *
+ * @returns {PTInfo[]} An array with the info of all the configured pluggable
+ * transports.
+ */
async getPluggableTransports() {
- const conn = await this.#getConnection();
- return conn.getPluggableTransports();
+ return this.#controller.getPluggableTransports();
+ }
+
+ /**
+ * Ask Tor its bootstrap phase.
+ * This function will also update the internal state when using an external
+ * tor daemon.
+ *
+ * @returns {object} An object with the bootstrap information received from
+ * Tor. Its keys might vary, depending on the input
+ */
+ async retrieveBootstrapStatus() {
+ this.#processBootstrapStatus(
+ await this.#controller.getBootstrapPhase(),
+ false
+ );
}
/**
@@ -212,14 +343,13 @@ export class TorProvider {
* @returns {Promise<NodeData>}
*/
async getNodeInfo(id) {
- const conn = await this.#getConnection();
const node = {
fingerprint: id,
ipAddrs: [],
bridgeType: null,
regionCode: null,
};
- const bridge = (await conn.getBridges())?.find(
+ const bridge = (await this.#controller.getBridges())?.find(
foundBridge => foundBridge.id?.toUpperCase() === id.toUpperCase()
);
if (bridge) {
@@ -230,14 +360,14 @@ export class TorProvider {
node.ipAddrs.push(ip);
}
} else {
- node.ipAddrs = await conn.getNodeAddresses(id);
+ node.ipAddrs = await this.#controller.getNodeAddresses(id);
}
if (node.ipAddrs.length) {
// Get the country code for the node's IP address.
try {
// Expect a 2-letter ISO3166-1 code, which should also be a valid
// BCP47 Region subtag.
- const regionCode = await conn.getIPCountry(node.ipAddrs[0]);
+ const regionCode = await this.#controller.getIPCountry(node.ipAddrs[0]);
if (regionCode && regionCode !== "??") {
node.regionCode = regionCode.toUpperCase();
}
@@ -248,301 +378,40 @@ export class TorProvider {
return node;
}
+ /**
+ * Add a private key to the Tor configuration.
+ *
+ * @param {string} address The address of the onion service
+ * @param {string} b64PrivateKey The private key of the service, in base64
+ * @param {boolean} isPermanent Tell whether the key should be saved forever
+ */
async onionAuthAdd(address, b64PrivateKey, isPermanent) {
- const conn = await this.#getConnection();
- return conn.onionAuthAdd(address, b64PrivateKey, isPermanent);
- }
-
- async onionAuthRemove(address) {
- const conn = await this.#getConnection();
- return conn.onionAuthRemove(address);
+ return this.#controller.onionAuthAdd(address, b64PrivateKey, isPermanent);
}
- async onionAuthViewKeys() {
- const conn = await this.#getConnection();
- return conn.onionAuthViewKeys();
- }
-
- // TODO: transform the following 4 functions in getters.
-
- // Returns Tor password string or null if an error occurs.
- torGetPassword() {
- return this.#controlPassword;
- }
-
- torGetControlIPCFile() {
- return this.#controlIPCFile?.clone();
- }
-
- torGetControlPort() {
- return this.#controlPort;
- }
-
- torGetSOCKSPortInfo() {
- return this.#SOCKSPortInfo;
- }
-
- get torControlPortInfo() {
- const info = {
- password: this.#controlPassword,
- };
- if (this.#controlIPCFile) {
- info.ipcFile = this.#controlIPCFile?.clone();
- }
- if (this.#controlPort) {
- info.host = this.#controlHost;
- info.port = this.#controlPort;
- }
- return info;
- }
-
- get torSOCKSPortInfo() {
- return this.#SOCKSPortInfo;
- }
-
- async #setSockets() {
- try {
- const isWindows = TorLauncherUtil.isWindows;
- // Determine how Tor Launcher will connect to the Tor control port.
- // Environment variables get top priority followed by preferences.
- if (!isWindows && Services.env.exists("TOR_CONTROL_IPC_PATH")) {
- const ipcPath = Services.env.get("TOR_CONTROL_IPC_PATH");
- this.#controlIPCFile = new lazy.FileUtils.File(ipcPath);
- } else {
- // Check for TCP host and port environment variables.
- if (Services.env.exists("TOR_CONTROL_HOST")) {
- this.#controlHost = Services.env.get("TOR_CONTROL_HOST");
- }
- if (Services.env.exists("TOR_CONTROL_PORT")) {
- this.#controlPort = parseInt(
- Services.env.get("TOR_CONTROL_PORT"),
- 10
- );
- }
-
- const useIPC =
- !isWindows &&
- Services.prefs.getBoolPref(
- "extensions.torlauncher.control_port_use_ipc",
- false
- );
- if (!this.#controlHost && !this.#controlPort && useIPC) {
- this.#controlIPCFile = TorLauncherUtil.getTorFile(
- "control_ipc",
- false
- );
- } else {
- if (!this.#controlHost) {
- this.#controlHost = Services.prefs.getCharPref(
- "extensions.torlauncher.control_host",
- "127.0.0.1"
- );
- }
- if (!this.#controlPort) {
- this.#controlPort = Services.prefs.getIntPref(
- "extensions.torlauncher.control_port",
- 9151
- );
- }
- }
- }
-
- // Populate _controlPassword so it is available when starting tor.
- if (Services.env.exists("TOR_CONTROL_PASSWD")) {
- this.#controlPassword = Services.env.get("TOR_CONTROL_PASSWD");
- } else if (Services.env.exists("TOR_CONTROL_COOKIE_AUTH_FILE")) {
- // TODO: test this code path (TOR_CONTROL_COOKIE_AUTH_FILE).
- const cookiePath = Services.env.get("TOR_CONTROL_COOKIE_AUTH_FILE");
- if (cookiePath) {
- this.#controlPassword = await this.#readAuthenticationCookie(
- cookiePath
- );
- }
- }
- if (!this.#controlPassword) {
- this.#controlPassword = this.#generateRandomPassword();
- }
-
- this.#SOCKSPortInfo = TorLauncherUtil.getPreferredSocksConfiguration();
- TorLauncherUtil.setProxyConfiguration(this.#SOCKSPortInfo);
-
- // Set the global control port info parameters.
- lazy.configureControlPortModule(
- this.#controlIPCFile,
- this.#controlHost,
- this.#controlPort,
- this.#controlPassword
- );
- } catch (e) {
- logger.error("Failed to get environment variables", e);
- }
- }
-
- async #getConnection() {
- if (!this.#controlConnection?.isOpen) {
- this.#controlConnection = await lazy.controller();
- }
- return this.#controlConnection;
- }
-
- #closeConnection() {
- if (this.#controlConnection) {
- logger.info("Closing the control connection");
- this.#controlConnection.close();
- this.#controlConnection = null;
- }
- }
-
- async #reconnect() {
- this.#closeConnection();
- await this.#getConnection();
- }
-
- async #readAuthenticationCookie(aPath) {
- const bytes = await IOUtils.read(aPath);
- return Array.from(bytes, b => this.#toHex(b, 2)).join("");
- }
-
- // Returns a random 16 character password, hex-encoded.
- #generateRandomPassword() {
- // Similar to Vidalia's crypto_rand_string().
- const kPasswordLen = 16;
- const kMinCharCode = "!".charCodeAt(0);
- const kMaxCharCode = "~".charCodeAt(0);
- let pwd = "";
- for (let i = 0; i < kPasswordLen; ++i) {
- const val = this.#cryptoRandInt(kMaxCharCode - kMinCharCode + 1);
- if (val < 0) {
- logger.error("_cryptoRandInt() failed");
- return null;
- }
- pwd += this.#toHex(kMinCharCode + val, 2);
- }
-
- return pwd;
- }
-
- // Returns -1 upon failure.
- #cryptoRandInt(aMax) {
- // Based on tor's crypto_rand_int().
- const maxUInt = 0xffffffff;
- if (aMax <= 0 || aMax > maxUInt) {
- return -1;
- }
-
- const cutoff = maxUInt - (maxUInt % aMax);
- let val = cutoff;
- while (val >= cutoff) {
- const uint32 = new Uint32Array(1);
- crypto.getRandomValues(uint32);
- val = uint32[0];
- }
- return val % aMax;
- }
-
- #toHex(aValue, aMinLen) {
- return aValue.toString(16).padStart(aMinLen, "0");
- }
-
- // Former TorMonitorService implementation.
- // FIXME: Refactor and integrate more with the rest of the class.
-
- _connection = null;
- _eventHandlers = {};
- _torLog = []; // Array of objects with date, type, and msg properties
- _startTimeout = null;
-
- _isBootstrapDone = false;
- _lastWarningPhase = null;
- _lastWarningReason = null;
-
- _torProcess = null;
-
- _inited = false;
-
/**
- * Stores the nodes of a circuit. Keys are cicuit IDs, and values are the node
- * fingerprints.
+ * Remove a private key from the Tor configuration.
*
- * Theoretically, we could hook this map up to the new identity notification,
- * but in practice it does not work. Tor pre-builds circuits, and the NEWNYM
- * signal does not affect them. So, we might end up using a circuit that was
- * built before the new identity but not yet used. If we cleaned the map, we
- * risked of not having the data about it.
- *
- * @type {Map<CircuitID, NodeFingerprint[]>}
+ * @param {string} address The address of the onion service
*/
- _circuits = new Map();
+ async onionAuthRemove(address) {
+ return this.#controller.onionAuthRemove(address);
+ }
+
/**
- * The last used bridge, or null if bridges are not in use or if it was not
- * possible to detect the bridge. This needs the user to have specified bridge
- * lines with fingerprints to work.
+ * Retrieve the list of private keys.
*
- * @type {NodeFingerprint?}
+ * @returns {OnionAuthKeyInfo[]}
*/
- _currentBridge = null;
-
- // Public methods
-
- // Starts Tor, if needed, and starts monitoring for events
- _monitorInit() {
- if (this._inited) {
- return;
- }
- this._inited = true;
-
- // We always liten to these events, because they are needed for the circuit
- // display.
- this._eventHandlers = new Map([
- ["CIRC", this._processCircEvent.bind(this)],
- ["STREAM", this._processStreamEvent.bind(this)],
- ]);
-
- if (this.ownsTorDaemon) {
- // When we own the tor daemon, we listen to more events, that are used
- // for about:torconnect or for showing the logs in the settings page.
- this._eventHandlers.set(
- "STATUS_CLIENT",
- this._processStatusClient.bind(this)
- );
- this._eventHandlers.set("NOTICE", this._processLog.bind(this));
- this._eventHandlers.set("WARN", this._processLog.bind(this));
- this._eventHandlers.set("ERR", this._processLog.bind(this));
- this._controlTor();
- } else {
- this._startEventMonitor();
- }
- logger.info("TorMonitorService initialized");
- }
-
- // Closes the connection that monitors for events.
- // When Tor is started by Tor Browser, it is configured to exit when the
- // control connection is closed. Therefore, as a matter of facts, calling this
- // function also makes the child Tor instance stop.
- _monitorUninit() {
- if (this._torProcess) {
- this._torProcess.forget();
- this._torProcess.onExit = null;
- this._torProcess.onRestart = null;
- this._torProcess = null;
- }
- this._shutDownEventMonitor();
- }
-
- async retrieveBootstrapStatus() {
- if (!this._connection) {
- throw new Error("Event monitor connection not available");
- }
-
- this._processBootstrapStatus(
- await this._connection.getBootstrapPhase(),
- true
- );
+ async onionAuthViewKeys() {
+ return this.#controller.onionAuthViewKeys();
}
- // Returns captured log message as a text string (one message per line).
+ /**
+ * Returns captured log message as a text string (one message per line).
+ */
getLog() {
- return this._torLog
+ return this.#logs
.map(logObj => {
const timeStr = logObj.date
.toISOString()
@@ -553,22 +422,27 @@ export class TorProvider {
.join(TorLauncherUtil.isWindows ? "\r\n" : "\n");
}
- // true if we launched and control tor, false if using system tor
+ /**
+ * @returns {boolean} true if we launched and control tor, false if we are
+ * using system tor.
+ */
get ownsTorDaemon() {
return TorLauncherUtil.shouldStartAndOwnTor;
}
get isBootstrapDone() {
- return this._isBootstrapDone;
- }
-
- clearBootstrapError() {
- this._lastWarningPhase = null;
- this._lastWarningReason = null;
+ return this.#isBootstrapDone;
}
+ /**
+ * TODO: Rename to isReady once we remove finish the migration.
+ *
+ * @returns {boolean} true if we currently have a connection to the control
+ * port. We take for granted that if we have one, we authenticated to it, and
+ * so we have already verified we can send and receive data.
+ */
get isRunning() {
- return !!this._connection;
+ return this.#controlConnection?.isOpen ?? false;
}
/**
@@ -580,258 +454,380 @@ export class TorProvider {
* is not a bridge, or no circuit has been opened, yet.
*/
get currentBridge() {
- return this._currentBridge;
+ return this.#currentBridge;
}
- // Private methods
+ // Process management
- async _startProcess() {
+ async #startDaemon(socksSettings) {
// TorProcess should be instanced once, then always reused and restarted
// only through the prompt it exposes when the controlled process dies.
- if (!this._torProcess) {
- this._torProcess = new lazy.TorProcess(
- this.torControlPortInfo,
- this.torSOCKSPortInfo
+ if (this.#torProcess) {
+ logger.warn(
+ "Ignoring a request to start a tor daemon because one is already running."
);
- this._torProcess.onExit = () => {
- this._shutDownEventMonitor();
- Services.obs.notifyObservers(null, TorProviderTopics.ProcessExited);
- };
- this._torProcess.onRestart = async () => {
- this._shutDownEventMonitor();
- await this._controlTor();
- Services.obs.notifyObservers(null, TorProviderTopics.ProcessRestarted);
- };
+ return;
}
- // Already running, but we did not start it
- if (this._torProcess.isRunning) {
- return false;
- }
+ this.#torProcess = new lazy.TorProcess(
+ this.#controlPortSettings,
+ socksSettings
+ );
+ // Use a closure instead of bind because we reassign #cancelConnection.
+ // Also, we now assign an exit handler that cancels the first connection,
+ // so that a sudden exit before the first connection is completed might
+ // still be handled as an initialization failure.
+ // But after the first connection is created successfully, we will change
+ // the exit handler to broadcast a notification instead.
+ this.#torProcess.onExit = () => {
+ this.#cancelConnection(
+ "The tor process exited before the first connection"
+ );
+ };
- try {
- await this._torProcess.start();
- if (this._torProcess.isRunning) {
- logger.info("tor started");
- this._torProcessStartTime = Date.now();
- }
- } catch (e) {
- // TorProcess already logs the error.
- this._lastWarningPhase = "startup";
- this._lastWarningReason = e.toString();
- }
- return this._torProcess.isRunning;
+ logger.debug("Trying to start the tor process.");
+ await this.#torProcess.start();
+ logger.info("Started a tor process");
}
- async _controlTor() {
- if (!this._torProcess?.isRunning && !(await this._startProcess())) {
- logger.error("Tor not running, not starting to monitor it.");
- return;
- }
-
- let delayMS = ControlConnTimings.initialDelayMS;
- const callback = async () => {
- if (await this._startEventMonitor()) {
- this.retrieveBootstrapStatus().catch(e => {
- logger.warn("Could not get the initial bootstrap status", e);
- });
-
- // FIXME: TorProcess is misleading here. We should use a topic related
- // to having a control port connection, instead.
- logger.info(`Notifying ${TorProviderTopics.ProcessIsReady}`);
- Services.obs.notifyObservers(null, TorProviderTopics.ProcessIsReady);
+ // Control port setup and connection
- // We reset this here hoping that _shutDownEventMonitor can interrupt
- // the current monitor, either by calling clearTimeout and preventing it
- // from starting, or by closing the control port connection.
- if (this._startTimeout === null) {
- logger.warn("Someone else reset _startTimeout!");
- }
- this._startTimeout = null;
- } else if (
- Date.now() - this._torProcessStartTime >
- ControlConnTimings.timeoutMS
- ) {
- let s = TorLauncherUtil.getLocalizedString("tor_controlconn_failed");
- this._lastWarningPhase = "startup";
- this._lastWarningReason = s;
- logger.info(s);
- if (this._startTimeout === null) {
- logger.warn("Someone else reset _startTimeout!");
- }
- this._startTimeout = null;
- } else {
- delayMS *= 2;
- if (delayMS > ControlConnTimings.maxRetryMS) {
- delayMS = ControlConnTimings.maxRetryMS;
+ /**
+ * Read the control port settings from environment variables and from
+ * preferences.
+ */
+ async #setControlPortConfiguration() {
+ logger.debug("Reading the control port configuration");
+ const settings = {};
+
+ const isWindows = Services.appinfo.OS === "WINNT";
+ // Determine how Tor Launcher will connect to the Tor control port.
+ // Environment variables get top priority followed by preferences.
+ if (!isWindows && Services.env.exists("TOR_CONTROL_IPC_PATH")) {
+ const ipcPath = Services.env.get("TOR_CONTROL_IPC_PATH");
+ settings.ipcFile = new lazy.FileUtils.File(ipcPath);
+ } else {
+ // Check for TCP host and port environment variables.
+ if (Services.env.exists("TOR_CONTROL_HOST")) {
+ settings.host = Services.env.get("TOR_CONTROL_HOST");
+ }
+ if (Services.env.exists("TOR_CONTROL_PORT")) {
+ const port = parseInt(Services.env.get("TOR_CONTROL_PORT"), 10);
+ if (Number.isInteger(port) && port > 0 && port <= 65535) {
+ settings.port = port;
}
- this._startTimeout = setTimeout(() => {
- logger.debug(`Control port not ready, waiting ${delayMS / 1000}s.`);
- callback();
- }, delayMS);
}
- };
- // Check again, in the unfortunate case in which the execution was alrady
- // queued, but was waiting network code.
- if (this._startTimeout === null) {
- this._startTimeout = setTimeout(callback, delayMS);
- } else {
- logger.error("Possible race? Refusing to start the timeout again");
}
- }
- async _startEventMonitor() {
- if (this._connection) {
- return true;
+ const useIPC =
+ !isWindows &&
+ Services.prefs.getBoolPref(Preferences.ControlUseIpc, false);
+ if (!settings.host && !settings.port && useIPC) {
+ settings.ipcFile = TorLauncherUtil.getTorFile("control_ipc", false);
+ } else {
+ if (!settings.host) {
+ settings.host = Services.prefs.getCharPref(
+ Preferences.ControlHost,
+ "127.0.0.1"
+ );
+ }
+ if (!settings.port) {
+ settings.port = Services.prefs.getIntPref(
+ Preferences.ControlPort,
+ 9151
+ );
+ }
}
- let conn;
- try {
- conn = await lazy.controller();
- } catch (e) {
- logger.error("Cannot open a control port connection", e);
- if (conn) {
- try {
- conn.close();
- } catch (e) {
- logger.error(
- "Also, the connection is not null but cannot be closed",
- e
- );
+ if (Services.env.exists("TOR_CONTROL_PASSWD")) {
+ const password = Services.env.get("TOR_CONTROL_PASSWD");
+ // As per 3.5 of control-spec.txt, AUTHENTICATE can use either a quoted
+ // string, or a sequence of hex characters.
+ // However, the password is hashed byte by byte, so we need to convert the
+ // string to its character codes, or the hex digits to actual bytes.
+ // Notice that Tor requires at least one hex character, without an upper
+ // limit, but it does not explicitly tell how to pad an odd number of hex
+ // characters, so we require the user to hand an even number of hex
+ // digits.
+ // We also want to enforce the authentication if we start the daemon.
+ // So, if a password is not valid (not a hex sequence and not a quoted
+ // string), or if it is empty (including the quoted empty string), we
+ // force a random password.
+ if (
+ password.length >= 2 &&
+ password[0] === '"' &&
+ password[password.length - 1] === '"'
+ ) {
+ const encoder = new TextEncoder();
+ settings.password = encoder.encode(TorParsers.unescapeString(password));
+ } else if (/^([0-9a-fA-F]{2})+$/.test(password)) {
+ settings.password = new Uint8Array(password.length / 2);
+ for (let i = 0, j = 0; i < settings.password.length; i++, j += 2) {
+ settings.password[i] = parseInt(password.substring(j, j + 2), 16);
}
}
- return false;
- }
-
- // TODO: optionally monitor INFO and DEBUG log messages.
- try {
- await conn.setEvents(Array.from(this._eventHandlers.keys()));
- } catch (e) {
- logger.error("SETEVENTS failed", e);
- conn.close();
- return false;
- }
-
- if (this._torProcess) {
- this._torProcess.connectionWorked();
- }
- if (this.ownsTorDaemon && !TorLauncherUtil.shouldOnlyConfigureTor) {
- try {
- await this._takeTorOwnership(conn);
- } catch (e) {
- logger.warn("Could not take ownership of the Tor daemon", e);
+ if (password && !settings.password?.length) {
+ logger.warn(
+ "Invalid password specified at TOR_CONTROL_PASSWD. " +
+ "You should put it in double quotes, or it should be a hex-encoded sequence. " +
+ "The password cannot be empty. " +
+ "A random password will be used, instead."
+ );
+ }
+ } else if (Services.env.exists("TOR_CONTROL_COOKIE_AUTH_FILE")) {
+ const cookiePath = Services.env.get("TOR_CONTROL_COOKIE_AUTH_FILE");
+ if (cookiePath) {
+ settings.cookieFilePath = cookiePath;
}
}
-
- this._connection = conn;
-
- for (const [type, callback] of this._eventHandlers.entries()) {
- this._monitorEvent(type, callback);
+ if (
+ this.ownsTorDaemon &&
+ !settings.password?.length &&
+ !settings.cookieFilePath
+ ) {
+ settings.password = this.#generateRandomPassword();
}
+ this.#controlPortSettings = settings;
+ logger.debug("Control port configuration read");
+ }
- // Populate the circuit map already, in case we are connecting to an
- // external tor daemon.
- try {
- const reply = await this._connection.sendCommand(
- "GETINFO circuit-status"
- );
- const lines = reply.split(/\r?\n/);
- if (lines.shift() === "250+circuit-status=") {
- for (const line of lines) {
- if (line === ".") {
- break;
- }
- // _processCircEvent processes only one line at a time
- this._processCircEvent("CIRC", [line]);
+ /**
+ * Start the first connection to the Tor daemon.
+ * This function should be called only once during the initialization.
+ */
+ async #firstConnection() {
+ let canceled = false;
+ let timeout = 0;
+ const maxDelay = 10_000;
+ let delay = 5;
+ logger.debug("Connecting to the control port for the first time.");
+ this.#controlConnection = await new Promise((resolve, reject) => {
+ this.#cancelConnection = reason => {
+ canceled = true;
+ clearTimeout(timeout);
+ reject(new Error(reason));
+ };
+ const tryConnect = () => {
+ if (this.ownsTorDaemon && !this.#torProcess?.isRunning) {
+ reject(new Error("The controlled tor daemon is not running."));
+ return;
}
+ this.#openControlPort()
+ .then(controller => {
+ this.#torProcess?.connectionWorked();
+ this.#cancelConnection = () => {};
+ // The cancel function should have already called reject.
+ if (!canceled) {
+ logger.info("Connected to the control port.");
+ resolve(controller);
+ }
+ })
+ .catch(e => {
+ if (delay < maxDelay && !canceled) {
+ logger.info(
+ `Failed to connect to the control port. Trying again in ${delay}ms.`,
+ e
+ );
+ timeout = setTimeout(tryConnect, delay);
+ delay *= 2;
+ } else {
+ reject(e);
+ }
+ });
+ };
+ tryConnect();
+ });
+
+ // The following code will never throw, but we still want to wait for it
+ // before marking the provider as initialized.
+
+ if (this.ownsTorDaemon) {
+ // The first connection cannot be canceled anymore, and the rest of the
+ // code is supposed not to fail. If the tor process exits, from now on we
+ // can only close the connection and broadcast a notification.
+ this.#torProcess.onExit = exitCode => {
+ logger.info(`The tor process exited with code ${exitCode}`);
+ this.#closeConnection("The tor process exited suddenly");
+ Services.obs.notifyObservers(null, TorProviderTopics.ProcessExited);
+ };
+ if (!TorLauncherUtil.shouldOnlyConfigureTor) {
+ await this.#takeOwnership();
}
- } catch (e) {
- logger.warn("Could not populate the initial circuit map", e);
}
-
- return true;
+ await this.#setupEvents();
}
- // Try to become the primary controller (TAKEOWNERSHIP).
- async _takeTorOwnership(conn) {
+ /**
+ * Try to become the primary controller. This will make tor exit when our
+ * connection is closed.
+ * This function cannot fail or throw (any exception will be treated as a
+ * warning and just logged).
+ */
+ async #takeOwnership() {
+ logger.debug("Taking the ownership of the tor process.");
try {
- conn.takeOwnership();
+ await this.#controlConnection.takeOwnership();
} catch (e) {
logger.warn("Take ownership failed", e);
return;
}
try {
- conn.resetOwningControllerProcess();
+ await this.#controlConnection.resetOwningControllerProcess();
} catch (e) {
logger.warn("Clear owning controller process failed", e);
}
}
- _monitorEvent(type, callback) {
- logger.info(`Watching events of type ${type}.`);
- let replyObj = {};
- this._connection.watchEvent(type, line => {
- if (!line) {
- return;
- }
- logger.debug("Event response: ", line);
- const isComplete = TorParsers.parseReplyLine(line, replyObj);
- if (!isComplete || replyObj._parseError || !replyObj.lineArray.length) {
- return;
- }
- const reply = replyObj;
- replyObj = {};
- if (reply.statusCode !== TorStatuses.EventNotification) {
- logger.error("Unexpected event status code:", reply.statusCode);
- return;
+ /**
+ * Tells the Tor daemon which events we want to receive.
+ * This function will never throw. Any failure will be treated as a warning of
+ * a possibly degraded experience, not as an error.
+ */
+ async #setupEvents() {
+ // We always listen to these events, because they are needed for the circuit
+ // display.
+ const events = ["CIRC", "STREAM"];
+ if (this.ownsTorDaemon) {
+ events.push("STATUS_CLIENT", "NOTICE", "WARN", "ERR");
+ // Do not await on the first bootstrap status retrieval, and do not
+ // propagate its errors.
+ this.#controlConnection
+ .getBootstrapPhase()
+ .then(status => this.#processBootstrapStatus(status, false))
+ .catch(e =>
+ logger.error("Failed to get the first bootstrap status", e)
+ );
+ }
+ try {
+ logger.debug(`Setting events: ${events.join(" ")}`);
+ await this.#controlConnection.setEvents(events);
+ } catch (e) {
+ logger.error(
+ "We could not enable all the events we need. Tor Browser's functionalities might be reduced.",
+ e
+ );
+ }
+ }
+
+ /**
+ * Open a connection to the control port and authenticate to it.
+ * #setControlPortConfiguration must have been called before, as this function
+ * will follow the configuration set by it.
+ *
+ * @returns {Promise<TorController>} An authenticated TorController
+ */
+ async #openControlPort() {
+ let controlPort;
+ if (this.#controlPortSettings.ipcFile) {
+ controlPort = lazy.TorController.fromIpcFile(
+ this.#controlPortSettings.ipcFile,
+ this
+ );
+ } else {
+ controlPort = lazy.TorController.fromSocketAddress(
+ this.#controlPortSettings.host,
+ this.#controlPortSettings.port,
+ this
+ );
+ }
+ try {
+ let password = this.#controlPortSettings.password;
+ if (password === undefined && this.#controlPortSettings.cookieFilePath) {
+ password = await this.#readAuthenticationCookie(
+ this.#controlPortSettings.cookieFilePath
+ );
}
- if (!reply.lineArray[0].startsWith(`${type} `)) {
- logger.error("Wrong format for the first line:", reply.lineArray[0]);
- return;
+ await controlPort.authenticate(password);
+ } catch (e) {
+ try {
+ controlPort.close();
+ } catch (ec) {
+ // Tor already closes the control port when the authentication fails.
+ logger.debug(
+ "Expected exception when closing the control port for a failed authentication",
+ ec
+ );
}
- reply.lineArray[0] = reply.lineArray[0].substring(type.length + 1);
+ throw e;
+ }
+ return controlPort;
+ }
+
+ /**
+ * Close the connection to the control port.
+ *
+ * @param {string} reason The reason for which we are closing the connection
+ * (used for logging and in case this ends up canceling the current connection
+ * attempt)
+ */
+ #closeConnection(reason) {
+ this.#cancelConnection(reason);
+ if (this.#controlConnection) {
+ logger.info("Closing the control connection", reason);
try {
- callback(type, reply.lineArray);
+ this.#controlConnection.close();
} catch (e) {
- logger.error("Exception while handling an event", reply, e);
+ logger.error("Failed to close the control port connection", e);
}
- });
+ this.#controlConnection = null;
+ } else {
+ logger.trace(
+ "Requested to close an already closed control port connection"
+ );
+ }
+ this.#isBootstrapDone = false;
+ this.#lastWarning = {};
}
- _processLog(type, lines) {
- if (type === "WARN" || type === "ERR") {
- // Notify so that Copy Log can be enabled.
- Services.obs.notifyObservers(null, TorProviderTopics.HasWarnOrErr);
- }
+ // Authentication
- const date = new Date();
- const maxEntries = Services.prefs.getIntPref(
- "extensions.torlauncher.max_tor_log_entries",
- 1000
- );
- if (maxEntries > 0 && this._torLog.length >= maxEntries) {
- this._torLog.splice(0, 1);
- }
+ /**
+ * Read a cookie file to perform cookie-based authentication.
+ *
+ * @param {string} path The path to the cookie file
+ * @returns {Uint8Array} The content of the file in bytes
+ */
+ async #readAuthenticationCookie(path) {
+ return IOUtils.read(path);
+ }
- const msg = lines.join("\n");
- this._torLog.push({ date, type, msg });
- const logString = `Tor ${type}: ${msg}`;
- logger.info(logString);
+ /**
+ * @returns {Uint8Array} A random 16-byte password.
+ */
+ #generateRandomPassword() {
+ const kPasswordLen = 16;
+ return crypto.getRandomValues(new Uint8Array(kPasswordLen));
+ }
+
+ // Notification handlers
+
+ /**
+ * Receive and process a notification with the bootstrap status.
+ *
+ * @param {object} status The status object
+ */
+ onBootstrapStatus(status) {
+ this.#processBootstrapStatus(status, true);
}
- // Process a bootstrap status to update the current state, and broadcast it
- // to TorBootstrapStatus observers.
- // If aSuppressErrors is true, errors are ignored. This is used when we
- // are handling the response to a "GETINFO status/bootstrap-phase" command.
- _processBootstrapStatus(statusObj, suppressErrors) {
+ /**
+ * Process a bootstrap status to update the current state, and broadcast it
+ * to TorBootstrapStatus observers.
+ *
+ * @param {object} statusObj The status object that the controller returned.
+ * Its entries depend on what Tor sent to us.
+ * @param {boolean} isNotification We broadcast warnings only when we receive
+ * them through an asynchronous notification.
+ */
+ #processBootstrapStatus(statusObj, isNotification) {
// Notify observers
Services.obs.notifyObservers(
{ wrappedJSObject: statusObj },
- "TorBootstrapStatus"
+ TorProviderTopics.BootstrapStatus
);
if (statusObj.PROGRESS === 100) {
- this._isBootstrapDone = true;
+ this.#isBootstrapDone = true;
try {
Services.prefs.setBoolPref(Preferences.PromptAtStartup, false);
} catch (e) {
@@ -840,23 +836,29 @@ export class TorProvider {
return;
}
- this._isBootstrapDone = false;
+ this.#isBootstrapDone = false;
if (
+ isNotification &&
statusObj.TYPE === "WARN" &&
- statusObj.RECOMMENDATION !== "ignore" &&
- !suppressErrors
+ statusObj.RECOMMENDATION !== "ignore"
) {
- this._notifyBootstrapError(statusObj);
+ this.#notifyBootstrapError(statusObj);
}
}
- _notifyBootstrapError(statusObj) {
+ /**
+ * Broadcast a bootstrap warning or error.
+ *
+ * @param {object} statusObj The bootstrap status object with the error
+ */
+ #notifyBootstrapError(statusObj) {
try {
Services.prefs.setBoolPref(Preferences.PromptAtStartup, true);
} catch (e) {
logger.warn(`Cannot set ${Preferences.PromptAtStartup}`, e);
}
+ // TODO: Move l10n to the above layers?
const phase = TorLauncherUtil.getLocalizedBootstrapStatus(statusObj, "TAG");
const reason = TorLauncherUtil.getLocalizedBootstrapStatus(
statusObj,
@@ -872,11 +874,11 @@ export class TorProvider {
);
if (
- statusObj.TAG !== this._lastWarningPhase ||
- statusObj.REASON !== this._lastWarningReason
+ statusObj.TAG !== this.#lastWarning.phase ||
+ statusObj.REASON !== this.#lastWarning.reason
) {
- this._lastWarningPhase = statusObj.TAG;
- this._lastWarningReason = statusObj.REASON;
+ this.#lastWarning.phase = statusObj.TAG;
+ this.#lastWarning.reason = statusObj.REASON;
const message = TorLauncherUtil.getLocalizedString(
"tor_bootstrap_failed"
@@ -888,123 +890,122 @@ export class TorProvider {
}
}
- _processStatusClient(_type, lines) {
- const statusObj = TorParsers.parseBootstrapStatus(lines[0]);
- if (!statusObj) {
- // No `BOOTSTRAP` in the line
- return;
+ /**
+ * Handle a log message from the tor daemon. It will be added to the internal
+ * logs. If it is a warning or an error, a notification will be broadcast.
+ *
+ * @param {string} type The message type
+ * @param {string} msg The message
+ */
+ onLogMessage(type, msg) {
+ if (type === "WARN" || type === "ERR") {
+ // Notify so that Copy Log can be enabled.
+ Services.obs.notifyObservers(null, TorProviderTopics.HasWarnOrErr);
}
- this._processBootstrapStatus(statusObj, false);
- }
- async _processCircEvent(_type, lines) {
- const builtEvent =
- /^(?<CircuitID>[a-zA-Z0-9]{1,16})\sBUILT\s(?<Path>(?:,?\$[0-9a-fA-F]{40}(?:~[a-zA-Z0-9]{1,19})?)+)/.exec(
- lines[0]
- );
- const closedEvent = /^(?<ID>[a-zA-Z0-9]{1,16})\sCLOSED/.exec(lines[0]);
- if (builtEvent) {
- const fp = /\$([0-9a-fA-F]{40})/g;
- const nodes = Array.from(builtEvent.groups.Path.matchAll(fp), g =>
- g[1].toUpperCase()
- );
- this._circuits.set(builtEvent.groups.CircuitID, nodes);
- // Ignore circuits of length 1, that are used, for example, to probe
- // bridges. So, only store them, since we might see streams that use them,
- // but then early-return.
- if (nodes.length === 1) {
- return;
- }
- // In some cases, we might already receive SOCKS credentials in the line.
- // However, this might be a problem with onion services: we get also a
- // 4-hop circuit that we likely do not want to show to the user,
- // especially because it is used only temporarily, and it would need a
- // technical explaination.
- // this._checkCredentials(lines[0], nodes);
- if (this._currentBridge?.fingerprint !== nodes[0]) {
- const nodeInfo = await this.getNodeInfo(nodes[0]);
- let notify = false;
- if (nodeInfo?.bridgeType) {
- logger.info(`Bridge changed to ${nodes[0]}`);
- this._currentBridge = nodeInfo;
- notify = true;
- } else if (this._currentBridge) {
- logger.info("Bridges disabled");
- this._currentBridge = null;
- notify = true;
- }
- if (notify) {
- Services.obs.notifyObservers(
- null,
- TorProviderTopics.BridgeChanged,
- this._currentBridge
- );
- }
- }
- } else if (closedEvent) {
- this._circuits.delete(closedEvent.groups.ID);
+ const date = new Date();
+ const maxEntries = Services.prefs.getIntPref(
+ Preferences.MaxLogEntries,
+ 1000
+ );
+ if (maxEntries > 0 && this.#logs.length >= maxEntries) {
+ this.#logs.splice(0, 1);
+ }
+
+ this.#logs.push({ date, type, msg });
+ switch (type) {
+ case "ERR":
+ logger.error(`[Tor error] ${msg}`);
+ break;
+ case "WARN":
+ logger.warn(`[Tor warning] ${msg}`);
+ break;
+ default:
+ logger.info(`[Tor ${type.toLowerCase()}] ${msg}`);
}
}
- _processStreamEvent(_type, lines) {
- // The first block is the stream ID, which we do not need at the moment.
- const succeeedEvent =
- /^[a-zA-Z0-9]{1,16}\sSUCCEEDED\s(?<CircuitID>[a-zA-Z0-9]{1,16})/.exec(
- lines[0]
- );
- if (!succeeedEvent) {
+ /**
+ * Handle a notification that a new circuit has been built.
+ * If a change of bridge is detected (including a change from bridge to a
+ * normal guard), a notification is broadcast.
+ *
+ * @param {CircuitID} id The circuit ID
+ * @param {NodeFingerprint[]} nodes The nodes that compose the circuit
+ */
+ async onCircuitBuilt(id, nodes) {
+ this.#circuits.set(id, nodes);
+ // Ignore circuits of length 1, that are used, for example, to probe
+ // bridges. So, only store them, since we might see streams that use them,
+ // but then early-return.
+ if (nodes.length === 1) {
return;
}
- const circuit = this._circuits.get(succeeedEvent.groups.CircuitID);
- if (!circuit) {
- logger.error(
- "Seen a STREAM SUCCEEDED with an unknown circuit. Not notifying observers.",
- lines[0]
- );
- return;
+
+ if (this.#currentBridge?.fingerprint !== nodes[0]) {
+ const nodeInfo = await this.getNodeInfo(nodes[0]);
+ let notify = false;
+ if (nodeInfo?.bridgeType) {
+ logger.info(`Bridge changed to ${nodes[0]}`);
+ this.#currentBridge = nodeInfo;
+ notify = true;
+ } else if (this.#currentBridge) {
+ logger.info("Bridges disabled");
+ this.#currentBridge = null;
+ notify = true;
+ }
+ if (notify) {
+ Services.obs.notifyObservers(
+ null,
+ TorProviderTopics.BridgeChanged,
+ this.#currentBridge
+ );
+ }
}
- this._checkCredentials(lines[0], circuit);
}
/**
- * Check if a STREAM or CIRC response line contains SOCKS_USERNAME and
- * SOCKS_PASSWORD. In case, notify observers that we could associate a certain
- * circuit to these credentials.
+ * Handle a notification of a circuit being closed. We use it to clean the
+ * internal data.
+ *
+ * @param {CircuitID} id The circuit id
+ */
+ onCircuitClosed(id) {
+ logger.debug("Circuit closed event", id);
+ this.#circuits.delete(id);
+ }
+
+ /**
+ * Handle a notification about a stream switching to the succeeded state.
*
- * @param {string} line The circ or stream line to check
- * @param {NodeFingerprint[]} circuit The fingerprints of the nodes in the
- * circuit.
+ * @param {StreamID} streamId The ID of the stream that switched to the
+ * succeeded state.
+ * @param {CircuitID} circuitId The ID of the circuit used by the stream
+ * @param {string} username The SOCKS username
+ * @param {string} password The SOCKS password
+ * @returns
*/
- _checkCredentials(line, circuit) {
- const username = /SOCKS_USERNAME=("(?:[^"\\]|\\.)*")/.exec(line);
- const password = /SOCKS_PASSWORD=("(?:[^"\\]|\\.)*")/.exec(line);
+ onStreamSucceeded(streamId, circuitId, username, password) {
if (!username || !password) {
return;
}
+ logger.debug("Stream succeeded event", username, password, circuitId);
+ const circuit = this.#circuits.get(circuitId);
+ if (!circuit) {
+ logger.error(
+ "Seen a STREAM SUCCEEDED with an unknown circuit. Not notifying observers."
+ );
+ return;
+ }
Services.obs.notifyObservers(
{
wrappedJSObject: {
- username: TorParsers.unescapeString(username[1]),
- password: TorParsers.unescapeString(password[1]),
+ username,
+ password,
circuit,
},
},
TorProviderTopics.StreamSucceeded
);
}
-
- _shutDownEventMonitor() {
- try {
- this._connection?.close();
- } catch (e) {
- logger.error("Could not close the connection to the control port", e);
- }
- this._connection = null;
- if (this._startTimeout !== null) {
- clearTimeout(this._startTimeout);
- this._startTimeout = null;
- }
- this._isBootstrapDone = false;
- this.clearBootstrapError();
- }
}
=====================================
toolkit/components/tor-launcher/TorProviderBuilder.sys.mjs
=====================================
@@ -4,13 +4,13 @@
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
+ TorLauncherUtil: "resource://gre/modules/TorLauncherUtil.sys.mjs",
TorProvider: "resource://gre/modules/TorProvider.sys.mjs",
});
export const TorProviderTopics = Object.freeze({
ProcessIsReady: "TorProcessIsReady",
ProcessExited: "TorProcessExited",
- ProcessRestarted: "TorProcessRestarted",
BootstrapStatus: "TorBootstrapStatus",
BootstrapError: "TorBootstrapError",
HasWarnOrErr: "TorLogHasWarnOrErr",
@@ -18,26 +18,141 @@ export const TorProviderTopics = Object.freeze({
StreamSucceeded: "TorStreamSucceeded",
});
+/**
+ * The factory to get a Tor provider.
+ * Currently we support only TorProvider, i.e., the one that interacts with
+ * C-tor through the control port protocol.
+ */
export class TorProviderBuilder {
+ /**
+ * A promise with the instance of the provider that we are using.
+ *
+ * @type {Promise<TorProvider>?}
+ */
static #provider = null;
+ /**
+ * The observer that checks when the tor process exits, and reinitializes the
+ * provider.
+ *
+ * @type {nsIObserver?}
+ */
+ static #observer = null;
+
+ /**
+ * Tell whether the browser UI is ready.
+ * We ignore any errors until it is because we cannot show them.
+ *
+ * @type {boolean}
+ */
+ static #uiReady = false;
+
+ /**
+ * Initialize the provider of choice.
+ * Even though initialization is asynchronous, we do not expect the caller to
+ * await this method. The reason is that any call to build() will wait the
+ * initialization anyway (and re-throw any initialization error).
+ */
static async init() {
- const provider = new lazy.TorProvider();
- await provider.init();
- // Assign it only when initialization succeeds.
- TorProviderBuilder.#provider = provider;
+ this.#observer = {
+ observe(subject, topic, data) {
+ if (topic !== TorProviderTopics.ProcessExited) {
+ return;
+ }
+ if (!TorProviderBuilder.#uiReady) {
+ console.warn(
+ `Seen ${TorProviderTopics.ProcessExited}, but not doing anything because the UI is not ready yet.`
+ );
+ return;
+ }
+ TorProviderBuilder.#torExited();
+ },
+ };
+ Services.obs.addObserver(this.#observer, TorProviderTopics.ProcessExited);
+ await this.#initProvider();
+ }
+
+ static async #initProvider() {
+ try {
+ const old = await this.#provider;
+ old?.uninit();
+ } catch {}
+ this.#provider = new Promise((resolve, reject) => {
+ const provider = new lazy.TorProvider();
+ provider
+ .init()
+ .then(() => resolve(provider))
+ .catch(reject);
+ });
+ await this.#provider;
}
static uninit() {
- TorProviderBuilder.#provider.uninit();
- TorProviderBuilder.#provider = null;
+ this.#provider?.then(provider => {
+ provider.uninit();
+ this.#provider = null;
+ });
+ if (this.#observer) {
+ Services.obs.removeObserver(
+ this.#observer,
+ TorProviderTopics.ProcessExited
+ );
+ this.#observer = null;
+ }
+ }
+
+ /**
+ * Build a provider.
+ * This method will wait for the system to be initialized, and allows you to
+ * catch also any initialization errors.
+ */
+ static async build() {
+ if (!this.#provider) {
+ throw new Error(
+ "The provider has not been initialized or already uninitialized."
+ );
+ }
+ return this.#provider;
+ }
+
+ /**
+ * Check if the provider has been succesfully initialized when the first
+ * browser window is shown.
+ * This is a workaround we need because ideally we would like the tor process
+ * to start as soon as possible, to avoid delays in the about:torconnect page,
+ * but we should modify TorConnect and about:torconnect to handle this case
+ * there with a better UX.
+ */
+ static async firstWindowLoaded() {
+ // FIXME: Just integrate this with the about:torconnect or about:tor UI.
+ let running = false;
+ try {
+ const provider = await this.#provider;
+ // The initialization might have succeeded, but so far we have ignored any
+ // error notification. So, check that the process has not exited after the
+ // provider has been initialized successfully, but the UI was not ready
+ // yet.
+ running = provider.isRunning;
+ } catch {
+ // Not even initialized, running is already false.
+ }
+ while (!running && lazy.TorLauncherUtil.showRestartPrompt(true)) {
+ try {
+ await this.#initProvider();
+ running = true;
+ } catch {}
+ }
+ // The user might have canceled the restart, but at this point the UI is
+ // ready in any case.
+ this.#uiReady = true;
}
- // TODO: Switch to an async build?
- static build() {
- if (!TorProviderBuilder.#provider) {
- throw new Error("TorProviderBuilder has not been initialized yet.");
+ static async #torExited() {
+ while (lazy.TorLauncherUtil.showRestartPrompt(false)) {
+ try {
+ await this.#initProvider();
+ break;
+ } catch {}
}
- return TorProviderBuilder.#provider;
}
}
=====================================
toolkit/components/tor-launcher/TorStartupService.sys.mjs
=====================================
@@ -34,9 +34,12 @@ export class TorStartupService {
async #init() {
Services.obs.addObserver(this, BrowserTopics.QuitApplicationGranted);
- await lazy.TorProviderBuilder.init();
+ // Do not await on this init. build() is expected to await the
+ // initialization, so anything that should need the Tor Provider should
+ // block there, instead.
+ lazy.TorProviderBuilder.init();
- lazy.TorSettings.init();
+ await lazy.TorSettings.init();
lazy.TorConnect.init();
lazy.TorDomainIsolator.init();
=====================================
toolkit/mozapps/update/UpdateService.sys.mjs
=====================================
@@ -388,13 +388,13 @@ XPCOMUtils.defineLazyGetter(
}
);
-function _shouldRegisterBootstrapObserver(errorCode) {
- const provider = lazy.TorProviderBuilder.build();
- return (
- errorCode == PROXY_SERVER_CONNECTION_REFUSED &&
- !provider.isBootstrapDone &&
- provider.ownsTorDaemon
- );
+async function _shouldRegisterBootstrapObserver(errorCode) {
+ try {
+ const provider = await lazy.TorProviderBuilder.build();
+ return !provider.isBootstrapDone && provider.ownsTorDaemon;
+ } catch {
+ return false;
+ }
}
/**
@@ -3338,7 +3338,10 @@ UpdateService.prototype = {
AUSTLMY.pingCheckCode(this._pingSuffix, AUSTLMY.CHK_OFFLINE);
}
return;
- } else if (_shouldRegisterBootstrapObserver(update.errorCode)) {
+ } else if (
+ update.errorCode === PROXY_SERVER_CONNECTION_REFUSED &&
+ (await _shouldRegisterBootstrapObserver())
+ ) {
// Register boostrap observer to try again, but only when we own the
// tor process.
this._registerBootstrapObserver();
@@ -6735,7 +6738,10 @@ Downloader.prototype = {
);
shouldRegisterOnlineObserver = true;
deleteActiveUpdate = false;
- } else if (_shouldRegisterBootstrapObserver(status)) {
+ } else if (
+ status === PROXY_SERVER_CONNECTION_REFUSED &&
+ (await _shouldRegisterBootstrapObserver())
+ ) {
// Register a bootstrap observer to try again.
// The bootstrap observer will continue the incremental download by
// calling downloadUpdate on the active update which continues
=====================================
toolkit/torbutton/chrome/locale/en-US/torlauncher.properties
=====================================
@@ -9,7 +9,6 @@ torlauncher.tor_exited_during_startup=Tor exited during startup. This might be d
torlauncher.tor_exited=Tor unexpectedly exited. This might be due to a bug in Tor itself, another program on your system, or faulty hardware. Until you restart Tor, Tor Browser will not be able to reach any websites. If the problem persists, please send a copy of your Tor Log to the support team.
torlauncher.tor_exited2=Restarting Tor will not close your browser tabs.
torlauncher.restart_tor=Restart Tor
-torlauncher.tor_controlconn_failed=Could not connect to Tor control port.
torlauncher.tor_bootstrap_failed=Tor failed to establish a Tor network connection.
torlauncher.tor_bootstrap_failed_details=%1$S failed (%2$S).
@@ -60,3 +59,7 @@ torlauncher.bootstrapWarning.pt_missing=missing pluggable transport
torlauncher.nsresult.NS_ERROR_NET_RESET=The connection to the server was lost.
torlauncher.nsresult.NS_ERROR_CONNECTION_REFUSED=Could not connect to the server.
torlauncher.nsresult.NS_ERROR_PROXY_CONNECTION_REFUSED=Could not connect to the proxy.
+
+## 12.5-only strings that can be removed once it goes EOL.
+
+torlauncher.tor_controlconn_failed=Could not connect to Tor control port.
View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/compare/47de2a69988d1da8b3bf73d383038047cde45bfd...00986a075980f9102638ee2011701734ba88b549
--
View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/compare/47de2a69988d1da8b3bf73d383038047cde45bfd...00986a075980f9102638ee2011701734ba88b549
You're receiving this email because of your account on gitlab.torproject.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.torproject.org/pipermail/tbb-commits/attachments/20230914/8872bb13/attachment-0001.htm>
More information about the tbb-commits
mailing list