class Net::SSH::Proxy::SOCKS4

  1. lib/net/ssh/proxy/socks4.rb
Parent: Proxy

An implementation of a SOCKS4 proxy. To use it, instantiate it, then pass the instantiated object via the :proxy key to Net::SSH.start:

require 'net/ssh/proxy/socks4'
proxy = Net::SSH::Proxy::SOCKS4.new('proxy.host', proxy_port, :user => 'user')
Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
  ...
end

Methods

Public Class

  1. new

Public Instance

  1. open
  2. options
  3. proxy_host
  4. proxy_port

Constants

CONNECT = 1  

The packet type for connection requests
GRANTED = 90  

The status code for a successful connection
VERSION = 4  

The SOCKS protocol version used by this class

Attributes

options [R]

The additional options that were given to the proxy's constructor.
proxy_host [R]

The proxy's host name or IP address, as given to the constructor.
proxy_port [R]

The proxy's port number.

Public Class methods

new (proxy_host, proxy_port=1080, options={})

Create a new proxy connection to the given proxy host and port. Optionally, a :user key may be given to identify the username with which to authenticate.

[show source] 
# File lib/net/ssh/proxy/socks4.rb, line 42
def initialize(proxy_host, proxy_port=1080, options={})
  @proxy_host = proxy_host
  @proxy_port = proxy_port
  @options = options
end

Public Instance methods

open (host, port, connection_options)

Return a new socket connected to the given host and port via the proxy that was requested when the socket factory was instantiated.

[show source] 
# File lib/net/ssh/proxy/socks4.rb, line 50
def open(host, port, connection_options)
  socket = TCPSocket.new(proxy_host, proxy_port)
  ip_addr = IPAddr.new(Resolv.getaddress(host))
  
  packet = [VERSION, CONNECT, port.to_i, ip_addr.to_i, options[:user]].pack("CCnNZ*")
  socket.send packet, 0

  version, status, port, ip = socket.recv(8).unpack("CCnN")
  if status != GRANTED
    socket.close
    raise ConnectError, "error connecting to proxy (#{status})"
  end

  return socket
end