Class: Net::SSH::Proxy::SOCKS5

### Home Classes Methods

### In Files

- lib/net/ssh/proxy/socks5.rb

### Parent

Object

### Methods

- ::new
- #open

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- Net
- Net::SSH
- Net::SSH::Authentication
- Net::SSH::Authentication::Agent
- Net::SSH::Authentication::Agent::Comment
- Net::SSH::Authentication::AgentError
- Net::SSH::Authentication::AgentNotAvailable
- Net::SSH::Authentication::Constants
- Net::SSH::Authentication::DisallowedMethod
- Net::SSH::Authentication::KeyManager
- Net::SSH::Authentication::KeyManagerError
- Net::SSH::Authentication::Methods
- Net::SSH::Authentication::Methods::Abstract
- Net::SSH::Authentication::Methods::Hostbased
- Net::SSH::Authentication::Methods::KeyboardInteractive
- Net::SSH::Authentication::Methods::None
- Net::SSH::Authentication::Methods::Password
- Net::SSH::Authentication::Methods::Publickey
- Net::SSH::Authentication::Session
- Net::SSH::AuthenticationFailed
- Net::SSH::Buffer
- Net::SSH::ChannelOpenFailed
- Net::SSH::ChannelRequestFailed
- Net::SSH::Compat
- Net::SSH::Config
- Net::SSH::Connection
- Net::SSH::Connection::Channel
- Net::SSH::Connection::Constants
- Net::SSH::Connection::Keepalive
- Net::SSH::Connection::Session
- Net::SSH::Connection::Session::NilChannel
- Net::SSH::Connection::Term
- Net::SSH::ConnectionTimeout
- Net::SSH::Disconnect
- Net::SSH::Exception
- Net::SSH::HostKeyError
- Net::SSH::HostKeyMismatch
- Net::SSH::HostKeyUnknown
- Net::SSH::KeyFactory
- Net::SSH::KnownHosts
- Net::SSH::Loggable
- Net::SSH::Packet
- Net::SSH::PromptMethods
- Net::SSH::PromptMethods::Clear
- Net::SSH::PromptMethods::Highline
- Net::SSH::PromptMethods::Termios
- Net::SSH::Proxy
- Net::SSH::Proxy::Command
- Net::SSH::Proxy::ConnectError
- Net::SSH::Proxy::Error
- Net::SSH::Proxy::HTTP
- Net::SSH::Proxy::SOCKS4
- Net::SSH::Proxy::SOCKS5
- Net::SSH::Proxy::UnauthorizedError
- Net::SSH::Test
- Net::SSH::Test::Channel
- Net::SSH::Test::Extensions
- Net::SSH::Test::Extensions::BufferedIo
- Net::SSH::Test::Extensions::Channel
- Net::SSH::Test::Extensions::IO
- Net::SSH::Test::Extensions::IO::ClassMethods
- Net::SSH::Test::Extensions::PacketStream
- Net::SSH::Test::Kex
- Net::SSH::Test::LocalPacket
- Net::SSH::Test::Packet
- Net::SSH::Test::RemotePacket
- Net::SSH::Test::Script
- Net::SSH::Test::Socket
- Net::SSH::Timeout
- Net::SSH::Transport
- Net::SSH::Transport::Algorithms
- Net::SSH::Transport::CTR
- Net::SSH::Transport::CipherFactory
- Net::SSH::Transport::Constants
- Net::SSH::Transport::HMAC
- Net::SSH::Transport::HMAC::Abstract
- Net::SSH::Transport::HMAC::MD5
- Net::SSH::Transport::HMAC::MD5_96
- Net::SSH::Transport::HMAC::None
- Net::SSH::Transport::HMAC::RIPEMD160
- Net::SSH::Transport::HMAC::SHA1
- Net::SSH::Transport::HMAC::SHA1_96
- Net::SSH::Transport::HMAC::SHA2_256
- Net::SSH::Transport::HMAC::SHA2_256_96
- Net::SSH::Transport::HMAC::SHA2_512
- Net::SSH::Transport::HMAC::SHA2_512_96
- Net::SSH::Transport::IdentityCipher
- Net::SSH::Transport::Kex
- Net::SSH::Transport::Kex::DiffieHellmanGroup14SHA1
- Net::SSH::Transport::Kex::DiffieHellmanGroup1SHA1
- Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA1
- Net::SSH::Transport::Kex::DiffieHellmanGroupExchangeSHA256
- Net::SSH::Transport::Kex::EcdhSHA2NistP256
- Net::SSH::Transport::Kex::EcdhSHA2NistP384
- Net::SSH::Transport::Kex::EcdhSHA2NistP521
- Net::SSH::Transport::KeyExpander
- Net::SSH::Transport::PacketStream
- Net::SSH::Transport::ServerVersion
- Net::SSH::Transport::Session
- Net::SSH::Transport::State
- Net::SSH::Verifiers
- Net::SSH::Verifiers::Lenient
- Net::SSH::Verifiers::Null
- Net::SSH::Verifiers::Secure
- Net::SSH::Verifiers::Strict
- Net::SSH::Version
- OpenSSL
- OpenSSL::BN
- OpenSSL::PKey
- OpenSSL::PKey::DH
- OpenSSL::PKey::DSA
- OpenSSL::PKey::EC
- OpenSSL::PKey::OpenSSL
- OpenSSL::PKey::OpenSSL::PKey
- OpenSSL::PKey::OpenSSL::PKey::OpenSSL
- OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey
- OpenSSL::PKey::OpenSSL::PKey::OpenSSL::PKey::ECError
- OpenSSL::PKey::PKey
- OpenSSL::PKey::RSA
- String

No matching classes.

# Net::SSH::Proxy::SOCKS5

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

    require 'net/ssh/proxy/socks5'

    proxy = Net::SSH::Proxy::SOCKS5.new('proxy.host', proxy_port,
      :user => 'user', :password => "password")
    Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
      ...
    end

### Constants

ATYP_DOMAIN

  The SOCKS address type for connections via domain name.

ATYP_IPV4

  The SOCKS address type for connections via IP address.

CMD_CONNECT

  The SOCKS packet type for requesting a proxy connection.

METHOD_NONE

  The SOCKS authentication type for when there are no supported authentication methods.

METHOD_NO_AUTH

  The SOCKS authentication type for requests without authentication

METHOD_PASSWD

  The SOCKS authentication type for requests via username/password

SUCCESS

  The SOCKS response code for a successful operation.

VERSION

  The SOCKS protocol version used by this class

### Attributes

options[R]

The map of options given at initialization

proxy_host[R]

The proxy's host name or IP address

proxy_port[R]

The proxy's port number

### Public Class Methods

new(proxy_host, proxy_port=1080, options={}) click to toggle source

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

    # File lib/net/ssh/proxy/socks5.rb, line 57
    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 = nil) click to toggle source

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

    # File lib/net/ssh/proxy/socks5.rb, line 65
    def open(host, port, connection_options = nil)
      socket = TCPSocket.new(proxy_host, proxy_port)

      methods = [METHOD_NO_AUTH]
      methods << METHOD_PASSWD if options[:user]

      packet = [VERSION, methods.size, *methods].pack("C*")
      socket.send packet, 0

      version, method = socket.recv(2).unpack("CC")
      if version != VERSION
        socket.close
        raise Net::SSH::Proxy::Error, "invalid SOCKS version (#{version})"
      end

      if method == METHOD_NONE
        socket.close
        raise Net::SSH::Proxy::Error, "no supported authorization methods"
      end

      negotiate_password(socket) if method == METHOD_PASSWD

      packet = [VERSION, CMD_CONNECT, 0].pack("C*")

      if host =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/
        packet << [ATYP_IPV4, $1.to_i, $2.to_i, $3.to_i, $4.to_i].pack("C*")
      else
        packet << [ATYP_DOMAIN, host.length, host].pack("CCA*")
      end

      packet << [port].pack("n")
      socket.send packet, 0

      version, reply, = socket.recv(2).unpack("C*")
      socket.recv(1)
      address_type = socket.recv(1).getbyte(0)
      case address_type
      when 1
        socket.recv(4)  # get four bytes for IPv4 address
      when 3
        len = socket.recv(1).getbyte(0)
        hostname = socket.recv(len)
      when 4
        ipv6addr hostname = socket.recv(16)
      else
        socket.close
        raise ConnectError, "Illegal response type"
      end
      portnum = socket.recv(2)

      unless reply == SUCCESS
        socket.close
        raise ConnectError, "#{reply}"
      end

      return socket
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.