Simple Socks Server

Creates a simple SOCKS5 server and gives you control over the flow (filter, auth, protocol).

This is a clone of https://github.com/brozeph/simple-socks.

Installation

``sh
$ npm install @e9x/simple-socks
`

Debugging

This package will not log errors caught in callbacks such as authenticate, filter, and connect by default. This may lead to unexpected errors being caught and causing clients to disconnect. This may lead to confusion and unintended closing of the SOCKS client. To help debug, this package uses debug.

Set the DEBUG environment variable to simple-socks in your terminal to see debug messages from this package.

$3

`cmd
set DEBUG=simple-socks & node examples/createServer.mjs
`

$3

`ps1
$env:DEBUG = 'simple-socks'; node examples/createServer.mjs
`

$3

`sh
DEBUG=simple-socks node examples/createServer.mjs
`

Example Usage

In the examples folder exists two examples, one that requires no authentication and one that requires username/password authentication. Below is an example with no authentication:

`js
import { createProxyServer } from "@e9x/simple-socks";

const server = createProxyServer();

server.listen(1080);
`

$3

#### No Authentication

For a SOCKS5 server that does not require authentication, look at examples/createServer.mjs:

`sh
$ node examples/createServer.mjs
`

In a separate terminal window:

`sh
$ curl http://www.google.com --socks5 127.0.0.1:1080
`

#### Username/Password Authentication

For a SOCKS5 server that requires username/password authentication, look at examples/createServerWithAuthentication.mjs:

`sh
$ node examples/createServerWithAuthentication.mjs
`

In a separate terminal window:

`sh
$ curl http://www.google.com --socks5 127.0.0.1:1080 --proxy-user foo:bar
`

#### Connection Filter

For a SOCKS5 server that can perform either origin or destination (or both!) address filtering, look at examples/createServerFilter.mjs:

`sh
$ node examples/createServerFilter.mjs
`

In a separate terminal window:

`sh
$ curl http://www.github.com --socks5 127.0.0.1:1080 # allowed
$ curl http://www.google.com --socks5 127.0.0.1:1080 # denied
`

#### Chained Socks Proxies

The underlying API to connect to the destination is exposed to allow for flexibility. As a result, you can use slightly higher level APIs to establish a connection to the destination. For a SOCKS5 server will connect to a locally hosted TOR socks proxy, look at examples/createServerConnect.mjs:

`sh
$ node examples/createServerConnect.mjs
`

In a separate terminal window:

`$
$ curl https://myip.wtf/json --socks5 127.0.0.1:1080
`

`json
{
"YourF*ingTorExit": true
}
`

Methods

$3

Factory method that creates an instance of a SOCKS5 proxy server:

`js
import { createProxyServer } from "@e9x/simple-socks";

const server = createProxyServer();

server.listen(1080, "0.0.0.0", () => {
console.log("SOCKS5 proxy server started on 0.0.0.0:1080");
});
`

This method accepts an optional options argument:

- options.authentication - A callback for authentication
- options.filter - A callback for connection filtering
- options.connect - A callback for low-level connecting

Unlike simple-socks, the callbacks are based on modern promises.

The return value is equivalent to net.Server with a pre-defined listener for connection.

#### authentication

To make the socks5 server require username/password authentication, supply a function callback in the options as follows:

`js
import { createProxyServer } from "@e9x/simple-socks";

const server = createProxyServer({
authenticate: (username, password) =>
username === "foo" && password === "bar",
});

// begin listening and require user/pass authentication
server.listen(1080);
`

The authenticate callback accepts three arguments:

- username - username of the proxy user
- password - password of the proxy user
- socket - the socket for the client connection

You must return a promise. The promise resolving true indicates the credentials were accepted. The promise resolving false indicates the credentials were rejected.

#### filter

Allows you to filter incoming connections, based on either origin and/or destination.

`js
import { createProxyServer } from "@e9x/simple-socks";

const server = createProxyServer({
filter: (destinationPort, destinationAddress, socket) => {
if (socket.remoteAddress === "127.0.0.1") {
console.log(
"denying access from %s:%s",
socket.remoteAddress,
socket.remotePort,
);

return false;
}

if (destinationAddress === "10.0.0.1") {
console.log(
"denying access to %s:%s",
destinationAddress,
destinationPort,
);

return false;
}

return true;
},
});
`

The filter callback accepts three arguments:

- port - the TCP port of the destination server
- address - the TCP address of the destination server
- socket - the socket for the client connection

For an example, see examples/createServerFilter.mjs.

You must return a promise. The promise resolving true indicates the connection was accepted. The promise resolving false indicates the connection was rejected.

#### connect

Allows you to control the flow of connecting to the remote.

`js
import { createProxyServer } from "@e9x/simple-socks";
import { SocksClient } from "socks";

const server = createProxyServer({
connect: async (port, host) => {
// connect to TOR socks proxy
const { socket } = await SocksClient.createConnection({
proxy: {
host: "127.0.0.1",
port: 9050, // TOR daemon
type: 5,
},
command: "connect",
destination: {
port,
host,
},
});

return socket;
},
});
`

The connect callback accepts three arguments:

- port - the TCP port of the destination server
- address - the TCP address of the destination server
- socket - the socket for the client connection

For an example, see examples/createServerConnect.mjs.

You must return a promise. The promise resolving true indicates the connection was accepted and is CONNECTED. The promise resolving false indicates the connection was rejected and was NOT connected. You can utilize waitForConnect to wait for the socket to connect/throw before resolving to make it compatible with this callback.

$3

Method that will wait for a socket to connect to help use unconnected sockets as the resolution for connect:

`js
import { createProxyServer, waitForConnect } from "@e9x/simple-socks";
import { connect } from "node:net";

const server = createProxyServer({
connect: async (port, host) => {
// create unconnected socket
const socket = connect(port, host);

await waitForConnect(socket);

return socket;
},
});
`

(non-async)

`js
import { createProxyServer, waitForConnect } from "@e9x/simple-socks";
import { connect } from "node:net";

const server = createProxyServer({
connect: (port, host) =>
new Promise((resolve, reject) => {
// create unconnected socket
const socket = connect(port, host);

waitForConnect(socket)
.then(() => {
resolve(socket);
})
.catch((err) => {
// only err should be passed to reject
reject(err);
});
}),
});
`

The waitForConnect` method accepts one argument:

- socket - the socket to the destination

The socket must not already be connected when calling this method. If it is, return the socket instead of calling this method. This method will throw an error if the socket could not connect. This error should be caught in the stack that called options.connect. You should not catch this error and return a different one because it contains an error code that is used to determine how the socket was ended.

Events

Unlike simple-socks, events have been removed due to the unlikeliness of them being used and their nature of wasting resources. Specifically the proxyData event is the culprit of poor speeds because it causes the stream to buffer, adding overhead to streaming data from the client to the remote. It may be argued the events being fired constantly are a waste of resources too. Use the hooks provided in options instead.