Remote Access

projectDocs/dev/developerGuide/developerGuide.md

@@ -1384,6 +1384,7 @@ For examples of how to define and use new extension points, please see the code
 |`Action` |`pre_speechCanceled` |Triggered before speech is canceled.|
 |`Action` |`pre_speech` |Triggered before NVDA handles prepared speech.|
 |`Action` |`post_speechPaused` |Triggered when speech is paused or resumed.|
+|`Action` |`pre_speechQueued` |Triggered after speech is processed and normalized and directly before it is enqueued.|
 |`Filter` |`filter_speechSequence` |Allows components or add-ons to filter speech sequence before it passes to the synth driver.|
 
 ### synthDriverHandler {#synthDriverHandlerExtPts}

requirements.txt

@@ -3,6 +3,7 @@ SCons==4.8.1
 
 # NVDA's runtime dependencies
 comtypes==1.4.6
+cryptography==44.0.0
 pyserial==3.5
 wxPython==4.2.2
 configobj @ git+https://github.com/DiffSK/configobj@8be54629ee7c26acb5c865b74c76284e80f3aa31#egg=configobj

source/core.py

@@ -897,6 +897,12 @@ def main():
 
 	log.debug("Initializing global plugin handler")
 	globalPluginHandler.initialize()
+
+	log.debug("Initializing remote client")
+	import remoteClient
+
+	remoteClient.initialize()
+
 	if globalVars.appArgs.install or globalVars.appArgs.installSilent:
 		import gui.installerGui
 
@@ -1049,6 +1055,7 @@ def _doPostNvdaStartupAction():
 			" This likely indicates NVDA is exiting due to WM_QUIT.",
 		)
 		queueHandler.pumpAll()
+	_terminate(remoteClient)
 	_terminate(gui)
 	config.saveOnExit()
 

source/globalCommands.py

@@ -69,7 +69,7 @@
 from utils.security import objectBelowLockScreenAndWindowsIsLocked
 import audio
 from audio import appsVolume
-
+import remoteClient
 
 #: Script category for text review commands.
 # Translators: The name of a category of NVDA commands.
@@ -119,6 +119,9 @@
 #: Script category for audio streaming commands.
 # Translators: The name of a category of NVDA commands.
 SCRCAT_AUDIO = _("Audio")
+#: Script category for Remote commands.
+# Translators: The name of a category of NVDA commands.
+SCRCAT_REMOTE = _("Remote")
 
 # Translators: Reported when there are no settings to configure in synth settings ring
 # (example: when there is no setting for language).
@@ -4888,6 +4891,69 @@ def script_toggleApplicationsVolumeAdjuster(self, gesture: "inputCore.InputGestu
 	def script_toggleApplicationsMute(self, gesture: "inputCore.InputGesture") -> None:
 		appsVolume._toggleAppsVolumeMute()
 
+	@script(
+		# Translators: Describes a command.
+		description=_("""Mute or unmute the speech coming from the remote computer"""),
+		category=SCRCAT_REMOTE,
+	)
+	def script_toggle_remote_mute(self, gesture):
+		remoteClient.client.toggleMute()
+
+	@script(
+		gesture="kb:control+shift+NVDA+c",
+		category=SCRCAT_REMOTE,
+		# Translators: Documentation string for the script that sends the contents of the clipboard to the remote machine.
+		description=_("Sends the contents of the clipboard to the remote machine"),
+	)
+	def script_push_clipboard(self, gesture):
+		remoteClient.client.pushClipboard()
+
+	@script(
+		# Translators: Documentation string for the script that copies a link to the remote session to the clipboard.
+		description=_("""Copies a link to the remote session to the clipboard"""),
+		category=SCRCAT_REMOTE,
+	)
+	def script_copy_link(self, gesture):
+		remoteClient.client.copyLink()
+		# Translators: A message indicating that a link has been copied to the clipboard.
+		ui.message(_("Copied link"))
+
+	@script(
+		gesture="kb:alt+NVDA+pageDown",
+		category=SCRCAT_REMOTE,
+		# Translators: Documentation string for the script that disconnects a remote session.
+		description=_("""Disconnect a remote session"""),
+	)
+	@gui.blockAction.when(gui.blockAction.Context.SECURE_MODE)
+	def script_disconnectFromRemote(self, gesture):
+		if not remoteClient.client.isConnected:
+			# Translators: A message indicating that the remote client is not connected.
+			ui.message(_("Not connected."))
+			return
+		remoteClient.client.disconnect()
+
+	@script(
+		gesture="kb:alt+NVDA+pageUp",
+		# Translators: Documentation string for the script that invokes the remote session.
+		description=_("""Connect to a remote computer"""),
+		category=SCRCAT_REMOTE,
+	)
+	@gui.blockAction.when(gui.blockAction.Context.MODAL_DIALOG_OPEN)
+	@gui.blockAction.when(gui.blockAction.Context.SECURE_MODE)
+	def script_connectToRemote(self, gesture):
+		if remoteClient.client.isConnected() or remoteClient.client.connecting:
+			return
+		remoteClient.client.doConnect()
+
+	@script(
+		# Translators: Documentation string for the script that toggles the control between guest and host machine.
+		description=_("Toggles the control between guest and host machine"),
+		category=SCRCAT_REMOTE,
+		gesture="kb:f11",
+	)
+	def script_sendKeys(self, gesture):
+		remoteClient.client.toggleRemoteKeyControl(gesture)
+
 
 #: The single global commands instance.
 #: @type: L{GlobalCommands}

source/gui/settingsDialogs.py

@@ -47,6 +47,7 @@
 import gui.contextHelp
 import globalVars
 from logHandler import log
+from remoteClient import configuration
 import audio
 import audioDucking
 import queueHandler
@@ -3340,6 +3341,159 @@ def onSave(self):
 		config.conf["addonStore"]["automaticUpdates"] = [x.value for x in AddonsAutomaticUpdate][index]
 
 
+class RemoteSettingsPanel(SettingsPanel):
+	# Translators: This is the label for the remote settings category in NVDA Settings screen.
+	title = _("Remote")
+	autoconnect: wx.CheckBox
+	client_or_server: wx.RadioBox
+	connection_type: wx.RadioBox
+	host: wx.TextCtrl
+	port: wx.SpinCtrl
+	key: wx.TextCtrl
+	play_sounds: wx.CheckBox
+	delete_fingerprints: wx.Button
+
+	def makeSettings(self, settingsSizer):
+		self.config = configuration.get_config()
+		sHelper = gui.guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
+		self.autoconnect = wx.CheckBox(
+			parent=self,
+			id=wx.ID_ANY,
+			# Translators: A checkbox in add-on options dialog to set whether NVDA should automatically connect to a control server on startup.
+			label=_("Auto-connect to control server on startup"),
+		)
+		self.autoconnect.Bind(wx.EVT_CHECKBOX, self.on_autoconnect)
+		sHelper.addItem(self.autoconnect)
+		# Translators: Whether or not to use a relay server when autoconnecting
+		self.client_or_server = wx.RadioBox(
+			self,
+			wx.ID_ANY,
+			choices=(
+				# Translators: Use a remote control server
+				_("Use Remote Control Server"),
+				# Translators: Host a control server
+				_("Host Control Server"),
+			),
+			style=wx.RA_VERTICAL,
+		)
+		self.client_or_server.Bind(wx.EVT_RADIOBOX, self.on_client_or_server)
+		self.client_or_server.SetSelection(0)
+		self.client_or_server.Enable(False)
+		sHelper.addItem(self.client_or_server)
+		choices = [
+			# Translators: Radio button to allow this machine to be controlled
+			_("Allow this machine to be controlled"),
+			# Translators: Radio button to allow this machine to control another machine
+			_("Control another machine"),
+		]
+		self.connection_type = wx.RadioBox(self, wx.ID_ANY, choices=choices, style=wx.RA_VERTICAL)
+		self.connection_type.SetSelection(0)
+		self.connection_type.Enable(False)
+		sHelper.addItem(self.connection_type)
+		sHelper.addItem(wx.StaticText(self, wx.ID_ANY, label=_("&Host:")))
+		self.host = wx.TextCtrl(self, wx.ID_ANY)
+		self.host.Enable(False)
+		sHelper.addItem(self.host)
+		sHelper.addItem(wx.StaticText(self, wx.ID_ANY, label=_("&Port:")))
+		self.port = wx.SpinCtrl(self, wx.ID_ANY, min=1, max=65535)
+		self.port.Enable(False)
+		sHelper.addItem(self.port)
+		sHelper.addItem(wx.StaticText(self, wx.ID_ANY, label=_("&Key:")))
+		self.key = wx.TextCtrl(self, wx.ID_ANY)
+		self.key.Enable(False)
+		sHelper.addItem(self.key)
+		# Translators: A checkbox in add-on options dialog to set whether sounds play instead of beeps.
+		self.play_sounds = wx.CheckBox(self, wx.ID_ANY, label=_("Play sounds instead of beeps"))
+		sHelper.addItem(self.play_sounds)
+		# Translators: A button in add-on options dialog to delete all fingerprints of unauthorized certificates.
+		self.delete_fingerprints = wx.Button(self, wx.ID_ANY, label=_("Delete all trusted fingerprints"))
+		self.delete_fingerprints.Bind(wx.EVT_BUTTON, self.on_delete_fingerprints)
+		sHelper.addItem(self.delete_fingerprints)
+		self.set_from_config()
+
+	def on_autoconnect(self, evt: wx.CommandEvent) -> None:
+		self.set_controls()
+
+	def set_controls(self) -> None:
+		state = bool(self.autoconnect.GetValue())
+		self.client_or_server.Enable(state)
+		self.connection_type.Enable(state)
+		self.key.Enable(state)
+		self.host.Enable(not bool(self.client_or_server.GetSelection()) and state)
+		self.port.Enable(bool(self.client_or_server.GetSelection()) and state)
+
+	def on_client_or_server(self, evt: wx.CommandEvent) -> None:
+		evt.Skip()
+		self.set_controls()
+
+	def set_from_config(self) -> None:
+		cs = self.config["controlserver"]
+		self_hosted = cs["self_hosted"]
+		connection_type = cs["connection_type"]
+		self.autoconnect.SetValue(cs["autoconnect"])
+		self.client_or_server.SetSelection(int(self_hosted))
+		self.connection_type.SetSelection(connection_type)
+		self.host.SetValue(cs["host"])
+		self.port.SetValue(str(cs["port"]))
+		self.key.SetValue(cs["key"])
+		self.set_controls()
+		self.play_sounds.SetValue(self.config["ui"]["play_sounds"])
+
+	def on_delete_fingerprints(self, evt: wx.CommandEvent) -> None:
+		if (
+			gui.messageBox(
+				_(
+					# Translators: This message is presented when the user tries to delete all stored trusted fingerprints.
+					"When connecting to an unauthorized server, you will again be prompted to accepts its certificate.",
+				),
+				# Translators: This is the title of the dialog presented when the user tries to delete all stored trusted fingerprints.
+				_("Are you sure you want to delete all stored trusted fingerprints?"),
+				wx.YES | wx.NO | wx.NO_DEFAULT | wx.ICON_WARNING,
+			)
+			== wx.YES
+		):
+			self.config["trusted_certs"].clear()
+		evt.Skip()
+
+	def isValid(self) -> bool:
+		if self.autoconnect.GetValue():
+			if not self.client_or_server.GetSelection() and (
+				not self.host.GetValue() or not self.key.GetValue()
+			):
+				gui.messageBox(
+					# Translators: This message is presented when the user tries to save the settings with the host or key field empty.
+					_("Both host and key must be set in the Remote section."),
+					# Translators: This is the title of the dialog presented when the user tries to save the settings with the host or key field empty.
+					_("Remote Error"),
+					wx.OK | wx.ICON_ERROR,
+				)
+				return False
+			elif self.client_or_server.GetSelection() and not self.port.GetValue() or not self.key.GetValue():
+				gui.messageBox(
+					# Translators: This message is presented when the user tries to save the settings with the port or key field empty.
+					_("Both port and key must be set in the Remote section."),
+					# Translators: This is the title of the dialog presented when the user tries to save the settings with the port or key field empty.
+					_("Remote Error"),
+					wx.OK | wx.ICON_ERROR,
+				)
+				return False
+		return True
+
+	def onSave(self):
+		cs = self.config["controlserver"]
+		cs["autoconnect"] = self.autoconnect.GetValue()
+		self_hosted = bool(self.client_or_server.GetSelection())
+		connection_type = self.connection_type.GetSelection()
+		cs["self_hosted"] = self_hosted
+		cs["connection_type"] = connection_type
+		if not self_hosted:
+			cs["host"] = self.host.GetValue()
+		else:
+			cs["port"] = int(self.port.GetValue())
+		cs["key"] = self.key.GetValue()
+		self.config["ui"]["play_sounds"] = self.play_sounds.GetValue()
+
+
 class TouchInteractionPanel(SettingsPanel):
 	# Translators: This is the label for the touch interaction settings panel.
 	title = _("Touch Interaction")
@@ -5207,6 +5361,8 @@ class NVDASettingsDialog(MultiCategorySettingsDialog):
 		DocumentNavigationPanel,
 		AddonStorePanel,
 	]
+	if not globalVars.appArgs.secure:
+		categoryClasses.append(RemoteSettingsPanel)
 	if touchHandler.touchSupported():
 		categoryClasses.append(TouchInteractionPanel)
 	if winVersion.isUwpOcrAvailable():

source/remoteClient/__init__.py

@@ -0,0 +1,22 @@
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2015-2025 NV Access Limited, Christopher Toth, Tyler Spivey, Babbage B.V., David Sexton and others.
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+
+from .client import RemoteClient
+
+client: RemoteClient = None
+
+
+def initialize():
+	"""Initialise the remote client."""
+	global client
+	import globalCommands
+
+	client = RemoteClient()
+	client.registerLocalScript(globalCommands.commands.script_sendKeys)
+
+
+def terminate():
+	"""Terminate the remote client."""
+	client.terminate()

source/remoteClient/beepSequence.py

@@ -0,0 +1,35 @@
+import collections.abc
+import threading
+import time
+from typing import Tuple, Union
+
+import tones
+
+local_beep = tones.beep
+
+BeepElement = Union[int, Tuple[int, int]]  # Either delay_ms or (frequency_hz, duration_ms)
+BeepSequence = collections.abc.Iterable[BeepElement]
+
+
+def beepSequence(*sequence: BeepElement) -> None:
+	"""Play a simple synchronous monophonic beep sequence
+	A beep sequence is an iterable containing one of two kinds of elements.
+	An element consisting of a tuple of two items is interpreted as a frequency and duration. Note, this function plays beeps synchronously, unlike tones.beep
+	A single integer is assumed to be a delay in ms.
+	"""
+	for element in sequence:
+		if not isinstance(element, collections.abc.Sequence):
+			time.sleep(float(element) / 1000)
+		else:
+			tone, duration = element
+			time.sleep(float(duration) / 1000)
+			local_beep(tone, duration)
+
+
+def beepSequenceAsync(*sequence: BeepElement) -> threading.Thread:
+	"""Play an asynchronous beep sequence.
+	This is the same as `beepSequence`, except it runs in a thread."""
+	thread = threading.Thread(target=beepSequence, args=sequence)
+	thread.daemon = True
+	thread.start()
+	return thread