js-tcp-tunnel 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-tcp-tunnel",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "js tcp tunnel",
   "main": "index.js",
   "type": "module",

package/src/lib.js

@@ -3,10 +3,12 @@ import net from 'node:net'
 import { Readable, Writable } from 'node:stream'
 import http from 'node:http'
 import https from 'node:https'
+import { ReadableStream, TransformStream, WritableStream } from 'node:stream/web'
 
 /**
  * @import {WebSocketServer} from 'ws'
  * @import Router from 'koa-router'
+ * @import {SocketChannel, TCP_TUNNEL_DATA, TUNNEL_TCP_CLIENT_HELPER, TUNNEL_TCP_DATA_CONNECT, TUNNEL_TCP_DATA_LISTEN, TUNNEL_TCP_DATA_PINGPONG, TUNNEL_TCP_SERVER_HELPER, TunnelTcpClientHelperParam, TunnelTcpServerHelperParam} from './types.js'
  */
 
 const DEBUG_TUNNEL_TCP = false
@@ -53,14 +55,6 @@ export function formatNumber(num) {
     return Number(num.toFixed(2))
 }
 
-/**
- * @typedef {{
- * promise: Promise<any>;
- * resolve: (value: any | null) => void;
- * reject: (reason: any | null) => void;
- * }} PromiseResolvers
- */
-
 export function Promise_withResolvers() {
     /** @type{(value?:object)=>void} */
     let resolve = null
@@ -303,17 +297,17 @@ let tcpTunnelDataSend = 0
  */
 export function printTcpTunnelData(data) {
     return `id: ${`${data.srcId}:${data.dstId}`.padEnd(10)} channel: ${`${data.srcChannel}:${data.dstChannel}`.padEnd(10)} ${{
-        0xa9b398d5: 'TUNNEL_TCP_TYPE_INIT      ',
-        0xe41957d3: 'TUNNEL_TCP_TYPE_LISTEN    ',
-        0x20993e38: 'TUNNEL_TCP_TYPE_ONLISTEN  ',
-        0x11d949f8: 'TUNNEL_TCP_TYPE_CONNECT   ',
-        0x377b2181: 'TUNNEL_TCP_TYPE_ONCONNECT ',
-        0x48678f39: 'TUNNEL_TCP_TYPE_DATA      ',
-        0x8117f762: 'TUNNEL_TCP_TYPE_ERROR     ',
-        0x72fd6470: 'TUNNEL_TCP_TYPE_CLOSE     ',
-        0x4768e1ba: 'TUNNEL_TCP_TYPE_PING      ',
-        0x106f43fb: 'TUNNEL_TCP_TYPE_PONG      ',
-        0xc5870539: 'TUNNEL_TCP_TYPE_ACK       ',
+        [TUNNEL_TCP_TYPE_INIT]: 'TUNNEL_TCP_TYPE_INIT      ',
+        [TUNNEL_TCP_TYPE_LISTEN]: 'TUNNEL_TCP_TYPE_LISTEN    ',
+        [TUNNEL_TCP_TYPE_ONLISTEN]: 'TUNNEL_TCP_TYPE_ONLISTEN  ',
+        [TUNNEL_TCP_TYPE_CONNECT]: 'TUNNEL_TCP_TYPE_CONNECT   ',
+        [TUNNEL_TCP_TYPE_ONCONNECT]: 'TUNNEL_TCP_TYPE_ONCONNECT ',
+        [TUNNEL_TCP_TYPE_DATA]: 'TUNNEL_TCP_TYPE_DATA      ',
+        [TUNNEL_TCP_TYPE_ERROR]: 'TUNNEL_TCP_TYPE_ERROR     ',
+        [TUNNEL_TCP_TYPE_CLOSE]: 'TUNNEL_TCP_TYPE_CLOSE     ',
+        [TUNNEL_TCP_TYPE_PING]: 'TUNNEL_TCP_TYPE_PING      ',
+        [TUNNEL_TCP_TYPE_PONG]: 'TUNNEL_TCP_TYPE_PONG      ',
+        [TUNNEL_TCP_TYPE_ACK]: 'TUNNEL_TCP_TYPE_ACK       ',
     }[data.type]} recv: ${(tcpTunnelDataRecv)} send: ${(tcpTunnelDataSend)} size:${data.buffer.length}`
 }
 
@@ -428,83 +422,6 @@ export const TUNNEL_TCP_TYPE_PING = 0x4768e1ba
 export const TUNNEL_TCP_TYPE_PONG = 0x106f43fb
 export const TUNNEL_TCP_TYPE_ACK = 0xc5870539
 
-/**
- * @typedef {TUNNEL_TCP_TYPE_INIT
- * |TUNNEL_TCP_TYPE_LISTEN
- * |TUNNEL_TCP_TYPE_ONLISTEN
- * |TUNNEL_TCP_TYPE_CONNECT
- * |TUNNEL_TCP_TYPE_ONCONNECT
- * |TUNNEL_TCP_TYPE_DATA
- * |TUNNEL_TCP_TYPE_ERROR
- * |TUNNEL_TCP_TYPE_CLOSE
- * |TUNNEL_TCP_TYPE_PING
- * |TUNNEL_TCP_TYPE_PONG
- * |TUNNEL_TCP_TYPE_ACK} TUNNEL_TCP_TYPE
- */
-
-/**
- * @typedef {{
- * type:TUNNEL_TCP_TYPE;
- * srcId:number;
- * dstId:number;
- * srcChannel:number;
- * dstChannel:number;
- * buffer:Uint8Array;
- * }} TCP_TUNNEL_DATA
- */
-
-/**
- * @typedef {{
- * key:string;
- * }} TUNNEL_TCP_DATA_LISTEN
- */
-
-/**
- * @typedef {{
- * key:string;
- * }} TUNNEL_TCP_DATA_CONNECT
- */
-
-/**
- * @typedef {{
- * time:number;
- * }} TUNNEL_TCP_DATA_PINGPONG
- */
-
-/**
- * @typedef {{
- * id:number;
- * encodeWriter:WritableStreamDefaultWriter<Uint8Array>;
- * }} TUNNEL_TCP_SERVER
- */
-
-/**
- * @typedef {{
- *     readable:ReadableStream<Uint8Array>;
- *     writable:WritableStream<Uint8Array>;
- *     reader:ReadableStreamDefaultReader<Uint8Array>;
- *     writer:WritableStreamDefaultWriter<Uint8Array>;
- *     dstId:number;
- * }} TUNNEL_TCP_SERVER_HELPER
- * @typedef {{
- *     readable:ReadableStream<Uint8Array>;
- *     writable:WritableStream<Uint8Array>;
- *     reader:ReadableStreamDefaultReader<Uint8Array>;
- *     writer:WritableStreamDefaultWriter<Uint8Array>;
- *     listen:(param:{ 
- *          clientKey?:string;
- *          tunnelKey:string;
- *          host?:string;
- *          port:number; 
- *        })=>Promise<void>;
- *     connect:(param:{ 
- *          clientKey?:string;
- *          tunnelKey: string;
- *          port: number;
- *        })=>Promise<void>;
- * }} TUNNEL_TCP_CLIENT_HELPER
- */
-
 /**
  * @param {TCP_TUNNEL_DATA} box
  */
@@ -647,7 +564,7 @@ export function pipeSocketDataWithChannel(channelMap, channelId, encodeWriter) {
             sendPackSize++
         },
         async close() {
-            await encodeWriter.write(buildTcpTunnelData({
+            encodeWriter.write(buildTcpTunnelData({
                 type: TUNNEL_TCP_TYPE_CLOSE,
                 srcId: channel.srcId,
                 srcChannel: channel.srcChannel,
@@ -846,7 +763,7 @@ async function dispatchClientBufferData(param, setup, listenKeyParamMap, channel
         let channel = channelMap.get(channelId)
         if (channel) {
             channelMap.delete(channelId)
-            channel.socket.end()
+            channel.socket.destroy()
         }
     }
     if (data.type == TUNNEL_TCP_TYPE_ERROR) {
@@ -923,39 +840,6 @@ export async function closeRemoteChannel(encodeWriter, data) {
     })).catch((err) => { console.error('closeRemoteChannel stream write error', err.message) })
 }
 
-/**
- * @typedef {{
- * writer:WritableStreamDefaultWriter<Uint8Array>;
- * socket:net.Socket;
- * srcId:number;
- * dstId:number;
- * srcChannel:number;
- * dstChannel:number;
- * notify:(size:number)=>void;
- * recvPackSize:number;
- * key_iv:[CryptoKey, Uint8Array];
- * }} SocketChannel
- */
-
-
-/**
- * @typedef {{
- * uniqueId:number;
- * listenMap:Map<string,number>;
- * dstMap:Map<number,TUNNEL_TCP_SERVER>;
- * serverKey?:string;
- * }} TunnelTcpServerHelperParam
- */
-
-/**
- * @typedef {{
- * signal:AbortSignal;
- * serverKey?:string;
- * uniqueId:number;
- * clientDataId:number;
- * }} TunnelTcpClientHelperParam 
- */
-
 /**
  * @param {TunnelTcpServerHelperParam} param 
  */
@@ -1144,7 +1028,7 @@ export function createTunnelTcpClientHelper(param) {
     }
 
     /** @type{TUNNEL_TCP_CLIENT_HELPER} */
-    let helper = { readable: encode.readable, writable: decode.writable, reader: null, writer: null, listen, connect }
+    let helper = { readable: encode.readable, writable: decode.writable, reader: null, writer: null, listen, connect, param: outParam }
     return helper
 
 }
@@ -1521,6 +1405,11 @@ export function createTunnelTcpClientHttp(param) {
                 console.error('createConnectionHttpx res close ')
                 promise.resolve()
             })
+            setTimeout(() => {
+                if (helper.param.clientDataId < 1) {
+                    res.destroy(new Error('init clientId failed!'))
+                }
+            }, 10_000).unref()
         })
         Readable.fromWeb(transform.readable).pipe(req)
         req.flushHeaders()

package/src/lib.test.js

@@ -62,7 +62,7 @@ test('tunnel-tcp-socket-test', async () => {
             console.error(err.message)
         })
 
-        let rec = null
+        let rec = ''
 
         await new Promise((resolve) => {
             socket.on('connect', async () => {
@@ -86,7 +86,8 @@ test('tunnel-tcp-socket-test', async () => {
             socketServer.close()
         })
 
-        strictEqual(rec, 'qwertyuiop - 99')
+        let from = rec.length - 'qwertyuiop - 99'.length
+        strictEqual(rec.substring(from), 'qwertyuiop - 99')
 
     })
     console.info('over!')

package/src/types.ts

@@ -0,0 +1,114 @@
+import net from 'node:net'
+import { WritableStream } from "stream/web"
+
+
+export type PromiseResolvers = {
+    promise: Promise<any>
+    resolve: (value: any | null) => void
+    reject: (reason: any | null) => void
+}
+
+export type TUNNEL_TCP_TYPE_INIT = 0xa9b398d5 // 链接建立后返回id
+export type TUNNEL_TCP_TYPE_LISTEN = 0xe41957d3
+export type TUNNEL_TCP_TYPE_ONLISTEN = 0x20993e38
+export type TUNNEL_TCP_TYPE_CONNECT = 0x11d949f8
+export type TUNNEL_TCP_TYPE_ONCONNECT = 0x377b2181
+export type TUNNEL_TCP_TYPE_DATA = 0x48678f39
+export type TUNNEL_TCP_TYPE_ERROR = 0x8117f762
+export type TUNNEL_TCP_TYPE_CLOSE = 0x72fd6470
+export type TUNNEL_TCP_TYPE_PING = 0x4768e1ba
+export type TUNNEL_TCP_TYPE_PONG = 0x106f43fb
+export type TUNNEL_TCP_TYPE_ACK = 0xc5870539
+
+export type TUNNEL_TCP_TYPE = TUNNEL_TCP_TYPE_INIT |
+    TUNNEL_TCP_TYPE_LISTEN |
+    TUNNEL_TCP_TYPE_ONLISTEN |
+    TUNNEL_TCP_TYPE_CONNECT |
+    TUNNEL_TCP_TYPE_ONCONNECT |
+    TUNNEL_TCP_TYPE_DATA |
+    TUNNEL_TCP_TYPE_ERROR |
+    TUNNEL_TCP_TYPE_CLOSE |
+    TUNNEL_TCP_TYPE_PING |
+    TUNNEL_TCP_TYPE_PONG |
+    TUNNEL_TCP_TYPE_ACK
+
+export type TCP_TUNNEL_DATA = {
+    type: TUNNEL_TCP_TYPE
+    srcId: number
+    dstId: number
+    srcChannel: number
+    dstChannel: number
+    buffer: Uint8Array
+}
+
+export type TUNNEL_TCP_DATA_LISTEN = {
+    key: string
+}
+
+export type TUNNEL_TCP_DATA_CONNECT = {
+    key: string
+}
+
+export type TUNNEL_TCP_DATA_PINGPONG = {
+    time: number
+}
+
+export type TUNNEL_TCP_SERVER = {
+    id: number
+    encodeWriter: WritableStreamDefaultWriter<Uint8Array>
+}
+
+export type TUNNEL_TCP_SERVER_HELPER = {
+    readable: ReadableStream<Uint8Array>
+    writable: WritableStream<Uint8Array>
+    reader: ReadableStreamDefaultReader<Uint8Array>
+    writer: WritableStreamDefaultWriter<Uint8Array>
+    dstId: number
+}
+
+export type TUNNEL_TCP_CLIENT_HELPER = {
+    readable: ReadableStream<Uint8Array>
+    writable: WritableStream<Uint8Array>
+    reader: ReadableStreamDefaultReader<Uint8Array>
+    writer: WritableStreamDefaultWriter<Uint8Array>
+    param: TunnelTcpClientHelperParam
+    listen: (param: {
+        clientKey?: string
+        tunnelKey: string
+        host?: string
+        port: number
+    }) => Promise<void>
+    connect: (param: {
+        clientKey?: string
+        tunnelKey: string
+        port: number
+    }) => Promise<void>
+}
+
+
+export type SocketChannel = {
+    writer: WritableStreamDefaultWriter<Uint8Array>
+    socket: net.Socket
+    srcId: number
+    dstId: number
+    srcChannel: number
+    dstChannel: number
+    notify: (size: number) => void
+    recvPackSize: number
+    key_iv: [CryptoKey, Uint8Array]
+}
+
+
+export type TunnelTcpServerHelperParam = {
+    uniqueId: number
+    listenMap: Map<string, number>
+    dstMap: Map<number, TUNNEL_TCP_SERVER>
+    serverKey?: string
+}
+
+export type TunnelTcpClientHelperParam = {
+    signal: AbortSignal
+    serverKey?: string
+    uniqueId: number
+    clientDataId: number
+}