Add support for signing jar and taco files using jar_signer

Signed-off-by: Sayali Gaikawad <[email protected]>

src/sign_workflow/sign_args.py

@@ -13,7 +13,7 @@
 
 class SignArgs:
     ACCEPTED_SIGNATURE_FILE_TYPES = [".sig", ".asc"]
-    ACCEPTED_PLATFORM = ["linux", "windows", "mac"]
+    ACCEPTED_PLATFORM = ["linux", "windows", "mac", "jar_signer"]
 
     target: Path
     components: List[str]

src/sign_workflow/signer_jar.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+import os
+from pathlib import Path
+
+from sign_workflow.signer import Signer
+
+"""
+This class is responsible for signing jar and taco files using the OpenSearch-signer-client and verifying its signature.
+"""
+
+
+class SignerJar(Signer):
+    ACCEPTED_FILE_TYPES = [".jar", ".taco"]
+
+    def generate_signature_and_verify(self, artifact: str, basepath: Path, signature_type: str) -> None:
+        filename = os.path.join(basepath, artifact)
+        signed_filename = filename if self.overwrite else os.path.join(basepath, "signed_" + artifact)
+        self.sign(artifact, basepath, signature_type)
+        self.verify(signed_filename)
+
+    def is_valid_file_type(self, file_name: str) -> bool:
+        return any(
+            file_name.endswith(x) for x in SignerJar.ACCEPTED_FILE_TYPES
+        )
+
+    def sign(self, artifact: str, basepath: Path, signature_type: str) -> None:
+        filename = os.path.join(basepath, artifact)
+        signed_filename = filename if self.overwrite else os.path.join(basepath, "signed_" + artifact)
+        signing_cmd = [
+            "./opensearch-signer-client",
+            "-i",
+            filename,
+            "-o",
+            signed_filename,
+            "-p",
+            "jar_signer",
+            "-r",
+            str(self.overwrite)
+        ]
+        self.git_repo.execute(" ".join(signing_cmd))
+
+    def verify(self, filename: str) -> None:
+        verify_cmd = ["jarsigner", "-verify", filename, "-verbose", "-certs", "-strict"]
+        self.git_repo.execute(" ".join(verify_cmd))

src/sign_workflow/signers.py

@@ -11,13 +11,15 @@
 from sign_workflow.signer_mac import SignerMac
 from sign_workflow.signer_pgp import SignerPGP
 from sign_workflow.signer_windows import SignerWindows
+from sign_workflow.signer_jar import SignerJar
 
 
 class Signers:
     TYPES = {
         "windows": SignerWindows,
         "linux": SignerPGP,
         "mac": SignerMac,
+        "jar_signer": SignerJar
     }
 
     @classmethod

tests/tests_sign_workflow/test_signer_jar.py

@@ -0,0 +1,61 @@
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+
+import os
+import unittest
+from pathlib import Path
+from unittest.mock import MagicMock, Mock, call, patch
+
+from sign_workflow.signer_jar import SignerJar
+
+
+class TestSignerJar(unittest.TestCase):
+
+    @patch("sign_workflow.signer.GitRepository")
+    def test_accepted_file_types(self, git_repo: Mock) -> None:
+        artifacts = [
+            "the-msi.msi",
+            "the-zip.zip",
+            "the-jar.jar",
+            "the-taco.taco",
+            "the-sys.sys",
+            "something-1.0.0.0.jar",
+        ]
+        expected = [
+            call("the-jar.jar", Path("path"), 'null'),
+            call("the-taco.taco", Path("path"), 'null'),
+            call("something-1.0.0.0.jar", Path("path"), 'null')
+        ]
+        signer = SignerJar(True)
+        signer.sign = MagicMock()  # type: ignore
+        signer.sign_artifacts(artifacts, Path("path"), 'null')
+        self.assertEqual(signer.sign.call_args_list, expected)
+
+    @patch("sign_workflow.signer.GitRepository")
+    @patch('os.rename')
+    @patch('os.mkdir')
+    def test_signer_sign(self, mock_os_mkdir: Mock, mock_os_rename: Mock, mock_repo: Mock) -> None:
+        signer = SignerJar(False)
+        signer.sign("the-jar.jar", Path("/path/"), "null")
+        command = "./opensearch-signer-client -i " + os.path.join(Path("/path/"), 'the-jar.jar') + " -o " + os.path.join(Path("/path/"), 'signed_the-jar.jar') + " -p jar_signer -r False"
+        mock_repo.assert_has_calls(
+            [call().execute(command)])
+
+    @patch("sign_workflow.signer.GitRepository")
+    def test_sign_command_for_overwrite(self, mock_repo: Mock) -> None:
+        signer = SignerJar(True)
+        signer.sign("the-taco.taco", Path("/path/"), 'null')
+        command = "./opensearch-signer-client -i " + os.path.join(Path("/path/"), 'the-taco.taco') + " -o " + os.path.join(Path("/path/"), 'the-taco.taco') + " -p jar_signer" + " -r True"
+        mock_repo.assert_has_calls(
+            [call().execute(command)])
+
+    @patch("sign_workflow.signer.GitRepository")
+    def test_signer_verify(self, mock_repo: Mock) -> None:
+        signer = SignerJar(True)
+        signer.verify("/path/the-jar.jar")
+        mock_repo.assert_has_calls([call().execute("jarsigner -verify /path/the-jar.jar -verbose -certs -strict")])

tests/tests_sign_workflow/test_signers.py

@@ -11,6 +11,7 @@
 from sign_workflow.signer_mac import SignerMac
 from sign_workflow.signer_pgp import SignerPGP
 from sign_workflow.signer_windows import SignerWindows
+from sign_workflow.signer_jar import SignerJar
 from sign_workflow.signers import Signers
 
 
@@ -31,6 +32,11 @@ def test_signer_macos(self, mock_repo: Mock) -> None:
         signer = Signers.create("mac", True)
         self.assertIs(type(signer), SignerMac)
 
+    @patch("sign_workflow.signer.GitRepository")
+    def test_signer_jar(self, mock_repo: Mock) -> None:
+        signer = Signers.create("jar_signer", True)
+        self.assertIs(type(signer), SignerJar)
+
     def test_signer_invalid(self) -> None:
         with self.assertRaises(ValueError) as ctx:
             Signers.create("java", False)