Download the PHP package clue/socks without Composer

MAINTENANCE MODE

This repository is currently in the process of being split up into a simple blocking client implementation and an async non-blocking client and server implementation. See issue #2 for details.

• If you're already using this library in legacy v0.4, consider upgrading to clue/socks-react. Upgrading should take no longer than 10 minutes, see the CHANGELOG.md for details.

• If you're looking for an async non-blocking client and server implementation, head over to clue/socks-react.

• If you're looking for the simple blocking client implementation, your best bet is to wait for issue #2 to be completed. Feel like contributing? :)

The following description applies to legacy v0.4, which has already been migrated to clue/socks-react.

clue/socks - SOCKS client and server

Async SOCKS client library to connect to SOCKS4, SOCKS4a and SOCKS5 proxy servers, as well as a SOCKS server implementation, capable of handling multiple concurrent connections in a non-blocking fashion.

Description

The SOCKS protocol family can be used to easily tunnel TCP connections independent of the actual application level protocol, such as HTTP, SMTP, IMAP, Telnet, etc.

Quickstart examples

Once installed, initialize a connection to a remote SOCKS proxy server:

Tunnelled TCP connections

The Socks/Client uses a Promise-based interface which makes working with asynchronous functions a breeze. Let's open up a TCP Stream connection and write some data:

HTTP requests

Or if all you want to do is HTTP requests, Socks/Client provides an even simpler HTTP client interface:

Yes, this works for both plain HTTP and SSL encrypted HTTPS requests.

SSL/TLS encrypted

If you want to connect to arbitrary SSL/TLS servers, there sure too is an easy to use API available:

SOCKS Protocol versions & differences

While SOCKS4 already had (a somewhat limited) support for SOCKS BIND requests and SOCKS5 added generic UDP support (SOCKS UDPASSOCIATE), this library focuses on the most commonly used core feature of SOCKS CONNECT. In this mode, a SOCKS server acts as a generic proxy allowing higher level application protocols to work through it.

Note, this is not a full SOCKS5 implementation due to missing GSSAPI authentication (but it's unlikely you're going to miss it anyway).

Explicitly setting protocol version

This library supports the SOCKS4, SOCKS4a and SOCKS5 protocol versions. Usually, there's no need to worry about which protocol version is being used. Depending on which features you use (e.g. authentication), the Socks/Client automatically uses the best protocol available. In general this library automatically switches to higher protocol versions when needed, but tries to keep things simple otherwise and sticks to lower protocol versions when possible. The Socks/Server supports all protocol versions by default.

If want to explicitly set the protocol version, use the supported values 4, 4a or 5:

In order to reset the protocol version to its default (i.e. automatic detection), use null as protocol version.

Remote vs. local DNS resolving

By default, the Socks/Client uses local DNS resolving to resolve target hostnames into IP addresses and only transmits the resulting target IP to the socks server.

Resolving locally usually results in better performance as for each outgoing request both resolving the hostname and initializing the connection to the SOCKS server can be done simultanously. So by the time the SOCKS connection is established (requires a TCP handshake for each connection), the target hostname will likely already be resolved ( usually either already cached or requires a simple DNS query via UDP).

You may want to switch to remote DNS resolving if your local Socks/Client either can not resolve target hostnames because it has no direct access to the internet or if it should not resolve target hostnames because its outgoing DNS traffic might be intercepted (in particular when using the Tor network).

Local DNS resolving is available in all SOCKS protocol versions. Remote DNS resolving is only available for SOCKS4a and SOCKS5 (i.e. it is NOT available for SOCKS4).

Valid values are boolean true(default) or false.

Username / Password authentication

This library supports username/password authentication for SOCKS5 servers as defined in RFC 1929.

On the client side, simply set your username and password to use for authentication (see below). For each further connection the client will merely send a flag to the server indicating authentication information is available. Only if the server requests authentication during the initial handshake, the actual authentication credentials will be transmitted to the server.

Note that the password is transmitted in cleartext to the SOCKS proxy server, so this methods should not be used on a network where you have to worry about eavesdropping. Authentication is only supported by protocol version 5 (SOCKS5), so setting authentication on the Socks/Client enforces communication with protocol version 5 and complains if you have explicitly set anything else.

Setting authentication on the Socks/Server enforces each further connected client to use protocol version 5. If a client tries to use any other protocol version, does not send along authentication details or if authentication details can not be verified, the connection will be rejected.

Because your authentication mechanism might take some time to actually check the provided authentication credentials (like querying a remote database or webservice), the server side uses a Promise based interface. While this might seem complex at first, it actually provides a very simple way to handle simultanous connections in a non-blocking fashion and increases overall performance.

Or if you only accept static authentication details, you can use the simple array-based authentication method as a shortcut:

If you do not want to use authentication anymore:

Usage

Using SSH as a SOCKS server

If you already have an SSH server set up, you can easily use it as a SOCKS tunnel end point. On your client, simply start your SSH client and use the -D [port] option to start a local SOCKS server (quoting the man page: a local "dynamic" application-level port forwarding) by issuing:

$ ssh -D 9050 ssh-server

Using the Tor (anonymity network) to tunnel SOCKS connections

The Tor anonymity network client software is designed to encrypt your traffic and route it over a network of several nodes to conceal its origin. It presents a SOCKS4 and SOCKS5 interface on TCP port 9050 by default which allows you to tunnel any traffic through the anonymity network. In most scenarios you probably don't want your client to resolve the target hostnames, because you would leak DNS information to anybody observing your local traffic. Also, Tor provides hidden services through an .onion pseudo top-level domain which have to be resolved by Tor.

Install

The recommended way to install this library is through composer. New to composer?

License

MIT, see license.txt