version 0.6: support key generation when key file is absent

Author: mike10004

crxtool-core/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.github.mike10004</groupId>
         <artifactId>crxtool</artifactId>
-        <version>0.5</version>
+        <version>0.6</version>
     </parent>
     <artifactId>crxtool-core</artifactId>
     <name>crxtool-core</name>

crxtool-maven-plugin-example/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.mike10004</groupId>
         <artifactId>crxtool</artifactId>
-        <version>0.5</version>
+        <version>0.6</version>
     </parent>
     <artifactId>crxtool-maven-plugin-example</artifactId>
     <packaging>pom</packaging>

crxtool-maven-plugin/pom.xml

@@ -3,12 +3,12 @@
     <parent>
         <artifactId>crxtool</artifactId>
         <groupId>com.github.mike10004</groupId>
-        <version>0.5</version>
+        <version>0.6</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>crxtool-maven-plugin</artifactId>
     <packaging>maven-plugin</packaging>
-    <name>crxtool-maven-plugin Maven Mojo</name>
+    <name>crxtool-maven-plugin</name>
     <url>http://maven.apache.org</url>
     <build>
         <plugins>
@@ -45,7 +45,7 @@
         <dependency>
             <groupId>com.github.mike10004</groupId>
             <artifactId>crxtool-testing</artifactId>
-            <version>0.5</version>
+            <version>0.6</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

crxtool-maven-plugin/src/main/java/com/github/mike10004/crxtool/maven/PackExtensionMojo.java

@@ -55,29 +55,43 @@ public class PackExtensionMojo extends AbstractMojo {
     private File outputFile;
 
     /**
-     * Flag that specifies whether the CRX header should be included. If this is
+     * Flag that specifies whether the CRX header is to be included. If this is
      * true, the output file is in ZIP format.
      */
-    @Parameter
+    @Parameter(property = PROP_PREFIX + "excludeHeader")
     private boolean excludeHeader;
 
+    /**
+     * Flag that specifies whether a signing key is to be generated if the
+     * specified private key file is absent. Use in conjunction with
+     * {@link #privateKey}.
+     */
+    @Parameter(property = PROP_PREFIX + "generateKeyIfAbsent")
+    private boolean generateKeyIfAbsent;
+
     @Override
     public void execute() throws MojoExecutionException {
         File outputFile = getOutputFile();
         try {
             KeyPair keyPair;
-            if (privateKey != null) {
+            boolean excludeHeader = isExcludeHeader();
+            File privateKey_ = getPrivateKey();
+            if (privateKey_ != null && excludeHeader) {
+                throw new PrivateKeyParameterConflictException("private key file is specified but excludeHeader is true; if the header is excluded, no private key is required");
+            }
+            if (privateKey_ == null || (isGenerateKeyIfAbsent() && !privateKey_.isFile())) {
+                getLog().debug("generating private key (specified key file is " + privateKey_ + ")");
+                keyPair = KeyPairs.generateRsKeyPair(createRandom());
+            } else {
                 byte[] keyBytes;
-                try (Reader reader = new InputStreamReader(new FileInputStream(privateKey), StandardCharsets.US_ASCII)) {
+                try (Reader reader = new InputStreamReader(new FileInputStream(privateKey_), StandardCharsets.US_ASCII)) {
                     keyBytes = new PemParser().extractBytes(reader);
                 }
                 keyPair = KeyPairs.loadRsaKeyPairFromPrivateKeyBytes(keyBytes);
-            } else {
-                keyPair = KeyPairs.generateRsKeyPair(createRandom());
             }
             Path extensionDir = sourceDirectory.toPath();
             com.google.common.io.Files.createParentDirs(outputFile);
-            if (isExcludeHeader()) {
+            if (excludeHeader) {
                 byte[] zipBytes = Zipping.zipDirectory(extensionDir, null);
                 java.nio.file.Files.write(outputFile.toPath(), zipBytes);
             } else {
@@ -132,4 +146,18 @@ public void setExcludeHeader(boolean excludeHeader) {
         this.excludeHeader = excludeHeader;
     }
 
+    static class PrivateKeyParameterConflictException extends MojoExecutionException {
+
+        public PrivateKeyParameterConflictException(String message) {
+            super(message);
+        }
+    }
+
+    public boolean isGenerateKeyIfAbsent() {
+        return generateKeyIfAbsent;
+    }
+
+    public void setGenerateKeyIfAbsent(boolean generateKeyIfAbsent) {
+        this.generateKeyIfAbsent = generateKeyIfAbsent;
+    }
 }

crxtool-maven-plugin/src/test/java/com/github/mike10004/crxtool/maven/PackExtensionMojoTest.java

@@ -1,5 +1,6 @@
 package com.github.mike10004.crxtool.maven;
 
+import com.github.mike10004.crxtool.maven.PackExtensionMojo.PrivateKeyParameterConflictException;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.io.BaseEncoding;
 import com.google.common.io.ByteStreams;
@@ -17,6 +18,7 @@
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URISyntaxException;
@@ -36,30 +38,47 @@ public class PackExtensionMojoTest {
 
     @Test
     public void testExecute_crx_noPrivateKey() throws Exception {
-        File crxFile = testExecute(false, null);
+        File crxFile = testExecute(false, null, false);
         checkMetadata(crxFile);
         checkZipDataInCrxFile(crxFile);
     }
 
     @Test
     public void testExecute_crx_privateKey() throws Exception {
         File pemFile = buildPemFile(KeyPairs.generateRsKeyPair(new SecureRandom()).getPrivate().getEncoded());
-        File crxFile = testExecute(false, pemFile);
+        File crxFile = testExecute(false, pemFile, false);
+        checkMetadata(crxFile);
+        checkZipDataInCrxFile(crxFile);
+    }
+
+    @Test
+    public void testExecute_crx_privateKeyFileSpecifiedButAbsent() throws Exception {
+        try {
+            File pemFile = new File(temporaryFolder.newFolder(), "mykey.pem");
+            testExecute(false, pemFile, false);
+        } catch (MojoExecutionException e) {
+            assertTrue(e.getCause() instanceof FileNotFoundException);
+        }
+    }
+
+    @Test
+    public void testExecute_crx_privateKeyFileSpecifiedButAbsent_ignoreAbsent() throws Exception {
+        File pemFile = new File(temporaryFolder.newFolder(), "mykey.pem");
+        File crxFile = testExecute(false, pemFile, true);
         checkMetadata(crxFile);
         checkZipDataInCrxFile(crxFile);
     }
 
     @Test
     public void testExecute_zip_noPrivateKey() throws Exception {
-        File zipFile = testExecute(true, null);
+        File zipFile = testExecute(true, null, false);
         checkZipData(Files.asByteSource(zipFile).read());
     }
 
-    @Test
+    @Test(expected = PrivateKeyParameterConflictException.class)
     public void testExecute_zip_privateKey() throws Exception {
-        File pemFile = buildPemFile(KeyPairs.generateRsKeyPair(new SecureRandom()).getPrivate().getEncoded());
-        File zipFile = testExecute(true, pemFile);
-        checkZipData(Files.asByteSource(zipFile).read());
+        File pemFile = temporaryFolder.newFile();
+        testExecute(true, pemFile, false);
     }
 
     private File buildPemFile(byte[] privateKey) throws IOException {
@@ -84,10 +103,11 @@ private PackExtensionMojo buildMojo() throws IOException, URISyntaxException {
         return mojo;
     }
 
-    private File testExecute(boolean excludeHeader, @Nullable File privateKey) throws IOException, MojoExecutionException, URISyntaxException {
+    private File testExecute(boolean excludeHeader, @Nullable File privateKey, boolean generateKey) throws IOException, MojoExecutionException, URISyntaxException {
         PackExtensionMojo mojo = buildMojo();
         mojo.setExcludeHeader(excludeHeader);
         mojo.setPrivateKey(privateKey);
+        mojo.setGenerateKeyIfAbsent(generateKey);
         mojo.execute();
         File outputFile = mojo.getOutputFile();
         assertTrue("file length", outputFile.length() > 0);
@@ -118,4 +138,5 @@ private void checkZipData(byte[] zipData) throws IOException {
         assertEquals("filepaths", ImmutableSet.of("manifest.json", "background.js"), ImmutableSet.copyOf(unzippage.fileEntries()));
     }
 
+
 }

crxtool-testing/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>crxtool</artifactId>
         <groupId>com.github.mike10004</groupId>
-        <version>0.5</version>
+        <version>0.6</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.mike10004</groupId>
     <artifactId>crxtool</artifactId>
-    <version>0.5</version>
+    <version>0.6</version>
     <name>crxtool</name>
     <description>Chrome extension tools</description>
     <packaging>pom</packaging>