2.0.0

.gitlab-ci.yml

@@ -1,12 +1,10 @@
 # gitzone ci_default
 image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-variables:
-  GIT_STRATEGY: clone
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -22,17 +20,19 @@ 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
 
@@ -49,6 +49,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - priv
 
@@ -56,22 +57,24 @@ testBuild:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
     - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -83,9 +86,11 @@ codequality:
   allow_failure: true
   script:
     - 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
 
@@ -96,20 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartproxy",
-  "version": "1.0.26",
+  "version": "2.0.0",
   "private": false,
   "description": "a proxy for handling high workloads of proxying",
   "main": "dist/index.js",
@@ -14,29 +14,31 @@
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.7.5",
+    "@types/node": "^13.7.0",
-    "tslint": "^5.20.0",
+    "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartnetwork": "^1.1.14",
+    "@pushrocks/lik": "^3.0.16",
-    "@pushrocks/smartpromise": "^3.0.5",
+    "@pushrocks/smartnetwork": "^1.1.18",
-    "@pushrocks/smartrequest": "^1.1.27",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.47",
     "@pushrocks/smartspawn": "^2.0.9",
+    "@pushrocks/smartstring": "^3.0.18",
     "@pushrocks/smartsystem": "^2.0.9",
-    "@tsclass/tsclass": "^2.0.6",
+    "@tsclass/tsclass": "^3.0.3",
-    "@types/ws": "^6.0.3",
+    "@types/ws": "^7.2.1",
-    "ws": "^7.1.2"
+    "ws": "^7.2.1"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_web/**/*",
-    "dist_ts_web/*",
+    "dist_ts_web/**/*",
-    "assets/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,7 +8,7 @@ a proxy for handling high workloads of proxying
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartproxy/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartproxy/badges/master/build.svg)](https://gitlab.com/pushrocks/smartproxy/commits/master)
+[![pipeline status](https://gitlab.com/pushrocks/smartproxy/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartproxy/commits/master)
 [![coverage report](https://gitlab.com/pushrocks/smartproxy/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartproxy/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartproxy.svg)](https://www.npmjs.com/package/@pushrocks/smartproxy)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartproxy/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartproxy)
@@ -18,6 +18,11 @@ a proxy for handling high workloads of proxying
 
 ## Usage
 
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -4,7 +4,7 @@ import * as smartproxy from '../ts/index';
 let testProxy: smartproxy.SmartProxy;
 
 tap.test('first test', async () => {
-  testProxy = new smartproxy.SmartProxy();
+  testProxy = new smartproxy.SmartProxy({});
 });
 
 tap.test('should start the testproxy', async () => {
@@ -12,10 +12,11 @@ tap.test('should start the testproxy', async () => {
 });
 
 tap.test('should supply reverse proxy config', async () => {
-  testProxy.updateReversConfigs([{
+  testProxy.updateReversConfigs([
+    {
       destinationIp: 'localhost',
-    destinationPort: '8080',
+      destinationPort: '3000',
-    hostName: 'central.eu',
+      hostName: 'push.rocks',
       privateKey: `-----BEGIN PRIVATE KEY-----
 MIIJRQIBADANBgkqhkiG9w0BAQEFAASCCS8wggkrAgEAAoICAQDi2F/0kQr96mhe
 3yEWvy2mRHOZoSSBtIqg6Bre4ZcMu901/cHNIjFnynNGFl9Se61yZbW2F3PfCt7+
@@ -97,11 +98,12 @@ r8d9QwrK+WaqVi2ofbMfMByVF72jgeJNa4nxwT9bVbu/Q1T2Lt+YPb4pQ7yCoUgS
 JNj2Dr5H0XoLFFnvuvzcRbhlJ9J67JzR+7g=
 -----END CERTIFICATE-----
     `
-  }]);
+    }
+  ]);
 });
 
 tap.test('should wait for 60 seconds', async tools => {
-  await tools.delayFor(60000);
+  await tools.delayFor(10000);
 });
 
 tap.test('should close the testproxy', async () => {

ts/smartproxy.classes.proxyworker.ts

@@ -3,16 +3,24 @@ import * as plugins from './smartproxy.plugins';
 import { SmartproxyRouter } from './smartproxy.classes.router';
 
 export class ProxyWorker {
-  public hostCandidates: plugins.tsclass.network.IReverseProxyConfig[] = [];
+  public proxyConfigs: plugins.tsclass.network.IReverseProxyConfig[] = [];
   public httpsServer: plugins.https.Server; // | plugins.http.Server;
   public port = 8001;
   public router = new SmartproxyRouter();
+  public socketMap = new plugins.lik.Objectmap<plugins.net.Socket>();
 
   /**
    * starts the proxyInstance
    */
   public async start() {
-    this.httpsServer = plugins.https.createServer({
+    this.httpsServer = plugins.https.createServer(
+      // ================
+      // Spotted this keypair in the code?
+      // Don't get exited:
+      // It is an invalid default keypair.
+      // For proper requests custom domain level keypairs are used that are provided in the reverse config
+      // ================
+      {
         key: `-----BEGIN PRIVATE KEY-----
 MIIJRQIBADANBgkqhkiG9w0BAQEFAASCCS8wggkrAgEAAoICAQDi2F/0kQr96mhe
 3yEWvy2mRHOZoSSBtIqg6Bre4ZcMu901/cHNIjFnynNGFl9Se61yZbW2F3PfCt7+
@@ -94,18 +102,78 @@ r8d9QwrK+WaqVi2ofbMfMByVF72jgeJNa4nxwT9bVbu/Q1T2Lt+YPb4pQ7yCoUgS
 JNj2Dr5H0XoLFFnvuvzcRbhlJ9J67JzR+7g=
 -----END CERTIFICATE-----
     `
-    }, async (req, res) => {
+      },
+      async (req, res) => {
         console.log('got request');
         const destinationConfig = this.router.routeReq(req);
+
+        // endRequest function
+        const endRequest = (
+          statusArg: number = 404,
+          messageArg: string = 'This route is not available on this server.',
+          headers: plugins.http.OutgoingHttpHeaders = {}
+        ) => {
+          res.writeHead(statusArg, messageArg);
+          res.end(messageArg);
+        };
+
+        // authentication
+        if (destinationConfig.authentication) {
+          const authInfo = destinationConfig.authentication;
+          switch (authInfo.type) {
+            case 'Basic':
+              const authHeader = req.headers.authorization;
+              if (authHeader) {
+                if (!authHeader.includes('Basic ')) {
+                  return endRequest(401, 'Authentication required', {
+                    'WWW-Authenticate': 'Basic realm="Access to the staging site", charset="UTF-8"'
+                  });
+                }
+                const authStringBase64 = req.headers.authorization.replace('Basic ', '');
+                const authString: string = plugins.smartstring.base64.decode(authStringBase64);
+                const userPassArray = authString.split(':');
+                const user = userPassArray[0];
+                const pass = userPassArray[1];
+                if (user === authInfo.user && pass === authInfo.pass) {
+                  console.log('request successfully authenticated');
+                } else {
+                  return endRequest(403, 'Forbidden: Wrong credentials');
+                }
+              }
+              break;
+            default:
+              return endRequest(
+                403,
+                'Forbidden: unsupported authentication method configured. Please report to the admin.'
+              );
+          }
+        }
+
+        let destinationUrl: string;
+        if (destinationConfig) {
+          destinationUrl = `http://${destinationConfig.destinationIp}:${destinationConfig.destinationPort}${req.url}`;
+        } else {
+          return endRequest();
+        }
+        console.log(destinationUrl);
         const response = await plugins.smartrequest.request(
-        `http://${destinationConfig.destinationIp}:${destinationConfig.destinationPort}${req.url}`,
+          destinationUrl,
           {
             method: req.method,
             headers: req.headers
           },
-        true // lets make this streaming
+          true, // lets make this streaming
+          request => {
+            req.on('data', data => {
+              request.write(data);
+            });
+            req.on('end', data => {
+              request.end();
+            });
+          }
         );
         res.statusCode = response.statusCode;
+        console.log(response.statusCode);
         for (const header of Object.keys(response.headers)) {
           res.setHeader(header, response.headers[header]);
         }
@@ -115,17 +183,20 @@ JNj2Dr5H0XoLFFnvuvzcRbhlJ9J67JzR+7g=
         response.on('end', () => {
           res.end();
         });
-    });
+      }
-
+    );
-    const Websocket = await import('ws');
 
     // Enable websockets
     const wss = new plugins.ws.Server({ server: this.httpsServer });
-    wss.on('connection', function connection(ws) {
+    wss.on('connection', (ws: plugins.wsDefault) => {
       console.log('got connection for wsc');
       const wscConnected = plugins.smartpromise.defer();
 
-      const wsc = new Websocket.default(`${ws.url}`);
+      const wsc = new plugins.wsDefault(this.router.routeWs(ws), {
+        headers: {
+          Host: ws.url
+        }
+      });
       wsc.on('open', () => {
         wscConnected.resolve();
       });
@@ -146,19 +217,28 @@ JNj2Dr5H0XoLFFnvuvzcRbhlJ9J67JzR+7g=
         ws.close();
       });
     });
+    this.httpsServer.keepAliveTimeout = 61000;
+    this.httpsServer.headersTimeout = 65000;
+
+    this.httpsServer.on('connection', connection => {
+      this.socketMap.add(connection);
+      connection.on('close', () => {
+        this.socketMap.remove(connection);
+      });
+    });
 
     this.httpsServer.listen(this.port);
-    console.log(`OK: now listening for new connections on port ${this.port}`);
+    console.log(`ProxyWorker -> OK: now listening for new connections on port ${this.port}`);
   }
 
-  public async updateCandidates(arrayOfReverseCandidates: plugins.tsclass.IReverseProxyConfig[]) {
+  public async updateProxyConfigs(proxyConfigsArg: plugins.tsclass.network.IReverseProxyConfig[]) {
-    this.hostCandidates = arrayOfReverseCandidates;
+    this.proxyConfigs = proxyConfigsArg;
-    this.router.setNewCandidates(arrayOfReverseCandidates);
+    this.router.setNewProxyConfigs(proxyConfigsArg);
-    for (const hostCandidate of this.hostCandidates) {
+    for (const hostCandidate of this.proxyConfigs) {
       // console.log(hostCandidate);
       this.httpsServer.addContext(hostCandidate.hostName, {
         cert: hostCandidate.publicKey,
-        key: hostCandidate.privateKey,
+        key: hostCandidate.privateKey
       });
     }
     /* this.httpsServer.close();
@@ -170,6 +250,9 @@ JNj2Dr5H0XoLFFnvuvzcRbhlJ9J67JzR+7g=
     this.httpsServer.close(() => {
       done.resolve();
     });
+    await this.socketMap.forEach(async socket => {
+      socket.destroy();
+    });
     await done.promise;
   }
 }
@@ -185,7 +268,7 @@ const proxyWorkerCalls = {
     await proxyWorkerInstance.start();
   },
   updateReverseConfigs: async (configArray: plugins.tsclass.network.IReverseProxyConfig[]) => {
-    await proxyWorkerInstance.updateCandidates(configArray);
+    await proxyWorkerInstance.updateProxyConfigs(configArray);
   }
 };
 

ts/smartproxy.classes.router.ts

@@ -1,20 +1,32 @@
 import * as plugins from './smartproxy.plugins';
 
 export class SmartproxyRouter {
-  public reverseCandidates: plugins.tsclass.network.IReverseProxyConfig[] = [];
+  public reverseProxyConfigs: plugins.tsclass.network.IReverseProxyConfig[] = [];
 
   /**
    * sets a new set of reverse configs to be routed to
    * @param reverseCandidatesArg
    */
-  public setNewCandidates(reverseCandidatesArg: plugins.tsclass.network.IReverseProxyConfig[]) {
+  public setNewProxyConfigs(reverseCandidatesArg: plugins.tsclass.network.IReverseProxyConfig[]) {
-    this.reverseCandidates = reverseCandidatesArg;
+    this.reverseProxyConfigs = reverseCandidatesArg;
   }
+
+  /**
+   * routes a request
+   */
   public routeReq(req: plugins.http.IncomingMessage): plugins.tsclass.network.IReverseProxyConfig {
     const originalHost = req.headers.host;
-    const correspodingReverseProxyConfig = this.reverseCandidates.find(reverseConfig => {
+    const correspodingReverseProxyConfig = this.reverseProxyConfigs.find(reverseConfig => {
       return reverseConfig.hostName === originalHost;
     });
     return correspodingReverseProxyConfig;
   }
+
+  public routeWs(ws: plugins.wsDefault) {
+    const originalHost = plugins.url.parse(ws.url).host;
+    const correspodingReverseProxyConfig = this.reverseProxyConfigs.find(reverseConfig => {
+      return reverseConfig.hostName === originalHost;
+    });
+    return correspodingReverseProxyConfig.destinationIp;
+  }
 }

ts/smartproxy.classes.smartproxy.ts

@@ -3,13 +3,23 @@ import * as plugins from './smartproxy.plugins';
 import { TProxyWorkerCalls } from './smartproxy.classes.proxyworker';
 import { TPortProxyCalls } from './smartproxy.portproxy';
 
+export interface ISmartProxyOptions {
+  port?: number;
+}
+
 export class SmartProxy {
   public smartsystem = new plugins.smartsystem.Smartsystem();
   public reverseConfigs: plugins.tsclass.network.IReverseProxyConfig[] = [];
   public proxyWorkerFunctions: plugins.smartspawn.ModuleThread<TProxyWorkerCalls>;
   public portProxyFunctions: plugins.smartspawn.ModuleThread<TPortProxyCalls>;
 
-  public async updateReversConfigs(
+  public options: ISmartProxyOptions;
+
+  constructor(optionsArg: ISmartProxyOptions = {}) {
+    this.options = optionsArg;
+  }
+
+  public async updateReverseConfigs(
     reverseConfigsArg: plugins.tsclass.network.IReverseProxyConfig[]
   ) {
     // TODO search for old hostCandidates with that target
@@ -28,6 +38,8 @@ export class SmartProxy {
     this.portProxyFunctions = await plugins.smartspawn.spawn<TPortProxyCalls>(
       new plugins.smartspawn.Worker('./smartproxy.portproxy')
     );
+
+    await this.portProxyFunctions.start(this.options.port);
     await this.proxyWorkerFunctions.start();
 
     console.log('successfully spawned portproxy and proxyworkers!');

ts/smartproxy.plugins.ts

@@ -1,8 +1,10 @@
 // node native scope
 import * as http from 'http';
 import * as https from 'https';
+import * as net from 'net';
+import * as url from 'url';
 
-export { http, https };
+export { http, https, net, url };
 
 // tsclass scope
 import * as tsclass from '@tsclass/tsclass';
@@ -10,14 +12,17 @@ import * as tsclass from '@tsclass/tsclass';
 export { tsclass };
 
 // pushrocks scope
+import * as lik from '@pushrocks/lik';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartspawn from '@pushrocks/smartspawn';
+import * as smartstring from '@pushrocks/smartstring';
 import * as smartsystem from '@pushrocks/smartsystem';
 
-export { smartrequest, smartpromise, smartspawn, smartsystem };
+export { lik, smartrequest, smartpromise, smartspawn, smartstring, smartsystem };
 
 // third party scope
 import * as ws from 'ws';
+import wsDefault from 'ws';
 
-export { ws };
+export { wsDefault, ws };

ts/smartproxy.portproxy.ts

@@ -1,7 +1,11 @@
 import * as plugins from './smartproxy.plugins';
 import { expose } from '@pushrocks/smartspawn';
 import * as net from 'net';
-const server = net
+let netServer: plugins.net.Server;
+
+const portProxyCalls = {
+  start: async (portArg = 8000) => {
+    netServer = net
       .createServer(from => {
         const to = net.createConnection({
           host: 'localhost',
@@ -10,12 +14,12 @@ const server = net
         from.pipe(to);
         to.pipe(from);
       })
-  .listen(8000);
+      .listen(portArg);
-
+    console.log(`PortProxy -> OK: Now listening on port ${portArg}`);
-const portProxyCalls = {
+  },
   stop: async () => {
     const done = plugins.smartpromise.defer();
-    server.close(() => {
+    netServer.close(() => {
       done.resolve();
     });
     await done.promise;