✨ feat: Client add userId identification

src/client/client.ts

@@ -21,11 +21,6 @@ export class Client {
    */
   private readonly port: number
 
-  /**
-   * Triggers whenever the socket initialized
-   */
-  private readonly connectionListener: (() => void) | undefined
-
   /**
    * The object which contains all default handlers
    */
@@ -36,11 +31,7 @@ export class Client {
    */
   private readonly event: Event<EventTypes>
 
-  constructor(
-    port: number,
-    host: string,
-    connectionListener: (() => void) | undefined
-  ) {
+  constructor(port: number, host: string) {
     this.host = host
     this.port = port
     this.handlers = new Handlers({
@@ -49,24 +40,28 @@ export class Client {
       bind: handlers.bind,
     })
     this.event = new Event<EventTypes>()
-    this.connectionListener = connectionListener
   }
 
   /**
    * Connect to the target host trough socks server
-   * @param port - Server port
-   * @param host - Server address
+   * @param port - Target port
+   * @param host - Target host address
    * @param version - Server protocol version
+   * @param userId - userId for identification in v4
    * @returns void
    */
-  connect(port: number, host: string, version: 4 | 5) {
+  connect(port: number, host: string, version: 4 | 5, userId?: string) {
     return new Promise<net.Socket>((resolve, reject) => {
-      const socket = net.connect(this.port, this.host, this.connectionListener)
+      const socket = net.connect(this.port, this.host)
       const connection = new Connection(this.event, socket, this.handlers)
       connection.version = version
       connection.address = new Address(port, host)
       connection.resolve = resolve
       connection.reject = reject
+      connection.userId = userId
+      connection.event.subscribeOnce('error', (err) => {
+        reject(err.message)
+      })
       if (version === 5) {
         const authenticator = new Authenticator(connection)
         authenticator.authenticate()
@@ -81,13 +76,8 @@ export class Client {
  * Open new connection and connect to server
  * @param port - Server port
  * @param host - Server address
- * @param connectionListener - Emitted when a new connection opens
  * @returns void
  */
-export const connect = (
-  port: number,
-  host: string,
-  connectionListener?: (() => void) | undefined
-) => {
-  return new Client(port, host, connectionListener)
+export const connect = (port: number, host: string) => {
+  return new Client(port, host)
 }

src/client/handlers/connect.ts

@@ -1,7 +1,8 @@
-import { handler } from '../../helper/handler'
+import { handler, Info } from '../../helper/handler'
 import Writable from '../../helper/writable'
 import { Readable } from '../../helper/readable'
 import { COMMANDS, SOCKS4REPLY, SOCKS5REPLY } from '../../helper/constants'
+import net from 'net'
 
 /**
  * Handle connect request
@@ -32,10 +33,11 @@ export const connect = handler((info, socket, resolve, reject) => {
     }
   } else if (info.version === 4) {
     const addressBuff = info.address.toBuffer()
-    writeable.push(
-      COMMANDS.connect,
-      Buffer.concat([addressBuff.port, addressBuff.host, Buffer.from([0x00])])
-    )
+    writeable.push(COMMANDS.connect, addressBuff.port, addressBuff.host)
+    if (info.userId) {
+      writeable.push(Buffer.from(info.userId))
+    }
+    writeable.push(Buffer.from([0x00]))
   }
   socket.write(writeable.toBuffer())
   socket.on('data', (data) => {

src/helper/connection.ts

@@ -76,6 +76,11 @@ class Connection {
     socks4: true,
   }
 
+  /**
+   * UserId for socks4 client
+   */
+  userId: string | undefined
+
   constructor(
     event: Event<EventTypes>,
     socket: net.Socket,

src/helper/handler.ts

@@ -5,6 +5,7 @@ import * as net from 'net'
 export interface Info {
   version: number
   address: Address
+  userId?: string
 }
 
 export type Handler = (
@@ -27,6 +28,7 @@ export const handler =
         {
           version: connection.version,
           address: connection.address,
+          userId: connection.userId,
         },
         connection.socket,
         connection.resolve,

src/helper/handlers.ts

@@ -18,7 +18,7 @@ export class Handlers {
   constructor(
     req: Req,
     auth: AuthMethod[] = [],
-    userId: (userId: string) => boolean = () => true,
+    userId: (userId: string) => boolean = () => true
   ) {
     this.req = req
     this.auth = auth

src/server/state/socks4.ts

@@ -1,6 +1,13 @@
-import { ADDRESSTYPES, COMMANDS } from '../../helper/constants'
+import {
+  ADDRESSTYPES,
+  COMMANDS,
+  SOCKS4REPLY,
+  SOCKSVERSIONS,
+} from '../../helper/constants'
 import Address from '../../helper/address'
 import { State } from '../../helper/state'
+import Writable from '../../helper/writable'
+import writable from '../../helper/writable'
 
 /**
  * The RequestState class is responsible to handle
@@ -43,9 +50,6 @@ export class RequestState extends State {
       ADDRESSTYPES.ipv4
     )
     this.userId = this.context.readUntil(Buffer.from([0x00]))
-    if (!this.context.handlers.userId(this.userId.toString())) {
-      this.context.close()
-    }
   }
 
   /**
@@ -54,6 +58,20 @@ export class RequestState extends State {
    * @returns void
    */
   reply() {
+    if (
+      this.userId &&
+      this.context.address &&
+      !this.context.handlers.userId(this.userId.toString())
+    ) {
+      const writable = new Writable()
+      writable.push(
+        0x00,
+        SOCKS4REPLY.identFail.code,
+        this.context.address.toBuffer().port,
+        this.context.address.toBuffer().host
+      )
+      this.context.write(writable)
+    }
     this.context.socket.removeAllListeners('data')
     switch (this.cmd) {
       case COMMANDS.connect:

test/client.test.ts

@@ -13,36 +13,39 @@ describe('client socks5 (connect | associate | bind)', () => {
     done()
   })
 
-  test('connect to google.com',(done) => {
-    connect(serverPort, serverHost).connect(
-      httpPort,
-      'google.com',
-      5
-    ).then(socket =>{
-      socket.write(
-        Buffer.from(
-          'GET / HTTP/1.1\r\n' +
-          'Host: www.google.com:80\r\n' +
-          'Connection: close\r\n' +
-          '\r\n'
+  test('connect to google.com', (done) => {
+    connect(serverPort, serverHost)
+      .connect(httpPort, 'google.com', 5)
+      .then((socket) => {
+        socket.write(
+          Buffer.from(
+            'GET / HTTP/1.1\r\n' +
+              'Host: www.google.com:80\r\n' +
+              'Connection: close\r\n' +
+              '\r\n'
+          )
         )
-      )
-      socket.on('data', async (data) => {
-        socket.removeAllListeners('data')
-        expect(data.toString()).toMatch(/20[01] OK/)
-        done()
+        socket.on('data', async (data) => {
+          socket.removeAllListeners('data')
+          expect(data.toString()).toMatch(/20[01] OK/)
+          done()
+        })
       })
-    }).catch(reason => {
-      expect(true).toBe(false)
-    })
+      .catch((reason) => {
+        expect(true).toBe(false)
+      })
+  })
+
+  test('connect to wrong domain', () => {
+    return expect(
+      connect(serverPort, serverHost).connect(httpPort, 'dummy-url.c', 5)
+    ).rejects.toBe(SOCKS5REPLY.generalFailure.msg)
   })
 
-  test('connect to wrong domain',() => {
-    return expect(connect(serverPort, serverHost).connect(
-      httpPort,
-      'dummy-url.c',
-      5
-    )).rejects.toBe(SOCKS5REPLY.generalFailure.msg)
+  test('wrong socks server address', async () => {
+    return expect(
+      connect(22, serverHost).connect(httpPort, 'google.com', 5)
+    ).rejects.toMatch(/ECONNREFUSED/)
   })
 
   afterAll((done) => {
@@ -58,28 +61,66 @@ describe('client socks4 (connect | associate | bind)', () => {
     done()
   })
 
-  test('connect to google.com',(done) => {
-    connect(serverPort, serverHost).connect(
-      httpPort,
-      '142.251.1.101',
-      4
-    ).then(socket =>{
-      socket.write(
-        Buffer.from(
-          'GET / HTTP/1.1\r\n' +
-          'Host: www.google.com:80\r\n' +
-          'Connection: close\r\n' +
-          '\r\n'
+  test('connect to google.com', (done) => {
+    connect(serverPort, serverHost)
+      .connect(httpPort, '142.251.1.101', 4)
+      .then((socket) => {
+        socket.write(
+          Buffer.from(
+            'GET / HTTP/1.1\r\n' +
+              'Host: www.google.com:80\r\n' +
+              'Connection: close\r\n' +
+              '\r\n'
+          )
         )
-      )
-      socket.on('data', async (data) => {
-        expect(data.toString()).toMatch(/20[01] OK/)
-        done()
-        socket.end()
+        socket.on('data', async (data) => {
+          expect(data.toString()).toMatch(/20[01] OK/)
+          done()
+          socket.end()
+        })
+      })
+      .catch((reason) => {
+        expect(true).toBe(false)
       })
-    }).catch(reason => {
-      expect(true).toBe(false)
+  })
+
+  afterAll((done) => {
+    server.close()
+    done()
+  })
+})
+
+describe('client check authentication and identification', () => {
+  const server = createServer()
+  beforeAll((done) => {
+    server.listen(serverPort, serverHost)
+    server.useIdent((userId) => {
+      return userId === 'tsocks'
     })
+    done()
+  })
+
+  test('socks4 identification', (done) => {
+    connect(serverPort, serverHost)
+      .connect(httpPort, '142.251.1.101', 4, 'tsocks')
+      .then((socket) => {
+        socket.write(
+          Buffer.from(
+            'GET / HTTP/1.1\r\n' +
+              'Host: www.google.com:80\r\n' +
+              'Connection: close\r\n' +
+              '\r\n'
+          )
+        )
+        socket.on('data', async (data) => {
+          expect(data.toString()).toMatch(/20[01] OK/)
+          done()
+          socket.end()
+        })
+      })
+      .catch((reason) => {
+        expect(true).toBe(false)
+      })
   })
 
   afterAll((done) => {

test/server.test.ts

@@ -38,10 +38,7 @@ describe('server socks5 (connect | associate | bind)', () => {
           ++state
           break
         default:
-          const google = new Address(
-            httpPort,
-            'google.com',
-          ).toBuffer()
+          const google = new Address(httpPort, 'google.com').toBuffer()
           client.write(
             Buffer.concat([
               Buffer.from([