October 2018 - tor-commits - lists.torproject.org

[tor/maint-0.3.5] Remove the `link_rust.sh.in` script
by nickm＠torproject.org 30 Oct '18

30 Oct '18

commit 6ebb2c46d5eae7bae8d827fdc68d3ed58b16e95a Author: Alex Crichton <alex(a)alexcrichton.com> Date: Mon Oct 1 22:50:08 2018 -0700 Remove the `link_rust.sh.in` script This is no longer necessary with upstream rust-lang/rust changes as well as some local tweaks. Namely: * The `-fsanitize=address`-style options are now passed via `-C link-args` through `RUSTFLAGS`. This obviates the need for the shell script. * The `-C default-linker-libraries`, disabling `-nodefaultlibs`, is passed through `RUSTFLAGS`, which is necessary to ensure that `-fsanitize=address` links correctly. * The `-C linker` option is passed to ensure we're using the same C compiler as normal C code, although it has a bit of hackery to only get the `gcc` out of `gcc -std=c99` --- configure.ac | 9 ++++----- link_rust.sh.in | 10 ---------- src/test/include.am | 3 +-- 3 files changed, 5 insertions(+), 17 deletions(-) diff --git a/configure.ac b/configure.ac index dbeba512c..ef8bb4e35 100644 --- a/configure.ac +++ b/configure.ac @@ -1210,17 +1210,17 @@ dnl variable. RUST_LINKER_OPTIONS="" if test "x$have_clang" = "xyes"; then if test "x$CFLAGS_ASAN" != "x"; then - RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS $CFLAGS_ASAN" + RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -Clink-arg=$CFLAGS_ASAN" fi if test "x$CFLAGS_UBSAN" != "x"; then - RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS $CFLAGS_UBSAN" + RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -Clink-arg=$CFLAGS_UBSAN" fi else if test "x$CFLAGS_ASAN" != "x"; then - RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -lasan" + RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -Clink-arg=-fsanitize=address" fi if test "x$CFLAGS_UBSAN" != "x"; then - RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -lubsan" + RUST_LINKER_OPTIONS="$RUST_LINKER_OPTIONS -Clink-arg=-fsanitize=undefined" fi fi AC_SUBST(RUST_LINKER_OPTIONS) @@ -2416,7 +2416,6 @@ AC_CONFIG_FILES([ Doxyfile Makefile config.rust - link_rust.sh contrib/dist/suse/tor.sh contrib/operator-tools/tor.logrotate contrib/dist/tor.sh diff --git a/link_rust.sh.in b/link_rust.sh.in deleted file mode 100644 index 59f4142ba..000000000 --- a/link_rust.sh.in +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh -# -# A linker script used when building Rust tests. Autoconf makes link_rust.sh -# from link_rust_sh.in, and uses it to pass extra options to the linker -# when linking Rust stuff. -# -# We'd like to remove the need for this, but build.rs doesn't let us pass -# -static-libasan and -static-libubsan to the linker. - -$CCLD @RUST_LINKER_OPTIONS@ "$@" diff --git a/src/test/include.am b/src/test/include.am index 1055cd0a8..431458108 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -12,8 +12,7 @@ TESTS_ENVIRONMENT = \ export EXTRA_CARGO_OPTIONS="$(EXTRA_CARGO_OPTIONS)"; \ export CARGO_ONLINE="$(CARGO_ONLINE)"; \ export CCLD="$(CCLD)"; \ - chmod +x "$(abs_top_builddir)/link_rust.sh"; \ - export RUSTFLAGS="-C linker=$(abs_top_builddir)/link_rust.sh"; + export RUSTFLAGS="-C linker=`echo '$(CC)' | cut -d' ' -f 1` $(RUST_LINKER_OPTIONS) -C default-linker-libraries"; TESTSCRIPTS = \ src/test/fuzz_static_testcases.sh \

1 0

[tor-browser/tor-browser-60.3.0esr-8.5-1] Bug 28125 - Prevent non-Necko network connections
by gk＠torproject.org 30 Oct '18

30 Oct '18

commit 2c4b103cfef5eafe276713478abf8bd1db057730 Author: Matthew Finkel <Matthew.Finkel(a)gmail.com> Date: Thu Oct 25 19:17:09 2018 +0000 Bug 28125 - Prevent non-Necko network connections --- .../base/java/org/mozilla/gecko/CrashReporter.java | 5 ++ .../base/java/org/mozilla/gecko/SuggestClient.java | 5 ++ .../homepanel/topstories/PocketStoriesLoader.java | 5 ++ .../mozilla/gecko/distribution/Distribution.java | 5 ++ .../java/org/mozilla/gecko/dlc/BaseAction.java | 6 ++ .../java/org/mozilla/gecko/home/ImageLoader.java | 7 ++ .../mozilla/gecko/icons/loader/IconDownloader.java | 11 +++ .../mozilla/gecko/search/SearchEngineManager.java | 5 ++ .../org/mozilla/gecko/switchboard/SwitchBoard.java | 6 ++ .../org/mozilla/gecko/updater/UpdateService.java | 11 +++ .../gecko/media/GeckoMediaDrmBridgeV21.java | 77 +++++++++++--------- .../exoplayer2/upstream/DefaultHttpDataSource.java | 85 ++++++++++++---------- .../service/utils/AbstractCommunicator.java | 5 ++ 13 files changed, 157 insertions(+), 76 deletions(-) diff --git a/mobile/android/base/java/org/mozilla/gecko/CrashReporter.java b/mobile/android/base/java/org/mozilla/gecko/CrashReporter.java index f1305cfc5398..618278773c38 100644 --- a/mobile/android/base/java/org/mozilla/gecko/CrashReporter.java +++ b/mobile/android/base/java/org/mozilla/gecko/CrashReporter.java @@ -472,6 +472,11 @@ public class CrashReporter extends AppCompatActivity } private void sendReport(File minidumpFile, Map<String, String> extras, File extrasFile) { + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "sendReport: This is Tor Browser. Skipping."); + return; + } + Log.i(LOGTAG, "sendReport: " + minidumpFile.getPath()); final CheckBox includeURLCheckbox = (CheckBox) findViewById(R.id.include_url); diff --git a/mobile/android/base/java/org/mozilla/gecko/SuggestClient.java b/mobile/android/base/java/org/mozilla/gecko/SuggestClient.java index 0ebffeccdf21..137e53cc5c03 100644 --- a/mobile/android/base/java/org/mozilla/gecko/SuggestClient.java +++ b/mobile/android/base/java/org/mozilla/gecko/SuggestClient.java @@ -72,6 +72,11 @@ public class SuggestClient { return mPrevResults; ArrayList<String> suggestions = new ArrayList<String>(); + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return suggestions; + } + if (TextUtils.isEmpty(mSuggestTemplate) || TextUtils.isEmpty(query)) { return suggestions; } diff --git a/mobile/android/base/java/org/mozilla/gecko/activitystream/homepanel/topstories/PocketStoriesLoader.java b/mobile/android/base/java/org/mozilla/gecko/activitystream/homepanel/topstories/PocketStoriesLoader.java index 7ebead4cfa3f..516c13610047 100644 --- a/mobile/android/base/java/org/mozilla/gecko/activitystream/homepanel/topstories/PocketStoriesLoader.java +++ b/mobile/android/base/java/org/mozilla/gecko/activitystream/homepanel/topstories/PocketStoriesLoader.java @@ -124,6 +124,11 @@ public class PocketStoriesLoader extends AsyncTaskLoader<List<TopStory>> { } protected String makeAPIRequestWithKey(final String apiKey) { + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return null; + } + HttpURLConnection connection = null; final Uri uri = Uri.parse(GLOBAL_ENDPOINT) diff --git a/mobile/android/base/java/org/mozilla/gecko/distribution/Distribution.java b/mobile/android/base/java/org/mozilla/gecko/distribution/Distribution.java index 7b93eb568acc..ea9534bfd741 100644 --- a/mobile/android/base/java/org/mozilla/gecko/distribution/Distribution.java +++ b/mobile/android/base/java/org/mozilla/gecko/distribution/Distribution.java @@ -534,6 +534,11 @@ public class Distribution { return false; } + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return false; + } + URI uri = getReferredDistribution(referrer); if (uri == null) { return false; diff --git a/mobile/android/base/java/org/mozilla/gecko/dlc/BaseAction.java b/mobile/android/base/java/org/mozilla/gecko/dlc/BaseAction.java index 5b1e0004fef1..56cfde26160c 100644 --- a/mobile/android/base/java/org/mozilla/gecko/dlc/BaseAction.java +++ b/mobile/android/base/java/org/mozilla/gecko/dlc/BaseAction.java @@ -151,6 +151,12 @@ public abstract class BaseAction { protected HttpURLConnection buildHttpURLConnection(String url) throws UnrecoverableDownloadContentException, IOException { try { + if (AppConstants.isTorBrowser()) { + String erdcl = "This is Tor Browser. Downloading is disabled for: " + url; + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + throw new UnrecoverableDownloadContentException(erdcl); + } + System.setProperty("http.keepAlive", "true"); HttpURLConnection connection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(new URI(url)); diff --git a/mobile/android/base/java/org/mozilla/gecko/home/ImageLoader.java b/mobile/android/base/java/org/mozilla/gecko/home/ImageLoader.java index cbbe7babbba4..b6ea0249445c 100644 --- a/mobile/android/base/java/org/mozilla/gecko/home/ImageLoader.java +++ b/mobile/android/base/java/org/mozilla/gecko/home/ImageLoader.java @@ -15,6 +15,7 @@ import com.squareup.picasso.Picasso; import com.squareup.picasso.Downloader.Response; import com.squareup.picasso.UrlConnectionDownloader; +import org.mozilla.gecko.AppConstants; import org.mozilla.gecko.util.ProxySelector; import java.io.File; @@ -91,6 +92,12 @@ public class ImageLoader { @Override protected HttpURLConnection openConnection(Uri path) throws IOException { + if (AppConstants.isTorBrowser()) { + String err = "This is Tor Browser. Downloading is disabled for: " + path.toString(); + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + throw new IOException(err); + } + try { // This is annoying, but |path| is an android.net.Uri and // openConnectionWithProxy() accepts a java.net.URI diff --git a/mobile/android/base/java/org/mozilla/gecko/icons/loader/IconDownloader.java b/mobile/android/base/java/org/mozilla/gecko/icons/loader/IconDownloader.java index 4a03d440556d..84eb7736e94e 100644 --- a/mobile/android/base/java/org/mozilla/gecko/icons/loader/IconDownloader.java +++ b/mobile/android/base/java/org/mozilla/gecko/icons/loader/IconDownloader.java @@ -12,6 +12,7 @@ import android.support.annotation.Nullable; import android.support.annotation.VisibleForTesting; import android.util.Log; +import org.mozilla.gecko.AppConstants; import org.mozilla.gecko.GeckoApplication; import org.mozilla.gecko.icons.decoders.FaviconDecoder; import org.mozilla.gecko.icons.decoders.LoadFaviconResult; @@ -132,6 +133,11 @@ public class IconDownloader implements IconLoader { return null; } + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return null; + } + HttpURLConnection connection = null; try { @@ -183,6 +189,11 @@ public class IconDownloader implements IconLoader { @VisibleForTesting @NonNull HttpURLConnection connectTo(String uri) throws URISyntaxException, IOException { + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + throw new IOException(); + } + final HttpURLConnection connection = (HttpURLConnection) ProxySelector.openConnectionWithProxy( new URI(uri)); diff --git a/mobile/android/base/java/org/mozilla/gecko/search/SearchEngineManager.java b/mobile/android/base/java/org/mozilla/gecko/search/SearchEngineManager.java index 1004b7b25ef1..df9b6d67b467 100644 --- a/mobile/android/base/java/org/mozilla/gecko/search/SearchEngineManager.java +++ b/mobile/android/base/java/org/mozilla/gecko/search/SearchEngineManager.java @@ -379,6 +379,11 @@ public class SearchEngineManager implements SharedPreferences.OnSharedPreference * @return String containing the country code */ private String fetchCountryCode() { + if (AppConstants.isTorBrowser()) { + Log.i(LOG_TAG, "This is Tor Browser. Skipping."); + return null; + } + // First, we look to see if we have a cached code. final String region = GeckoSharedPrefs.forApp(context).getString(PREF_REGION_KEY, null); if (region != null) { diff --git a/mobile/android/base/java/org/mozilla/gecko/switchboard/SwitchBoard.java b/mobile/android/base/java/org/mozilla/gecko/switchboard/SwitchBoard.java index d78663060f99..e32b50ebadb5 100644 --- a/mobile/android/base/java/org/mozilla/gecko/switchboard/SwitchBoard.java +++ b/mobile/android/base/java/org/mozilla/gecko/switchboard/SwitchBoard.java @@ -409,6 +409,12 @@ public class SwitchBoard { HttpURLConnection connection = null; InputStreamReader inputStreamReader = null; BufferedReader bufferReader = null; + + if (AppConstants.isTorBrowser()) { + Log.i(TAG, "This is Tor Browser. Skipping."); + return null; + } + try { connection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(url.toURI()); connection.setRequestProperty("User-Agent", HardwareUtils.isTablet() ? diff --git a/mobile/android/base/java/org/mozilla/gecko/updater/UpdateService.java b/mobile/android/base/java/org/mozilla/gecko/updater/UpdateService.java index 0598105fe108..71e1097711d9 100644 --- a/mobile/android/base/java/org/mozilla/gecko/updater/UpdateService.java +++ b/mobile/android/base/java/org/mozilla/gecko/updater/UpdateService.java @@ -379,6 +379,11 @@ public class UpdateService extends IntentService { try { URI uri = getUpdateURI(force); + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return null; + } + if (uri == null) { Log.e(LOGTAG, "failed to get update URI"); return null; @@ -527,6 +532,12 @@ public class UpdateService extends IntentService { private File downloadUpdatePackage(UpdateInfo info, boolean overwriteExisting) { URL url = null; + + if (AppConstants.isTorBrowser()) { + Log.i(LOGTAG, "This is Tor Browser. Skipping."); + return null; + } + try { url = info.uri.toURL(); } catch (java.net.MalformedURLException e) { diff --git a/mobile/android/geckoview/src/main/java/org/mozilla/gecko/media/GeckoMediaDrmBridgeV21.java b/mobile/android/geckoview/src/main/java/org/mozilla/gecko/media/GeckoMediaDrmBridgeV21.java index d0973f3dcc17..39d10615d35c 100644 --- a/mobile/android/geckoview/src/main/java/org/mozilla/gecko/media/GeckoMediaDrmBridgeV21.java +++ b/mobile/android/geckoview/src/main/java/org/mozilla/gecko/media/GeckoMediaDrmBridgeV21.java @@ -473,43 +473,48 @@ public class GeckoMediaDrmBridgeV21 implements GeckoMediaDrm { @Override protected Void doInBackground(Void... params) { - try { - URI finalURI = new URI(mURL + "&signedRequest=" + URLEncoder.encode(new String(mDrmRequest), "UTF-8")); - HttpURLConnection urlConnection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(finalURI); - urlConnection.setRequestMethod("POST"); - if (DEBUG) Log.d(LOGTAG, "Provisioning, posting url =" + finalURI.toString()); - - // Add data - urlConnection.setRequestProperty("Accept", "*/*"); - urlConnection.setRequestProperty("User-Agent", getCDMUserAgent()); - urlConnection.setRequestProperty("Content-Type", "application/json"); - - // Execute HTTP Post Request - urlConnection.connect(); - - int responseCode = urlConnection.getResponseCode(); - if (responseCode == HttpURLConnection.HTTP_OK) { - BufferedReader in = - new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), StringUtils.UTF_8)); - String inputLine; - StringBuffer response = new StringBuffer(); - - while ((inputLine = in.readLine()) != null) { - response.append(inputLine); - } - in.close(); - mResponseBody = String.valueOf(response).getBytes(StringUtils.UTF_8); - if (DEBUG) Log.d(LOGTAG, "Provisioning, response received."); - if (mResponseBody != null) Log.d(LOGTAG, "response length=" + mResponseBody.length); - } else { - Log.d(LOGTAG, "Provisioning, server returned HTTP error code :" + responseCode); - } - } catch (IOException e) { - Log.e(LOGTAG, "Got exception during posting provisioning request ...", e); - } catch (URISyntaxException e) { - Log.e(LOGTAG, "Got exception during creating uri ...", e); - } + // AppConstants.isTorBrowser() is in base/, so it's not available in geckoview/ + Log.i(LOGTAG, "This is Tor Browser. Skipping."); return null; + + /* Dead code */ + //try { + // URI finalURI = new URI(mURL + "&signedRequest=" + URLEncoder.encode(new String(mDrmRequest), "UTF-8")); + // HttpURLConnection urlConnection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(finalURI); + // urlConnection.setRequestMethod("POST"); + // if (DEBUG) Log.d(LOGTAG, "Provisioning, posting url =" + finalURI.toString()); + + // // Add data + // urlConnection.setRequestProperty("Accept", "*/*"); + // urlConnection.setRequestProperty("User-Agent", getCDMUserAgent()); + // urlConnection.setRequestProperty("Content-Type", "application/json"); + + // // Execute HTTP Post Request + // urlConnection.connect(); + + // int responseCode = urlConnection.getResponseCode(); + // if (responseCode == HttpURLConnection.HTTP_OK) { + // BufferedReader in = + // new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), StringUtils.UTF_8)); + // String inputLine; + // StringBuffer response = new StringBuffer(); + + // while ((inputLine = in.readLine()) != null) { + // response.append(inputLine); + // } + // in.close(); + // mResponseBody = String.valueOf(response).getBytes(StringUtils.UTF_8); + // if (DEBUG) Log.d(LOGTAG, "Provisioning, response received."); + // if (mResponseBody != null) Log.d(LOGTAG, "response length=" + mResponseBody.length); + // } else { + // Log.d(LOGTAG, "Provisioning, server returned HTTP error code :" + responseCode); + // } + //} catch (IOException e) { + // Log.e(LOGTAG, "Got exception during posting provisioning request ...", e); + //} catch (URISyntaxException e) { + // Log.e(LOGTAG, "Got exception during creating uri ...", e); + //} + //return null; } @Override diff --git a/mobile/android/geckoview/src/thirdparty/java/com/google/android/exoplayer2/upstream/DefaultHttpDataSource.java b/mobile/android/geckoview/src/thirdparty/java/com/google/android/exoplayer2/upstream/DefaultHttpDataSource.java index 75e1f675c5eb..22e9e1ffcb9b 100644 --- a/mobile/android/geckoview/src/thirdparty/java/com/google/android/exoplayer2/upstream/DefaultHttpDataSource.java +++ b/mobile/android/geckoview/src/thirdparty/java/com/google/android/exoplayer2/upstream/DefaultHttpDataSource.java @@ -395,51 +395,56 @@ public class DefaultHttpDataSource implements HttpDataSource { */ private HttpURLConnection makeConnection(URL url, byte[] postBody, long position, long length, boolean allowGzip, boolean followRedirects) throws IOException, URISyntaxException { + // AppConstants.isTorBrowser() is in base/, so it's not available in geckoview/ + Log.i(TAG, "This is Tor Browser. Skipping."); + throw new IOException(); + /** * Tor Project modified the way the connection object was created. For the sake of * simplicity, instead of duplicating the whole file we changed the connection object * to use the ProxySelector. */ - HttpURLConnection connection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(url.toURI()); - - connection.setConnectTimeout(connectTimeoutMillis); - connection.setReadTimeout(readTimeoutMillis); - if (defaultRequestProperties != null) { - for (Map.Entry<String, String> property : defaultRequestProperties.getSnapshot().entrySet()) { - connection.setRequestProperty(property.getKey(), property.getValue()); - } - } - for (Map.Entry<String, String> property : requestProperties.getSnapshot().entrySet()) { - connection.setRequestProperty(property.getKey(), property.getValue()); - } - if (!(position == 0 && length == C.LENGTH_UNSET)) { - String rangeRequest = "bytes=" + position + "-"; - if (length != C.LENGTH_UNSET) { - rangeRequest += (position + length - 1); - } - connection.setRequestProperty("Range", rangeRequest); - } - connection.setRequestProperty("User-Agent", userAgent); - if (!allowGzip) { - connection.setRequestProperty("Accept-Encoding", "identity"); - } - connection.setInstanceFollowRedirects(followRedirects); - connection.setDoOutput(postBody != null); - if (postBody != null) { - connection.setRequestMethod("POST"); - if (postBody.length == 0) { - connection.connect(); - } else { - connection.setFixedLengthStreamingMode(postBody.length); - connection.connect(); - OutputStream os = connection.getOutputStream(); - os.write(postBody); - os.close(); - } - } else { - connection.connect(); - } - return connection; + /* Dead code */ + //HttpURLConnection connection = (HttpURLConnection) ProxySelector.openConnectionWithProxy(url.toURI()); + + //connection.setConnectTimeout(connectTimeoutMillis); + //connection.setReadTimeout(readTimeoutMillis); + //if (defaultRequestProperties != null) { + // for (Map.Entry<String, String> property : defaultRequestProperties.getSnapshot().entrySet()) { + // connection.setRequestProperty(property.getKey(), property.getValue()); + // } + //} + //for (Map.Entry<String, String> property : requestProperties.getSnapshot().entrySet()) { + // connection.setRequestProperty(property.getKey(), property.getValue()); + //} + //if (!(position == 0 && length == C.LENGTH_UNSET)) { + // String rangeRequest = "bytes=" + position + "-"; + // if (length != C.LENGTH_UNSET) { + // rangeRequest += (position + length - 1); + // } + // connection.setRequestProperty("Range", rangeRequest); + //} + //connection.setRequestProperty("User-Agent", userAgent); + //if (!allowGzip) { + // connection.setRequestProperty("Accept-Encoding", "identity"); + //} + //connection.setInstanceFollowRedirects(followRedirects); + //connection.setDoOutput(postBody != null); + //if (postBody != null) { + // connection.setRequestMethod("POST"); + // if (postBody.length == 0) { + // connection.connect(); + // } else { + // connection.setFixedLengthStreamingMode(postBody.length); + // connection.connect(); + // OutputStream os = connection.getOutputStream(); + // os.write(postBody); + // os.close(); + // } + //} else { + // connection.connect(); + //} + //return connection; } /** diff --git a/mobile/android/stumbler/java/org/mozilla/mozstumbler/service/utils/AbstractCommunicator.java b/mobile/android/stumbler/java/org/mozilla/mozstumbler/service/utils/AbstractCommunicator.java index 9b3ee98f89db..fc3248d72219 100644 --- a/mobile/android/stumbler/java/org/mozilla/mozstumbler/service/utils/AbstractCommunicator.java +++ b/mobile/android/stumbler/java/org/mozilla/mozstumbler/service/utils/AbstractCommunicator.java @@ -68,6 +68,11 @@ public abstract class AbstractCommunicator { } private void openConnectionAndSetHeaders() { + if (AppConstants.isTorBrowser()) { + Log.i(LOG_TAG, "This is Tor Browser. Skipping."); + throw new Exception(); + } + try { Prefs prefs = Prefs.getInstanceWithoutContext(); if (sMozApiKey == null || prefs != null) {

1 0

[chutney/master] Debug: when tor is missing, give instructions that actually work
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit 4a87a0bb54c807522798535847ed0c9fa1a7df18 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 13:29:21 2018 +1000 Debug: when tor is missing, give instructions that actually work Also, exit with a failure exit status. --- lib/chutney/TorNet.py | 45 ++++++++++++++++++++------------------------- 1 file changed, 20 insertions(+), 25 deletions(-) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index 1814d2e..faa3d88 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -90,6 +90,16 @@ def get_new_absolute_nodes_path(now=time.time()): newdir = "%s.%d" % (newdirbase, i) return newdir +def _warnMissingTor(tor_path, cmdline, tor_name="tor"): + """Log a warning that the binary tor_name can't be found at tor_path + while running cmdline. + """ + print(("Cannot find the {} binary at '{}' for the command line '{}'. " + + "Set the TOR_DIR environment variable to the directory " + + "containing {}.") + .format(tor_name, tor_path, " ".join(cmdline), tor_name)) + + class Node(object): """A Node represents a Tor node or a set of Tor nodes. It's created @@ -263,19 +273,6 @@ class LocalNodeBuilder(NodeBuilder): NodeBuilder.__init__(self, env) self._env = env - def _warnMissingTor(self, tor, cmdline, - tor_name="tor", tor_env="CHUTNEY_TOR"): - """Log a warning that the binary tor can't be found while running - cmdline. Advise the user to put the path to tor_name in the tor_env - environmental variable. - """ - print(("Cannot find the {} binary {} for the command line '{}'. " + - "Use the {} environment variable to set the path, " + - "or put the binary into $PATH: '{}'. " + - "If your $PATH contains ~, use $HOME instead.") - .format(tor_name, tor, " ".join(cmdline), - tor_env, os.getenv("PATH"))) - def _createTorrcFile(self, checkOnly=False): """Write the torrc file for this node, disabling any options that are not supported by env's tor binary using comments. @@ -303,8 +300,8 @@ class LocalNodeBuilder(NodeBuilder): except OSError as e: # only catch file not found error if e.errno == errno.ENOENT: - self._warnMissingTor(tor, cmdline) - sys.exit(0) + _warnMissingTor(tor, cmdline) + sys.exit(1) else: raise # check we received a list of options, and nothing else @@ -427,10 +424,10 @@ class LocalNodeBuilder(NodeBuilder): except OSError as e: # only catch file not found error if e.errno == errno.ENOENT: - self._warnMissingTor(tor_gencert, cmdline, - tor_name="tor-gencert", - tor_env="CHUTNEY_TOR_GENCERT") - sys.exit(0) + _warnMissingTor(tor_gencert, cmdline, + tor_name="tor-gencert", + tor_env="CHUTNEY_TOR_GENCERT") + sys.exit(1) else: raise p.communicate(passphrase + "\n") @@ -457,8 +454,8 @@ class LocalNodeBuilder(NodeBuilder): except OSError as e: # only catch file not found error if e.errno == errno.ENOENT: - self._warnMissingTor(tor, cmdline) - sys.exit(0) + _warnMissingTor(tor, cmdline) + sys.exit(1) else: raise stdout, stderr = p.communicate() @@ -628,10 +625,8 @@ class LocalNodeController(NodeController): except OSError as e: # only catch file not found error if e.errno == errno.ENOENT: - print("Cannot find tor binary %r. Use CHUTNEY_TOR " - "environment variable to set the path, or put the " - "binary into $PATH." % tor_path) - sys.exit(0) + _warnMissingTor(tor_path, cmdline): + sys.exit(1) else: raise if self.waitOnLaunch():

1 0

[chutney/master] Debug: refactor debugging into its own module
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit 05d50aa45c1daacbd3b9ffa304d4d692a58f0b30 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 13:28:56 2018 +1000 Debug: refactor debugging into its own module --- lib/chutney/Debug.py | 26 ++++++++++++++++++++++++++ lib/chutney/TorNet.py | 2 ++ lib/chutney/Traffic.py | 10 +--------- 3 files changed, 29 insertions(+), 9 deletions(-) diff --git a/lib/chutney/Debug.py b/lib/chutney/Debug.py new file mode 100644 index 0000000..556ac5c --- /dev/null +++ b/lib/chutney/Debug.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python2 +# +# Copyright 2011 Nick Mathewson, Michael Stone +# Copyright 2013 The Tor Project +# +# You may do anything with this work that copyright law would normally +# restrict, so long as you retain the above notice(s) and this license +# in all redistributed copies and derived works. There is no warranty. + +from __future__ import print_function + +import cgitb +import os + +# Get verbose tracebacks, so we can diagnose better. +cgitb.enable(format="plain") + + +# Set debug_flag=True in order to debug this program or to get hints +# about what's going wrong in your system. +debug_flag = os.environ.get("CHUTNEY_DEBUG", "") != "" + +def debug(s): + "Print a debug message on stdout if debug_flag is True." + if debug_flag: + print("DEBUG: %s" % s) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index bf26978..1814d2e 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -21,6 +21,8 @@ import time import shutil import importlib +from chutney.Debug import debug_flag, debug + import chutney.Templating import chutney.Traffic diff --git a/lib/chutney/Traffic.py b/lib/chutney/Traffic.py index cbeddd7..283f286 100644 --- a/lib/chutney/Traffic.py +++ b/lib/chutney/Traffic.py @@ -30,15 +30,7 @@ import errno import time import os -# Set debug_flag=True in order to debug this program or to get hints -# about what's going wrong in your system. -debug_flag = os.environ.get("CHUTNEY_DEBUG", "") != "" - -def debug(s): - "Print a debug message on stdout if debug_flag is True." - if debug_flag: - print("DEBUG: %s" % s) - +from chutney.Debug import debug_flag, debug def socks_cmd(addr_port): """

1 0

[chutney/master] Debug: set tor --quiet when not debugging
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit 1aa7b8210f84be96c551894e9d16f426d98cd013 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 14:58:44 2018 +1000 Debug: set tor --quiet when not debugging And tor-gencert -v when debugging. --- lib/chutney/TorNet.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index d59a846..e4465c9 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -105,6 +105,8 @@ def run_tor(cmdline): Returns the combined stdout and stderr of the process. """ + if not debug_flag: + cmdline.append("--quiet") try: stdouterr = subprocess.check_output(cmdline, stderr=subprocess.STDOUT, @@ -133,6 +135,10 @@ def launch_process(cmdline, tor_name="tor", stdin=None): Returns the Popen object for the launched process. """ + if tor_name == "tor" and not debug_flag: + cmdline.append("--quiet") + elif tor_name == "tor-gencert" and debug_flag: + cmdline.append("-v") try: p = subprocess.Popen(cmdline, stdin=stdin, @@ -358,7 +364,7 @@ class LocalNodeBuilder(NodeBuilder): cmdline = [ tor, "--list-torrc-options", - "--hush"] + ] opts = run_tor(cmdline) # check we received a list of options, and nothing else assert re.match(r'(^\w+$)+', opts, flags=re.MULTILINE) @@ -472,7 +478,8 @@ class LocalNodeBuilder(NodeBuilder): '-s', skfile, '-c', certfile, '-m', str(lifetime), - '-a', addr] + '-a', addr, + ] print("Creating identity key %s for %s with %s" % ( idfile, self._env['nick'], " ".join(cmdline))) outerr = run_tor_gencert(cmdline, passphrase) @@ -491,7 +498,6 @@ class LocalNodeBuilder(NodeBuilder): "--list-fingerprint", "--orport", "1", "--datadirectory", datadir, - "--quiet", ] stdouterr = run_tor(cmdline) fingerprint = "".join((stdouterr.rstrip().split('\n')[-1]).split()[1:]) @@ -653,7 +659,6 @@ class LocalNodeController(NodeController): cmdline = [ tor_path, "-f", torrc, - "--quiet", ] p = launch_process(cmdline) if self.waitOnLaunch():

1 0

[chutney/master] Debug: Make test-network.sh --debug work
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit 187eb5ec666e5aa011b0a0593e029f3f2bb4137f Author: teor <teor(a)torproject.org> Date: Sat Oct 6 16:31:19 2018 -0500 Debug: Make test-network.sh --debug work The environmental variable was misspelt. Closes #27970. --- tools/test-network.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/test-network.sh b/tools/test-network.sh index b55a737..603ff9c 100755 --- a/tools/test-network.sh +++ b/tools/test-network.sh @@ -47,7 +47,7 @@ do shift ;; --debug) - export CHUTEY_DEBUG="yes" + export CHUTNEY_DEBUG="yes" ;; --flavor|--flavour|--network-flavor|--network-flavour) export NETWORK_FLAVOUR="$2"

1 0

[chutney/master] Debug: refactor subprocess launches into their own functions
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit db3570aca753cba6c02a1fd0ba6da04717483cf9 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 14:46:09 2018 +1000 Debug: refactor subprocess launches into their own functions --- lib/chutney/TorNet.py | 140 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 85 insertions(+), 55 deletions(-) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index faa3d88..d59a846 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -99,6 +99,71 @@ def _warnMissingTor(tor_path, cmdline, tor_name="tor"): "containing {}.") .format(tor_name, tor_path, " ".join(cmdline), tor_name)) +def run_tor(cmdline): + """Run the tor command line cmdline, which must start with the path or + name of a tor binary. + + Returns the combined stdout and stderr of the process. + """ + try: + stdouterr = subprocess.check_output(cmdline, + stderr=subprocess.STDOUT, + universal_newlines=True, + bufsize=-1) + except OSError as e: + # only catch file not found error + if e.errno == errno.ENOENT: + _warnMissingTor(cmdline[0], cmdline) + sys.exit(1) + else: + raise + except subprocess.CalledProcessError as e: + # only catch file not found error + if e.returncode == 127: + _warnMissingTor(cmdline[0], cmdline) + sys.exit(1) + else: + raise + return stdouterr + +def launch_process(cmdline, tor_name="tor", stdin=None): + """Launch the command line cmdline, which must start with the path or + name of a binary. Use tor_name as the canonical name of the binary. + Pass stdin to the Popen constructor. + + Returns the Popen object for the launched process. + """ + try: + p = subprocess.Popen(cmdline, + stdin=stdin, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + universal_newlines=True, + bufsize=-1) + except OSError as e: + # only catch file not found error + if e.errno == errno.ENOENT: + _warnMissingTor(cmdline[0], cmdline, tor_name=tor_name) + sys.exit(1) + else: + raise + return p + +def run_tor_gencert(cmdline, passphrase): + """Run the tor-gencert command line cmdline, which must start with the + path or name of a tor-gencert binary. + Then send passphrase to the stdin of the process. + + Returns the combined stdout and stderr of the process. + """ + p = launch_process(cmdline, + tor_name="tor-gencert", + stdin=subprocess.PIPE) + (stdouterr, empty_stderr) = p.communicate(passphrase + "\n") + assert p.returncode == 0 # XXXX BAD! + assert empty_stderr is None + return stdouterr + class Node(object): @@ -294,16 +359,7 @@ class LocalNodeBuilder(NodeBuilder): tor, "--list-torrc-options", "--hush"] - try: - opts = subprocess.check_output(cmdline, bufsize=-1, - universal_newlines=True) - except OSError as e: - # only catch file not found error - if e.errno == errno.ENOENT: - _warnMissingTor(tor, cmdline) - sys.exit(1) - else: - raise + opts = run_tor(cmdline) # check we received a list of options, and nothing else assert re.match(r'(^\w+$)+', opts, flags=re.MULTILINE) torrc_opts = opts.split() @@ -419,19 +475,7 @@ class LocalNodeBuilder(NodeBuilder): '-a', addr] print("Creating identity key %s for %s with %s" % ( idfile, self._env['nick'], " ".join(cmdline))) - try: - p = subprocess.Popen(cmdline, stdin=subprocess.PIPE) - except OSError as e: - # only catch file not found error - if e.errno == errno.ENOENT: - _warnMissingTor(tor_gencert, cmdline, - tor_name="tor-gencert", - tor_env="CHUTNEY_TOR_GENCERT") - sys.exit(1) - else: - raise - p.communicate(passphrase + "\n") - assert p.returncode == 0 # XXXX BAD! + outerr = run_tor_gencert(cmdline, passphrase) def _genRouterKey(self): """Generate an identity key for this router, unless we already have, @@ -449,20 +493,11 @@ class LocalNodeBuilder(NodeBuilder): "--datadirectory", datadir, "--quiet", ] - try: - p = subprocess.Popen(cmdline, stdout=subprocess.PIPE) - except OSError as e: - # only catch file not found error - if e.errno == errno.ENOENT: - _warnMissingTor(tor, cmdline) - sys.exit(1) - else: - raise - stdout, stderr = p.communicate() - fingerprint = "".join((stdout.rstrip().split('\n')[-1]).split()[1:]) + stdouterr = run_tor(cmdline) + fingerprint = "".join((stdouterr.rstrip().split('\n')[-1]).split()[1:]) if not re.match(r'^[A-F0-9]{40}$', fingerprint): - print(("Error when calling %r. It gave %r as a fingerprint " - " and %r on stderr.") % (" ".join(cmdline), stdout, stderr)) + print("Error when getting fingerprint using '%r'. It output '%r'." + .format(" ".join(cmdline), stdouterr)) sys.exit(1) self._env['fingerprint'] = fingerprint @@ -620,18 +655,11 @@ class LocalNodeController(NodeController): "-f", torrc, "--quiet", ] - try: - p = subprocess.Popen(cmdline) - except OSError as e: - # only catch file not found error - if e.errno == errno.ENOENT: - _warnMissingTor(tor_path, cmdline): - sys.exit(1) - else: - raise + p = launch_process(cmdline) if self.waitOnLaunch(): # this requires that RunAsDaemon is set - p.wait() + (stdouterr, empty_stderr) = p.communicate() + assert empty_stderr is None else: # this does not require RunAsDaemon to be set, but is slower. # @@ -648,16 +676,18 @@ class LocalNodeController(NodeController): p.poll() if p.returncode is not None and p.returncode != 0: if self._env['poll_launch_time'] is None: - print("Couldn't launch %s (%s): %s" % (self._env['nick'], - " ".join(cmdline), - p.returncode)) + print("Couldn't launch {} command '{}': exit {}, output '{}'" + .format(self._env['nick'], + " ".join(cmdline), + p.returncode, + stdouterr)) else: - print("Couldn't poll %s (%s) " - "after waiting %s seconds for launch" - ": %s" % (self._env['nick'], - " ".join(cmdline), - self._env['poll_launch_time'], - p.returncode)) + print(("Couldn't poll {} command '{}' " + + "after waiting {} seconds for launch: " + + "exit {}").format(self._env['nick'], + " ".join(cmdline), + self._env['poll_launch_time'], + p.returncode)) return False return True

1 0

[chutney/master] Debug: add some debug output, and move other outputs to debug
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit 624da7316d5a90e5dca3da69162365eb0171c627 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 15:22:45 2018 +1000 Debug: add some debug output, and move other outputs to debug --- chutney | 2 +- lib/chutney/TorNet.py | 32 +++++++++++++++++--------------- tools/test-network.sh | 2 +- 3 files changed, 19 insertions(+), 17 deletions(-) diff --git a/chutney b/chutney index f231e66..7c7e1df 100755 --- a/chutney +++ b/chutney @@ -51,5 +51,5 @@ then exit 1 fi -printf "Using %s\n" "$("${PYTHON}" --version 2>&1)" +printf "\nLaunching chutney using %s\n" "$("${PYTHON}" --version 2>&1)" "${PYTHON}" -m chutney.TorNet "${@}" diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index e4465c9..8c6cb57 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -112,6 +112,7 @@ def run_tor(cmdline): stderr=subprocess.STDOUT, universal_newlines=True, bufsize=-1) + debug(stdouterr) except OSError as e: # only catch file not found error if e.errno == errno.ENOENT: @@ -166,6 +167,7 @@ def run_tor_gencert(cmdline, passphrase): tor_name="tor-gencert", stdin=subprocess.PIPE) (stdouterr, empty_stderr) = p.communicate(passphrase + "\n") + debug(stdouterr) assert p.returncode == 0 # XXXX BAD! assert empty_stderr is None return stdouterr @@ -480,9 +482,11 @@ class LocalNodeBuilder(NodeBuilder): '-m', str(lifetime), '-a', addr, ] - print("Creating identity key %s for %s with %s" % ( - idfile, self._env['nick'], " ".join(cmdline))) - outerr = run_tor_gencert(cmdline, passphrase) + print("Creating identity key for {} with {}" + .format(self._env['nick'], cmdline[0])) + debug("Identity key path '{}', command {}" + .format(idfile, " ".join(cmdline))) + run_tor_gencert(cmdline, passphrase) def _genRouterKey(self): """Generate an identity key for this router, unless we already have, @@ -664,6 +668,7 @@ class LocalNodeController(NodeController): if self.waitOnLaunch(): # this requires that RunAsDaemon is set (stdouterr, empty_stderr) = p.communicate() + debug(stdouterr) assert empty_stderr is None else: # this does not require RunAsDaemon to be set, but is slower. @@ -707,8 +712,8 @@ class LocalNodeController(NodeController): def cleanup_lockfile(self): lf = self._env['lockfile'] if not self.isRunning() and os.path.exists(lf): - print('Removing stale lock file for {0} ...'.format( - self._env['nick'])) + debug('Removing stale lock file for {0} ...' + .format(self._env['nick'])) os.remove(lf) def waitOnLaunch(self): @@ -926,8 +931,8 @@ class TorEnviron(chutney.Templating.Environ): return "#ServerDNSResolvConfFile using tor's compile-time default" elif my['dns_conf'] is None: # if there is no DNS conf file set - print("CHUTNEY_DNS_CONF not specified, using '%s'." - % (TorEnviron.DEFAULT_DNS_RESOLV_CONF)) + debug("CHUTNEY_DNS_CONF not specified, using '{}'." + .format(TorEnviron.DEFAULT_DNS_RESOLV_CONF)) dns_conf = TorEnviron.DEFAULT_DNS_RESOLV_CONF else: dns_conf = my['dns_conf'] @@ -937,8 +942,8 @@ class TorEnviron(chutney.Templating.Environ): # (os.path.exists returns False for broken symbolic links) if not os.path.exists(dns_conf): # Issue a warning so the user notices - print("CHUTNEY_DNS_CONF '%s' does not exist, using '%s'." - % (dns_conf, TorEnviron.OFFLINE_DNS_RESOLV_CONF)) + print("CHUTNEY_DNS_CONF '{}' does not exist, using '{}'." + .format(dns_conf, TorEnviron.OFFLINE_DNS_RESOLV_CONF)) dns_conf = TorEnviron.OFFLINE_DNS_RESOLV_CONF return "ServerDNSResolvConfFile %s" % (dns_conf) @@ -1055,12 +1060,9 @@ class Network(object): self.start() def start(self): - if self._dfltEnv['poll_launch_time'] is not None: - # format polling correctly - avoid printing a newline - sys.stdout.write("Starting nodes") - sys.stdout.flush() - else: - print("Starting nodes") + # format polling correctly - avoid printing a newline + sys.stdout.write("Starting nodes") + sys.stdout.flush() rv = all([n.getController().start() for n in self._nodes]) # now print a newline unconditionally - this stops poll()ing # output from being squashed together, at the cost of a blank diff --git a/tools/test-network.sh b/tools/test-network.sh index 603ff9c..4509fa3 100755 --- a/tools/test-network.sh +++ b/tools/test-network.sh @@ -224,7 +224,7 @@ if [ -d "$TOR_DIR" ]; then $ECHO "$myname: \$TOR_DIR is a Tor 0.3.4 or earlier build directory" TOR_APP_DIR="$TOR_DIR/src/or" else - $ECHO "$myname: \$TOR_DIR has no src/app or src/or, chutney will use \$CHUTNEY_TOR and \$CHUTNEY_TOR_GENCERT as tor binary paths, or search \$PATH for tor binary names" + $ECHO "$myname: \$TOR_DIR has no src/app or src/or, looking elsewhere" unset TOR_DIR fi fi

1 0

[chutney/master] Logging: consistently use $ for env vars
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit e34ceea7919450ad0480ecdc9db6610a1b1d41b2 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 15:28:09 2018 +1000 Logging: consistently use $ for env vars --- tools/test-network.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/test-network.sh b/tools/test-network.sh index 4509fa3..c87b587 100755 --- a/tools/test-network.sh +++ b/tools/test-network.sh @@ -293,17 +293,17 @@ else if [ -x "$CHUTNEY_TOR" ]; then $ECHO "$myname: Assuming \$CHUTNEY_TOR is a path to a binary" elif [ ! -z "$CHUTNEY_TOR" ]; then - $ECHO "$myname: Assuming \$CHUTNEY_TOR is a binary name in PATH" + $ECHO "$myname: Assuming \$CHUTNEY_TOR is a binary name in \$PATH" else - $ECHO "$myname: Setting \$CHUTNEY_TOR to the standard binary name in PATH" + $ECHO "$myname: Setting \$CHUTNEY_TOR to the standard binary name in \$PATH" export CHUTNEY_TOR="$tor_name" fi if [ -x "$CHUTNEY_TOR_GENCERT" ]; then $ECHO "$myname: Assuming \$CHUTNEY_TOR_GENCERT is a path to a binary" elif [ ! -z "$CHUTNEY_TOR_GENCERT" ]; then - $ECHO "$myname: Assuming \$CHUTNEY_TOR_GENCERT is a binary name in PATH" + $ECHO "$myname: Assuming \$CHUTNEY_TOR_GENCERT is a binary name in \$PATH" else - $ECHO "$myname: Setting \$CHUTNEY_TOR_GENCERT to the standard binary name in PATH" + $ECHO "$myname: Setting \$CHUTNEY_TOR_GENCERT to the standard binary name in \$PATH" export CHUTNEY_TOR_GENCERT="$tor_gencert_name" fi fi

1 0

[chutney/master] Debug: print tor versions when launching tor
by teor＠torproject.org 30 Oct '18

30 Oct '18

commit bbf30360ee42dd2af05ff9c7b0e06ebdc6d62d05 Author: teor <teor(a)torproject.org> Date: Tue Oct 23 16:20:45 2018 +1000 Debug: print tor versions when launching tor And for unsupported torrc options. Also limit the number of unsupported torrc options that are printed. --- lib/chutney/TorNet.py | 103 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 73 insertions(+), 30 deletions(-) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index 8c6cb57..2aa7235 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -27,9 +27,13 @@ import chutney.Templating import chutney.Traffic _BASE_ENVIRON = None +_TOR_VERSIONS = None _TORRC_OPTIONS = None _THE_NETWORK = None +TORRC_OPTION_WARN_LIMIT = 10 +torrc_option_warn_count = 0 + # Get verbose tracebacks, so we can diagnose better. cgitb.enable(format="plain") @@ -172,6 +176,49 @@ def run_tor_gencert(cmdline, passphrase): assert empty_stderr is None return stdouterr +def get_tor_version(tor): + """Return the version of the tor binary. + Versions are cached for each unique tor path. + """ + # find the version of the current tor binary, and cache it + if tor not in _TOR_VERSIONS: + cmdline = [ + tor, + "--version", + ] + tor_version = run_tor(cmdline) + # clean it up a bit + tor_version = tor_version.strip() + tor_version = tor_version.replace("version ", "") + tor_version = tor_version.replace(").", ")") + # check we received a tor version, and nothing else + assert re.match(r'^[-+.() A-Za-z0-9]+$', tor_version) + # cache the version for this tor binary's path + _TOR_VERSIONS[tor] = tor_version + else: + tor_version = _TOR_VERSIONS[tor] + return tor_version + +def get_torrc_options(tor): + """Return the torrc options supported by the tor binary. + Options are cached for each unique tor path. + """ + # find the options the current tor binary supports, and cache them + if tor not in _TORRC_OPTIONS: + cmdline = [ + tor, + "--list-torrc-options", + ] + opts = run_tor(cmdline) + # check we received a list of options, and nothing else + assert re.match(r'(^\w+$)+', opts, flags=re.MULTILINE) + torrc_opts = opts.split() + # cache the options for this tor binary's path + _TORRC_OPTIONS[tor] = torrc_opts + else: + torrc_opts = _TORRC_OPTIONS[tor] + return torrc_opts + class Node(object): @@ -361,26 +408,12 @@ class LocalNodeBuilder(NodeBuilder): # now filter the options we're about to write, commenting out # the options that the current tor binary doesn't support tor = self._env['tor'] - # find the options the current tor binary supports, and cache them - if tor not in _TORRC_OPTIONS: - cmdline = [ - tor, - "--list-torrc-options", - ] - opts = run_tor(cmdline) - # check we received a list of options, and nothing else - assert re.match(r'(^\w+$)+', opts, flags=re.MULTILINE) - torrc_opts = opts.split() - # cache the options for this tor binary's path - _TORRC_OPTIONS[tor] = torrc_opts - else: - torrc_opts = _TORRC_OPTIONS[tor] + tor_version = get_tor_version(tor) + torrc_opts = get_torrc_options(tor) # check if each option is supported before writing it # Unsupported option values may need special handling. with open(fn_out, 'w') as f: # we need to do case-insensitive option comparison - # even if this is a static whitelist, - # so we convert to lowercase as close to the loop as possible lower_opts = [opt.lower() for opt in torrc_opts] # keep ends when splitting lines, so we can write them out # using writelines() without messing around with "\n"s @@ -391,17 +424,20 @@ class LocalNodeBuilder(NodeBuilder): if (len(sline) == 0 or sline[0] == '#' or sline.split()[0].lower() in lower_opts): - f.writelines([line]) + pass else: - # well, this could get spammy - # TODO: warn once per option per tor binary - # TODO: print tor version? - print(("The tor binary at %r does not support the " - "option in the torrc line:\n" - "%r") % (tor, line.strip())) - # we could decide to skip these lines entirely - # TODO: write tor version? - f.writelines(["# " + tor + " unsupported: " + line]) + warn_msg = (("The tor binary at {} does not support " + + "the option in the torrc line:\n{}") + .format(tor, line.strip())) + if torrc_option_warn_count < TORRC_OPTION_WARN_LIMIT: + print(warn_msg) + torrc_option_warn_count += 1 + else: + debug(warn_msg) + # always dump the full output to the torrc file + line = ("# {} version {} does not support: {}" + .format(tor, tor_version, line)) + f.writelines([line]) def _getTorrcTemplate(self): """Return the template used to write the torrc for this node.""" @@ -625,18 +661,21 @@ class LocalNodeController(NodeController): nick = self._env['nick'] datadir = self._env['dir'] corefile = "core.%s" % pid + tor_version = get_tor_version(self._env['tor']) if self.isRunning(pid): if listRunning: - print("%s is running with PID %s" % (nick, pid)) + print("{} is running with PID {}: {}" + .format(nick, pid, tor_version)) return True elif os.path.exists(os.path.join(datadir, corefile)): if listNonRunning: - print("%s seems to have crashed, and left core file %s" % ( - nick, corefile)) + print("{} seems to have crashed, and left core file {}: {}" + .format(nick, corefile, tor_version)) return False else: if listNonRunning: - print("%s is stopped" % nick) + print("{} is stopped: {}" + .format(nick, tor_version)) return False def hup(self): @@ -1180,9 +1219,13 @@ def parseArgs(): def main(): global _BASE_ENVIRON + global _TOR_VERSIONS global _TORRC_OPTIONS global _THE_NETWORK _BASE_ENVIRON = TorEnviron(chutney.Templating.Environ(**DEFAULTS)) + # _TOR_VERSIONS gets initialised on demand as a map of + # "/path/to/tor" => "Tor version ..." + _TOR_VERSIONS = dict() # _TORRC_OPTIONS gets initialised on demand as a map of # "/path/to/tor" => ["SupportedOption1", "SupportedOption2", ...] # Or it can be pre-populated as a static whitelist of options

1 0