Make TunnelManager the point of asynchronicity

Signed-off-by: Samuel Holland <samuel@sholland.org>
This commit is contained in:
Samuel Holland
2018-01-07 00:24:56 -06:00
parent 5a2f692d73
commit be8b6017d5
6 changed files with 125 additions and 154 deletions
@@ -7,61 +7,53 @@ import com.wireguard.config.Config;
import java.util.Set;
import java9.util.concurrent.CompletionStage;
/**
* Interface for implementations of the WireGuard secure network tunnel.
*/
public interface Backend {
/**
* Update the volatile configuration of a running tunnel, asynchronously, and return the
* resulting configuration. If the tunnel is not up, return the configuration that would result
* (if known), or else simply return the given configuration.
* Update the volatile configuration of a running tunnel and return the resulting configuration.
* If the tunnel is not up, return the configuration that would result (if known), or else
* simply return the given configuration.
*
* @param tunnel The tunnel to apply the configuration to.
* @param config The new configuration for this tunnel.
* @return A future completed when the configuration of the tunnel has been updated, and the new
* volatile configuration has been determined. This future will always be completed on the main
* thread.
* @return The updated configuration of the tunnel.
*/
CompletionStage<Config> applyConfig(Tunnel tunnel, Config config);
Config applyConfig(Tunnel tunnel, Config config) throws Exception;
/**
* Enumerate the names of currently-running tunnels.
*
* @return A future completed when the set of running tunnel names is available. This future
* will always be completed on the main thread.
* @return The set of running tunnel names.
*/
CompletionStage<Set<String>> enumerate();
Set<String> enumerate() throws Exception;
/**
* Get the actual state of a tunnel, asynchronously.
* Get the actual state of a tunnel.
*
* @param tunnel The tunnel to examine the state of.
* @return A future completed when the state of the tunnel has been determined. This future will
* always be completed on the main thread.
* @return The state of the tunnel.
*/
CompletionStage<State> getState(Tunnel tunnel);
State getState(Tunnel tunnel) throws Exception;
/**
* Get statistics about traffic and errors on this tunnel, asynchronously. If the tunnel is not
* running, the statistics object will be filled with zero values.
* Get statistics about traffic and errors on this tunnel. If the tunnel is not running, the
* statistics object will be filled with zero values.
*
* @param tunnel The tunnel to retrieve statistics for.
* @return A future completed when statistics for the tunnel are available. This future will
* always be completed on the main thread.
* @return The statistics for the tunnel.
*/
CompletionStage<Statistics> getStatistics(Tunnel tunnel);
Statistics getStatistics(Tunnel tunnel) throws Exception;
/**
* Set the state of a tunnel, asynchronously.
* Set the state of a tunnel.
*
* @param tunnel The tunnel to control the state of.
* @param state The new state for this tunnel. Must be {@code UP}, {@code DOWN}, or
* {@code TOGGLE}.
* @return A future completed when the state of the tunnel has changed, containing the new state
* of the tunnel. This future will always be completed on the main thread.
* @return The updated state of the tunnel.
*/
CompletionStage<State> setState(Tunnel tunnel, State state);
State setState(Tunnel tunnel, State state) throws Exception;
}
@@ -6,7 +6,6 @@ import android.util.Log;
import com.wireguard.android.model.Tunnel;
import com.wireguard.android.model.Tunnel.State;
import com.wireguard.android.model.Tunnel.Statistics;
import com.wireguard.android.util.AsyncWorker;
import com.wireguard.android.util.RootShell;
import com.wireguard.config.Config;
@@ -17,25 +16,20 @@ import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java9.util.concurrent.CompletableFuture;
import java9.util.concurrent.CompletionStage;
import java9.util.stream.Collectors;
import java9.util.stream.Stream;
/**
* Created by samuel on 12/19/17.
* WireGuard backend that uses {@code wg-quick} to implement tunnel configuration.
*/
public final class WgQuickBackend implements Backend {
private static final String TAG = WgQuickBackend.class.getSimpleName();
private final AsyncWorker asyncWorker;
private final Context context;
private final RootShell rootShell;
public WgQuickBackend(final AsyncWorker asyncWorker, final Context context,
final RootShell rootShell) {
this.asyncWorker = asyncWorker;
public WgQuickBackend(final Context context, final RootShell rootShell) {
this.context = context;
this.rootShell = rootShell;
}
@@ -49,47 +43,47 @@ public final class WgQuickBackend implements Backend {
}
@Override
public CompletionStage<Config> applyConfig(final Tunnel tunnel, final Config config) {
public Config applyConfig(final Tunnel tunnel, final Config config) {
if (tunnel.getState() == State.UP)
return CompletableFuture.failedFuture(new UnsupportedOperationException("stub"));
return CompletableFuture.completedFuture(config);
throw new UnsupportedOperationException("Not implemented");
return config;
}
@Override
public CompletionStage<Set<String>> enumerate() {
return asyncWorker.supplyAsync(() -> {
final List<String> output = new LinkedList<>();
// Don't throw an exception here or nothing will show up in the UI.
if (rootShell.run(output, "wg show interfaces") != 0 || output.isEmpty())
return Collections.emptySet();
// wg puts all interface names on the same line. Split them into separate elements.
return Stream.of(output.get(0).split(" "))
.collect(Collectors.toUnmodifiableSet());
});
public Set<String> enumerate() {
final List<String> output = new LinkedList<>();
// Don't throw an exception here or nothing will show up in the UI.
if (rootShell.run(output, "wg show interfaces") != 0 || output.isEmpty())
return Collections.emptySet();
// wg puts all interface names on the same line. Split them into separate elements.
return Stream.of(output.get(0).split(" ")).collect(Collectors.toUnmodifiableSet());
}
@Override
public CompletionStage<State> getState(final Tunnel tunnel) {
public State getState(final Tunnel tunnel) {
Log.v(TAG, "Requested state for tunnel " + tunnel.getName());
return enumerate().thenApply(set -> set.contains(tunnel.getName()) ? State.UP : State.DOWN);
return enumerate().contains(tunnel.getName()) ? State.UP : State.DOWN;
}
@Override
public CompletionStage<Statistics> getStatistics(final Tunnel tunnel) {
return CompletableFuture.completedFuture(new Statistics());
public Statistics getStatistics(final Tunnel tunnel) {
return new Statistics();
}
@Override
public CompletionStage<State> setState(final Tunnel tunnel, final State state) {
public State setState(final Tunnel tunnel, final State state) throws IOException {
Log.v(TAG, "Requested state change to " + state + " for tunnel " + tunnel.getName());
return tunnel.getStateAsync().thenCompose(currentState -> asyncWorker.supplyAsync(() -> {
final String stateName = resolveState(currentState, state).name().toLowerCase();
final File file = new File(context.getFilesDir(), tunnel.getName() + ".conf");
final String path = file.getAbsolutePath();
final State originalState = getState(tunnel);
final State resolvedState = resolveState(originalState, state);
if (resolvedState == State.UP) {
// FIXME: Assumes file layout from FileConfigStore. Use a temporary file.
if (rootShell.run(null, String.format("wg-quick %s '%s'", stateName, path)) != 0)
final File file = new File(context.getFilesDir(), tunnel.getName() + ".conf");
if (rootShell.run(null, String.format("wg-quick up '%s'", file.getAbsolutePath())) != 0)
throw new IOException("wg-quick failed");
return tunnel;
})).thenCompose(this::getState);
} else {
if (rootShell.run(null, String.format("wg-quick down '%s'", tunnel.getName())) != 0)
throw new IOException("wg-quick failed");
}
return getState(tunnel);
}
}