Add a PCLI sub command to sign services stream files

hedera-node/cli-clients/build.gradle.kts

@@ -17,7 +17,6 @@
 plugins {
   id("com.hedera.hashgraph.conventions")
   id("com.hedera.hashgraph.shadow-jar")
-  id("org.gradle.java-test-fixtures")
 }
 
 description = "Hedera Services Command-Line Clients"

hedera-node/cli-clients/src/main/java/com/hedera/services/cli/sign/AccountBalanceSigningUtils.java

@@ -74,15 +74,19 @@ public static boolean signAccountBalanceFile(
 
             return true;
         } catch (final SignatureException | IOException e) {
-            System.err.println("Failed to sign file " + streamFileToSign.getFileName() + ". Exception: " + e);
+            System.err.printf(
+                    "signAccountBalanceFile :: Failed to sign file [%s] with exception : [%s]%n", streamFileToSign, e);
             return false;
         } catch (final InvalidKeyException | NoSuchAlgorithmException | NoSuchProviderException e) {
-            System.err.println("Irrecoverable error encountered: " + e);
-            throw new RuntimeException("Irrecoverable error encountered", e);
+            System.err.printf(
+                    "signAccountBalanceFile :: Irrecoverable error encountered when signing [%s] with exception : [%s]%n",
+                    streamFileToSign, e);
+            throw new RuntimeException("signAccountBalanceFile :: Irrecoverable error encountered", e);
         }
     }
 
-    private static void generateSigBalanceFile(final File filePath, final byte[] signature, final byte[] fileHash) {
+    private static void generateSigBalanceFile(final File filePath, final byte[] signature, final byte[] fileHash)
+            throws IOException {
         try (final BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream(filePath))) {
             output.write(TYPE_FILE_HASH);
             output.write(fileHash);
@@ -91,8 +95,10 @@ private static void generateSigBalanceFile(final File filePath, final byte[] sig
             output.write(signature);
             output.flush();
         } catch (final IOException e) {
-            System.err.println("generateSigBalanceFile :: Fail to generate signature file for " + filePath
-                    + " with exception :" + e);
+            System.err.printf(
+                    "generateSigBalanceFile :: Failed to generate signature file [%s] with exception : [%s]%n",
+                    filePath.getAbsolutePath(), e);
+            throw e;
         }
     }
 }

hedera-node/cli-clients/src/main/java/com/hedera/services/cli/sign/InvalidProtobufVersionException.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2020-2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hedera.services.cli.sign;
+
+/**
+ * An exception that is thrown if invalid protobuf version is found.
+ *
+ */
+public class InvalidProtobufVersionException extends Exception {
+
+    /**
+     * Constructs a new exception with the specified detail message.
+     *
+     * @param errMessage, the detail error message.
+     */
+    public InvalidProtobufVersionException(String errMessage) {
+        super(errMessage);
+    }
+}

hedera-node/cli-clients/src/main/java/com/hedera/services/cli/sign/RecordStreamCommand.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2016-2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hedera.services.cli.sign;
+
+import com.swirlds.cli.PlatformCli;
+import com.swirlds.cli.utility.AbstractCommand;
+import com.swirlds.cli.utility.SubcommandOf;
+import picocli.CommandLine;
+
+/**
+ * A collection of operations on record stream.
+ */
+@CommandLine.Command(
+        name = "record-stream",
+        mixinStandardHelpOptions = true,
+        description = "Operations on record stream files.")
+@SubcommandOf(PlatformCli.class)
+public final class RecordStreamCommand extends AbstractCommand {
+
+    private RecordStreamCommand() {}
+}

hedera-node/cli-clients/src/main/java/com/hedera/services/cli/sign/RecordStreamSignCommand.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hedera.services.cli.sign;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.swirlds.cli.utility.SubcommandOf;
+import com.swirlds.platform.cli.SignCommand;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import java.nio.file.Path;
+import java.security.KeyPair;
+import picocli.CommandLine;
+import picocli.CommandLine.Option;
+
+/**
+ * A subcommand of the {@link SignCommand}, for signing record stream files
+ */
+@CommandLine.Command(name = "sign", mixinStandardHelpOptions = true, description = "Sign record stream files")
+@SubcommandOf(RecordStreamCommand.class)
+public final class RecordStreamSignCommand extends SignCommand {
+    @Option(
+            names = {"-hv", "--hapiVersion"},
+            arity = "1",
+            description =
+                    "Hapi protobuf version. This is the hapi-version value in hedera-services/settings.gradle.kts. Mandatory!")
+    String hapiVersion;
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean generateSignatureFile(
+            @NonNull Path signatureFileDestination, @NonNull Path fileToSign, @NonNull KeyPair keyPair) {
+
+        return RecordStreamSigningUtils.signRecordStreamFile(
+                signatureFileDestination, fileToSign, keyPair, hapiVersion);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isFileSupported(@NonNull final Path path) {
+        return RecordStreamType.getInstance().isStreamFile(path.toFile())
+                || RecordStreamType.getInstance().isGzFile(path.toFile().getName());
+    }
+
+    @VisibleForTesting
+    public void setHapiVersion(String hapiVersion) {
+        this.hapiVersion = hapiVersion;
+    }
+}