summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2021-09-09 19:15:25 -0700
committerMicah Lee <micah@micahflee.com>2021-09-09 19:15:25 -0700
commit24e48801d2a02decfb86ebb16bb52a6ce8f8ada8 (patch)
tree585bffdb85a4fdbe895b2b1eab101d9bd8376e98
parent83786dd102e38c85409f35bd4c3efcd5ed432310 (diff)
downloadonionshare-24e48801d2a02decfb86ebb16bb52a6ce8f8ada8.tar.gz
onionshare-24e48801d2a02decfb86ebb16bb52a6ce8f8ada8.zip
Update the rest of the docs
-rw-r--r--docs/source/_static/screenshots/settings.pngbin55802 -> 47996 bytes
-rw-r--r--docs/source/advanced.rst2
-rw-r--r--docs/source/develop.rst118
-rw-r--r--docs/source/features.rst14
-rw-r--r--docs/source/security.rst2
-rw-r--r--docs/source/tor.rst2
6 files changed, 69 insertions, 69 deletions
diff --git a/docs/source/_static/screenshots/settings.png b/docs/source/_static/screenshots/settings.png
index 6b705496..2e0e49f1 100644
--- a/docs/source/_static/screenshots/settings.png
+++ b/docs/source/_static/screenshots/settings.png
Binary files differ
diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst
index 0014bf1a..08cc28e3 100644
--- a/docs/source/advanced.rst
+++ b/docs/source/advanced.rst
@@ -57,7 +57,7 @@ If nothing happens to you, you can cancel the service before it's scheduled to s
.. image:: _static/screenshots/advanced-schedule-start-timer.png
-**Scheduling an OnionShare service to automatically stop can be useful to limit exposure**, like if you want to share secret documents while making sure they're not available on the Internet for more than a few days.
+**Scheduling an OnionShare service to automatically stop can be useful to limit exposure**, like if you want to share secret documents while making sure they're not available on the internet for more than a few days.
.. image:: _static/screenshots/advanced-schedule-stop-timer.png
diff --git a/docs/source/develop.rst b/docs/source/develop.rst
index 5b08c921..042800c4 100644
--- a/docs/source/develop.rst
+++ b/docs/source/develop.rst
@@ -40,7 +40,7 @@ Verbose mode
When developing, it's convenient to run OnionShare from a terminal and add the ``--verbose`` (or ``-v``) flag to the command.
This prints a lot of helpful messages to the terminal, such as when certain objects are initialized, when events occur (like buttons clicked, settings saved or reloaded), and other debug info. For example::
- $ poetry run onionshare-cli -v ~/Documents/roms/nes/Q-bert\ \(USA\).nes
+ $ $ poetry run onionshare-cli -v ~/Documents/roms/nes/Q-bert\ \(USA\).nes
╭───────────────────────────────────────────╮
│ * ▄▄█████▄▄ * │
│ ▄████▀▀▀████▄ * │
@@ -58,62 +58,61 @@ This prints a lot of helpful messages to the terminal, such as when certain obje
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │
- │ v2.3.3 │
+ │ v2.4 │
│ │
│ https://onionshare.org/ │
╰───────────────────────────────────────────╯
-
- [Aug 28 2021 10:32:39] Settings.__init__
- [Aug 28 2021 10:32:39] Settings.load
- [Aug 28 2021 10:32:39] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=wordlist.txt
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=wordlist.txt, path=/home/user/git/onionshare/cli/onionshare_cli/resources/wordlist.txt
- [Aug 28 2021 10:32:39] ModeSettings.load: creating /home/user/.config/onionshare/persistent/dreamy-stiffen-moving.json
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.title = None
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.public = False
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.autostart_timer = 0
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.autostop_timer = 0
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: share.autostop_sharing = True
- [Aug 28 2021 10:32:39] Web.__init__: is_gui=False, mode=share
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=static
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=static, path=/home/user/git/onionshare/cli/onionshare_cli/resources/static
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=templates
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=templates, path=/home/user/git/onionshare/cli/onionshare_cli/resources/templates
- [Aug 28 2021 10:32:39] Web.generate_static_url_path: new static_url_path is /static_3tix3w3s5feuzlhii3zwqb2gpq
- [Aug 28 2021 10:32:39] ShareModeWeb.init
- [Aug 28 2021 10:32:39] Onion.__init__
- [Aug 28 2021 10:32:39] Onion.connect
- [Aug 28 2021 10:32:39] Settings.__init__
- [Aug 28 2021 10:32:39] Settings.load
- [Aug 28 2021 10:32:39] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:39] Onion.connect: tor_data_directory_name=/home/user/.config/onionshare/tmp/tmppb7kvf4k
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=torrc_template
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=torrc_template, path=/home/user/git/onionshare/cli/onionshare_cli/resources/torrc_template
+
+ [Sep 09 2021 19:13:20] Settings.__init__
+ [Sep 09 2021 19:13:20] Settings.load
+ [Sep 09 2021 19:13:20] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=wordlist.txt
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=wordlist.txt, path=/home/user/code/onionshare/cli/onionshare_cli/resources/wordlist.txt
+ [Sep 09 2021 19:13:20] ModeSettings.load: creating /home/user/.config/onionshare/persistent/polish-pushpin-hydrated.json
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.title = None
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.public = False
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.autostart_timer = 0
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.autostop_timer = 0
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: share.autostop_sharing = True
+ [Sep 09 2021 19:13:20] Web.__init__: is_gui=False, mode=share
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=static
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=static, path=/home/user/code/onionshare/cli/onionshare_cli/resources/static
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=templates
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=templates, path=/home/user/code/onionshare/cli/onionshare_cli/resources/templates
+ [Sep 09 2021 19:13:20] Web.generate_static_url_path: new static_url_path is /static_gvvq2hplxhs2cekk665kagei6m
+ [Sep 09 2021 19:13:20] ShareModeWeb.init
+ [Sep 09 2021 19:13:20] Onion.__init__
+ [Sep 09 2021 19:13:20] Onion.connect
+ [Sep 09 2021 19:13:20] Settings.__init__
+ [Sep 09 2021 19:13:20] Settings.load
+ [Sep 09 2021 19:13:20] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:20] Onion.connect: tor_data_directory_name=/home/user/.config/onionshare/tmp/tmpf3akiouy
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=torrc_template
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=torrc_template, path=/home/user/code/onionshare/cli/onionshare_cli/resources/torrc_template
Connecting to the Tor network: 100% - Done
- [Aug 28 2021 10:32:56] Onion.connect: Connected to tor 0.4.6.7
- [Aug 28 2021 10:32:56] Settings.load
- [Aug 28 2021 10:32:56] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:56] OnionShare.__init__
- [Aug 28 2021 10:32:56] OnionShare.start_onion_service
- [Aug 28 2021 10:32:56] Onion.start_onion_service: port=17609
- [Aug 28 2021 10:32:56] Onion.start_onion_service: key_type=NEW, key_content=ED25519-V3
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: general.service_id = sobp4rklarkz34mcog3pqtkb4t5bvyxv3dazvsqmfyhw4imqj446ffqd
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.private_key = sFiznwaPWJdKmFXumdDLkJGdUUdjI/0TWo+l/QEZiE/XoVogjK9INNoz2Tf8vmpe66ssa85En+5w6F2kKyTstA==
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.client_auth_priv_key = YL6YIEMZS6J537Y5ZKEA2Z6IIQEWFK2CMGTWK5G3DGGUREHJSJNQ
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.client_auth_pub_key = 5HUL6RCPQ5VEFDOHCSRAHPFIB74EHVFJO6JJHDP76EDWVRJE2RJQ
+ [Sep 09 2021 19:13:30] Onion.connect: Connected to tor 0.4.6.7
+ [Sep 09 2021 19:13:30] Settings.load
+ [Sep 09 2021 19:13:30] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:30] OnionShare.__init__
+ [Sep 09 2021 19:13:30] OnionShare.start_onion_service
+ [Sep 09 2021 19:13:30] Onion.start_onion_service: port=17616
+ [Sep 09 2021 19:13:30] Onion.start_onion_service: key_type=NEW, key_content=ED25519-V3
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: general.service_id = vucwsdmjt7szoc6pel3puqoxobiepdsowmqaq7pm7dzhembtzr2capad
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.private_key = +HfFALM4MtrNh59ibfMtRwDCIpfpWHIcNh3boahqrHh3TkLAyQvzKTm/y53KoYKSh0VU+m9DZY7DtZuCzkHkqQ==
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.client_auth_priv_key = G24TSNLIJX7YZM6R7P24AIGRU4N56ZFL7ENZVIDIWUEWY66YS3EQ
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.client_auth_pub_key = GDY2EPXSS7Q3ELQJFIX2VELTVZ3QEYIGWIZ26CEDQKZJ5Y7VKI3A
Compressing files.
- [Aug 28 2021 10:33:03] ShareModeWeb.init
- [Aug 28 2021 10:33:03] ShareModeWeb.set_file_info_custom
- [Aug 28 2021 10:33:03] ShareModeWeb.build_zipfile_list
- [Aug 28 2021 10:33:03] Web.start: port=17609
- * Running on http://127.0.0.1:17609/ (Press CTRL+C to quit)
-
+ [Sep 09 2021 19:13:35] ShareModeWeb.init
+ [Sep 09 2021 19:13:35] ShareModeWeb.set_file_info_custom
+ [Sep 09 2021 19:13:35] ShareModeWeb.build_zipfile_list
+ [Sep 09 2021 19:13:35] Web.start: port=17616
+ * Running on http://127.0.0.1:17616/ (Press CTRL+C to quit)
+
Give this address and private key to the recipient:
- http://sobp4rklarkz34mcog3pqtkb4t5bvyxv3dazvsqmfyhw4imqj446ffqd.onion
- Private key: YL6YIEMZS6J537Y5ZKEA2Z6IIQEWFK2CMGTWK5G3DGGUREHJSJNQ
-
- Press Ctrl+C to stop the server
+ http://vucwsdmjt7szoc6pel3puqoxobiepdsowmqaq7pm7dzhembtzr2capad.onion
+ Private key: G24TSNLIJX7YZM6R7P24AIGRU4N56ZFL7ENZVIDIWUEWY66YS3EQ
+ Press Ctrl+C to stop the server
You can add your own debug messages by running the ``Common.log`` method from ``onionshare/common.py``. For example::
@@ -145,24 +144,25 @@ You can do this with the ``--local-only`` flag. For example::
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │
- │ v2.3.3 │
+ │ v2.4 │
│ │
│ https://onionshare.org/ │
╰───────────────────────────────────────────╯
-
- * Running on http://127.0.0.1:17621/ (Press CTRL+C to quit)
-
+
+ * Running on http://127.0.0.1:17641/ (Press CTRL+C to quit)
+
Files sent to you appear in this folder: /home/user/OnionShare
-
+
Warning: Receive mode lets people upload files to your computer. Some files can potentially take control of your computer if you open them. Only open things from people you trust, or if you know what you are doing.
-
+
Give this address and private key to the sender:
- http://127.0.0.1:17621
+ http://127.0.0.1:17641
Private key: E2GOT5LTUTP3OAMRCRXO4GSH6VKJEUOXZQUC336SRKAHTTT5OVSA
-
+
Press Ctrl+C to stop the server
-In this case, you load the URL ``http://127.0.0.1:17621`` in a normal web-browser like Firefox, instead of using the Tor Browser. The Private key is not actually needed in local-only mode, so you can ignore it.
+
+In this case, you load the URL ``http://127.0.0.1:17641`` in a normal web-browser like Firefox, instead of using the Tor Browser. The private key is not actually needed in local-only mode, so you can ignore it.
Contributing Translations
-------------------------
diff --git a/docs/source/features.rst b/docs/source/features.rst
index 86c83a33..497b0ede 100644
--- a/docs/source/features.rst
+++ b/docs/source/features.rst
@@ -15,13 +15,13 @@ And private keys might look something like this::
K3N3N3U3BURJW46HZEZV2LZHBPKEFAGVN6DPC7TY6FHWXT7RLRAQ
-You're responsible for securely sharing that URL and private key using a communication channel of your choice like in an encrypted chat message, or using something less secure like unencrypted e-mail, depending on your `threat model <https://ssd.eff.org/module/your-security-plan>`_.
+You're responsible for securely sharing that URL and private key using a communication channel of your choice like in an encrypted chat message, or using something less secure like unencrypted email, depending on your `threat model <https://ssd.eff.org/module/your-security-plan>`_.
The people you send the URL to then copy and paste it into their `Tor Browser <https://www.torproject.org/>`_ to access the OnionShare service. Tor Browser will then prompt for the private key, which the people can also then copy and paste in.
.. image:: _static/screenshots/private-key.png
-If you run OnionShare on your laptop to send someone files, and then suspend it before the files are sent, the service will not be available until your laptop is unsuspended and on the Internet again. OnionShare works best when working with people in real-time.
+If you run OnionShare on your laptop to send someone files, and then suspend it before the files are sent, the service will not be available until your laptop is unsuspended and on the internet again. OnionShare works best when working with people in real-time.
Because your own computer is the web server, *no third party can access anything that happens in OnionShare*, not even the developers of OnionShare. It's completely private. And because OnionShare is based on Tor onion services too, it also protects your anonymity. See the :doc:`security design </security>` for more info.
@@ -36,7 +36,7 @@ After you add files, you'll see some settings. Make sure you choose the setting
.. image:: _static/screenshots/share-files.png
-As soon as someone finishes downloading your files, OnionShare will automatically stop the server, removing the website from the Internet.
+As soon as someone finishes downloading your files, OnionShare will automatically stop the server, removing the website from the internet.
To allow multiple people to download them, uncheck the "Stop sharing after files have been sent (uncheck to allow downloading individual files)" box.
Also, if you uncheck this box, people will be able to download the individual files you share rather than a single compressed version of all the files.
@@ -85,7 +85,7 @@ Setting up an OnionShare receiving service is useful for journalists and others
Use at your own risk
^^^^^^^^^^^^^^^^^^^^
-Just like with malicious e-mail attachments, it's possible someone could try to attack your computer by uploading a malicious file to your OnionShare service. OnionShare does not add any safety mechanisms to protect your system from malicious files.
+Just like with malicious email attachments, it's possible someone could try to attack your computer by uploading a malicious file to your OnionShare service. OnionShare does not add any safety mechanisms to protect your system from malicious files.
If you receive an Office document or a PDF through OnionShare, you can convert these documents into PDFs that are safe to open using `Dangerzone <https://dangerzone.rocks/>`_. You can also protect yourself when opening untrusted documents by opening them in `Tails <https://tails.boum.org/>`_ or in a `Qubes <https://qubes-os.org/>`_ disposableVM.
@@ -94,7 +94,7 @@ However, it is always safe to open text messages sent through OnionShare.
Tips for running a receive service
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you want to host your own anonymous dropbox using OnionShare, it's recommended you do so on a separate, dedicated computer always powered on and connected to the Internet, and not on the one you use on a regular basis.
+If you want to host your own anonymous dropbox using OnionShare, it's recommended you do so on a separate, dedicated computer always powered on and connected to the internet, and not on the one you use on a regular basis.
If you intend to put the OnionShare address on your website or social media profiles, save the tab (see :ref:`save_tabs`) and run it as a public service (see :ref:`turn_off_private_key`). It's also a good idea to give it a custom title (see :ref:`custom_titles`).
@@ -123,7 +123,7 @@ If you want to load content from third-party websites, like assets or JavaScript
Tips for running a website service
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you want to host a long-term website using OnionShare (meaning not just to quickly show someone something), it's recommended you do it on a separate, dedicated computer that is always powered on and connected to the Internet, and not on the one you use on a regular basis.
+If you want to host a long-term website using OnionShare (meaning not just to quickly show someone something), it's recommended you do it on a separate, dedicated computer that is always powered on and connected to the internet, and not on the one you use on a regular basis.
Save the tab (see :ref:`save_tabs`) so you can resume the website with the same address if you close OnionShare and re-open it later.
If your website is intended for the public, you should run it as a public service (see :ref:`turn_off_private_key`).
@@ -163,7 +163,7 @@ If you for example send a message to a Signal group, a copy of your message ends
OnionShare chat rooms don't store any messages anywhere, so the problem is reduced to a minimum.
OnionShare chat rooms can also be useful for people wanting to chat anonymously and securely with someone without needing to create any accounts.
-For example, a source can send an OnionShare address to a journalist using a disposable e-mail address, and then wait for the journalist to join the chat room, all without compromosing their anonymity.
+For example, a source can send an OnionShare address to a journalist using a disposable email address, and then wait for the journalist to join the chat room, all without compromosing their anonymity.
How does the encryption work?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/source/security.rst b/docs/source/security.rst
index 93ed3bce..7e656996 100644
--- a/docs/source/security.rst
+++ b/docs/source/security.rst
@@ -14,7 +14,7 @@ What OnionShare protects against
**Anonymity of OnionShare users are protected by Tor.** OnionShare and Tor Browser protect the anonymity of the users. As long as the OnionShare user anonymously communicates the OnionShare address with the Tor Browser users, the Tor Browser users and eavesdroppers can't learn the identity of the OnionShare user.
-**If an attacker learns about the onion service, it still can't access anything.** Prior attacks against the Tor network to enumerate onion services allowed the attacker to discover private .onion addresses. If an attack discovers a private OnionShare address, but not the private key used for Client Authentication, they will be prevented from accessing it (unless the OnionShare user chooses to turn off the private key and make it public - see :ref:`turn_off_private_key`).
+**If an attacker learns about the onion service, it still can't access anything.** Prior attacks against the Tor network to enumerate onion services allowed the attacker to discover private ``.onion`` addresses. If an attack discovers a private OnionShare address, they will also need to guess the private key used for client authentication in order to access it (unless the OnionShare user chooses make their serivce public by turning off the private key -- see :ref:`turn_off_private_key`).
What OnionShare doesn't protect against
---------------------------------------
diff --git a/docs/source/tor.rst b/docs/source/tor.rst
index 9bb42a88..e0b02d27 100644
--- a/docs/source/tor.rst
+++ b/docs/source/tor.rst
@@ -106,7 +106,7 @@ If all goes well, you should see "Connected to the Tor controller".
Using Tor bridges
-----------------
-If your access to the Internet is censored, you can configure OnionShare to connect to the Tor network using `Tor bridges <https://2019.www.torproject.org/docs/bridges.html.en>`_. If OnionShare connects to Tor without one, you don't need to use a bridge.
+If your access to the internet is censored, you can configure OnionShare to connect to the Tor network using `Tor bridges <https://2019.www.torproject.org/docs/bridges.html.en>`_. If OnionShare connects to Tor without one, you don't need to use a bridge.
To configure bridges, click the "⚙" icon in OnionShare.