socks

Creating a SOCKS client

This code sample demonstrates how to create a SOCKS client that connects to a specified destination through a SOCKS proxy server.

const { SocksClient } = require('socks');

const options = {
  proxy: {
    host: 'host', // ipv4, ipv6, or hostname
    port: 1080,
    type: 5 // Proxy version (4, 5)
  },
  command: 'connect',
  destination: {
    host: 'destinationHost',
    port: 80
  }
};

SocksClient.createConnection(options, (err, info) => {
  if (err) {
    console.log(err);
    return;
  }
  const socket = info.socket;
  console.log('Connected to server through SOCKS proxy');
});

Creating a SOCKS server

This code sample shows how to create a SOCKS server that listens for incoming connections and can handle custom authentication.

const socks = require('socks').SocksServer;

const server = new socks({
  proxy: {
    ipaddress: 'localhost',
    port: 1080,
    type: 5
  },
  authenticate: function(username, password, socket, callback) {
    // Custom authentication logic
    callback();
  }
});

server.listen();

server.on('proxyConnect', (info, destinationSocket) => {
  console.log(`Accepted connection to ${info.host}:${info.port}`);
});

Handling UDP connections

This code sample illustrates how to handle UDP connections through a SOCKS proxy using the 'associate' command.

const { SocksClient } = require('socks');

const options = {
  proxy: {
    host: 'host',
    port: 1080,
    type: 5
  },
  command: 'associate',
  destination: {
    host: '0.0.0.0', // The local interface to bind for UDP association
    port: 0 // A random port will be used
  }
};

SocksClient.createConnection(options, (err, info) => {
  if (err) {
    console.log(err);
    return;
  }
  const udpSocket = info.socket;
  console.log('UDP association has been established.');
});