2.0.27

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.13",
+  "version": "2.0.27",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -170,13 +170,14 @@
       }
     },
     "@pushrocks/smartexpress": {
-      "version": "3.0.0",
+      "version": "3.0.4",
-      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartexpress/-/smartexpress-3.0.0.tgz",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartexpress/-/smartexpress-3.0.4.tgz",
-      "integrity": "sha512-F3x+AFUxkKxb5WgQuIZsfkrNzMz0PaYYIw4gdQbAPn5N/UCEP4eE2OQWXnAcCSYwsXI8hgjEuUOC9gTbCSPDRg==",
+      "integrity": "sha512-sn6yQpTGylvT/t4arCN7te8EUzimhv9JB+73XOwv503u6HokE//nT8eCAhkjprH3hgHpIgvR3iPGI8UBSCJFsw==",
       "requires": {
         "@pushrocks/lik": "^3.0.4",
         "@pushrocks/smartfile": "^6.0.11",
         "@pushrocks/smartpromise": "^2.0.5",
+        "@pushrocks/smartrequest": "^1.1.14",
         "@types/express": "^4.16.0",
         "@types/finalhandler": "0.0.33",
         "@types/helmet": "0.0.42",
@@ -271,12 +272,12 @@
       }
     },
     "@pushrocks/smartstring": {
-      "version": "3.0.5",
+      "version": "3.0.8",
-      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartstring/-/smartstring-3.0.5.tgz",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartstring/-/smartstring-3.0.8.tgz",
-      "integrity": "sha512-Bws2s6+Pc0HIXA35QH6cl6LJywhZ1U5icjyYMx+1kH8nURG+njzkacfarr9NWqyVYYOVu7SgXLzp9sR0eH7k9g==",
+      "integrity": "sha512-twmCGF47+TJoiCpj6t5MxwcKDDJEATuKqJXxftcHOlXWW743LJ/1bCpMueDdtumo5EheUfSxb43aRse3DU3wig==",
       "requires": {
         "crypto-random-string": "^1.0.0",
-        "js-base64": "^2.4.9",
+        "js-base64": "^2.5.0",
         "normalize-newline": "^3.0.0",
         "randomatic": "^3.1.1",
         "strip-indent": "^2.0.0"
@@ -1614,9 +1615,9 @@
       "integrity": "sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU="
     },
     "luxon": {
-      "version": "1.9.0",
+      "version": "1.10.0",
-      "resolved": "https://verdaccio.lossless.one/luxon/-/luxon-1.9.0.tgz",
+      "resolved": "https://verdaccio.lossless.one/luxon/-/luxon-1.10.0.tgz",
-      "integrity": "sha512-N1kSwtIEhM/gIRGASXPgi1CwfQZX5VTjndYFjOsZdEEtWij2uSoRrgDGWwViZCUNY9Rwh4UVG/TLcUinHM20cA=="
+      "integrity": "sha512-ry3GKh//v3isD6oJN5pFWmdh+3GiScwv9q8VgG6fZ2j1guGOol2vVVdo4GBAWCrcq5RHOqSeipqHBnOu/u024Q=="
     },
     "make-error": {
       "version": "1.3.5",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.13",
+  "version": "2.0.27",
   "private": false,
   "description": "acme implementation in TypeScript",
   "main": "dist/index.js",
@@ -29,12 +29,13 @@
     "@pushrocks/smartdata": "^3.1.13",
     "@pushrocks/smartdelay": "^2.0.2",
     "@pushrocks/smartdns": "^3.0.8",
-    "@pushrocks/smartexpress": "^3.0.0",
+    "@pushrocks/smartexpress": "^3.0.4",
     "@pushrocks/smartpromise": "^2.0.5",
     "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartstring": "^3.0.8",
     "@pushrocks/smarttime": "^3.0.5",
     "@pushrocks/smartunique": "^3.0.1",
-    "acme-client": "^2.2.2"
+    "acme-client": "2.2.2"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.4",

test/test.ts

@@ -30,4 +30,15 @@ tap.test('should create a valid instance of SmartAcme', async () => {
   // await smartAcmeInstance.getCertificateForDomain('bleu.de');
 });
 
+tap.test('certmatcher should correctly match domains', async () => {
+  const certMatcherMod = await import('../ts/smartacme.classes.certmatcher'); 
+  const certMatcher = new certMatcherMod.CertMatcher();
+  const matchedCert = certMatcher.getCertificateDomainNameByDomainName('level3.level2.level1');
+  expect(matchedCert).to.equal('level2.level1');
+});
+
+tap.test('should stop correctly', async () => {
+  await smartAcmeInstance.stop();
+});
+
 tap.start();

ts/smartacme.classes.cert.ts

@@ -5,6 +5,7 @@ import * as interfaces from './interfaces';
 import { CertManager } from './smartacme.classes.certmanager';
 
 import { Collection, svDb, unI } from '@pushrocks/smartdata';
+import { ICert } from './interfaces';
 
 @plugins.smartdata.Collection(() => {
   return CertManager.activeDB;
@@ -28,10 +29,12 @@ export class Cert extends plugins.smartdata.SmartDataDbDoc<Cert> implements inte
   @svDb()
   public csr: string;
 
-  constructor(privateKeyArg: string, publicKeyArg: string, csrArg: string) {
+  constructor(optionsArg: ICert) {
     super();
-    this.privateKey = privateKeyArg;
+    if (optionsArg) {
-    this.publicKey = publicKeyArg;
+      Object.keys(optionsArg).forEach(key => {
-    this.csr = csrArg;
+        this[key] = optionsArg[key];
+      });
+    }
   }
 }

ts/smartacme.classes.certmanager.ts

@@ -34,7 +34,7 @@ export class CertManager {
 
     // Pending Map
     this.pendingMap = new plugins.lik.Stringmap();
-  };
+  }
 
   /**
    * retrieves a certificate
@@ -44,7 +44,7 @@ export class CertManager {
   public async retrieveCertificate(domainName: string): Promise<Cert> {
     await this.checkCerts();
     const existingCertificate: Cert = await Cert.getInstance({
-      name: domainName
+      domainName
     });
 
     if(existingCertificate) {
@@ -61,10 +61,10 @@ export class CertManager {
    * @param privateKeyArg 
    * @param csrArg 
    */
-  public async storeCertificate(privateKeyArg: string, publicKeyArg: string, csrArg: string) {
+  public async storeCertificate(optionsArg: interfaces.ICert) {
-    const cert = new Cert(privateKeyArg, publicKeyArg, csrArg);
+    const cert = new Cert(optionsArg);
-    cert.save();
+    await cert.save();
-  };
+  }
 
   public async deleteCertificate(domainNameArg: string) {
 

ts/smartacme.classes.certmatcher.ts

@@ -0,0 +1,10 @@
+import * as plugins from './smartacme.plugins';
+
+export class CertMatcher {
+  public getCertificateDomainNameByDomainName(domainNameArg: string): string {
+    const originalDomain = new plugins.smartstring.Domain(domainNameArg);
+    if (!originalDomain.level4) {
+      return `${originalDomain.level2}.${originalDomain.level1}`;
+    }
+  }
+}

ts/smartacme.classes.smartacme.ts

@@ -1,11 +1,13 @@
 import * as plugins from './smartacme.plugins';
+import { Cert } from './smartacme.classes.cert';
 import { CertManager } from './smartacme.classes.certmanager';
+import { CertMatcher } from './smartacme.classes.certmatcher';
 
 import * as interfaces from './interfaces';
 import { request } from 'http';
 
 /**
- *
+ * the options for the class @see SmartAcme
  */
 export interface ISmartAcmeOptions {
   accountPrivateKey?: string;
@@ -13,9 +15,19 @@ export interface ISmartAcmeOptions {
   mongoDescriptor: plugins.smartdata.IMongoDescriptor;
   setChallenge: (domainName: string, keyAuthorization: string) => Promise<any>;
   removeChallenge: (domainName: string) => Promise<any>;
-  validateRemoteRequest: () => Promise<boolean>;
+  environment: 'production' | 'integration';
 }
 
+/**
+ * class SmartAcme
+ * can be used for setting up communication with an ACME authority
+ * 
+ * ```ts
+ * const mySmartAcmeInstance = new SmartAcme({
+ *  // see ISmartAcmeOptions for options
+ * })
+ * ```
+ */
 export class SmartAcme {
   private options: ISmartAcmeOptions;
 
@@ -29,11 +41,15 @@ export class SmartAcme {
   // challenge fullfillment
   private setChallenge: (domainName: string, keyAuthorization: string) => Promise<any>;
   private removeChallenge: (domainName: string) => Promise<any>;
-  private validateRemoteRequest: () => Promise<boolean>;
 
   // certmanager
   private certmanager: CertManager;
-  private certremoteHandler: plugins.smartexpress.Handler;
+  private certmatcher: CertMatcher;
+
+  /**
+   * the remote handler to hand the request and response to.
+   */
+  public certremoteHandler: (req: plugins.smartexpress.Request, res: plugins.smartexpress.Response) => Promise<any>;
 
   constructor(optionsArg: ISmartAcmeOptions) {
     this.options = optionsArg;
@@ -41,6 +57,9 @@ export class SmartAcme {
 
   /**
    * inits the instance
+   * ```ts
+   * await myCloudlyInstance.init() // does not support options
+   * ```
    */
   public async init() {
     this.privateKey =
@@ -54,8 +73,11 @@ export class SmartAcme {
     });
     await this.certmanager.init();
 
+    // CertMatcher
+    this.certmatcher = new CertMatcher();
+
     // CertRemoteHandler
-    this.certremoteHandler = new plugins.smartexpress.Handler('POST', async (req, res) => {
+    this.certremoteHandler = async (req, res) => {
       const requestBody: interfaces.ICertRemoteRequest = req.body;
       const status: interfaces.TCertStatus = await this.certmanager.getCertificateStatus(requestBody.domainName);
       const existingCertificate = await this.certmanager.retrieveCertificate(
@@ -66,13 +88,7 @@ export class SmartAcme {
          case 'existing':
           response = {
             status,
-            certificate: {
+            certificate: await existingCertificate.createSavableObject()
-              created: existingCertificate.created,
-              csr: existingCertificate.csr,
-              domainName: existingCertificate.domainName,
-              privateKey: existingCertificate.privateKey,
-              publicKey: existingCertificate.publicKey
-            }
           };
           break;
         default:
@@ -84,11 +100,17 @@ export class SmartAcme {
       res.status(200);
       res.send(response);
       res.end();
-    });
+    };
 
     // ACME Client
     this.client = new plugins.acme.Client({
-      directoryUrl: plugins.acme.directory.letsencrypt.staging,
+      directoryUrl: (() => {
+        if(this.options.environment === 'production') {
+          return plugins.acme.directory.letsencrypt.production;
+        } else {
+          return plugins.acme.directory.letsencrypt.staging;
+        }
+      })(),
       accountKey: this.privateKey
     });
 
@@ -99,10 +121,14 @@ export class SmartAcme {
     });
   }
 
-  public async getCertificateForDomain(domainArg: string) {
+  public async stop() {
-    const domain = domainArg;
+    await this.certmanager.smartdataDb.close();
+  }
 
-    const retrievedCertificate = await this.certmanager.retrieveCertificate(domain);
+  public async getCertificateForDomain(domainArg: string): Promise<Cert> {
+    const certDomain = this.certmatcher.getCertificateDomainNameByDomainName(domainArg);
+
+    const retrievedCertificate = await this.certmanager.retrieveCertificate(certDomain);
 
     if (retrievedCertificate) {
       return retrievedCertificate;
@@ -110,7 +136,7 @@ export class SmartAcme {
 
     /* Place new order */
     const order = await this.client.createOrder({
-      identifiers: [{ type: 'dns', value: domain }, { type: 'dns', value: `*.${domain}` }]
+      identifiers: [{ type: 'dns', value: certDomain }, { type: 'dns', value: `*.${certDomain}` }]
     });
 
     /* Get authorizations and select challenges */
@@ -129,6 +155,8 @@ export class SmartAcme {
         /* Satisfy challenge */
         await this.setChallenge(domainDnsName, keyAuthorization);
         await this.smartdns.checkUntilAvailable(domainDnsName, 'TXT', keyAuthorization, 100, 5000);
+        console.log('Cool down an extra 60 second for region availability');
+        await plugins.smartdelay.delayFor(60000);
 
         /* Verify that challenge is satisfied */
         await this.client.verifyChallenge(authz, dnsChallenge);
@@ -150,8 +178,8 @@ export class SmartAcme {
 
     /* Finalize order */
     const [key, csr] = await plugins.acme.forge.createCsr({
-      commonName: `*.${domain}`,
+      commonName: `*.${certDomain}`,
-      altNames: [domain]
+      altNames: [certDomain]
     });
 
     await this.client.finalizeOrder(order, csr);
@@ -162,6 +190,15 @@ export class SmartAcme {
     console.log(`Private key:\n${key.toString()}`);
     console.log(`Certificate:\n${cert.toString()}`);
 
-    this.certmanager.storeCertificate(key.toString(), cert.toString(), csr.toString());
+    await this.certmanager.storeCertificate({
+      domainName: certDomain,
+      privateKey: key.toString(),
+      publicKey: cert.toString(),
+      csr: csr.toString(),
+      created: Date.now()
+    });
+
+    const newCertificate = await this.certmanager.retrieveCertificate(certDomain);
+    return newCertificate;
   }
 }

ts/smartacme.plugins.ts

@@ -7,9 +7,10 @@ import * as smartexpress from '@pushrocks/smartexpress';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartunique from '@pushrocks/smartunique';
+import * as smartstring from '@pushrocks/smartstring';
 import * as smarttime from '@pushrocks/smarttime';
 
-export { lik, smartdata, smartdelay, smartdns, smartexpress, smartpromise, smartrequest, smartunique, smarttime };
+export { lik, smartdata, smartdelay, smartdns, smartexpress, smartpromise, smartrequest, smartunique, smartstring, smarttime };
 
 // thirs party scope
 import * as acme from 'acme-client';