Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 15:29:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Tor documentation reworked

Browse Source
This commit is contained in:
Allan Nordhøy 2020-09-22 07:51:18 +00:00 committed by GitHub
parent 437beef098
commit f688ecbc87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 55 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
docs/source/tor.rst
View File

@ -1,53 +1,65 @@
Connecting to Tor Connecting to Tor
================= =================
There are several options for how OnionShare should connect to Tor. You can change them in Settings, which you can get to by clicking the gear icon in the bottom-right of the window. Pick a way to connect OnionShare to Tor by clicking the "⚙" icon in the bottom right of the OnionShare window to get to its settings.
.. image:: _static/screenshots/settings.png .. image:: _static/screenshots/settings.png
Use Tor that is bundled with OnionShare Use the Tor bundled with OnionShare
--------------------------------------- -----------------------------------
This is the default way that OnionShare connects to Tor, and it's also the simplest and most reliable way. For this reason, it's recommended for most users. This is the default, simplest and most reliable way that OnionShare connects to Tor.
For this reason, it's recommended for most users.
When you open OnionShare, it will launch a Tor process in the background that's configured specifically for OnionShare to use. This Tor process won't interfere with other Tor processes on your computer, so you're free to run Tor Browser or use a system Tor in the background. When you open OnionShare, it launches an already configured Tor process in the background OnionShare to use.
It doesn't interfere with other Tor processes on your computer, so you can use the Tor Browser or the system Tor on their own.
Attempt automatic configuration with Tor Browser Attempt auto-configuration with Tor Browser
------------------------------------------------ ------------------------------------------------
You can configure OnionShare to connect to the Tor that comes with Tor Browser. First, `download Tor Browser <https://www.torproject.org>`_ here if you don't already have it. With this setting selected, you need to keep Tor Browser open in the background while you're using OnionShare. If you have `downloaded the Tor Browser <https://www.torproject.org>`_ and don't want two Tor processes running, you can use the Tor process from the Tor browser.
Keep in mind you need to keep Tor Browser open in the background while you're using OnionShare for this to work.
Using a system Tor in Windows Using a system Tor in Windows
----------------------------- -----------------------------
This is fairly advanced. You'll need to know how edit plaintext files and do stuff as an administrator. This is fairly advanced. You'll need to know how edit plaintext files and do stuff as an administrator.
Download the Tor Windows Expert Bundle, which you can get `from here <https://www.torproject.org/download/tor/>`_. Extract the zip file and copy the extracted folder to ``C:\Program Files (x86)\``, and rename the folder to ``tor-win32``, so that inside that folder is the ``Data`` and ``Tor`` folders. Download the Tor Windows Expert Bundle `from <https://www.torproject.org/download/tor/>`_.
Extract the ZIP file and copy the extracted folder to ``C:\Program Files (x86)\``
Rename the folder with ``Data`` and ``Tor`` in it to ``tor-win32``.
Make up a control port password. I'm going to use ``comprised stumble rummage work avenging construct volatile`` as my password. Now open a command prompt as an administrator, and use ``tor.exe --hash-password`` to generate a hash of your password. For example:: Make up a control port password.
(Using 7 words in a sequence like ``comprised stumble rummage work avenging construct volatile`` is a good idea for a password.)
Now open a command prompt (cmd) as an administrator, and use ``tor.exe --hash-password`` to generate a hash of your password. For example::
cd "C:\Program Files (x86)\tor-win32\Tor" cd "C:\Program Files (x86)\tor-win32\Tor"
tor.exe --hash-password "comprised stumble rummage work avenging construct volatile" tor.exe --hash-password "comprised stumble rummage work avenging construct volatile"
The hashed password output is displayed after some warnings (which you can ignore). In my case, it was ``16:00322E903D96DE986058BB9ABDA91E010D7A863768635AC38E213FDBEF``. The hashed password output is displayed after some warnings (which you can ignore). In the case of the above example, it is ``16:00322E903D96DE986058BB9ABDA91E010D7A863768635AC38E213FDBEF``.
Now create a new text file at ``C:\Program Files (x86)\tor-win32\torrc`` and put this in it, replacing the ``HashedControlPassword`` with the one you just generated:: Now create a new text file at ``C:\Program Files (x86)\tor-win32\torrc`` and put your hashed password output in it, replacing the ``HashedControlPassword`` with the one you just generated::
ControlPort 9051 ControlPort 9051
HashedControlPassword 16:00322E903D96DE986058BB9ABDA91E010D7A863768635AC38E213FDBEF HashedControlPassword (The numbers you generate from the password you pick above)
In your administrator command prompt, install tor as a service using the appropriate ``torrc`` file you just created (see `here <https://2019.www.torproject.org/docs/faq.html.en#NTService>`_ for more information on doing this). Like this:: In your administrator command prompt, install Tor as a service using the appropriate ``torrc`` file you just created (as described in `here <https://2019.www.torproject.org/docs/faq.html.en#NTService>`_). Like this::
tor.exe --service install -options -f "C:\Program Files (x86)\tor-win32\torrc" tor.exe --service install -options -f "C:\Program Files (x86)\tor-win32\torrc"
You're now running a system Tor in Windows! You are now running a system Tor process in Windows!
Open OnionShare. Click the Settings icon. Under "How should OnionShare connect to Tor?" choose "Connect using control port", and set the control port host to ``127.0.0.1`` and the port to ``9051``. Under "Tor authentication options" choose "Password" and set the password to your password, in my case ``comprised stumble rummage work avenging construct volatile``. Click the "Test Settings" button. If all goes well, you should see successfully connected to tor. Open OnionShare. Under "How should OnionShare connect to Tor?" choose "Connect using control port", and set
"Control port" to ``127.0.0.1`` and
"Port" to ``9051``.
Under "Tor authentication options" choose "Password" and set the password to the control port password password you picked above
Click the "Test Settings" button.
If all goes well, you should see "Connected to the Tor controller".
Using a system Tor in macOS Using the system's Tor in macOS
--------------------------- -------------------------------
First, install `Homebrew <http://brew.sh/>`_ if you don't already have it. Then, install Tor:: First, install `Homebrew <https://brew.sh/>`_ if you don't already have it. Then, install Tor::
brew install tor brew install tor
@ -62,14 +74,22 @@ And start the system Tor service::
brew services start tor brew services start tor
Open OnionShare. Click the Settings icon. Under "How should OnionShare connect to Tor?" choose "Connect using socket file", and set the socket file to be ``/usr/local/var/run/tor/control.socket``. Under "Tor authentication options" choose "No authentication, or cookie authentication". Click the "Test Settings" button. If all goes well, you should see successfully connected to tor. Open OnionShare and click the "⚙" icon in it. Under "How should OnionShare connect to Tor?" choose "Connect using control port", and set
"Control port" to ``127.0.0.1`` and
"Port" to ``9051``.
Using a system Tor in Linux Under "Tor authentication settings" choose "Password", and set your password.
--------------------------- (Using 7 words in a sequence like ``comprised stumble rummage work avenging construct volatile`` is a good idea for a password.)
Click the "Test Connection to Tor" button.
First, install the tor package. If you're using Debian, Ubuntu, or a similar Linux distro, I recommend you use Tor Project's `official repository <https://2019.www.torproject.org/docs/debian.html.en>`_. For example, in Ubuntu 20.04:: If all goes well, you should see "Connected to the Tor controller".
sudo su -c "echo 'deb http://deb.torproject.org/torproject.org focal main' > /etc/apt/sources.list.d/torproject.list" Using the system's Tor in Linux
-------------------------------
First, install the Tor package. If you're using Debian, Ubuntu, or a similar Linux distro, It is recommended to use the Tor Project's `official repository <https://2019.www.torproject.org/docs/debian.html.en>`_. For example, in Ubuntu 20.04::
sudo su -c "echo 'deb https://deb.torproject.org/torproject.org focal main' > /etc/apt/sources.list.d/torproject.list"
curl https://deb.torproject.org/torproject.org/A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89.asc | gpg --import curl https://deb.torproject.org/torproject.org/A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89.asc | gpg --import
gpg --export A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89 | sudo apt-key add - gpg --export A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89 | sudo apt-key add -
sudo apt-get update sudo apt-get update
@ -81,13 +101,21 @@ Add your user to the ``debian-tor`` group by running this command (replace ``use
sudo usermod -a -G debian-tor username sudo usermod -a -G debian-tor username
Reboot your computer. After it boots up again, open OnionShare. Click the Settings icon. Under "How should OnionShare connect to Tor?" choose "Connect using socket file", and set the socket file to be ``/var/run/tor/control``. Under "Tor authentication options" choose "No authentication, or cookie authentication". Click the "Test Settings" button. If all goes well, you should see successfully connect to Tor. Reboot your computer.
After it boots up again, open OnionShare and click the "⚙" icon in it.
Under "How should OnionShare connect to Tor?" choose "Connect using socket file".
Set the socket file to be ``/var/run/tor/control``.
Under "Tor authentication options" choose "No authentication, or cookie authentication".
Click the "Test Settings" button.
If all goes well, you should see "Connected to the Tor controller".
Using Tor bridges 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 successfully connects to Tor, 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, open OnionShare settings. To configure bridges, click the "⚙" icon in OnionShare.
You can use the built-in obfs4 pluggable transports, the built-in meek_lite (Azure) pluggable transports, or custom bridges, which you can obtain from Tor's `BridgeDB <https://bridges.torproject.org/>`_. If you need to use a bridge, you should try the built-in obfs4 ones first. You can use the built-in obfs4 pluggable transports, the built-in meek_lite (Azure) pluggable transports, or custom bridges, which you can obtain from Tor's `BridgeDB <https://bridges.torproject.org/>`_.
If you need to use a bridge, try the built-in obfs4 ones first.