mkcert - npm Package Compare versions

Comparing version 0.0.5 to 1.0.0

lib/cli.js

@@ -56,2 +56,3 @@ #!/usr/bin/env node
   console.log(`CA Certificate: ${cert}`);
+  console.log('Please keep the private key in a secure location');
 }
@@ -73,17 +74,15 @@
 
-  if (!addresses.length) return console.error('`--address` must be a comma separated list of ip/domains.'); //Check if ca key exists
+  if (!addresses.length) return console.error('`--address` must be a comma separated list of ip/domains.'); //Read CA data
 
-  let caKeyData;
+  const ca = {}; //Read CA key
 
   try {
-    caKeyData = _fs.default.readFileSync(_path.default.resolve(caKey), 'utf-8');
+    ca.key = _fs.default.readFileSync(_path.default.resolve(caKey), 'utf-8');
   } catch (err) {
     return console.error(`Unable to read \`${caKey}\`. Please run \`mkcert create-ca\` to create a new certificate authority.`);
-  } //Check if ca certificate exists
+  } //Read CA certificate
 
 
-  let caCertData;
-
   try {
-    caCertData = _fs.default.readFileSync(_path.default.resolve(caCert), 'utf-8');
+    ca.cert = _fs.default.readFileSync(_path.default.resolve(caCert), 'utf-8');
   } catch (err) {
@@ -94,10 +93,10 @@ return console.error(`Unable to read \`${caCert}\`. Please run \`mkcert create-ca\` to create a new certificate authority.`);
 
-  let ssl;
+  let tls;
 
   try {
-    ssl = await mkcert.createSSL({
+    tls = await mkcert.createCertificate({
       addresses,
       validityDays: validity,
-      caKey: caKeyData,
-      caCert: caCertData
+      caKey: ca.key,
+      caCert: ca.cert
     });
@@ -111,11 +110,11 @@ } catch (err) {
 
-  _fs.default.writeFileSync(key, ssl.key);
+  _fs.default.writeFileSync(key, tls.key);
 
-  console.log(`SSL Private Key: ${key}`);
+  console.log(`Private Key: ${key}`);
   cert = _path.default.resolve(cert);
 
-  _fs.default.writeFileSync(cert, `${ssl.cert}\n${caCertData}`); //Create full chain by combining ca and domain certificate
+  _fs.default.writeFileSync(cert, `${tls.cert}\n${ca.cert}`); //Create full chain by combining ca and domain certificate
 
 
-  console.log(`SSL Certificate: ${cert}`);
+  console.log(`Certificate: ${cert}`);
 }
@@ -122,0 +121,0 @@

lib/mkcert.js

@@ -7,3 +7,3 @@ "use strict";
 exports.createCA = createCA;
-exports.createSSL = createSSL;
+exports.createCertificate = createCertificate;
 
@@ -24,3 +24,3 @@ var _nodeForge = _interopRequireWildcard(require("node-forge"));
 
-async function createCertificate({
+async function generateCertificate({
   subject,
@@ -99,3 +99,3 @@ issuer,
   }];
-  return await createCertificate({
+  return await generateCertificate({
     subject: attributes,
@@ -108,3 +108,3 @@ issuer: attributes,
 
-async function createSSL({
+async function createCertificate({
   addresses,
@@ -161,3 +161,3 @@ validityDays,
 
-  return await createCertificate({
+  return await generateCertificate({
     subject: attributes,
@@ -164,0 +164,0 @@ issuer: ca.subject.attributes,

package.json

 {
   "name": "mkcert",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "Create Self Signed Development Certificates",
@@ -5,0 +5,0 @@ "main": "lib/mkcert.js",

readme.md

@@ -70,3 +70,3 @@ Create self signed ssl certificates without OpenSSL.
 //Then create the certificate
-mkcert.createSSL({
+mkcert.createCertificate({
   addresses: ['127.0.0.1', 'localhost'],
@@ -73,0 +73,0 @@ validityDays: 365,

src/cli.js

@@ -28,2 +28,3 @@ #!/usr/bin/env node
   console.log(`CA Certificate: ${cert}`);
+  console.log('Please keep the private key in a secure location');
 }
@@ -40,6 +41,8 @@
 
-  //Check if ca key exists
-  let caKeyData;
+  //Read CA data
+  const ca = {};
+
+  //Read CA key
   try {
-    caKeyData = fs.readFileSync(path.resolve(caKey), 'utf-8');
+    ca.key = fs.readFileSync(path.resolve(caKey), 'utf-8');
   } catch(err) {
@@ -49,6 +52,5 @@ return console.error(`Unable to read \`${caKey}\`. Please run \`mkcert create-ca\` to create a new certificate authority.`);
 
-  //Check if ca certificate exists
-  let caCertData;
+  //Read CA certificate
   try {
-    caCertData = fs.readFileSync(path.resolve(caCert), 'utf-8');
+    ca.cert = fs.readFileSync(path.resolve(caCert), 'utf-8');
   } catch(err) {
@@ -59,5 +61,5 @@ return console.error(`Unable to read \`${caCert}\`. Please run \`mkcert create-ca\` to create a new certificate authority.`);
   //Create the certificate
-  let ssl;
+  let tls;
   try {
-    ssl = await mkcert.createSSL({ addresses, validityDays: validity, caKey: caKeyData, caCert: caCertData });
+    tls = await mkcert.createCertificate({ addresses, validityDays: validity, caKey: ca.key, caCert: ca.cert });
   } catch (err) {
@@ -69,7 +71,7 @@ return console.error(`Failed to create the certificate. Error: ${err.message}`);
   key = path.resolve(key);
-  fs.writeFileSync(key, ssl.key);
-  console.log(`SSL Private Key: ${key}`);
+  fs.writeFileSync(key, tls.key);
+  console.log(`Private Key: ${key}`);
   cert = path.resolve(cert);
-  fs.writeFileSync(cert, `${ssl.cert}\n${caCertData}`); //Create full chain by combining ca and domain certificate
-  console.log(`SSL Certificate: ${cert}`);
+  fs.writeFileSync(cert, `${tls.cert}\n${ca.cert}`); //Create full chain by combining ca and domain certificate
+  console.log(`Certificate: ${cert}`);
 }
@@ -76,0 +78,0 @@

src/mkcert.js

@@ -7,3 +7,3 @@ import forge, { pki } from 'node-forge';
 
-async function createCertificate({ subject, issuer, extensions, validityDays, signWith }) {
+async function generateCertificate({ subject, issuer, extensions, validityDays, signWith }) {
   const keyPair = await generateKeyPair({ bits: 2048, workers: 4 });
@@ -59,3 +59,3 @@ const cert = pki.createCertificate();
 
-  return await createCertificate({
+  return await generateCertificate({
     subject: attributes,
@@ -68,3 +68,3 @@ issuer: attributes,
 
-export async function createSSL({ addresses, validityDays, caKey, caCert }) {
+export async function createCertificate({ addresses, validityDays, caKey, caCert }) {
   //Certificate Attributes: https://git.io/fptna
@@ -95,3 +95,3 @@ const attributes = [
   //Create the cert
-  return await createCertificate({
+  return await generateCertificate({
     subject: attributes,
@@ -98,0 +98,0 @@ issuer: ca.subject.attributes,

tests/mkcert.test.js

@@ -18,3 +18,3 @@ import * as mkcert from '../src/mkcert';
 
-test('Test createSSL()', async ()=> {
+test('Test createCertificate()', async ()=> {
   const ca = await mkcert.createCA({
@@ -28,3 +28,3 @@ organization: 'Test CA',
 
-  const ssl = await mkcert.createSSL({
+  const tls = await mkcert.createCertificate({
     addresses: ['127.0.0.1', 'localhost'],
@@ -36,4 +36,4 @@ validityDays: 365,
 
-  expect(ssl.key).toBeDefined();
-  expect(ssl.cert).toBeDefined();
+  expect(tls.key).toBeDefined();
+  expect(tls.cert).toBeDefined();
 });
@@ -50,3 +50,3 @@
 
-//   const ssl = await mkcert.createSSL({
+//   const tls = await mkcert.createCertificate({
 //     addresses: ['localhost', '127.0.0.1'],
@@ -59,4 +59,4 @@ //     validityDays: 365,
 //   const server = https.createServer({
-//     key: ssl.key,
-//     cert: `${ssl.cert}\n${ca.cert}` //Create full chain by combining ca and domain certificate
+//     key: tls.key,
+//     cert: `${tls.cert}\n${ca.cert}` //Create full chain by combining ca and domain certificate
 //   }, (req, res)=> {
@@ -63,0 +63,0 @@ //     res.end('This Works');

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22185

increased by0.6%

Lines of code

467

increased by0.21%

Number of low quality alerts

0

decreased by-100%

No dependency changes