2.1.2

.gitignore

@@ -1,5 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
-.nogit/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -20,62 +20,27 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - docker
     - notpriv
 
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
     - npmci npm prepare
@@ -84,6 +49,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -95,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +83,14 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,24 +1,19 @@
-# smartacme
+# @pushrocks/smartuniverse
+acme with an easy yet powerful interface in TypeScript
 
-acme implementation in TypeScript
-
-## Availabililty
-
-[![npm](https://umbrellazone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartacme)
-[![git](https://umbrellazone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/umbrellazone/smartacme)
-[![git](https://umbrellazone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/umbrellazone/smartacme)
-[![docs](https://umbrellazone.gitlab.io/assets/repo-button-docs.svg)](https://umbrellazone.gitlab.io/smartacme/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
+* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/umbrellazone/smartacme/badges/master/build.svg)](https://GitLab.com/umbrellazone/smartacme/commits/master)
-[![coverage report](https://GitLab.com/umbrellazone/smartacme/badges/master/coverage.svg)](https://GitLab.com/umbrellazone/smartacme/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartacme.svg)](https://www.npmjs.com/package/smartacme)
-[![Dependency Status](https://david-dm.org/umbrellazone/smartacme.svg)](https://david-dm.org/umbrellazone/smartacme)
-[![bitHound Dependencies](https://www.bithound.io/github/umbrellazone/smartacme/badges/dependencies.svg)](https://www.bithound.io/github/umbrellazone/smartacme/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/umbrellazone/smartacme/badges/code.svg)](https://www.bithound.io/github/umbrellazone/smartacme)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
@@ -28,36 +23,14 @@ Use TypeScript for best in class instellisense.
 ```javascript
 import { SmartAcme } from 'smartacme';
 
-let smac = new SmartAcme()(async () => {
-  // learn async/await, it'll make your life easier
+let smac = new SmartAcme()
 
-  // optionally accepts a filePath Arg with a stored acmeaccount.json
-  // will create an account and
-  let myAccount = await smac.createAcmeAccount();
-
-  // will return a dnsHash to set in your DNS record
-  let myCert = await myAccount.createAcmeCert('example.com');
-
-  // gets and accepts the specified challenge
-  // first argument optional, defaults to dns-01 (which is the cleanest method for production use)
-  let myChallenge = await myCert.getChallenge('dns-01');
-
-  /* ----------
-    Now you need to set the challenge in your DNS
-    myChallenge.domainNamePrefixed is the address for the record
-    myChallenge.dnsKeyHash is the ready to use txt record value expected by letsencrypt
-    -------------*/
-})();
+// TODO
 ```
 
-## Other relevant npm modules
-
-| module name | description                                                         |
-| ----------- | ------------------------------------------------------------------- |
-| cert        | a higlevel production module that uses smartacme to manage certs    |
-| smartnginx  | a highlevel production tool for docker environments to manage nginx |
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://umbrellazone.gitlab.io/assets/repo-footer.svg)](https://umbrella.zone
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -1,4 +1,16 @@
 {
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartuniverse",
+      "shortDescription": "acme with an easy yet powerful interface in TypeScript",
+      "npmPackagename": "@pushrocks/smartuniverse",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.32",
+  "version": "2.1.2",
   "private": false,
-  "description": "acme implementation in TypeScript",
+  "description": "acme with an easy yet powerful interface in TypeScript",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
@@ -25,28 +25,39 @@
   },
   "homepage": "https://gitlab.com/umbrellazone/smartacme#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
-    "@pushrocks/smartdata": "^3.1.13",
-    "@pushrocks/smartdelay": "^2.0.2",
+    "@pushrocks/lik": "^3.0.17",
+    "@pushrocks/smartdata": "^3.1.25",
+    "@pushrocks/smartdelay": "^2.0.6",
     "@pushrocks/smartdns": "^3.0.8",
-    "@pushrocks/smartexpress": "^3.0.6",
-    "@pushrocks/smartlog": "^2.0.11",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartrequest": "^1.1.14",
-    "@pushrocks/smartstring": "^3.0.8",
-    "@pushrocks/smarttime": "^3.0.5",
+    "@pushrocks/smartexpress": "^3.0.57",
+    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartstring": "^3.0.18",
+    "@pushrocks/smarttime": "^3.0.12",
     "@pushrocks/smartunique": "^3.0.1",
-    "acme-client": "2.2.2"
+    "acme-client": "^3.3.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@mojoio/cloudflare": "^2.0.0",
-    "@pushrocks/qenv": "^4.0.0",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.18",
-    "tslint": "^5.12.1",
-    "tslint-config-prettier": "^1.17.0"
-  }
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@mojoio/cloudflare": "^3.0.5",
+    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.7.0",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -22,10 +22,13 @@ tap.test('should create a valid instance of SmartAcme', async () => {
     setChallenge: async (...args) => {
       console.log(args);
     },
-    environment: "integration"
+    environment: 'integration'
   });
   await smartAcmeInstance.init();
-  // await smartAcmeInstance.getCertificateForDomain('bleu.de');
+});
+
+tap.test('should get a domain certificate', async () => {
+  await smartAcmeInstance.getCertificateForDomain('bleu.de');
 });
 
 tap.test('certmatcher should correctly match domains', async () => {

ts/smartacme.classes.cert.ts

@@ -5,7 +5,6 @@ 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;
@@ -29,7 +28,28 @@ export class Cert extends plugins.smartdata.SmartDataDbDoc<Cert> implements inte
   @svDb()
   public csr: string;
 
-  constructor(optionsArg: ICert) {
+  /**
+   * computed value for when the certificate is still valid
+   */
+  get validUntil(): number {
+    return (
+      this.created +
+      plugins.smarttime.getMilliSecondsFromUnits({
+        days: 90
+      })
+    );
+  }
+
+  get isStillValid(): boolean {
+    const shouldBeValitAtLeastUntil =
+      Date.now() +
+      plugins.smarttime.getMilliSecondsFromUnits({
+        days: 10
+      });
+    return this.validUntil >= shouldBeValitAtLeastUntil;
+  }
+
+  constructor(optionsArg: interfaces.ICert) {
     super();
     if (optionsArg) {
       Object.keys(optionsArg).forEach(key => {

ts/smartacme.classes.certmanager.ts

@@ -4,14 +4,12 @@ import { SmartAcme } from './smartacme.classes.smartacme';
 
 import * as interfaces from './interfaces';
 
-
 export class CertManager {
   // =========
   // STATIC
   // =========
   public static activeDB: plugins.smartdata.SmartdataDb;
 
-  
   // =========
   // INSTANCE
   // =========
@@ -20,13 +18,16 @@ export class CertManager {
 
   public pendingMap: plugins.lik.Stringmap;
 
-  constructor(smartAcmeArg: SmartAcme,optionsArg: {
+  constructor(
+    smartAcmeArg: SmartAcme,
+    optionsArg: {
       mongoDescriptor: plugins.smartdata.IMongoDescriptor;
-  }) {
+    }
+  ) {
     this.mongoDescriptor = optionsArg.mongoDescriptor;
   }
 
-  public async init () {
+  public async init() {
     // Smartdata DB
     this.smartdataDb = new plugins.smartdata.SmartdataDb(this.mongoDescriptor);
     await this.smartdataDb.init();
@@ -47,12 +48,11 @@ export class CertManager {
       domainName
     });
 
-    if(existingCertificate) {
+    if (existingCertificate) {
       return existingCertificate;
     } else {
       return null;
     }
-
   }
 
   /**
@@ -65,14 +65,12 @@ export class CertManager {
     this.pendingMap.removeString(optionsArg.domainName);
   }
 
-  public async deleteCertificate(domainNameArg: string) {
-
-  }
+  public async deleteCertificate(domainNameArg: string) {}
 
   /**
    * announce a certificate as being in the process of being retrieved
    */
-  public async announceCertificate (domainNameArg: string) {
+  public async announceCertificate(domainNameArg: string) {
     this.pendingMap.addString(domainNameArg);
   }
 
@@ -100,5 +98,5 @@ export class CertManager {
    */
   private async checkCerts() {
     // TODO
-  };
+  }
 }

ts/smartacme.classes.certmatcher.ts

@@ -1,6 +1,15 @@
 import * as plugins from './smartacme.plugins';
+import * as interfaces from './interfaces';
 
+/**
+ * certmatcher is responsible for matching certificates
+ */
 export class CertMatcher {
+  /**
+   * creates a domainName for the certificate that will include the broadest scope
+   * for wild card certificates
+   * @param domainNameArg the domainNameArg to create the scope from
+   */
   public getCertificateDomainNameByDomainName(domainNameArg: string): string {
     const originalDomain = new plugins.smartstring.Domain(domainNameArg);
     if (!originalDomain.level4) {

ts/smartacme.classes.certremoteclient.ts

@@ -26,18 +26,17 @@ export class CertRemoteClient {
   public async getCertificateForDomain(domainNameArg: string): Promise<interfaces.ICert> {
     let certificate: interfaces.ICert;
     const doRequestCycle = async (): Promise<interfaces.ICert> => {
-      const responseBody: interfaces.ICertRemoteResponse = (await plugins.smartrequest.postJson(
-        this.remoteUrl,
-        {
+      const responseBody: interfaces.ICertRemoteResponse = (
+        await plugins.smartrequest.postJson(this.remoteUrl, {
           requestBody: <interfaces.ICertRemoteRequest>{
             domainName: domainNameArg,
             secret: this.secret
           }
-        }
-      )).body;
-      console.log(responseBody);
+        })
+      ).body;
       switch (responseBody.status as interfaces.TCertStatus) {
         case 'pending':
+          this.logger.log('info', `request for ${domainNameArg} still pending!`);
           await plugins.smartdelay.delayFor(5000);
           const finalResponse = await doRequestCycle();
           return finalResponse;

ts/smartacme.classes.smartacme.ts

@@ -56,9 +56,11 @@ export class SmartAcme {
     res: plugins.smartexpress.Response
   ) => {
     const requestBody: interfaces.ICertRemoteRequest = req.body;
+    this.logger.log('ok', `got certificate request for ${requestBody.domainName}`);
     const certDomain = this.certmatcher.getCertificateDomainNameByDomainName(
       requestBody.domainName
     );
+    this.logger.log('ok', `mapping ${requestBody.domainName} to ${certDomain}`);
     let status: interfaces.TCertStatus = await this.certmanager.getCertificateStatus(certDomain);
     let response: interfaces.ICertRemoteResponse;
     switch (status) {
@@ -66,9 +68,9 @@ export class SmartAcme {
         this.logger.log('ok', `certificate exists for ${certDomain}. Sending certificate!`);
         response = {
           status,
-          certificate: await (await this.certmanager.retrieveCertificate(
-            certDomain
-          )).createSavableObject()
+          certificate: await (
+            await this.certmanager.retrieveCertificate(certDomain)
+          ).createSavableObject()
         };
         break;
       default:
@@ -84,7 +86,7 @@ export class SmartAcme {
     res.status(200);
     res.send(response);
     res.end();
-  }
+  };
 
   constructor(optionsArg: ISmartAcmeOptions) {
     this.options = optionsArg;
@@ -101,7 +103,7 @@ export class SmartAcme {
    */
   public async init() {
     this.privateKey =
-      this.options.accountPrivateKey || (await plugins.acme.forge.createPrivateKey());
+      this.options.accountPrivateKey || (await plugins.acme.forge.createPrivateKey()).toString();
     this.setChallenge = this.options.setChallenge;
     this.removeChallenge = this.options.removeChallenge;
 
@@ -137,18 +139,36 @@ export class SmartAcme {
     await this.certmanager.smartdataDb.close();
   }
 
+  /**
+   * gets a certificate
+   * it runs through the following steps
+   *
+   * * look in the database
+   * * if in the database return it
+   * * of not in the database announce it
+   * * then get it from letsencrypt
+   * * store it
+   * * remove it from the pending map (which it go onto by announcing it)
+   * * retrieve it from the databse and return it
+   *
+   * @param domainArg
+   */
   public async getCertificateForDomain(domainArg: string): Promise<Cert> {
     const certDomain = this.certmatcher.getCertificateDomainNameByDomainName(domainArg);
-    await this.certmanager.announceCertificate(certDomain);
     const retrievedCertificate = await this.certmanager.retrieveCertificate(certDomain);
 
     if (retrievedCertificate) {
       return retrievedCertificate;
+    } else {
+      await this.certmanager.announceCertificate(certDomain);
     }
 
     /* Place new order */
     const order = await this.client.createOrder({
-      identifiers: [{ type: 'dns', value: certDomain }, { type: 'dns', value: `*.${certDomain}` }]
+      identifiers: [
+        { type: 'dns', value: certDomain },
+        { type: 'dns', value: `*.${certDomain}` }
+      ]
     });
 
     /* Get authorizations and select challenges */

ts/smartacme.plugins.ts

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