Bidirectional forwarding

Send target response to Webhook.site
Increase minimum node version to 16 (due to AbortSignal.timeout)
Adds version number output to "help" command
Version 0.2.0

Author: fredsted

.nvmrc

@@ -1 +1 @@
-v14
+v16

README.md

@@ -16,7 +16,7 @@ If you have installed [Docker](https://docs.docker.com/get-docker/), you can sim
 
 ### Node.js
 
-[Node](https://nodejs.org/en/download) version 14 or greater required.
+[Node](https://nodejs.org/en/download) version 16 or greater required.
 
 To install: `npm install -g @webhooksite/cli`
 

commands/forward.js

@@ -1,35 +1,66 @@
-import fetch from "node-fetch";
+import fetch, {Response} from "node-fetch";
 import listen from "./lib/listen.js";
 import replaceVariables from "./lib/replace-variables.js";
 import log from "./lib/log.js";
+import {setApiKey, setResponse, updateTokenListen} from "./lib/api.js";
+
+const getTargetPath = function (url) {
+    // We only want the `/a/b/c` part:
+    // https://my-url.webhook.site/a/b/c
+    const pathMatchDomain = url.match(/https?:\/\/[a-zA-Z0-9-]{3,36}\.webhook\.site(\/[^?#]+)/)
+    if (pathMatchDomain) {
+        return pathMatchDomain[1];
+    }
+
+    // We only want the `/a/b/c` part:
+    // https://webhook.site/00000000-0000-0000-00000-000000000000/a/b/c
+    const pathMatch = url.match(/https?:\/\/[^\/]*\/[a-z0-9-]+(\/[^?#]+)/)
+    return pathMatch ? pathMatch[1] : '';
+}
 
 export default async (argv) => {
     if (!argv.token && !process.env.WH_TOKEN) {
         throw new Error('Please specify a token (--token)')
     }
+    const tokenId = argv.token ?? process.env.WH_TOKEN;
+    const apiKey = argv['api-key'] ?? process.env.WH_API_KEY;
+    const listenSeconds = argv['listen-timeout'] ?? process.env.WH_LISTEN_TIMEOUT ?? 5;
+
+    setApiKey(apiKey);
+
+    // Listen for the amount of seconds
+    await updateTokenListen(tokenId, listenSeconds);
+
+    const clearTokenListen = async function () {
+        await updateTokenListen(tokenId, 0);
+        process.exit()
+    }
+
+    // Remove token listening on exit
+    process.on('exit', clearTokenListen)
+    process.on('SIGINT', clearTokenListen)
 
     listen(
-        argv.token ?? process.env.WH_TOKEN,
-        argv['api-key'] ?? process.env.WH_API_KEY,
+        tokenId,
+        apiKey,
         (data) => {
             let target = replaceVariables(argv.target ?? process.env.WH_TARGET ?? 'https://localhost', data.variables)
 
             if (!argv['keep-url']) {
+                let path = '';
                 const query = data.request.query !== null
                     ? '?' + new URLSearchParams(data.request.query).toString()
                     : '';
 
-                // We only want the `/a/b/c` part:
-                // https://webhook.site/00000000-0000-0000-00000-000000000000/a/b/c
-                const pathMatch = data.request.url.match(/https?:\/\/[^\/]*\/[a-z0-9-]+(\/[^?#]+)/)
-                const path = pathMatch ? pathMatch[1] : '';
-                target = target + path + query;
+                target = target + getTargetPath(data.request.url) + query;
             }
 
             let options = {
                 method: data.request.method,
                 headers: data.request.headers,
                 body: null,
+                // Enough time to clear token listen property when command exits.
+                signal: AbortSignal.timeout(listenSeconds*1000),
             };
 
             const removeHeaders = [
@@ -48,12 +79,28 @@ export default async (argv) => {
             }
 
             fetch(target, options)
-                .then((res) => {
+                .then(async (res) => {
                     log.info({
                         msg: 'Forwarded incoming request',
                         url: res.url,
-                        status: res.status
+                        status: res.status,
                     });
+                    if (listenSeconds > 0) {
+                        await setResponse(
+                            tokenId,
+                            data.request.uuid,
+                            res.status,
+                            res.arrayBuffer(),
+                            res.headers.raw(),
+                            listenSeconds*1000
+                        )
+                    }
+                })
+                .catch((err) => {
+                    log.error({
+                        msg: 'Error forwarding incoming request',
+                        err,
+                    })
                 })
         }
     )

commands/help.js

@@ -1,7 +1,9 @@
 import "colors";
+import * as fs from "node:fs";
+const packageJson = JSON.parse(fs.readFileSync('package.json'))
 
 export default () => {
-    console.log(`${'⚓ whcli: Webhook.site CLI'.bold}
+    console.log(`⚓ whcli: Webhook.site CLI ${packageJson.version}
 Usage: whcli [command] [--arg...]
 Documentation: https://docs.webhook.site/cli.html
 
@@ -17,6 +19,10 @@ ${'Commands and Arguments'.bold}
                                     are replaced; see below.
     --keep-url                      When used, skips merging path and query strings
                                     into the target URL.
+    --listen-timeout=5              Amount of seconds to wait for a response before
+                                    forwarding it back to Webhook.site.
+                                    Default 5. Max 10. 
+                                    Set to 0 to disable bidirectional forwarding.
 
   ${'exec'.underline}      Execute shell commands on traffic to a Webhook.site URL.
     --token=                        Specifies which Webhook.site URL (token ID)
@@ -32,12 +38,13 @@ ${'Variable Replacement'.bold}
     
 ${'Environment Variables'.bold}
   Some command arguments can be specified via environment variables:
-    ${'WH_TOKEN'.underline}         Specifies --token         
-    ${'WH_API_KEY'.underline}       Specifies --api-key       
-    ${'WH_TARGET'.underline}        Specifies --target        
-    ${'WH_COMMAND'.underline}       Specifies --command       
-    ${'WH_LOG_LEVEL'.underline}     Sets log level (silent, trace, debug, info, 
-                     warn, error, fatal) Defaults to info.
+    ${'WH_TOKEN'.underline}           Specifies --token         
+    ${'WH_API_KEY'.underline}         Specifies --api-key       
+    ${'WH_TARGET'.underline}          Specifies --target        
+    ${'WH_COMMAND'.underline}         Specifies --command    
+    ${'WH_LISTEN_TIMEOUT'.underline}  Specifies --listen-timeout   
+    ${'WH_LOG_LEVEL'.underline}       Sets log level (silent, trace, debug, info, 
+                       warn, error, fatal) Defaults to info.
     ${'NODE_TLS_REJECT_UNAUTHORIZED'.underline}    Set to "0" to disable e.g. self-signed 
                                     or expired certificate errors.
 `)

commands/lib/api.js

@@ -0,0 +1,100 @@
+import fetch from "node-fetch";
+import * as self from "./api.js";
+import log from "./log.js";
+
+let apiKey = process.env.WH_API_KEY ?? null;
+let apiUrl = process.env.WH_API ?? 'https://webhook.site';
+
+const getHeaders = function () {
+    let headers = {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json',
+    }
+
+    if (apiKey) {
+        headers['Api-Key'] = apiKey;
+    }
+
+    return headers;
+}
+
+export function setApiKey(newApiKey) {
+    apiKey = newApiKey;
+}
+
+export async function getToken(id) {
+    return fetch(`${apiUrl}/token/${id}`, {
+        method: 'GET',
+        headers: getHeaders(),
+    })
+        .then(async res => {
+            if (res.status === 200) {
+                return res.json();
+            }
+            throw Error('Could not get token: ' + await res.text());
+        });
+}
+
+export async function updateToken(id, tokenData) {
+    return fetch(`${apiUrl}/token/${id}`, {
+        method: 'PUT',
+        body: JSON.stringify(tokenData),
+        headers: getHeaders(),
+    })
+        .then(async res => {
+            if (res.status === 200) {
+                return res.json();
+            }
+            throw Error('Could not update token: ' + await res.text());
+        });
+}
+
+export async function setResponse(tokenId, requestId, status, content, headers, timeout) {
+    await fetch(
+        `${apiUrl}/token/${tokenId}/request/${requestId}/response`,
+        {
+            method: 'PUT',
+            body: JSON.stringify({
+                status,
+                content: Buffer.from(await content).toString('base64'),
+                headers: headers,
+            }),
+            headers: getHeaders(),
+            signal: AbortSignal.timeout(timeout)
+        }
+    )
+        .then(async (res) => {
+            if (res.status === 200) {
+                log.info({
+                    msg: 'Forwarded response to Webhook.site',
+                    status: res.status,
+                })
+                return;
+            }
+
+            if (res.status === 413) {
+                log.error({
+                    msg: 'Error forwarding response to Webhook.site: 10 MB response size exceeded',
+                })
+                return;
+            }
+
+            log.info({
+                msg: 'Error forwarding response to Webhook.site',
+                status: res.status,
+                error: (await res.text()),
+            })
+        })
+        .catch((err) => {
+            log.error({
+                msg: 'Error forwarding response to Webhook.site',
+                err,
+            })
+        });
+}
+
+export async function updateTokenListen(id, listenSeconds) {
+    const tokenData = await self.getToken(id)
+    tokenData['listen'] = listenSeconds;
+    return await self.updateToken(id, tokenData);
+}

commands/lib/listen.js

@@ -20,8 +20,12 @@ export default (tokenId, apiKey, onRequest) => {
         }
     })
 
-    channel.socket.on('error', (error) => {
-        logger.trace('WS: Error', { error })
+    channel.socket.on('error', (err) => {
+        logger.trace(err, 'WS: Error')
+    })
+
+    channel.error((err) => {
+        logger.trace(err, 'WS: Error');
     })
 
     channel.listen('.request.created', (data) => {

commands/lib/log.js

@@ -4,9 +4,15 @@ const log = pino({
     level: process.env.WH_LOG_LEVEL ?? 'info',
 })
 
+const whitelistedExceptions = ['write EPIPE'];
 process.on('uncaughtException',
     (err) => {
         log.fatal(err, 'Unhandled Exception');
+
+        if (whitelistedExceptions.includes(err.message)) {
+            return
+        }
+
         setTimeout(() => { process.abort() }, 1000).unref()
         process.exit(1);
     });

package.json

@@ -2,11 +2,14 @@
   "name": "@webhooksite/cli",
   "description": "Client for Webhook.site",
   "repository": "webhooksite/cli",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "type": "module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "engines" : {
+    "node" : ">=16.0.0"
+  },
   "dependencies": {
     "colors": "^1.4.0",
     "laravel-echo": "^1.16.1",