From abe80da100813fcc1b5536ec0f3e47f446c1a3d7 Mon Sep 17 00:00:00 2001 From: traumschule Date: Fri, 14 Sep 2018 10:15:16 +0200 Subject: [PATCH] faq: add environment variables respected by Tor Launcher (#13005) --- docs/en/faq.wml | 172 ++++++++++++++++++++++++- docs/en/update_signing-keys.pl.withsig | 121 +++++++++++++++++ 2 files changed, 292 insertions(+), 1 deletion(-) create mode 100755 docs/en/update_signing-keys.pl.withsig diff --git a/docs/en/faq.wml b/docs/en/faq.wml index c622e69c..38780f08 100644 --- a/docs/en/faq.wml +++ b/docs/en/faq.wml @@ -93,6 +93,10 @@ run another application through Tor.
  • What should I do if I can't set a proxy with my application?
    • +
  • How do I make Tor Browser use the tor that is + already running on the system?
    • +
  • Which environment variables does Tor Launcher + respect?
    • @@ -1410,7 +1414,7 @@ First (best option), if you're on Linux, you can install the system Tor package (e.g. apt-get install tor) and then set it up to be a relay - (instructions). + (instructions). You can then use TBB independent of that.

    @@ -1427,6 +1431,172 @@
    + +

    + How do I make Tor Browser use the tor that is already running on the system? +

    + +

    + Are you sure you want to do this? The Tor Browser runs tor using different + ports so it can co-exist happily with the tor process already running on + your system. Furthermore if you are running a relay, it may be better to + run another tor instance for all of your personal Tor usage. +

    + +

    + Note: Using Tor Browser in this manner is NOT OFFICIALLY SUPPORTED. +
    + If this does not work or randomly clobbers your torrc, you are on your own. +

    + +

    + If you are using the Tor Project's + Debian/Ubuntu packages + (You ran apt-get install tor at some point): +

    + +

    + Add the user you will be running Tor Browser as to the debian-tor group. + Set the following environment variables: +

    + + 
    +    export TOR_SKIP_LAUNCH=1
+    export TOR_SOCKS_PORT=9050
+    export TOR_CONTROL_PORT=9051
+    export TOR_CONTROL_COOKIE_AUTH_FILE=/var/run/tor/control.authcookie
+
    + +

    + Start Tor Browser. +

    + + 
    +    $ ./start-tor-browser.sh
+
    + +

    + If you wish to use password authentication for the control port, + you will need to wait till #9936 is fixed. +

    + +
    + + +

    + Which environment variables does Tor Launcher respect? +

    + +

    + Following settings can be changed but be aware that this is + not recommended and can harm your anonymity. +

    + +

    + In the default situation (without TOR_CONFIGURE_ONLY and without + TOR_SKIP_LAUNCH), Tor Launcher starts tor and then issues a + TAKEOWNERSHIP command via tor's control port so that the tor process will + automatically exit when Tor Launcher's control port connection is closed. + That way we have a much lower risk of an old tor process hanging around if + the browser is killed or if it crashes. But when TOR_CONFIGURE_ONLY=1 + and TOR_SKIP_LAUNCH=1 are set, Tor Launcher does not TAKEOWNERSHIP + (the assumption being that if Tor Launcher did not start the tor process, + it is someone else's problem to control its life cycle). +

    + + + +

    + There are Firefox preferences that correspond to some of the environment + variables. If an env variable is set the equivalent preference setting is + overwritten: +

    + + + +
    +

    Why are the file timestamps from 2000?

    diff --git a/docs/en/update_signing-keys.pl.withsig b/docs/en/update_signing-keys.pl.withsig new file mode 100755 index 00000000..b18120f5 --- /dev/null +++ b/docs/en/update_signing-keys.pl.withsig @@ -0,0 +1,121 @@ +#!/usr/bin/env perl +use strict; +use warnings; + +my $keysfile = "include/keys.txt"; +my $wmifile = 'include/keys.wmi'; +my $forcekeyupdates = 0; +my $skipkeyupdates = 0; + +# First we load the keys, then we create a wmi file which is included by +# https://www.torproject.org/docs/signing-keys.html.en + +# Determine the base directory in case we are called from somewhere else. +# We assume to sit in docs/en. Update $root path if this file has moved: +$0 =~ /^(.+)\/[^\/]+$/; +my $root = "$1/../.."; +chdir $root or die "Could not enter $root: $! (script path: $0)\n"; + +open my $kf, '<', "$keysfile" # read keys + or die "Could not open $keysfile: $!\n"; + +my %sections; # project => key owners +my %owners; # key owner => string with all keys +my @projects; # save sections in order of appearance +my $section; +foreach (<$kf>) { + # filters comment and empty lines + next if ($_ eq "\n"); + if (/^#/) { + # [section] / project + } elsif (/^\[(.+)\]$/) { + $section = "$1"; + $sections{"$section"} = (); + push (@projects, $section); + # key owner with list of key id(s) + } elsif (/^([^:]+):(.+)$/) { + my $owner = "$1"; + my $keys = "$2"; + push( @{$sections{"$section"}}, $owner); + $owners{"$owner"} = "$keys"; + # tell about unrecognized lines + } else { print "Ignored line: $_\n"; } +} +close $kf; +my @owners = keys %owners; +print "Loaded $keysfile. Found $#owners key owners in $#projects projects.\n"; + +# If the keysfile did not change since the last run, we will not update them. +# To update all keys anyway, set $forcekeyupdates = 1 above, or comment: +if (-f $wmifile && qx/[ $wmifile -nt $keysfile ]/) { + $forcekeyupdates or $skipkeyupdates++; +} + +open my $out, '>', "$wmifile" + or die "Could not write to $wmifile; $!\n"; +print $out "#!/usr/bin/env wml\n

    +This page is automatically generated from +keys.txt (.asc). +You can verify its signature as described in our +manual to verify signatures. +The signing keys we use are:\n

    \n\n

    Fingerprints

    \n

    The fingerprints for the keys are:

    \n"; +foreach my $project (@projects) { + print $out "

    $project

    \n". $fingerprints{"$project"}; +} +close $out; print "Wrote $wmifile.\n"; exit 0;