[PAN-2614] Add simple PeerPermissions interface (#1446)

PegaSysEng · May 17, 2019 · c227d1b · c227d1b
1 parent 8b26d3a
commit c227d1b
Show file tree

Hide file tree

Showing 39 changed files with 1,369 additions and 873 deletions.
diff --git a/...c/test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ThreadPantheonNodeRunner.java b/...c/test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ThreadPantheonNodeRunner.java
@@ -32,7 +32,6 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.time.Clock;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -108,7 +107,6 @@ public void startNode(final PantheonNode node) {
             .jsonRpcConfiguration(node.jsonRpcConfiguration())
             .webSocketConfiguration(node.webSocketConfiguration())
             .dataDir(node.homeDirectory())
-            .bannedNodeIds(Collections.emptySet())
             .metricsSystem(noOpMetricsSystem)
             .metricsConfiguration(node.metricsConfiguration())
             .p2pEnabled(node.isP2pEnabled())

diff --git a/ethereum/eth/src/test/java/tech/pegasys/pantheon/ethereum/eth/transactions/TestNode.java b/ethereum/eth/src/test/java/tech/pegasys/pantheon/ethereum/eth/transactions/TestNode.java
@@ -44,7 +44,6 @@
 import tech.pegasys.pantheon.ethereum.p2p.network.DefaultP2PNetwork;
 import tech.pegasys.pantheon.ethereum.p2p.peers.DefaultPeer;
 import tech.pegasys.pantheon.ethereum.p2p.peers.Peer;
-import tech.pegasys.pantheon.ethereum.p2p.peers.PeerBlacklist;
 import tech.pegasys.pantheon.ethereum.p2p.wire.messages.DisconnectMessage.DisconnectReason;
 import tech.pegasys.pantheon.ethereum.worldstate.WorldStateArchive;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
@@ -126,7 +125,6 @@ public TestNode(
                         .vertx(vertx)
                         .keyPair(this.kp)
                         .config(networkingConfiguration)
-                        .peerBlacklist(new PeerBlacklist())
                         .metricsSystem(new NoOpMetricsSystem())
                         .supportedCapabilities(capabilities)
                         .build())

diff --git a/...c/src/test/java/tech/pegasys/pantheon/ethereum/jsonrpc/JsonRpcHttpServiceRpcApisTest.java b/...c/src/test/java/tech/pegasys/pantheon/ethereum/jsonrpc/JsonRpcHttpServiceRpcApisTest.java
@@ -37,7 +37,6 @@
 import tech.pegasys.pantheon.ethereum.p2p.config.NetworkingConfiguration;
 import tech.pegasys.pantheon.ethereum.p2p.config.RlpxConfiguration;
 import tech.pegasys.pantheon.ethereum.p2p.network.DefaultP2PNetwork;
-import tech.pegasys.pantheon.ethereum.p2p.peers.PeerBlacklist;
 import tech.pegasys.pantheon.ethereum.p2p.wire.Capability;
 import tech.pegasys.pantheon.ethereum.permissioning.AccountLocalConfigPermissioningController;
 import tech.pegasys.pantheon.ethereum.permissioning.NodeLocalConfigPermissioningController;
@@ -243,7 +242,6 @@ private P2PNetwork createP2pNetwork() {
             .keyPair(SECP256K1.KeyPair.generate())
             .vertx(vertx)
             .config(config)
-            .peerBlacklist(new PeerBlacklist())
             .metricsSystem(new NoOpMetricsSystem())
             .build();
 

diff --git a/ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/DiscoveryPeer.java b/ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/DiscoveryPeer.java
@@ -31,6 +31,7 @@ public class DiscoveryPeer extends DefaultPeer {
   private long firstDiscovered = 0;
   private long lastContacted = 0;
   private long lastSeen = 0;
+  private long lastAttemptedConnection = 0;
 
   private DiscoveryPeer(final EnodeURL enode, final Endpoint endpoint) {
     super(enode);
@@ -88,6 +89,14 @@ public void setLastContacted(final long lastContacted) {
     this.lastContacted = lastContacted;
   }
 
+  public long getLastAttemptedConnection() {
+    return lastAttemptedConnection;
+  }
+
+  public void setLastAttemptedConnection(final long lastAttemptedConnection) {
+    this.lastAttemptedConnection = lastAttemptedConnection;
+  }
+
   public long getLastSeen() {
     return lastSeen;
   }

diff --git a/...um/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/PeerDiscoveryAgent.java b/...um/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/PeerDiscoveryAgent.java
@@ -14,25 +14,19 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
-import static java.util.concurrent.TimeUnit.MILLISECONDS;
 import static tech.pegasys.pantheon.util.bytes.BytesValue.wrapBuffer;
 
 import tech.pegasys.pantheon.crypto.SECP256K1;
-import tech.pegasys.pantheon.ethereum.p2p.api.DisconnectCallback;
-import tech.pegasys.pantheon.ethereum.p2p.api.PeerConnection;
 import tech.pegasys.pantheon.ethereum.p2p.config.DiscoveryConfiguration;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.PeerDiscoveryEvent.PeerBondedEvent;
-import tech.pegasys.pantheon.ethereum.p2p.discovery.PeerDiscoveryEvent.PeerDroppedEvent;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.Packet;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerDiscoveryController;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerDiscoveryController.AsyncExecutor;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerRequirement;
-import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerTable;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PingPacketData;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.TimerUtil;
-import tech.pegasys.pantheon.ethereum.p2p.peers.DefaultPeerId;
-import tech.pegasys.pantheon.ethereum.p2p.peers.PeerBlacklist;
-import tech.pegasys.pantheon.ethereum.p2p.wire.messages.DisconnectMessage;
+import tech.pegasys.pantheon.ethereum.p2p.peers.PeerId;
+import tech.pegasys.pantheon.ethereum.p2p.permissions.PeerPermissions;
 import tech.pegasys.pantheon.ethereum.permissioning.node.NodePermissioningController;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
 import tech.pegasys.pantheon.util.NetworkUtility;
@@ -47,7 +41,6 @@
 import java.util.OptionalInt;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CopyOnWriteArrayList;
-import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -61,17 +54,16 @@
  * The peer discovery agent is the network component that sends and receives peer discovery messages
  * via UDP.
  */
-public abstract class PeerDiscoveryAgent implements DisconnectCallback {
+public abstract class PeerDiscoveryAgent {
   protected static final Logger LOG = LogManager.getLogger();
 
   // The devp2p specification says only accept packets up to 1280, but some
   // clients ignore that, so we add in a little extra padding.
   private static final int MAX_PACKET_SIZE_BYTES = 1600;
-  private static final long PEER_REFRESH_INTERVAL_MS = MILLISECONDS.convert(30, TimeUnit.MINUTES);
 
   protected final List<DiscoveryPeer> bootstrapPeers;
   private final List<PeerRequirement> peerRequirements = new CopyOnWriteArrayList<>();
-  private final PeerBlacklist peerBlacklist;
+  private final PeerPermissions peerPermissions;
   private final Optional<NodePermissioningController> nodePermissioningController;
   private final MetricsSystem metricsSystem;
   /* The peer controller, which takes care of the state machine of peers. */
@@ -80,7 +72,6 @@ public abstract class PeerDiscoveryAgent implements DisconnectCallback {
   /* The keypair used to sign messages. */
   protected final SECP256K1.KeyPair keyPair;
   private final BytesValue id;
-  private final PeerTable peerTable;
   protected final DiscoveryConfiguration config;
 
   /* This is the {@link tech.pegasys.pantheon.ethereum.p2p.Peer} object holding who we are. */
@@ -89,12 +80,11 @@ public abstract class PeerDiscoveryAgent implements DisconnectCallback {
   /* Is discovery enabled? */
   private boolean isActive = false;
   private final Subscribers<Consumer<PeerBondedEvent>> peerBondedObservers = new Subscribers<>();
-  private final Subscribers<Consumer<PeerDroppedEvent>> peerDroppedObservers = new Subscribers<>();
 
   public PeerDiscoveryAgent(
       final SECP256K1.KeyPair keyPair,
       final DiscoveryConfiguration config,
-      final PeerBlacklist peerBlacklist,
+      final PeerPermissions peerPermissions,
       final Optional<NodePermissioningController> nodePermissioningController,
       final MetricsSystem metricsSystem) {
     this.metricsSystem = metricsSystem;
@@ -103,14 +93,13 @@ public PeerDiscoveryAgent(
 
     validateConfiguration(config);
 
-    this.peerBlacklist = peerBlacklist;
+    this.peerPermissions = peerPermissions;
     this.nodePermissioningController = nodePermissioningController;
     this.bootstrapPeers =
         config.getBootnodes().stream().map(DiscoveryPeer::fromEnode).collect(Collectors.toList());
 
     this.config = config;
     this.keyPair = keyPair;
-    this.peerTable = new PeerTable(keyPair.getPublicKey().getEncodedBytes(), 16);
 
     id = keyPair.getPublicKey().getEncodedBytes();
   }
@@ -164,21 +153,19 @@ private void startController() {
   }
 
   private PeerDiscoveryController createController() {
-    return new PeerDiscoveryController(
-        keyPair,
-        advertisedPeer,
-        peerTable,
-        bootstrapPeers,
-        this::handleOutgoingPacket,
-        createTimer(),
-        createWorkerExecutor(),
-        PEER_REFRESH_INTERVAL_MS,
-        PeerRequirement.combine(peerRequirements),
-        peerBlacklist,
-        nodePermissioningController,
-        peerBondedObservers,
-        peerDroppedObservers,
-        metricsSystem);
+    return PeerDiscoveryController.builder()
+        .keypair(keyPair)
+        .localPeer(advertisedPeer)
+        .bootstrapNodes(bootstrapPeers)
+        .outboundMessageHandler(this::handleOutgoingPacket)
+        .timerUtil(createTimer())
+        .workerExecutor(createWorkerExecutor())
+        .peerRequirement(PeerRequirement.combine(peerRequirements))
+        .peerPermissions(peerPermissions)
+        .nodePermissioningController(nodePermissioningController)
+        .peerBondedObservers(peerBondedObservers)
+        .metricsSystem(metricsSystem)
+        .build();
   }
 
   protected boolean validatePacketSize(final int packetSize) {
@@ -240,6 +227,10 @@ public Stream<DiscoveryPeer> streamDiscoveredPeers() {
     return controller.map(PeerDiscoveryController::streamDiscoveredPeers).orElse(Stream.empty());
   }
 
+  public void dropPeer(final PeerId peer) {
+    controller.ifPresent(c -> c.dropPeer(peer));
+  }
+
   public Optional<DiscoveryPeer> getAdvertisedPeer() {
     return Optional.ofNullable(advertisedPeer);
   }
@@ -272,29 +263,6 @@ public boolean removePeerBondedObserver(final long observerId) {
     return peerBondedObservers.unsubscribe(observerId);
   }
 
-  /**
-   * Adds an observer that will get called when a peer is dropped from the peer table.
-   *
-   * <p><i>No guarantees are made about the order in which observers are invoked.</i>
-   *
-   * @param observer The observer to call.
-   * @return A unique ID identifying this observer, to that it can be removed later.
-   */
-  public long observePeerDroppedEvents(final Consumer<PeerDroppedEvent> observer) {
-    checkNotNull(observer);
-    return peerDroppedObservers.subscribe(observer);
-  }
-
-  /**
-   * Removes an previously added peer dropped observer.
-   *
-   * @param observerId The unique ID identifying the observer to remove.
-   * @return Whether the observer was located and removed.
-   */
-  public boolean removePeerDroppedObserver(final long observerId) {
-    return peerDroppedObservers.unsubscribe(observerId);
-  }
-
   /**
    * Returns the count of observers that are registered on this controller.
    *
@@ -320,15 +288,6 @@ private static void validateConfiguration(final DiscoveryConfiguration config) {
     checkArgument(config.getBucketSize() > 0, "bucket size cannot be negative nor zero");
   }
 
-  @Override
-  public void onDisconnect(
-      final PeerConnection connection,
-      final DisconnectMessage.DisconnectReason reason,
-      final boolean initiatedByPeer) {
-    final BytesValue nodeId = connection.getPeerInfo().getNodeId();
-    peerTable.tryEvict(new DefaultPeerId(nodeId));
-  }
-
   /**
    * Returns the current state of the PeerDiscoveryAgent.
    *

diff --git a/...p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/VertxPeerDiscoveryAgent.java b/...p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/VertxPeerDiscoveryAgent.java
@@ -21,7 +21,7 @@
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerDiscoveryController.AsyncExecutor;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.TimerUtil;
 import tech.pegasys.pantheon.ethereum.p2p.discovery.internal.VertxTimerUtil;
-import tech.pegasys.pantheon.ethereum.p2p.peers.PeerBlacklist;
+import tech.pegasys.pantheon.ethereum.p2p.permissions.PeerPermissions;
 import tech.pegasys.pantheon.ethereum.permissioning.node.NodePermissioningController;
 import tech.pegasys.pantheon.metrics.MetricCategory;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
@@ -58,10 +58,10 @@ public VertxPeerDiscoveryAgent(
       final Vertx vertx,
       final KeyPair keyPair,
       final DiscoveryConfiguration config,
-      final PeerBlacklist peerBlacklist,
+      final PeerPermissions peerPermissions,
       final Optional<NodePermissioningController> nodePermissioningController,
       final MetricsSystem metricsSystem) {
-    super(keyPair, config, peerBlacklist, nodePermissioningController, metricsSystem);
+    super(keyPair, config, peerPermissions, nodePermissioningController, metricsSystem);
     checkArgument(vertx != null, "vertx instance cannot be null");
     this.vertx = vertx;
 

diff --git a/...in/java/tech/pegasys/pantheon/ethereum/p2p/discovery/internal/OutboundMessageHandler.java b/...in/java/tech/pegasys/pantheon/ethereum/p2p/discovery/internal/OutboundMessageHandler.java
@@ -16,7 +16,7 @@
 
 @FunctionalInterface
 public interface OutboundMessageHandler {
-  public static OutboundMessageHandler NOOP = (peer, packet) -> {};
+  OutboundMessageHandler NOOP = (peer, packet) -> {};
 
   void send(final DiscoveryPeer toPeer, final Packet packet);
 }