removed tests for pki qbft and add deprecation notice (#6979)

* removed tests for pki qbft and add deprecation notice Signed-off-by: Sally MacFarlane <[email protected]> * remove more PKI and CMS creation utils from tests Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]>
hyperledger · Apr 23, 2024 · 12723ac · 12723ac
1 parent e4df70a
commit 12723ac
Show file tree

Hide file tree

Showing 27 changed files with 1 addition and 2,396 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 
 ### Upcoming Breaking Changes
 - Receipt compaction will be enabled by default in a future version of Besu. After this change it will not be possible to downgrade to the previous Besu version.
+- PKI-backed QBFT will be removed in a future version of Besu. Other forms of QBFT will remain unchanged. 
 
 ### Deprecations
 

diff --git a/...ance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/BesuNode.java b/...ance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/BesuNode.java
@@ -35,7 +35,6 @@
 import org.hyperledger.besu.ethereum.permissioning.PermissioningConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
 import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration;
-import org.hyperledger.besu.pki.config.PkiKeyStoreConfiguration;
 import org.hyperledger.besu.tests.acceptance.dsl.condition.Condition;
 import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.NodeConfiguration;
 import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.genesis.GenesisConfigurationProvider;
@@ -132,7 +131,6 @@ public class BesuNode implements NodeConfiguration, RunnableNode, AutoCloseable
   private final List<String> staticNodes;
   private boolean isDnsEnabled = false;
   private Optional<Integer> exitCode = Optional.empty();
-  private Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration = Optional.empty();
   private final boolean isStrictTxReplayProtectionEnabled;
   private final Map<String, String> environment;
 
@@ -169,7 +167,6 @@ public BesuNode(
       final Optional<PrivacyParameters> privacyParameters,
       final List<String> runCommand,
       final Optional<KeyPair> keyPair,
-      final Optional<PkiKeyStoreConfiguration> pkiKeyStoreConfiguration,
       final boolean isStrictTxReplayProtectionEnabled,
       final Map<String, String> environment)
       throws IOException {
@@ -230,7 +227,6 @@ public BesuNode(
     this.staticNodes = staticNodes;
     this.isDnsEnabled = isDnsEnabled;
     privacyParameters.ifPresent(this::setPrivacyParameters);
-    this.pkiKeyStoreConfiguration = pkiKeyStoreConfiguration;
     this.environment = environment;
     LOG.info("Created BesuNode {}", this);
   }
@@ -763,10 +759,6 @@ public List<String> getRunCommand() {
     return runCommand;
   }
 
-  public Optional<PkiKeyStoreConfiguration> getPkiKeyStoreConfiguration() {
-    return pkiKeyStoreConfiguration;
-  }
-
   public boolean isStrictTxReplayProtectionEnabled() {
     return isStrictTxReplayProtectionEnabled;
   }

diff --git a/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java b/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java
@@ -377,33 +377,6 @@ public void startNode(final BesuNode node) {
                       permissioningConfiguration.getNodeSmartContractInterfaceVersion()));
             });
 
-    node.getPkiKeyStoreConfiguration()
-        .ifPresent(
-            pkiConfig -> {
-              params.add("--Xpki-block-creation-enabled");
-
-              params.add("--Xpki-block-creation-keystore-certificate-alias");
-              params.add(pkiConfig.getCertificateAlias());
-
-              params.add("--Xpki-block-creation-keystore-type");
-              params.add(pkiConfig.getKeyStoreType());
-
-              params.add("--Xpki-block-creation-keystore-file");
-              params.add(pkiConfig.getKeyStorePath().toAbsolutePath().toString());
-
-              params.add("--Xpki-block-creation-keystore-password-file");
-              params.add(pkiConfig.getKeyStorePasswordPath().toAbsolutePath().toString());
-
-              params.add("--Xpki-block-creation-truststore-type");
-              params.add(pkiConfig.getTrustStoreType());
-
-              params.add("--Xpki-block-creation-truststore-file");
-              params.add(pkiConfig.getTrustStorePath().toAbsolutePath().toString());
-
-              params.add("--Xpki-block-creation-truststore-password-file");
-              params.add(pkiConfig.getTrustStorePasswordPath().toAbsolutePath().toString());
-            });
-
     params.addAll(node.getExtraCLIOptions());
 
     params.add("--key-value-storage");

diff --git a/...sl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ThreadBesuNodeRunner.java b/...sl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ThreadBesuNodeRunner.java
@@ -21,7 +21,6 @@
 import org.hyperledger.besu.cli.config.EthNetworkConfig;
 import org.hyperledger.besu.cli.config.NetworkName;
 import org.hyperledger.besu.config.GenesisConfigFile;
-import org.hyperledger.besu.consensus.qbft.pki.PkiBlockCreationConfigurationProvider;
 import org.hyperledger.besu.controller.BesuController;
 import org.hyperledger.besu.controller.BesuControllerBuilder;
 import org.hyperledger.besu.crypto.KeyPairUtil;
@@ -253,9 +252,6 @@ public void startNode(final BesuNode node) {
         .isRevertReasonEnabled(node.isRevertReasonEnabled())
         .storageProvider(storageProvider)
         .gasLimitCalculator(GasLimitCalculator.constant())
-        .pkiBlockCreationConfiguration(
-            node.getPkiKeyStoreConfiguration()
-                .map(pkiConfig -> new PkiBlockCreationConfigurationProvider().load(pkiConfig)))
         .evmConfiguration(EvmConfiguration.DEFAULT)
         .maxPeers(maxPeers)
         .maxRemotelyInitiatedPeers(15)

diff --git a/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java b/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java
@@ -39,7 +39,6 @@
 import org.hyperledger.besu.tests.acceptance.dsl.node.RunnableNode;
 import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.genesis.GenesisConfigurationFactory;
 import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.genesis.GenesisConfigurationFactory.CliqueOptions;
-import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.pki.PkiKeystoreConfigurationFactory;
 
 import java.io.File;
 import java.io.IOException;
@@ -57,8 +56,6 @@
 public class BesuNodeFactory {
 
   private final NodeConfigurationFactory node = new NodeConfigurationFactory();
-  private final PkiKeystoreConfigurationFactory pkiKeystoreConfigurationFactory =
-      new PkiKeystoreConfigurationFactory();
 
   public BesuNode create(final BesuNodeConfiguration config) throws IOException {
     return new BesuNode(
@@ -94,7 +91,6 @@ public BesuNode create(final BesuNodeConfiguration config) throws IOException {
         config.getPrivacyParameters(),
         config.getRunCommand(),
         config.getKeyPair(),
-        config.getPkiKeyStoreConfiguration(),
         config.isStrictTxReplayProtectionEnabled(),
         config.getEnvironment());
   }
@@ -517,31 +513,6 @@ public BesuNode createQbftNode(final String name) throws IOException {
             .build());
   }
 
-  public BesuNode createPkiQbftJKSNode(final String name) throws IOException {
-    return createPkiQbftNode(KeyStoreWrapper.KEYSTORE_TYPE_JKS, name);
-  }
-
-  public BesuNode createPkiQbftPKCS11Node(final String name) throws IOException {
-    return createPkiQbftNode(KeyStoreWrapper.KEYSTORE_TYPE_PKCS11, name);
-  }
-
-  public BesuNode createPkiQbftPKCS12Node(final String name) throws IOException {
-    return createPkiQbftNode(KeyStoreWrapper.KEYSTORE_TYPE_PKCS12, name);
-  }
-
-  public BesuNode createPkiQbftNode(final String type, final String name) throws IOException {
-    return create(
-        new BesuNodeConfigurationBuilder()
-            .name(name)
-            .miningEnabled()
-            .jsonRpcConfiguration(node.createJsonRpcWithQbftEnabledConfig(false))
-            .webSocketConfiguration(node.createWebSocketEnabledConfig())
-            .devMode(false)
-            .genesisConfigProvider(GenesisConfigurationFactory::createQbftGenesisConfig)
-            .pkiBlockCreationEnabled(pkiKeystoreConfigurationFactory.createPkiConfig(type, name))
-            .build());
-  }
-
   public BesuNode createCustomGenesisNode(
       final String name, final String genesisPath, final boolean canBeBootnode) throws IOException {
     return createCustomGenesisNode(name, genesisPath, canBeBootnode, false);
@@ -699,41 +670,6 @@ public BesuNode createQbftNodeWithContractBasedValidators(
             .build());
   }
 
-  public BesuNode createPkiQbftJKSNodeWithValidators(final String name, final String... validators)
-      throws IOException {
-    return createPkiQbftNodeWithValidators(KeyStoreWrapper.KEYSTORE_TYPE_JKS, name, validators);
-  }
-
-  public BesuNode createPkiQbftPKCS11NodeWithValidators(
-      final String name, final String... validators) throws IOException {
-    return createPkiQbftNodeWithValidators(KeyStoreWrapper.KEYSTORE_TYPE_PKCS11, name, validators);
-  }
-
-  public BesuNode createPkiQbftPKCS12NodeWithValidators(
-      final String name, final String... validators) throws IOException {
-    return createPkiQbftNodeWithValidators(KeyStoreWrapper.KEYSTORE_TYPE_PKCS12, name, validators);
-  }
-
-  public BesuNode createPkiQbftNodeWithValidators(
-      final String type, final String name, final String... validators) throws IOException {
-
-    return create(
-        new BesuNodeConfigurationBuilder()
-            .name(name)
-            .miningEnabled()
-            .jsonRpcConfiguration(node.createJsonRpcWithQbftEnabledConfig(false))
-            .webSocketConfiguration(node.createWebSocketEnabledConfig())
-            .devMode(false)
-            .pkiBlockCreationEnabled(pkiKeystoreConfigurationFactory.createPkiConfig(type, name))
-            .genesisConfigProvider(
-                nodes ->
-                    node.createGenesisConfigForValidators(
-                        asList(validators),
-                        nodes,
-                        GenesisConfigurationFactory::createQbftGenesisConfig))
-            .build());
-  }
-
   public BesuNode createNodeWithStaticNodes(final String name, final List<Node> staticNodes)
       throws IOException {
 

diff --git a/...ger/besu/tests/acceptance/dsl/node/configuration/pki/PkiKeystoreConfigurationFactory.java b/...ger/besu/tests/acceptance/dsl/node/configuration/pki/PkiKeystoreConfigurationFactory.java