Merge pull request #2196 from mgpai22/peer-ban

kushti · web-flow · commit 4d7aa0993fed · 2024-11-25T00:19:21.000+03:00
Add peer Ban To Config
diff --git a/ergo-core/src/main/scala/org/ergoplatform/settings/Settings.scala b/ergo-core/src/main/scala/org/ergoplatform/settings/Settings.scala
@@ -12,67 +12,81 @@ import scala.concurrent.duration._
 
 case class LoggingSettings(level: String)
 
-case class RESTApiSettings(bindAddress: InetSocketAddress,
-                           apiKeyHash: Option[String],
-                           corsAllowedOrigin: Option[String],
-                           timeout: FiniteDuration,
-                           publicUrl: Option[URL])
+case class RESTApiSettings(
+  bindAddress: InetSocketAddress,
+  apiKeyHash: Option[String],
+  corsAllowedOrigin: Option[String],
+  timeout: FiniteDuration,
+  publicUrl: Option[URL]
+)
 
-case class NetworkSettings(nodeName: String,
-                           addedMaxDelay: Option[FiniteDuration],
-                           localOnly: Boolean,
-                           knownPeers: Seq[InetSocketAddress],
-                           bindAddress: InetSocketAddress,
-                           maxConnections: Int,
-                           connectionTimeout: FiniteDuration,
-                           upnpEnabled: Boolean,
-                           upnpGatewayTimeout: Option[FiniteDuration],
-                           upnpDiscoverTimeout: Option[FiniteDuration],
-                           declaredAddress: Option[InetSocketAddress],
-                           handshakeTimeout: FiniteDuration,
-                           deliveryTimeout: FiniteDuration,
-                           maxDeliveryChecks: Int,
-                           appVersion: String,
-                           agentName: String,
-                           desiredInvObjects: Int,
-                           syncInterval: FiniteDuration,
-                           syncStatusRefresh: FiniteDuration,
-                           syncIntervalStable: FiniteDuration,
-                           syncStatusRefreshStable: FiniteDuration,
-                           inactiveConnectionDeadline: FiniteDuration,
-                           syncTimeout: Option[FiniteDuration],
-                           controllerTimeout: Option[FiniteDuration],
-                           maxModifiersCacheSize: Int,
-                           magicBytes: Array[Byte],
-                           getPeersInterval: FiniteDuration,
-                           maxPeerSpecObjects: Int,
-                           temporalBanDuration: FiniteDuration,
-                           penaltySafeInterval: FiniteDuration,
-                           penaltyScoreThreshold: Int,
-                           peerEvictionInterval: FiniteDuration,
-                           peerDiscovery: Boolean)
-
-case class ScorexSettings(dataDir: File,
-                          logDir: File,
-                          logging: LoggingSettings,
-                          network: NetworkSettings,
-                          restApi: RESTApiSettings)
+case class NetworkSettings(
+  nodeName: String,
+  addedMaxDelay: Option[FiniteDuration],
+  localOnly: Boolean,
+  knownPeers: Seq[InetSocketAddress],
+  bannedPeers: Seq[InetSocketAddress],
+  bindAddress: InetSocketAddress,
+  maxConnections: Int,
+  connectionTimeout: FiniteDuration,
+  upnpEnabled: Boolean,
+  upnpGatewayTimeout: Option[FiniteDuration],
+  upnpDiscoverTimeout: Option[FiniteDuration],
+  declaredAddress: Option[InetSocketAddress],
+  handshakeTimeout: FiniteDuration,
+  deliveryTimeout: FiniteDuration,
+  maxDeliveryChecks: Int,
+  appVersion: String,
+  agentName: String,
+  desiredInvObjects: Int,
+  syncInterval: FiniteDuration,
+  syncStatusRefresh: FiniteDuration,
+  syncIntervalStable: FiniteDuration,
+  syncStatusRefreshStable: FiniteDuration,
+  inactiveConnectionDeadline: FiniteDuration,
+  syncTimeout: Option[FiniteDuration],
+  controllerTimeout: Option[FiniteDuration],
+  maxModifiersCacheSize: Int,
+  magicBytes: Array[Byte],
+  getPeersInterval: FiniteDuration,
+  maxPeerSpecObjects: Int,
+  temporalBanDuration: FiniteDuration,
+  penaltySafeInterval: FiniteDuration,
+  penaltyScoreThreshold: Int,
+  peerEvictionInterval: FiniteDuration,
+  peerDiscovery: Boolean
+)
 
+case class ScorexSettings(
+  dataDir: File,
+  logDir: File,
+  logging: LoggingSettings,
+  network: NetworkSettings,
+  restApi: RESTApiSettings
+)
 
 object ScorexSettings extends ScorexLogging with SettingsReaders {
 
   protected val configPath: String = "scorex"
 
   def readConfigFromPath(userConfigPath: Option[String], configPath: String): Config = {
 
-    val maybeConfigFile: Option[File] = userConfigPath.map(filename => new File(filename)).filter(_.exists())
-      .orElse(userConfigPath.flatMap(filename => Option(getClass.getClassLoader.getResource(filename))).
-        map(r => new File(r.toURI)).filter(_.exists()))
+    val maybeConfigFile: Option[File] = userConfigPath
+      .map(filename => new File(filename))
+      .filter(_.exists())
+      .orElse(
+        userConfigPath
+          .flatMap(filename => Option(getClass.getClassLoader.getResource(filename)))
+          .map(r => new File(r.toURI))
+          .filter(_.exists())
+      )
 
     val config = maybeConfigFile match {
       // if no user config is supplied, the library will handle overrides/application/reference automatically
       case None =>
-        log.warn("NO CONFIGURATION FILE WAS PROVIDED. STARTING WITH DEFAULT SETTINGS FOR TESTNET!")
+        log.warn(
+          "NO CONFIGURATION FILE WAS PROVIDED. STARTING WITH DEFAULT SETTINGS FOR TESTNET!"
+        )
         ConfigFactory.load()
       // application config needs to be resolved wrt both system properties *and* user-supplied config.
       case Some(file) =>
@@ -96,7 +110,8 @@ object ScorexSettings extends ScorexLogging with SettingsReaders {
   }
 
   def fromConfig(config: Config): ScorexSettings = {
-    config.as[ScorexSettings](configPath)
+    config
+      .as[ScorexSettings](configPath)
       .ensuring(_.network.magicBytes.length == MagicLength)
   }
 }
diff --git a/src/main/resources/application.conf b/src/main/resources/application.conf
@@ -498,6 +498,9 @@ scorex {
     # A list of `IP:port` pairs of well known nodes.
     knownPeers = []
 
+    # A list of `IP:port` pairs peers that will be permanently banned
+    bannedPeers = []
+
     # Interval between GetPeers messages to be send by our node to a random one
     getPeersInterval = 2m
 
diff --git a/src/main/scala/org/ergoplatform/network/peer/PeerDatabase.scala b/src/main/scala/org/ergoplatform/network/peer/PeerDatabase.scala
@@ -1,7 +1,11 @@
 package org.ergoplatform.network.peer
 
-import org.ergoplatform.nodeView.history.ErgoHistoryUtils._
-import java.io.{ByteArrayInputStream, ByteArrayOutputStream, ObjectInputStream, ObjectOutputStream}
+import java.io.{
+  ByteArrayInputStream,
+  ByteArrayOutputStream,
+  ObjectInputStream,
+  ObjectOutputStream
+}
 import java.net.{InetAddress, InetSocketAddress}
 import org.ergoplatform.settings.ErgoSettings
 import scorex.db.LDBFactory
@@ -17,6 +21,13 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
 
   private val persistentStore = LDBFactory.createKvDb(s"${settings.directory}/peers")
 
+  /**
+    * banned peer ip -> ban expiration timestamp
+    */
+  private var blacklist = settings.scorexSettings.network.bannedPeers.map { addr =>
+    addr.getAddress -> Long.MaxValue // Permanent ban
+  }.toMap
+
   private var peers =
     loadPeers match {
       case Success(loadedPeers) =>
@@ -26,11 +37,6 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
         Map.empty[InetSocketAddress, PeerInfo]
     }
 
-  /**
-    * banned peer ip -> ban expiration timestamp
-    */
-  private var blacklist = Map.empty[InetAddress, Time]
-
   /**
     * penalized peer ip -> (accumulated penalty score, last penalty timestamp)
     */
@@ -41,7 +47,7 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
    */
   private def serialize(obj: Object): Array[Byte] = {
     val stream: ByteArrayOutputStream = new ByteArrayOutputStream()
-    val oos = new ObjectOutputStream(stream)
+    val oos                           = new ObjectOutputStream(stream)
     oos.writeObject(obj)
     oos.close()
     stream.toByteArray
@@ -50,7 +56,7 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
   /*
    * Deserialize object using standard Java serializer
    */
-  private def deserialize(bytes: Array[Byte]) : Object = {
+  private def deserialize(bytes: Array[Byte]): Object = {
     val ois = new ObjectInputStream(new ByteArrayInputStream(bytes))
     ois.readObject()
   }
@@ -60,8 +66,8 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
    */
   private def loadPeers: Try[Map[InetSocketAddress, PeerInfo]] = Try {
     var peers = Map.empty[InetSocketAddress, PeerInfo]
-    for ((addr,peer) <- persistentStore.getAll) {
-      val address = deserialize(addr).asInstanceOf[InetSocketAddress]
+    for ((addr, peer) <- persistentStore.getAll) {
+      val address  = deserialize(addr).asInstanceOf[InetSocketAddress]
       val peerInfo = PeerInfoSerializer.parseBytes(peer)
       peers += address -> peerInfo
     }
@@ -84,8 +90,10 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
     remove(socketAddress)
     Option(socketAddress.getAddress).foreach { address =>
       penaltyBook -= address
-      if (!blacklist.keySet.contains(address)){
-        blacklist += address -> (System.currentTimeMillis() + penaltyDuration(penaltyType))
+      if (!blacklist.keySet.contains(address)) {
+        blacklist += address -> (System.currentTimeMillis() + penaltyDuration(
+          penaltyType
+        ))
       } else {
         log.warn(s"${address.toString} is already blacklisted")
       }
@@ -104,12 +112,12 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
 
   def knownPeers: Map[InetSocketAddress, PeerInfo] = peers
 
-  def blacklistedPeers: Seq[InetAddress] = blacklist
-    .map { case (address, bannedTill) =>
-      checkBanned(address, bannedTill)
-      address
-    }
-    .toSeq
+  def blacklistedPeers: Seq[InetAddress] =
+    blacklist.map {
+      case (address, bannedTill) =>
+        checkBanned(address, bannedTill)
+        address
+    }.toSeq
 
   def isEmpty: Boolean = peers.isEmpty
 
@@ -126,10 +134,10 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
     */
   def penalize(socketAddress: InetSocketAddress, penaltyType: PenaltyType): Boolean =
     Option(socketAddress.getAddress).exists { address =>
-      val currentTime = System.currentTimeMillis()
-      val safeInterval = settings.scorexSettings.network.penaltySafeInterval.toMillis
+      val currentTime                      = System.currentTimeMillis()
+      val safeInterval                     = settings.scorexSettings.network.penaltySafeInterval.toMillis
       val (penaltyScoreAcc, lastPenaltyTs) = penaltyBook.getOrElse(address, (0, 0L))
-      val applyPenalty = currentTime - lastPenaltyTs - safeInterval > 0 || penaltyType.isPermanent
+      val applyPenalty                     = currentTime - lastPenaltyTs - safeInterval > 0 || penaltyType.isPermanent
       val newPenaltyScore = if (applyPenalty) {
         penaltyScoreAcc + penaltyScore(penaltyType)
       } else {
@@ -173,10 +181,10 @@ final class PeerDatabase(settings: ErgoSettings) extends ScorexLogging {
 
   private def penaltyDuration(penalty: PenaltyType): Long =
     penalty match {
-      case PenaltyType.NonDeliveryPenalty | PenaltyType.MisbehaviorPenalty | PenaltyType.SpamPenalty =>
+      case PenaltyType.NonDeliveryPenalty | PenaltyType.MisbehaviorPenalty |
+          PenaltyType.SpamPenalty =>
         settings.scorexSettings.network.temporalBanDuration.toMillis
       case PenaltyType.PermanentPenalty =>
         (360 * 10).days.toMillis
     }
-
 }
