.circleci/config.yml

@@ -1,8 +1,3 @@
-# To run the tests, CircleCI needs these environment variables:
-# QT_EMAIL - email address for a Qt account
-# QT_PASSWORD - password for a Qt account
-# (Unfortunately you can't install Qt without logging in.)
-
 version: 2
 workflows:
   version: 2

CHANGELOG.md

@@ -1,5 +1,11 @@
 # OnionShare Changelog
 
+## 2.4
+
+* Major feature: Private keys (v3 onion client authentication) replaces passwords and HTTP basic auth
+* Updated Tor to 0.4.6.7 on all platforms
+* Various bug fixes
+
 ## 2.3.3
 
 * New feature: Setting for light or dark theme

README.md

@@ -22,4 +22,4 @@ To learn how OnionShare works, what its security properties are, how to use it,
 
 ---
 
-Test status: [![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)
+Test status: [![CircleCI](https://circleci.com/gh/onionshare/onionshare.svg?style=svg)](https://circleci.com/gh/onionshare/onionshare)

RELEASE.md

@@ -11,6 +11,7 @@ Before making a release, you must update the version in these places:
 - [ ] `cli/onionshare_cli/resources/version.txt`
 - [ ] `desktop/pyproject.toml` (under `version` and **don't forget** the `./onionshare_cli-$VERSION-py3-none-any.whl` dependency)
 - [ ] `desktop/src/setup.py`
+- [ ] `desktop/src/org.onionshare.OnionShare.appdata.xml`
 - [ ] `docs/source/conf.py` (`version` at the top, and the `versions` list too)
 - [ ] `snap/snapcraft.yaml`
 
@@ -41,7 +42,7 @@ Finalize localization:
 
 You also must edit these files:
 
-- [ ] `desktop/src/org.onionshare.OnionShare.appdata.xml` should have the correct version, release date, and links to correct screenshots
+- [ ] `desktop/src/org.onionshare.OnionShare.appdata.xml` should have the correct release date, and links to correct screenshots
 - [ ] `CHANGELOG.md` should be updated to include a list of all major changes since the last release
 
 Make sure snapcraft packaging works. In `snap/snapcraft.yaml`:

cli/README.md

@@ -22,14 +22,69 @@
 
 ## Installing OnionShare CLI
 
-First, make sure you have `tor` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`.
+First, make sure you have `tor` and `python3` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`. Second, OnionShare is written in python, and you can install the command line version use python's package manager `pip`.
 
-Then install OnionShare CLI:
+### Requirements
 
+Debian/Ubuntu (APT):
 ```sh
-pip install onionshare-cli
+sudo apt-get install tor python3-pip
 ```
 
+Arch (Pacman):
+```sh
+sudo pacman -S tor python-pip
+```
+
+CentOS, Red Hat, and Fedora (Yum):
+```sh
+sudo yum install tor python3 python3-wheel
+```
+
+macOS (Homebrew):
+```sh
+brew install tor python
+sudo easy_install pip
+```
+
+### Main
+
+#### Installation
+
+Install OnionShare CLI:
+
+```sh
+pip install --user onionshare-cli
+```
+
+#### Set path
+
+When you install programs with pip and use the --user flag, it installs them into ~/.local/bin, which isn't in your path by default. To add ~/.local/bin to your path automatically for the next time you reopen the terminal or source your shell configuration file, do the following:
+
+First, discover what shell you are using:
+
+```sh
+echo $SHELL
+```
+
+Then apply the path to your shell file:
+
+bash:
+
+```sh
+echo "PATH=\$PATH:~/.local/bin" >> ~/.bashrc
+source ~/.bashrc
+```
+
+zsh:
+
+```sh
+echo "PATH=\$PATH:~/.local/bin" >> ~/.zshrc
+source ~/.zshrc
+```
+
+#### Usage
+
 Then run it with:
 
 ```sh

cli/onionshare_cli/__init__.py

@@ -38,14 +38,6 @@
 from .mode_settings import ModeSettings
 
 
-def build_url(mode_settings, app, web):
-    # Build the URL
-    if mode_settings.get("general", "public"):
-        return f"http://{app.onion_host}"
-    else:
-        return f"http://onionshare:{web.password}@{app.onion_host}"
-
-
 def main(cwd=None):
     """
     The main() function implements all of the logic that the command-line version of
@@ -113,7 +105,7 @@ def main(cwd=None):
         action="store_true",
         dest="public",
         default=False,
-        help="Don't use a password",
+        help="Don't use a private key",
     )
     parser.add_argument(
         "--auto-start-timer",
@@ -129,20 +121,6 @@ def main(cwd=None):
         default=0,
         help="Stop onion service at schedule time (N seconds from now)",
     )
-    parser.add_argument(
-        "--legacy",
-        action="store_true",
-        dest="legacy",
-        default=False,
-        help="Use legacy address (v2 onion service, not recommended)",
-    )
-    parser.add_argument(
-        "--client-auth",
-        action="store_true",
-        dest="client_auth",
-        default=False,
-        help="Use client authorization (requires --legacy)",
-    )
     # Share args
     parser.add_argument(
         "--no-autostop-sharing",
@@ -215,8 +193,6 @@ def main(cwd=None):
     public = bool(args.public)
     autostart_timer = int(args.autostart_timer)
     autostop_timer = int(args.autostop_timer)
-    legacy = bool(args.legacy)
-    client_auth = bool(args.client_auth)
     autostop_sharing = not bool(args.no_autostop_sharing)
     data_dir = args.data_dir
     webhook_url = args.webhook_url
@@ -225,25 +201,9 @@ def main(cwd=None):
     disable_csp = bool(args.disable_csp)
     verbose = bool(args.verbose)
 
-    if receive:
-        mode = "receive"
-    elif website:
-        mode = "website"
-    elif chat:
-        mode = "chat"
-    else:
-        mode = "share"
-
     # Verbose mode?
     common.verbose = verbose
 
-    # client_auth can only be set if legacy is also set
-    if client_auth and not legacy:
-        print(
-            "Client authentication (--client-auth) is only supported with with legacy onion services (--legacy)"
-        )
-        sys.exit()
-
     # Re-load settings, if a custom config was passed in
     if config_filename:
         common.load_settings(config_filename)
@@ -254,18 +214,26 @@ def main(cwd=None):
     if persistent_filename:
         mode_settings = ModeSettings(common, persistent_filename)
         mode_settings.set("persistent", "enabled", True)
-        mode_settings.set("persistent", "mode", mode)
     else:
         mode_settings = ModeSettings(common)
 
+    if receive:
+        mode = "receive"
+    elif website:
+        mode = "website"
+    elif chat:
+        mode = "chat"
+    else:
+        mode = "share"
+
     if mode_settings.just_created:
         # This means the mode settings were just created, not loaded from disk
         mode_settings.set("general", "title", title)
         mode_settings.set("general", "public", public)
         mode_settings.set("general", "autostart_timer", autostart_timer)
         mode_settings.set("general", "autostop_timer", autostop_timer)
-        mode_settings.set("general", "legacy", legacy)
-        mode_settings.set("general", "client_auth", client_auth)
+        if persistent_filename:
+            mode_settings.set("persistent", "mode", mode)
         if mode == "share":
             mode_settings.set("share", "autostop_sharing", autostop_sharing)
         if mode == "receive":
@@ -352,11 +320,6 @@ def main(cwd=None):
     try:
         common.settings.load()
 
-        if mode_settings.get("general", "public"):
-            web.password = None
-        else:
-            web.generate_password(mode_settings.get("onion", "password"))
-
         # Receive mode needs to know the tor proxy details for webhooks
         if mode == "receive":
             if local_only:
@@ -381,7 +344,7 @@ def main(cwd=None):
                 sys.exit()
 
             app.start_onion_service(mode, mode_settings, False)
-            url = build_url(mode_settings, app, web)
+            url = f"http://{app.onion_host}"
             schedule = datetime.now() + timedelta(seconds=autostart_timer)
             if mode == "receive":
                 print(
@@ -394,21 +357,21 @@ def main(cwd=None):
                     "what you are doing."
                 )
                 print("")
-                if mode_settings.get("general", "client_auth"):
+                if not mode_settings.get("general", "public"):
                     print(
-                        f"Give this address and HidServAuth lineto your sender, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
+                        f"Give this address and private key to your sender, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
                     )
-                    print(app.auth_string)
+                    print(f"Private key: {app.auth_string}")
                 else:
                     print(
                         f"Give this address to your sender, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
                     )
             else:
-                if mode_settings.get("general", "client_auth"):
+                if not mode_settings.get("general", "public"):
                     print(
-                        f"Give this address and HidServAuth line to your recipient, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
+                        f"Give this address and private key to your recipient, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
                     )
-                    print(app.auth_string)
+                    print(f"Private key: {app.auth_string}")
                 else:
                     print(
                         f"Give this address to your recipient, and tell them it won't be accessible until: {schedule.strftime('%I:%M:%S%p, %b %d, %y')}"
@@ -426,7 +389,6 @@ def main(cwd=None):
         sys.exit()
     except (TorTooOldEphemeral, TorTooOldStealth, TorErrorProtocolError) as e:
         print("")
-        print(e.args[0])
         sys.exit()
 
     if mode == "website":
@@ -458,21 +420,14 @@ def main(cwd=None):
     t.start()
 
     try:  # Trap Ctrl-C
-        # Wait for web.generate_password() to finish running
         time.sleep(0.2)
 
         # start auto-stop timer thread
         if app.autostop_timer > 0:
             app.autostop_timer_thread.start()
 
-        # Save the web password if we are using a persistent private key
-        if mode_settings.get("persistent", "enabled"):
-            if not mode_settings.get("onion", "password"):
-                mode_settings.set("onion", "password", web.password)
-                # mode_settings.save()
-
         # Build the URL
-        url = build_url(mode_settings, app, web)
+        url = f"http://{app.onion_host}"
 
         print("")
         if autostart_timer > 0:
@@ -490,21 +445,21 @@ def main(cwd=None):
                 )
                 print("")
 
-                if mode_settings.get("general", "client_auth"):
-                    print("Give this address and HidServAuth to the sender:")
+                if mode_settings.get("general", "public"):
+                    print("Give this address to the sender:")
                     print(url)
-                    print(app.auth_string)
                 else:
-                    print("Give this address to the sender:")
+                    print("Give this address and private key to the sender:")
                     print(url)
+                    print(f"Private key: {app.auth_string}")
             else:
-                if mode_settings.get("general", "client_auth"):
-                    print("Give this address and HidServAuth line to the recipient:")
+                if mode_settings.get("general", "public"):
+                    print("Give this address to the recipient:")
                     print(url)
-                    print(app.auth_string)
                 else:
-                    print("Give this address to the recipient:")
+                    print("Give this address and private key to the recipient:")
                     print(url)
+                    print(f"Private key: {app.auth_string}")
         print("")
         print("Press Ctrl+C to stop the server")
 

cli/onionshare_cli/mode_settings.py

@@ -37,17 +37,15 @@ def __init__(self, common, filename=None, id=None):
         self.default_settings = {
             "onion": {
                 "private_key": None,
-                "hidservauth_string": None,
-                "password": 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,
-                "legacy": False,
-                "client_auth": False,
                 "service_id": None,
             },
             "share": {"autostop_sharing": True, "filenames": []},