Version 0.0.1 - Initial implementation

Author: bitifet

.gitignore

@@ -0,0 +1,31 @@
+# Vim
+**.sw*
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+

LICENSE

@@ -0,0 +1,154 @@
+
+ＮｅｔＪａｍ 🕸️
+===============
+
+> Network congestion simulator for TCP connections.
+
+
+Usage
+-----
+
+
+```sh
+user@host:~$ npx netjam --help
+
+netjam - Network (TCP) traffic jam simulator.
+
+SYNTAX: npx netjam <remoteHost> <remotePort> [listenPort]
+Where:
+    <remoteHost>  Network name or IP of remote host.
+    <remotePort>  Destination port number
+    [ListenPort]  Sourece port number to forward (default = 5000
+```
+
+
+Example
+-------
+
+Create a *jamable* TCP tunnel to local PostgreSQL Server listening in its
+default port (5432):
+
+```sh
+user@host:~$ npx netjam localhost 5432
+Server listening on port 5000
+
+STATUS:
+┌─────────────┬────────────────────────────┐
+│   (index)   │           Values           │
+├─────────────┼────────────────────────────┤
+│ remoteHost  │        'localhost'         │
+│ remotePort  │           '5432'           │
+│ listenPort  │            5000            │
+│  timestamp  │ '2024-08-06T18:52:11.042Z' │
+│   waiting   │             0              │
+│    open     │             0              │
+│   closed    │             0              │
+│  withError  │             0              │
+│     tx      │             0              │
+│     rx      │             0              │
+│  iputDelay  │             0              │
+│ outputDelay │             0              │
+│ logInterval │       '0 (Disabled)'       │
+└─────────────┴────────────────────────────┘
+
+AVAILABLE COMMANDS:
+  inputDelay    - Sets input delay to specified value
+  outputDelay   - Sets output delay to specified value
+  delay         - Sets overall balanced delay to specified value
+  logInterval   - Show/Set status (stderr) logging interval in msecs
+  quit          - Quit the program
+
+>
+```
+
+> 📌 Now, every time you hit the `Enter` key, you will get an updated *Status
+> Report* and a list of available commands.
+> 
+> Additionally, if you set logInterval to a non zero value, it will start
+> periodically logging status data in JSON format to *stderr*. You can use below
+> command instead of the previous one to keep it apart to a file:
+> 
+> ```sh
+> user@host:~$ npx netjam localhost 5432 2> netjam_log.json
+> ```
+
+
+Now you can open another terminal and connect to your local Postgres database
+throug port 5000:
+
+```sh
+user@host:~$ psql -h localhost -p 5000
+Contraseña para usuario user:
+user@constructor:~/112/mnt (master)$ LANG=C psql -h localhost -p 5000
+Password for user user:
+psql (15.7 (Ubuntu 15.7-1.pgdg22.04+1))
+SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, compression: off)
+Type "help" for help.
+
+user=>
+```
+
+This is a fully working conection with almost no penalty.
+
+Now, at netjam console, you can, for instance, set a 1 second delay for every
+round-trip (tx+rx) connection:
+
+
+
+```
+> delay 1000
+STATUS:
+┌─────────────┬────────────────────────────┐
+│   (index)   │           Values           │
+├─────────────┼────────────────────────────┤
+│ remoteHost  │        'localhost'         │
+│ remotePort  │           '5432'           │
+│ listenPort  │            5000            │
+│  timestamp  │ '2024-08-06T19:02:33.886Z' │
+│   waiting   │             0              │
+│    open     │             3              │
+│   closed    │             3              │
+│  withError  │             0              │
+│     tx      │             20             │
+│     rx      │             21             │
+│  iputDelay  │             0              │
+│ outputDelay │            500             │
+│ inputDelay  │            500             │
+│ logInterval │       '0 (Disabled)'       │
+└─────────────┴────────────────────────────┘
+
+AVAILABLE COMMANDS:
+  inputDelay    - Sets input delay to specified value
+  outputDelay   - Sets output delay to specified value
+  delay         - Sets overall balanced delay to specified value
+  logInterval   - Show/Set status (stderr) logging interval in msecs
+  quit          - Quit the program
+
+> 
+```
+
+Now your PostgreSQL connection still works, but a little bit slower... 😉
+
+
+<a name="contributing"></a>Contributing
+---------------------------------------
+
+If you are interested in contributing with this project, you can do it in many ways:
+
+  * Creating and/or mantainig documentation.
+
+  * Implementing new features or improving code implementation.
+
+  * Reporting bugs and/or fixing it.
+  
+  * Sending me any other feedback.
+
+  * Whatever you like...
+    
+Please, contact-me, open issues or send pull-requests thought [this project GIT repository](https://github.com/bitifet/netjam)
+
+
+License
+-------
+
+  [GPLv3](LICENSE)

README.md

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+"use strict";
+
+const net = require('net');
+
+const status = require("./src/status");
+const handleClient = require("./src/clientHandler");
+const {welcome} = require("./src/console");
+
+
+
+
+// Crear el servidor TCP
+const server = net.createServer(handleClient);
+
+server.listen(status.listenPort, () => {
+  console.log(`Server listening on port ${status.listenPort}`);
+  welcome();
+});
+

index.js

@@ -0,0 +1,29 @@
+{
+  "name": "netjam",
+  "version": "0.0.1",
+  "description": "Network congestion simulator for TCP connections.",
+  "main": "index.js",
+  "bin": {
+    "netjam": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bitifet/netjam.git"
+  },
+  "keywords": [
+    "network",
+    "congestion",
+    "bottleneck",
+    "traffic",
+    "simulator"
+  ],
+  "author": "Joan Miquel Torres <[email protected]>",
+  "license": "GPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/bitifet/netjam/issues"
+  },
+  "homepage": "https://github.com/bitifet/netjam#readme"
+}

package.json

@@ -0,0 +1,91 @@
+"use strict";
+const status = require("./status");
+const net = require('net');
+let connCount = 0;
+
+
+
+module.exports = function handleClient(clientSocket) {
+  ///console.log('Client connected:', clientSocket.remoteAddress, clientSocket.remotePort);
+
+  const connId = connCount++;
+
+  let closed = false;
+  function flagClosed(hadError) {
+      if (closed) return;
+      status.stats.closed++;
+      if (hadError) status.stats.withError++;
+      status.allConnections.delete(connId);
+      closed = true;
+  };
+
+  status.stats.waiting++;
+
+  // Crear un socket per a connectar al servidor remot
+  const remoteSocket = new net.Socket();
+
+
+  status.allConnections.set(connId, {
+      clientSocket,
+      remoteSocket,
+  });
+
+
+  remoteSocket.connect(status.remotePort, status.remoteHost, (c) => {
+    ///console.log('Connected to remote server');
+    status.stats.open++;
+    status.stats.waiting--;
+  });
+
+  // Manejar dades del client
+  clientSocket.on('data', (data) => {
+
+    ///console.log('Data from client:', data.toString());
+    status.stats.tx++;
+
+    // Implementar un retard de 1 segon abans d'enviar les dades al servidor remot
+    setTimeout(() => {
+      remoteSocket.write(data);
+    }, status.cfg.outputDelay);
+  });
+
+  // Manejar dades del servidor remot
+  remoteSocket.on('data', (data) => {
+
+    ///console.log('Data from remote server:', data.toString());
+    status.stats.rx++;
+
+    // Implementar un retard de 1 segon abans d'enviar les dades al client
+    setTimeout(() => {
+      clientSocket.write(data);
+    }, status.cfg.inputDelay);
+  });
+
+  // Manejar el tancament de la connexió del client
+  clientSocket.on('close', (hadError) => {
+    ///console.log('Client connection closed', hadError ? 'with error' : 'cleanly');
+    flagClosed(hadError);
+    remoteSocket.end();
+  });
+
+  // Manejar el tancament de la connexió remota
+  remoteSocket.on('close', (hadError) => {
+    ///console.log('Remote connection closed', hadError ? 'with error' : 'cleanly');
+    flagClosed(hadError);
+    clientSocket.end();
+  });
+
+  // Manejar errors de connexió del client
+  clientSocket.on('error', (err) => {
+    ///console.error('Client socket error:', err);
+    flagClosed(true);
+    remoteSocket.destroy();
+  });
+
+  // Manejar errors de connexió remota
+  remoteSocket.on('error', (err) => {
+    ///console.error('Remote socket error:', err);
+    flagClosed(true);
+    clientSocket.destroy();
+  });
+};