[ETCM-366] White listing consensus (#797)

Author: KonradStaniec

src/ets/scala/io/iohk/ethereum/ets/blockchain/ScenarioSetup.scala

@@ -2,6 +2,8 @@ package io.iohk.ethereum.ets.blockchain
 
 import akka.util.ByteString
 import java.util.concurrent.Executors
+
+import io.iohk.ethereum.consensus.Protocol.NoAdditionalEthashData
 import io.iohk.ethereum.consensus.ethash.EthashConsensus
 import io.iohk.ethereum.consensus.ethash.validators.ValidatorsExecutor
 import io.iohk.ethereum.consensus.{ConsensusConfig, FullConsensusConfig, TestConsensus, ethash}
@@ -31,7 +33,7 @@ object ScenarioSetup {
       blockchainConfig: BlockchainConfig,
       validators: ValidatorsExecutor
   ): ethash.EthashConsensus = {
-    val consensus = EthashConsensus(vm, blockchain, blockchainConfig, fullConfig, validators)
+    val consensus = EthashConsensus(vm, blockchain, blockchainConfig, fullConfig, validators, NoAdditionalEthashData)
     consensus
   }
 

src/it/scala/io/iohk/ethereum/sync/util/RegularSyncItSpecUtils.scala

@@ -7,6 +7,7 @@ import io.iohk.ethereum.Mocks.MockValidatorsAlwaysSucceed
 import io.iohk.ethereum.blockchain.sync.{PeersClient, SyncProtocol}
 import io.iohk.ethereum.blockchain.sync.regular.BlockBroadcasterActor.BroadcastBlock
 import io.iohk.ethereum.blockchain.sync.regular.RegularSync
+import io.iohk.ethereum.consensus.Protocol.NoAdditionalEthashData
 import io.iohk.ethereum.consensus.blocks.CheckpointBlockGenerator
 import io.iohk.ethereum.consensus.ethash.{EthashConfig, EthashConsensus}
 import io.iohk.ethereum.consensus.{ConsensusConfig, FullConsensusConfig, ethash}
@@ -45,7 +46,8 @@ object RegularSyncItSpecUtils {
       val specificConfig: EthashConfig = ethash.EthashConfig(config)
       val fullConfig = FullConsensusConfig(consensusConfig, specificConfig)
       val vm = VmSetup.vm(VmConfig(config), blockchainConfig, testMode = false)
-      val consensus = EthashConsensus(vm, bl, blockchainConfig, fullConfig, ValidatorsExecutorAlwaysSucceed)
+      val consensus =
+        EthashConsensus(vm, bl, blockchainConfig, fullConfig, ValidatorsExecutorAlwaysSucceed, NoAdditionalEthashData)
       consensus
     }
 

src/main/resources/application.conf

@@ -251,7 +251,7 @@ mantis {
     # Declaring the protocol here means that a more protocol-specific configuration
     # is pulled from the corresponding consensus implementation.
     # For example, in case of ethash, a section named `ethash` is used.
-    # Available protocols: ethash, mocked
+    # Available protocols: ethash, mocked, restricted-ethash
     # In case of mocked, remember to enable qa api
     protocol = ethash
 

src/main/resources/chains/test-chain.conf

@@ -160,4 +160,8 @@
 
   # Set of initial nodes
   bootstrap-nodes = []
+
+  # List of hex encoded public keys of miners which can extend chain (only used when using restricted-ethash consensus)
+  # empty means that everybody can mine
+  allowed-miners = []
 }

src/main/resources/chains/testnet-internal-gac-chain.conf

@@ -144,4 +144,8 @@
 
     # List of hex encoded public keys of Checkpoint Authorities
     checkpoint-public-keys = []
+
+    # List of hex encoded public keys of miners which can extend chain (only used when using restricted-ethash consensus)
+    # empty means that everybody can mine
+    allowed-miners = []
 }

src/main/resources/chains/testnet-internal-nomad-chain.conf

@@ -150,4 +150,8 @@
 
     # List of hex encoded public keys of Checkpoint Authorities
     checkpoint-public-keys = []
+
+    # List of hex encoded public keys of miners which can extend chain (only used when using restricted-ethash consensus)
+    # empty means that everybody can mine
+    allowed-miners = []
 }

src/main/scala/io/iohk/ethereum/consensus/ConsensusBuilder.scala

@@ -1,5 +1,6 @@
 package io.iohk.ethereum.consensus
 
+import io.iohk.ethereum.consensus.Protocol.{NoAdditionalEthashData, RestrictedEthashMinerData}
 import io.iohk.ethereum.consensus.ethash.EthashConsensus
 import io.iohk.ethereum.consensus.ethash.validators.ValidatorsExecutor
 import io.iohk.ethereum.nodebuilder._
@@ -17,18 +18,32 @@ trait ConsensusBuilder {
   *      [[io.iohk.ethereum.consensus.ethash.EthashConsensus EthashConsensus]],
   */
 trait StdConsensusBuilder extends ConsensusBuilder {
-  self: VmBuilder with BlockchainBuilder with BlockchainConfigBuilder with ConsensusConfigBuilder with Logger =>
+  self: VmBuilder
+    with BlockchainBuilder
+    with BlockchainConfigBuilder
+    with ConsensusConfigBuilder
+    with NodeKeyBuilder
+    with Logger =>
 
   private lazy val mantisConfig = Config.config
 
   private def newConfig[C <: AnyRef](c: C): FullConsensusConfig[C] =
     FullConsensusConfig(consensusConfig, c)
 
+  //TODO [ETCM-397] refactor configs to avoid possibility of running mocked or
+  // restricted-ethash consensus on real network like ETC or Mordor
   protected def buildEthashConsensus(): ethash.EthashConsensus = {
     val specificConfig = ethash.EthashConfig(mantisConfig)
+
     val fullConfig = newConfig(specificConfig)
+
     val validators = ValidatorsExecutor(blockchainConfig, consensusConfig.protocol)
-    val consensus = EthashConsensus(vm, blockchain, blockchainConfig, fullConfig, validators)
+
+    val additionalEthashData = consensusConfig.protocol match {
+      case Protocol.Ethash | Protocol.MockedPow => NoAdditionalEthashData
+      case Protocol.RestrictedEthash => RestrictedEthashMinerData(nodeKey)
+    }
+    val consensus = EthashConsensus(vm, blockchain, blockchainConfig, fullConfig, validators, additionalEthashData)
     consensus
   }
 
@@ -38,7 +53,7 @@ trait StdConsensusBuilder extends ConsensusBuilder {
 
     val consensus =
       config.protocol match {
-        case Protocol.Ethash | Protocol.MockedPow => buildEthashConsensus()
+        case Protocol.Ethash | Protocol.MockedPow | Protocol.RestrictedEthash => buildEthashConsensus()
       }
     log.info(s"Using '${protocol.name}' consensus [${consensus.getClass.getName}]")
 

src/main/scala/io/iohk/ethereum/consensus/ConsensusConfig.scala

@@ -36,7 +36,8 @@ object ConsensusConfig extends Logger {
 
   final val AllowedProtocols = Set(
     Protocol.Names.Ethash,
-    Protocol.Names.MockedPow
+    Protocol.Names.MockedPow,
+    Protocol.Names.RestrictedEthash
   )
 
   final val AllowedProtocolsError = (s: String) =>

src/main/scala/io/iohk/ethereum/consensus/Protocol.scala

@@ -1,5 +1,7 @@
 package io.iohk.ethereum.consensus
 
+import org.bouncycastle.crypto.AsymmetricCipherKeyPair
+
 /**
   * Enumerates the known consensus protocols that Mantis can use.
   * For the respective implementations, see [[io.iohk.ethereum.consensus.Consensus Consensus]].
@@ -20,20 +22,38 @@ object Protocol {
     final val Ethash = "ethash"
 
     final val MockedPow = "mocked"
+
+    final val RestrictedEthash = "restricted-ethash"
   }
 
   sealed abstract class ProtocolImpl(val name: String) extends Protocol
 
+  /** Mocked pow consensus algorithm used for tests etc. */
+  case object MockedPow extends ProtocolImpl(Names.MockedPow)
+
   /** The standard Ethereum PoW consensus protocol. */
   case object Ethash extends ProtocolImpl(Names.Ethash)
 
-  /** Mocked pow consensus algorithm used for tests etc. */
-  case object MockedPow extends ProtocolImpl(Names.MockedPow)
+  /**
+    * Non-standard ethereum PoW consensus protocol, which allows restricting list of possible miners.
+    * Main differences from basic PoW consensus protocol:
+    *   - Each miner, signs header data before mining i.e prepared header without mixHash and Nonce, and appends this
+    *     signature to blockheader.extraData field. Only such prepared header is mined upon.
+    *   - Each validator, checks (in addition to standard blockheader validations):
+    *       a) if blockheader.extraData field has at most 97 bytes length (32 bytes of standard extraData + 65 bytes
+    *          for ECDSA signature
+    *       b) if signature is a valid signature over all blockheader data except: mixHash, Nonce, last 65 bytes of
+    *          extraData field (those bytes are signature itself)
+    *       c) if public key recovered from correct signature is contained within allowedMinersPublicKeys set defined
+    *          for given chain
+    */
+  case object RestrictedEthash extends ProtocolImpl(Names.RestrictedEthash)
 
   /** All the known protocols. If a protocol is not put here, then it cannot be used to run Mantis. */
   final val KnownProtocols = Set(
     Ethash,
-    MockedPow
+    MockedPow,
+    RestrictedEthash
   )
 
   final val KnownProtocolNames = KnownProtocols.map(_.name)
@@ -44,4 +64,8 @@ object Protocol {
     find(name).getOrElse {
       throw new IllegalArgumentException("Unknown protocol " + name)
     }
+
+  sealed abstract class AdditionalEthashProtocolData
+  case object NoAdditionalEthashData extends AdditionalEthashProtocolData
+  case class RestrictedEthashMinerData(miningNodeKey: AsymmetricCipherKeyPair) extends AdditionalEthashProtocolData
 }

src/main/scala/io/iohk/ethereum/consensus/TestConsensusBuilder.scala

@@ -22,6 +22,8 @@ trait StdTestConsensusBuilder
     with BlockchainBuilder
     with StorageBuilder
     with BlockchainConfigBuilder
+    with NodeKeyBuilder
+    with SecureRandomBuilder
     with ConsensusConfigBuilder
     with ShutdownHookBuilder
     with Logger

src/main/scala/io/iohk/ethereum/consensus/ethash/EthashConsensus.scala

@@ -6,11 +6,22 @@ import java.util.concurrent.atomic.AtomicReference
 
 import akka.actor.ActorRef
 import akka.util.Timeout
-import io.iohk.ethereum.consensus.Protocol.{Ethash, MockedPow}
+import io.iohk.ethereum.consensus.Protocol.{
+  AdditionalEthashProtocolData,
+  Ethash,
+  MockedPow,
+  NoAdditionalEthashData,
+  RestrictedEthash,
+  RestrictedEthashMinerData
+}
 import io.iohk.ethereum.consensus.blocks.TestBlockGenerator
 import io.iohk.ethereum.consensus.difficulty.DifficultyCalculator
 import io.iohk.ethereum.consensus.ethash.MinerResponses.MinerNotExist
-import io.iohk.ethereum.consensus.ethash.blocks.{EthashBlockGenerator, EthashBlockGeneratorImpl}
+import io.iohk.ethereum.consensus.ethash.blocks.{
+  EthashBlockGenerator,
+  EthashBlockGeneratorImpl,
+  RestrictedEthashBlockGeneratorImpl
+}
 import io.iohk.ethereum.consensus.ethash.validators.ValidatorsExecutor
 import io.iohk.ethereum.consensus.validators.Validators
 import io.iohk.ethereum.domain.BlockchainImpl
@@ -61,7 +72,7 @@ class EthashConsensus private (
     atomicMiner.get() match {
       case None =>
         val miner = config.generic.protocol match {
-          case Ethash => EthashMiner(node)
+          case Ethash | RestrictedEthash => EthashMiner(node)
           case MockedPow => MockedMiner(node)
         }
         atomicMiner.set(Some(miner))
@@ -175,7 +186,8 @@ object EthashConsensus {
       blockchain: BlockchainImpl,
       blockchainConfig: BlockchainConfig,
       config: FullConsensusConfig[EthashConfig],
-      validators: ValidatorsExecutor
+      validators: ValidatorsExecutor,
+      additionalEthashProtocolData: AdditionalEthashProtocolData
   ): EthashConsensus = {
 
     val difficultyCalculator = DifficultyCalculator(blockchainConfig)
@@ -187,14 +199,28 @@ object EthashConsensus {
       blockchainConfig = blockchainConfig
     )
 
-    val blockGenerator = new EthashBlockGeneratorImpl(
-      validators = validators,
-      blockchain = blockchain,
-      blockchainConfig = blockchainConfig,
-      consensusConfig = config.generic,
-      blockPreparator = blockPreparator,
-      difficultyCalculator
-    )
+    val blockGenerator = additionalEthashProtocolData match {
+      case RestrictedEthashMinerData(key) =>
+        new RestrictedEthashBlockGeneratorImpl(
+          validators = validators,
+          blockchain = blockchain,
+          blockchainConfig = blockchainConfig,
+          consensusConfig = config.generic,
+          blockPreparator = blockPreparator,
+          difficultyCalc = difficultyCalculator,
+          minerKeyPair = key
+        )
+
+      case NoAdditionalEthashData =>
+        new EthashBlockGeneratorImpl(
+          validators = validators,
+          blockchain = blockchain,
+          blockchainConfig = blockchainConfig,
+          consensusConfig = config.generic,
+          blockPreparator = blockPreparator,
+          difficultyCalc = difficultyCalculator
+        )
+    }
 
     new EthashConsensus(
       vm = vm,

src/main/scala/io/iohk/ethereum/consensus/ethash/RestrictedEthashSigner.scala

@@ -0,0 +1,33 @@
+package io.iohk.ethereum.consensus.ethash
+
+import akka.util.ByteString
+import io.iohk.ethereum.crypto
+import io.iohk.ethereum.crypto.ECDSASignature
+import io.iohk.ethereum.domain.BlockHeader
+import io.iohk.ethereum.domain.BlockHeader.getEncodedWithoutNonce
+import org.bouncycastle.crypto.AsymmetricCipherKeyPair
+
+object RestrictedEthashSigner {
+
+  def validateSignature(blockHeader: BlockHeader, allowedMiners: Set[ByteString]): Boolean = {
+    val signature = blockHeader.extraData.takeRight(ECDSASignature.EncodedLength)
+    val blockHeaderWithoutSig = blockHeader.dropRightNExtraDataBytes(ECDSASignature.EncodedLength)
+    val encodedBlockHeader = getEncodedWithoutNonce(blockHeaderWithoutSig)
+    val headerHash = crypto.kec256(encodedBlockHeader)
+    val maybePubKey = for {
+      sig <- ECDSASignature.fromBytes(signature)
+      pubKeyBytes <- sig.publicKey(headerHash)
+    } yield ByteString.fromArrayUnsafe(pubKeyBytes)
+
+    maybePubKey.exists(allowedMiners.contains)
+  }
+
+  def signHeader(blockHeader: BlockHeader, keyPair: AsymmetricCipherKeyPair): BlockHeader = {
+    val encoded = getEncodedWithoutNonce(blockHeader)
+    val hash = crypto.kec256(encoded)
+    val signed = ECDSASignature.sign(hash, keyPair)
+    val sigBytes = signed.toBytes
+    blockHeader.withAdditionalExtraData(sigBytes)
+  }
+
+}

src/main/scala/io/iohk/ethereum/consensus/ethash/blocks/RestrictedEthashBlockGeneratorImpl.scala

@@ -0,0 +1,69 @@
+package io.iohk.ethereum.consensus.ethash.blocks
+
+import io.iohk.ethereum.consensus.ConsensusConfig
+import io.iohk.ethereum.consensus.blocks.{BlockTimestampProvider, DefaultBlockTimestampProvider, PendingBlockAndState}
+import io.iohk.ethereum.consensus.difficulty.DifficultyCalculator
+import io.iohk.ethereum.consensus.ethash.RestrictedEthashSigner
+import io.iohk.ethereum.consensus.ethash.validators.ValidatorsExecutor
+import io.iohk.ethereum.domain.{Address, Block, Blockchain, SignedTransaction}
+import io.iohk.ethereum.ledger.{BlockPreparator, InMemoryWorldStateProxy}
+import io.iohk.ethereum.utils.BlockchainConfig
+import org.bouncycastle.crypto.AsymmetricCipherKeyPair
+
+class RestrictedEthashBlockGeneratorImpl(
+    validators: ValidatorsExecutor,
+    blockchain: Blockchain,
+    blockchainConfig: BlockchainConfig,
+    consensusConfig: ConsensusConfig,
+    override val blockPreparator: BlockPreparator,
+    difficultyCalc: DifficultyCalculator,
+    minerKeyPair: AsymmetricCipherKeyPair,
+    blockTimestampProvider: BlockTimestampProvider = DefaultBlockTimestampProvider
+) extends EthashBlockGeneratorImpl(
+      validators,
+      blockchain,
+      blockchainConfig,
+      consensusConfig,
+      blockPreparator,
+      difficultyCalc,
+      blockTimestampProvider
+    ) {
+
+  override def generateBlock(
+      parent: Block,
+      transactions: Seq[SignedTransaction],
+      beneficiary: Address,
+      ommers: Ommers,
+      initialWorldStateBeforeExecution: Option[InMemoryWorldStateProxy]
+  ): PendingBlockAndState = {
+    val pHeader = parent.header
+    val blockNumber = pHeader.number + 1
+    val parentHash = pHeader.hash
+
+    val validatedOmmers = validators.ommersValidator.validate(parentHash, blockNumber, ommers, blockchain) match {
+      case Left(_) => emptyX
+      case Right(_) => ommers
+    }
+    val prepared = prepareBlock(
+      parent,
+      transactions,
+      beneficiary,
+      blockNumber,
+      blockPreparator,
+      validatedOmmers,
+      initialWorldStateBeforeExecution
+    )
+    val preparedHeader = prepared.pendingBlock.block.header
+    val headerWithAdditionalExtraData = RestrictedEthashSigner.signHeader(preparedHeader, minerKeyPair)
+    val modifiedPrepared = prepared.copy(pendingBlock =
+      prepared.pendingBlock.copy(block = prepared.pendingBlock.block.copy(header = headerWithAdditionalExtraData))
+    )
+
+    cache.updateAndGet { t: List[PendingBlockAndState] =>
+      (modifiedPrepared :: t).take(blockCacheSize)
+    }
+
+    modifiedPrepared
+  }
+
+}