Contents

# Sockit

Transparent SOCKS 5 support for TCPSockets

## Installation

Add this line to your application's Gemfile:

    gem 'sockit'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sockit

## Usage

By loading the gem TCPSocket will get monkey patched adding seamless transparent SOCKS proxy support.  I favor using SS5 for a SOCKS server, so at this point I'm uncertain of absolute compatibility with other SOCKS servers.  I'm following the RFC here; so if (insert other SOCKS server flavor here) follows the RFC everything is in theory compatible.

### Configuration

You can configure on the singleton class or an instance of the class.  The SOCKS configuration is stored in a class variable; so it is shared across all TCPSocket instances and the singleton, thus changing the configuration in one instance will also affect all other instances.  The configuration is stored in an OpenStruct; you can reference `socks` with a block as shown, where the configuration OpenStruct is yielded to the block; or without in which case the configuration OpenStruct itself is returned.

The defaults are as follows:

    TCPSocket.socks do |config|
      config.version = 5
      config.ignore = ["127.0.0.1"]
      config.debug = false
    end

Specify your SOCKS server and port:

    TCPSocket.socks do |config|
      config.host = "127.0.0.1"
      config.port = "1080"
    end

If you want to use username/password authentication:

    TCPSocket.socks do |config|
      config.username = "username"
      config.password = "password"
    end

Turn on debug output:

    TCPSocket.socks do |config|
      config.debug = true
    end

Ignore some more hosts:

    TCPSocket.socks do |config|
      config.ignore << "192.168.0.1"
    end


## Contributing

I await your pull request.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sockit-0.0.2	README.md