Added signing key generation

Author: adambullmer

README.md

@@ -76,6 +76,10 @@ I hope to be able to scaffold an app so that identifying the below in unnecessar
    |- manifest.json
 ```
 
+## System Dependencies
+
+If you wish to use the signing key functionality you will need to have `openssl` available on your system.
+
 ## Adding to your project
 
 This can be added to your vuejs project by one of the following methods:
@@ -269,9 +273,7 @@ yarn test
 
 ## Roadmap
 
-- Add some generator options for other pieces of browser extensions. This includes scaffolding the components/dirs, and registering the build options into the build time hooks.
 - A preset
-- Key Generation
 - Cleanup the dist-zip directory
 
 ## Credits

generator/index.js

@@ -1,5 +1,6 @@
 const fs = require('fs')
 const path = require('path')
+const { generateKey } = require('../lib/signing-key')
 const gitignoreSnippet = `
 # Vue Browser Extension Output
 *.pem
@@ -117,6 +118,12 @@ module.exports = (api, _options) => {
     api.render('./template/content-script', { ...options })
   }
 
+  if (options.generateSigningKey === true) {
+    api.render((files) => {
+      files['key.pem'] = generateKey()
+    })
+  }
+
   api.onCreateComplete(() => {
     const gitignore = fs.readFileSync(api.resolve('./.gitignore'), 'utf8')
     fs.writeFileSync(api.resolve('./.gitignore'), gitignore + gitignoreSnippet)

index.js

@@ -1,11 +1,10 @@
 const path = require('path')
-const fs = require('fs')
-const { exec } = require('child_process')
 const logger = require('@vue/cli-shared-utils')
 const webpack = require('webpack')
 const CopyWebpackPlugin = require('copy-webpack-plugin')
 const ExtensionReloader = require('webpack-extension-reloader')
 const ZipPlugin = require('zip-webpack-plugin')
+const { keyExists, hashKey } = require('./lib/signing-key')
 const defaultOptions = {
   components: {},
   componentOptions: {},
@@ -36,7 +35,7 @@ module.exports = (api, options) => {
   const packageJson = require(path.join(appRootPath, 'package.json'))
   const isProduction = api.service.mode === 'production'
   const keyFile = api.resolve('key.pem')
-  const hasKeyFile = fs.existsSync(keyFile)
+  const hasKeyFile = keyExists(keyFile)
 
   api.chainWebpack((webpackConfig) => {
     webpackConfig.entryPoints.delete('app')
@@ -114,15 +113,7 @@ module.exports = (api, options) => {
 
             if (hasKeyFile) {
               try {
-                jsonContent.key = await new Promise((resolve, reject) => {
-                  exec(`openssl rsa -in ${keyFile} -pubout -outform DER | openssl base64 -A`, (error, stdout) => {
-                    if (error) {
-                      // node couldn't execute the command
-                      return reject(error)
-                    }
-                    resolve(stdout)
-                  })
-                })
+                jsonContent.key = await hashKey(keyFile)
               } catch (error) {
                 logger.error('Unexpected error hashing keyfile:', error)
               }

lib/signing-key.js

@@ -0,0 +1,17 @@
+const { existsSync } = require('fs')
+const { exec, execSync } = require('child_process')
+
+exports.keyExists = (keyFile) => existsSync(keyFile)
+
+exports.generateKey = () => execSync('openssl genrsa 2048 | openssl pkcs8 -topk8 -nocrypt')
+
+exports.hashKey = (keyFile) =>
+  new Promise((resolve, reject) => {
+    exec(`openssl rsa -in ${keyFile} -pubout -outform DER | openssl base64 -A`, (error, stdout) => {
+      if (error) {
+        // node couldn't execute the command
+        return reject(error)
+      }
+      resolve(stdout)
+    })
+  })

prompts.js

@@ -82,5 +82,11 @@ module.exports = [
     message: 'Make polyfill available without import?',
     default: true,
     when: (answers) => answers.usePolyfill
+  },
+  {
+    name: 'generateSigningKey',
+    type: 'confirm',
+    message: 'Generate a new signing key (danger)?',
+    default: false
   }
 ]