onionshare_cli 2.6.1__py3-none-any.whl

onionshare_cli/meek.py

@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+"""
+OnionShare | https://onionshare.org/
+
+Copyright (C) 2014-2022 Micah Lee, et al. <micah@micahflee.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+import os
+import subprocess
+import time
+
+
+class Meek(object):
+    """
+    The Meek object starts the meek-client as a subprocess.
+    This process is used to do domain-fronting to connect to
+    the Tor APIs for censorship circumvention and retrieving
+    bridges, before connecting to Tor.
+    """
+
+    def __init__(self, common, get_tor_paths=None):
+        """
+        Set up the Meek object
+        """
+
+        self.common = common
+        self.common.log("Meek", "__init__")
+
+        # Set the path of the meek binary
+        if not get_tor_paths:
+            get_tor_paths = self.common.get_tor_paths
+        (
+            self.tor_path,
+            self.tor_geo_ip_file_path,
+            self.tor_geo_ipv6_file_path,
+            self.obfs4proxy_file_path,
+            self.snowflake_file_path,
+            self.meek_client_file_path,
+        ) = get_tor_paths()
+
+        self.meek_proxies = {}
+        self.meek_url = "https://moat.torproject.org.global.prod.fastly.net/"
+        self.meek_front = "cdn.sstatic.net"
+        self.meek_env = {
+            "TOR_PT_MANAGED_TRANSPORT_VER": "1",
+            "TOR_PT_CLIENT_TRANSPORTS": "meek",
+        }
+        self.meek_host = "127.0.0.1"
+        self.meek_port = None
+
+    def start(self):
+        """
+        Start the Meek Client and populate the SOCKS proxies dict
+        for use with requests to the Tor Moat API.
+        """
+        # Abort early if we can't find the Meek client
+        if self.meek_client_file_path is None or not os.path.exists(
+            self.meek_client_file_path
+        ):
+            raise MeekNotFound(self.common)
+
+        # Start the Meek Client as a subprocess.
+        self.common.log("Meek", "start", "Starting meek client")
+
+        if self.common.platform == "Windows":
+            env = os.environ.copy()
+            for key in self.meek_env:
+                env[key] = self.meek_env[key]
+
+            # In Windows, hide console window when opening meek-client.exe subprocess
+            startupinfo = subprocess.STARTUPINFO()
+            startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
+            self.meek_proc = subprocess.Popen(
+                [
+                    self.meek_client_file_path,
+                    "--url",
+                    self.meek_url,
+                    "--front",
+                    self.meek_front,
+                ],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                startupinfo=startupinfo,
+                bufsize=1,
+                env=env,
+                text=True,
+            )
+        else:
+            self.meek_proc = subprocess.Popen(
+                [
+                    self.meek_client_file_path,
+                    "--url",
+                    self.meek_url,
+                    "--front",
+                    self.meek_front,
+                ],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                bufsize=1,
+                env=self.meek_env,
+                # Using universal_newlines instead of text because the snap package using python < 3.7
+                universal_newlines=True,
+            )
+
+        # Obtain the host and port that meek is running on
+        for line in iter(self.meek_proc.stdout.readline, b""):
+            if "CMETHOD meek socks5" in line:
+                self.meek_host = line.split(" ")[3].split(":")[0]
+                self.meek_port = line.split(" ")[3].split(":")[1]
+                self.common.log(
+                    "Meek",
+                    "start",
+                    f"Meek running on {self.meek_host}:{self.meek_port}",
+                )
+                break
+
+            if "CMETHOD-ERROR" in line:
+                self.cleanup()
+                raise MeekNotRunning(self.common, line)
+                break
+
+        if self.meek_port:
+            self.meek_proxies = {
+                "http": f"socks5h://{self.meek_host}:{self.meek_port}",
+                "https": f"socks5h://{self.meek_host}:{self.meek_port}",
+            }
+        else:
+            self.cleanup()
+            raise MeekNotRunning(self.common, "Could not obtain the meek port")
+
+    def cleanup(self):
+        """
+        Kill any meek subprocesses.
+        """
+        self.common.log("Meek", "cleanup")
+
+        if self.meek_proc:
+            self.meek_proc.terminate()
+            time.sleep(0.2)
+            if self.meek_proc.poll() is None:
+                self.common.log(
+                    "Meek",
+                    "cleanup",
+                    "Tried to terminate meek-client process but it's still running",
+                )
+                try:
+                    self.meek_proc.kill()
+                    time.sleep(0.2)
+                    if self.meek_proc.poll() is None:
+                        self.common.log(
+                            "Meek",
+                            "cleanup",
+                            "Tried to kill meek-client process but it's still running",
+                        )
+                except Exception:
+                    self.common.log(
+                        "Meek", "cleanup", "Exception while killing meek-client process"
+                    )
+            self.meek_proc = None
+
+            # Reset other Meek settings
+            self.meek_proxies = {}
+            self.meek_port = None
+
+
+class MeekNotRunning(Exception):
+    """
+    We were unable to start Meek or obtain the port
+    number it started on, in order to do domain fronting.
+    """
+
+    def __init__(self, common, info=None):
+        self.common = common
+        msg = "Meek experienced an error starting up"
+        if info:
+            msg = msg + f": {info}"
+        self.common.log("MeekNotRunning", "__init__", msg)
+
+
+class MeekNotFound(Exception):
+    """
+    We were unable to find the Meek Client binary.
+    """
+
+    def __init__(self, common):
+        self.common = common
+        self.common.log("MeekNotFound", "__init__", "Could not find the meek binary")

onionshare_cli/mode_settings.py

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+"""
+OnionShare | https://onionshare.org/
+
+Copyright (C) 2014-2022 Micah Lee, et al. <micah@micahflee.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+import os
+import json
+import platform
+
+if platform.system() == "Darwin":
+    import pwd
+
+
+class ModeSettings:
+    """
+    This stores the settings for a single instance of an OnionShare mode. In CLI there
+    is only one ModeSettings, and in the GUI there is a separate ModeSettings for each tab
+    """
+
+    def __init__(self, common, filename=None, id=None):
+        self.common = common
+
+        self.default_settings = {
+            "onion": {
+                "private_key": None,
+                "client_auth_priv_key": None,
+                "client_auth_pub_key": None,
+            },
+            "persistent": {"mode": None, "enabled": False},
+            "general": {
+                "title": None,
+                "public": False,
+                "autostart_timer": False,
+                "autostop_timer": False,
+                "service_id": None,
+            },
+            "share": {"autostop_sharing": True, "filenames": []},
+            "receive": {
+                "data_dir": self.build_default_receive_data_dir(),
+                "webhook_url": None,
+                "disable_text": False,
+                "disable_files": False,
+            },
+            "website": {"disable_csp": False, "custom_csp": None, "filenames": []},
+            "chat": {},
+        }
+        self._settings = {}
+
+        self.just_created = False
+        if id:
+            self.id = id
+        else:
+            self.id = self.common.build_password(3)
+
+        self.load(filename)
+
+    def fill_in_defaults(self):
+        """
+        If there are any missing settings from self._settings, replace them with
+        their default values.
+        """
+        for key in self.default_settings:
+            if key in self._settings:
+                for inner_key in self.default_settings[key]:
+                    if inner_key not in self._settings[key]:
+                        self._settings[key][inner_key] = self.default_settings[key][
+                            inner_key
+                        ]
+            else:
+                self._settings[key] = self.default_settings[key]
+
+    def get(self, group, key):
+        return self._settings[group][key]
+
+    def set(self, group, key, val):
+        self._settings[group][key] = val
+        self.common.log(
+            "ModeSettings", "set", f"updating {self.id}: {group}.{key} = {val}"
+        )
+        self.save()
+
+    def build_default_receive_data_dir(self):
+        """
+        Returns the path of the default Downloads directory for receive mode.
+        """
+
+        if self.common.platform == "Darwin":
+            # We can't use os.path.expanduser() in macOS because in the sandbox it
+            # returns the path to the sandboxed homedir
+            real_homedir = pwd.getpwuid(os.getuid()).pw_dir
+            return os.path.join(real_homedir, "OnionShare")
+        elif self.common.platform == "Windows":
+            # On Windows, os.path.expanduser() needs to use backslash, or else it
+            # retains the forward slash, which breaks opening the folder in explorer.
+            return os.path.expanduser("~\\OnionShare")
+        else:
+            # All other OSes
+            return os.path.expanduser("~/OnionShare")
+
+    def load(self, filename=None):
+        # Load persistent settings from disk. If the file doesn't exist, create it
+        if filename:
+            self.filename = filename
+        else:
+            self.filename = os.path.join(
+                self.common.build_persistent_dir(), f"{self.id}.json"
+            )
+
+        if os.path.exists(self.filename):
+            try:
+                with open(self.filename, "r") as f:
+                    self._settings = json.load(f)
+                    self.fill_in_defaults()
+                    self.common.log("ModeSettings", "load", f"loaded {self.filename}")
+                    return
+            except Exception:
+                pass
+
+        # If loading settings didn't work, create the settings file
+        self.common.log("ModeSettings", "load", f"creating {self.filename}")
+        self.fill_in_defaults()
+        self.just_created = True
+
+    def save(self):
+        # Save persistent setting to disk
+        if not self.get("persistent", "enabled"):
+            return
+
+        if self.filename:
+            with open(self.filename, "w") as file:
+                file.write(json.dumps(self._settings, indent=2))
+
+    def delete(self):
+        # Delete the file from disk
+        if os.path.exists(self.filename):
+            os.remove(self.filename)