squashed commit for Pluggable Transports

* implement handling of different provider API version (v1 and v2)
* detect provider's obfs support
* shapeshifter-dispatcher installation
* necessary changes to control shapeshifter-dispatcher from Bitmask
* route openvpn traffic over shapeshifter-dispatcher

2 files changed, 433 insertions, 0 deletions

diff --git a/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/BinaryInstaller.java b/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/BinaryInstaller.java
new file mode 100644
index 00000000..0d6aa61e
--- /dev/null
+++ b/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/BinaryInstaller.java
@@ -0,0 +1,204 @@
+/* Copyright (c) 2009, Nathan Freitas, Orbot / The Guardian Project - http://openideals.com/guardian */
+/* See LICENSE for licensing information */
+
+package se.leap.bitmaskclient.pluggableTransports;
+
+import android.content.Context;
+import android.util.Log;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.concurrent.TimeoutException;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipInputStream;
+
+public class BinaryInstaller {
+
+    File installFolder;
+    Context context;
+
+    public BinaryInstaller(Context context, File installFolder)
+    {
+        this.installFolder = installFolder;
+
+        this.context = context;
+    }
+
+    public void deleteDirectory(File file) {
+        if( file.exists() ) {
+            if (file.isDirectory()) {
+                File[] files = file.listFiles();
+                for(int i=0; i<files.length; i++) {
+                    if(files[i].isDirectory()) {
+                        deleteDirectory(files[i]);
+                    }
+                    else {
+                        files[i].delete();
+                    }
+                }
+            }
+
+            file.delete();
+        }
+    }
+
+    private final static String COMMAND_RM_FORCE = "rm -f ";
+    private final static String MP3_EXT = ".mp3";
+    //        
+    /*
+     * Extract the resources from the APK file using ZIP
+     */
+    public File installResource (String basePath, String assetKey, boolean overwrite) throws IOException, FileNotFoundException, TimeoutException
+    {
+
+        InputStream is;
+        File outFile;
+
+        outFile = new File(installFolder, assetKey);
+
+        if (outFile.exists() && (!overwrite)) {
+            Log.d("BINARY_INSTALLER", "Binary already exists! Using " + outFile.getCanonicalPath());
+            return outFile;
+        }
+
+        deleteDirectory(installFolder);
+        installFolder.mkdirs();
+
+        Log.d("BINARY_INSTALLER", "Search asset in " + basePath + "/" + assetKey);
+
+        is = context.getAssets().open(basePath + '/' + assetKey);
+        streamToFile(is,outFile, false, false);
+        setExecutable(outFile);
+
+        Log.d("BINARY_INSTALLER", "Asset copied from " + basePath + "/" + assetKey + " to: " + outFile.getCanonicalPath());
+
+        return outFile;
+    }
+
+
+    private final static int FILE_WRITE_BUFFER_SIZE = 1024*8;
+    /*
+     * Write the inputstream contents to the file
+     */
+    public static boolean streamToFile(InputStream stm, File outFile, boolean append, boolean zip) throws IOException
+
+    {
+        byte[] buffer = new byte[FILE_WRITE_BUFFER_SIZE];
+
+        int bytecount;
+
+        OutputStream stmOut = new FileOutputStream(outFile.getAbsolutePath(), append);
+        ZipInputStream zis = null;
+
+        if (zip)
+        {
+            zis = new ZipInputStream(stm);
+            ZipEntry ze = zis.getNextEntry();
+            stm = zis;
+
+        }
+
+        while ((bytecount = stm.read(buffer)) > 0)
+        {
+
+            stmOut.write(buffer, 0, bytecount);
+
+        }
+
+        stmOut.close();
+        stm.close();
+
+        if (zis != null)
+            zis.close();
+
+
+        return true;
+
+    }
+
+    //copy the file from inputstream to File output - alternative impl
+    public static boolean copyFile (InputStream is, File outputFile)
+    {
+
+        try {
+            if (outputFile.exists())
+                outputFile.delete();
+
+            boolean newFile = outputFile.createNewFile();
+            DataOutputStream out = new DataOutputStream(new FileOutputStream(outputFile));
+            DataInputStream in = new DataInputStream(is);
+
+            int b = -1;
+            byte[] data = new byte[1024];
+
+            while ((b = in.read(data)) != -1) {
+                out.write(data);
+            }
+
+            if (b == -1); //rejoice
+
+            //
+            out.flush();
+            out.close();
+            in.close();
+            // chmod?
+
+            return newFile;
+
+
+        } catch (IOException ex) {
+            Log.e("Binaryinstaller", "error copying binary", ex);
+            return false;
+        }
+
+    }
+
+    /**
+     * Copies a raw resource file, given its ID to the given location
+     * @param ctx context
+     * @param resid resource id
+     * @param file destination file
+     * @param mode file permissions (E.g.: "755")
+     * @throws IOException on error
+     * @throws InterruptedException when interrupted
+     */
+    public static void copyRawFile(Context ctx, int resid, File file, String mode, boolean isZipd) throws IOException, InterruptedException
+    {
+        final String abspath = file.getAbsolutePath();
+        // Write the iptables binary
+        final FileOutputStream out = new FileOutputStream(file);
+        InputStream is = ctx.getResources().openRawResource(resid);
+
+        if (isZipd)
+        {
+            ZipInputStream zis = new ZipInputStream(is);
+            ZipEntry ze = zis.getNextEntry();
+            is = zis;
+        }
+
+        byte buf[] = new byte[1024];
+        int len;
+        while ((len = is.read(buf)) > 0) {
+            out.write(buf, 0, len);
+        }
+        out.close();
+        is.close();
+        // Change the permissions
+        Runtime.getRuntime().exec("chmod "+mode+" "+abspath).waitFor();
+    }
+
+
+    private void setExecutable(File fileBin) {
+        fileBin.setReadable(true);
+        fileBin.setExecutable(true);
+        fileBin.setWritable(false);
+        fileBin.setWritable(true, true);
+    }
+
+}
diff --git a/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/Dispatcher.java b/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/Dispatcher.java
new file mode 100644
index 00000000..ac846fd9
--- /dev/null
+++ b/app/src/main/java/se/leap/bitmaskclient/pluggableTransports/Dispatcher.java
@@ -0,0 +1,229 @@
+/**
+ * Copyright (c) 2019 LEAP Encryption Access Project and contributers
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package se.leap.bitmaskclient.pluggableTransports;
+
+import android.content.Context;
+import android.support.annotation.WorkerThread;
+import android.util.Log;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStreamWriter;
+import java.util.StringTokenizer;
+
+
+/**
+ * Created by cyberta on 22.02.19.
+ */
+
+public class Dispatcher {
+    private static final String ASSET_KEY = "piedispatcher";
+    private static final String TAG = Dispatcher.class.getName();
+    private final String remoteIP;
+    private final String remotePort;
+    private final String certificate;
+    private final String iatMode;
+    private File fileDispatcher;
+    private Context context;
+    private String port = "";
+    private Thread dispatcherThread = null;
+    private int dipatcherPid = -1;
+
+    public Dispatcher(Context context, String remoteIP, String remotePort, String certificate, String iatMode) {
+        this.context = context.getApplicationContext();
+        this.remoteIP = remoteIP;
+        this.remotePort = remotePort;
+        this.certificate = certificate;
+        this.iatMode = iatMode;
+    }
+
+    @WorkerThread
+    public void initSync() {
+        try {
+            fileDispatcher = installDispatcher();
+
+            // start dispatcher
+            dispatcherThread = new Thread(() -> {
+                try {
+                    StringBuilder dispatcherLog = new StringBuilder();
+                    String dispatcherCommand = fileDispatcher.getCanonicalPath() +
+                            " -transparent" +
+                            " -client" +
+                            " -state " + context.getFilesDir().getCanonicalPath() + "/state" +
+                            " -target " + remoteIP + ":" + remotePort +
+                            " -transports obfs4" +
+                            " -options \"" + String.format("{\\\"cert\\\": \\\"%s\\\", \\\"iatMode\\\": \\\"%s\\\"}\"", certificate, iatMode) +
+                            " -logLevel DEBUG -enableLogging";
+
+                    runBlockingCmd(new String[]{dispatcherCommand}, dispatcherLog);
+                } catch (IOException e) {
+                    e.printStackTrace();
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            });
+            dispatcherThread.start();
+
+            // get pid of dispatcher
+            StringBuilder log = new StringBuilder();
+            String pidCommand = "ps | grep " + fileDispatcher.getCanonicalPath();
+            runBlockingCmd(new String[]{pidCommand}, log);
+            String output  = log.toString();
+            StringTokenizer st = new StringTokenizer(output, " ");
+            st.nextToken(); // proc owner
+            dipatcherPid = Integer.parseInt(st.nextToken().trim());
+
+            // get open port of dispatcher
+            String getPortCommand = "cat " + context.getFilesDir().getCanonicalPath() + "/state/dispatcher.log | grep \"obfs4 - registered listener\"";
+            long timeout = System.currentTimeMillis() + 5000;
+            int i = 1;
+            while (this.port.length() == 0 && System.currentTimeMillis() < timeout) {
+                log = new StringBuilder();
+                Log.d(TAG, i + ". try to get port");
+                runBlockingCmd(new String[]{getPortCommand}, log);
+                output = log.toString();
+                if (output.length() > 0) {
+                    Log.d(TAG, "dispatcher log: \n =================\n" + output);
+                }
+
+                String dispatcherLog[] = output.split(" ");
+                if (dispatcherLog.length > 0) {
+                    String localAddressAndPort = dispatcherLog[dispatcherLog.length - 1];
+                    if (localAddressAndPort.contains(":")) {
+                        this.port = localAddressAndPort.split(":")[1].replace(System.getProperty("line.separator"), "");
+                        Log.d(TAG, "local port is: " + this.port);
+                    }
+                }
+                i += 1;
+            }
+
+        } catch(Exception e){
+            if (dispatcherThread.isAlive()) {
+                Log.e(TAG, e.getMessage() + ". Shutting down Dispatcher thread.");
+                stop();
+            }
+        }
+    }
+
+    public String getPort() {
+        return port;
+    }
+
+    public void stop() {
+        Log.d(TAG, "Shutting down Dispatcher thread.");
+        if (dispatcherThread != null && dispatcherThread.isAlive()) {
+            try {
+                killProcess(dipatcherPid);
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+            dispatcherThread.interrupt();
+        }
+    }
+
+    private void killProcess(int pid) throws Exception {
+        String killPid = "kill -9 " + pid;
+        runCmd(new String[]{killPid}, null, false);
+    }
+
+    public boolean isRunning() {
+        return dispatcherThread != null && dispatcherThread.isAlive();
+    }
+
+    private File installDispatcher(){
+        File fileDispatcher = null;
+        BinaryInstaller bi = new BinaryInstaller(context,context.getFilesDir());
+
+        String arch = System.getProperty("os.arch");
+        if (arch.contains("arm"))
+            arch = "arm";
+        else
+            arch = "x86";
+
+        try {
+            fileDispatcher = bi.installResource(arch, ASSET_KEY, false);
+        } catch (Exception ioe) {
+            Log.d(TAG,"Couldn't install dispatcher: " + ioe);
+        }
+
+        return fileDispatcher;
+    }
+
+    @WorkerThread
+    private void runBlockingCmd(String[] cmds, StringBuilder log) throws Exception {
+        runCmd(cmds, log, true);
+    }
+
+    @WorkerThread
+    private int runCmd(String[] cmds, StringBuilder log,
+                       boolean waitFor) throws Exception {
+
+        int exitCode = -1;
+        Process proc = Runtime.getRuntime().exec("sh");
+        OutputStreamWriter out = new OutputStreamWriter(proc.getOutputStream());
+
+        try {
+            for (String cmd : cmds) {
+                Log.d(TAG, "executing CMD: " + cmd);
+                out.write(cmd);
+                out.write("\n");
+            }
+
+            out.flush();
+            out.write("exit\n");
+            out.flush();
+        } catch (IOException e) {
+            e.printStackTrace();
+        } finally {
+            out.close();
+        }
+
+        if (waitFor) {
+            // Consume the "stdout"
+            InputStreamReader reader = new InputStreamReader(proc.getInputStream());
+            readToLogString(reader, log);
+
+            // Consume the "stderr"
+            reader = new InputStreamReader(proc.getErrorStream());
+            readToLogString(reader, log);
+
+            try {
+                exitCode = proc.waitFor();
+            } catch (InterruptedException e) {
+                e.printStackTrace();
+            }
+        }
+
+        return exitCode;
+    }
+
+    private void readToLogString(InputStreamReader reader, StringBuilder log) throws IOException {
+        final char buf[] = new char[10];
+        int read = 0;
+        try {
+            while ((read = reader.read(buf)) != -1) {
+                if (log != null)
+                    log.append(buf, 0, read);
+            }
+        } catch (IOException e) {
+            reader.close();
+            throw new IOException(e);
+        }
+        reader.close();
+    }
+}