Class: Rex::Socket::Parameters
- Inherits:
-
Object
- Object
- Rex::Socket::Parameters
- Defined in:
- lib/rex/socket/parameters.rb
Overview
This class represents the set of parameters that are used to create a socket, whether it be a server or client socket.
Instance Attribute Summary collapse
-
#bare ⇒ Bool
Whether or not this is a bare (non-extended) socket instance that should be created.
-
#comm ⇒ Comm
The Comm instance that should be used to create the underlying socket.
-
#context ⇒ Hash
The context hash that was passed in to the structure.
-
#localhost ⇒ String
(also: #localaddr)
The local host.
-
#localport ⇒ Fixnum
The local port.
-
#peerhost ⇒ String
(also: #peeraddr)
The remote host information, equivalent to the PeerHost parameter hash key.
-
#peerport ⇒ Fixnum
The remote port.
-
#proto ⇒ String
The protocol to to use, such as TCP.
-
#proxies ⇒ String
List of proxies to use.
-
#retries ⇒ Fixnum
The number of attempts that should be made.
-
#server ⇒ Bool
Whether or not this is a server.
-
#ssl ⇒ Bool
Whether or not SSL should be used to wrap the connection.
-
#ssl_cert ⇒ String
The SSL certificate, in pem format, stored as a string.
-
#ssl_cipher ⇒ String, Array
What specific SSL Cipher(s) to use, may be a string containing the cipher name or an array of strings containing cipher names e.g.
-
#ssl_compression ⇒ Bool
Enables SSL/TLS-level compression.
-
#ssl_verify_mode ⇒ Object
The SSL context verification mechanism.
-
#ssl_version ⇒ String, Symbol
What version of SSL to use (Auto, SSL2, SSL3, SSL23, TLS1).
-
#sslctx ⇒ OpenSSL::SSL::SSLContext
Pre configured SSL Context to use.
-
#timeout ⇒ Fixnum
The number of seconds before a connection attempt should time out.
-
#v6 ⇒ Bool
Whether we should use IPv6.
Class Method Summary collapse
-
.from_hash(hash) ⇒ Object
Creates an instance of the Parameters class using the supplied hash.
Instance Method Summary collapse
-
#bare? ⇒ Boolean
Returns true if the socket is a bare socket that does not inherit from any extended Rex classes.
-
#client? ⇒ Boolean
Returns true if this represents parameters for a client.
-
#initialize(hash) ⇒ Parameters
constructor
Initializes the attributes from the supplied hash.
-
#ip? ⇒ Boolean
Returns true if the protocol for the parameters is IP.
-
#server? ⇒ Boolean
Returns true if this represents parameters for a server.
-
#ssl? ⇒ Boolean
Returns true if SSL has been requested.
-
#tcp? ⇒ Boolean
Returns true if the protocol for the parameters is TCP.
-
#udp? ⇒ Boolean
Returns true if the protocol for the parameters is UDP.
-
#v6? ⇒ Boolean
Returns true if IPv6 has been enabled.
Constructor Details
#initialize(hash) ⇒ Parameters
Initializes the attributes from the supplied hash. The following hash keys can be specified.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/rex/socket/parameters.rb', line 80 def initialize(hash) if (hash['PeerHost']) self.peerhost = hash['PeerHost'] elsif (hash['PeerAddr']) self.peerhost = hash['PeerAddr'] else self.peerhost = nil end if (hash['LocalHost']) self.localhost = hash['LocalHost'] elsif (hash['LocalAddr']) self.localhost = hash['LocalAddr'] else self.localhost = '0.0.0.0' end if (hash['PeerPort']) self.peerport = hash['PeerPort'].to_i else self.peerport = 0 end if (hash['LocalPort']) self.localport = hash['LocalPort'].to_i else self.localport = 0 end if (hash['Bare']) self. = hash['Bare'] else self. = false end if (hash['SSL'] and hash['SSL'].to_s =~ /^(t|y|1)/i) self.ssl = true else self.ssl = false end if hash['SSLContext'] self.sslctx = hash['SSLContext'] end supported_ssl_versions = ['Auto', 'SSL2', 'SSL23', 'TLS1', 'SSL3', :Auto, :SSLv2, :SSLv3, :SSLv23, :TLSv1] if (hash['SSLVersion'] and supported_ssl_versions.include? hash['SSLVersion']) self.ssl_version = hash['SSLVersion'] end supported_ssl_verifiers = %W{CLIENT_ONCE FAIL_IF_NO_PEER_CERT NONE PEER} if (hash['SSLVerifyMode'] and supported_ssl_verifiers.include? hash['SSLVerifyMode']) self.ssl_verify_mode = hash['SSLVerifyMode'] end if hash['SSLCompression'] self.ssl_compression = hash['SSLCompression'] end if (hash['SSLCipher']) self.ssl_cipher = hash['SSLCipher'] end if (hash['SSLCert'] and ::File.file?(hash['SSLCert'])) begin self.ssl_cert = ::File.read(hash['SSLCert']) rescue ::Exception => e elog("Failed to read cert: #{e.class}: #{e}", LogSource) end end if hash['Proxies'] self.proxies = hash['Proxies'].split('-').map{|a| a.strip}.map{|a| a.split(':').map{|b| b.strip}} end # The protocol this socket will be using if (hash['Proto']) self.proto = hash['Proto'].downcase else self.proto = 'tcp' end # Whether or not the socket should be a server self.server = hash['Server'] || false # The communication subsystem to use to create the socket self.comm = hash['Comm'] # The context that was passed in, if any. self.context = hash['Context'] || {} # If no comm was supplied, try to use the comm that is best fit to # handle the provided host based on the current routing table. if( self.server ) if (self.comm == nil and self.localhost) self.comm = Rex::Socket::SwitchBoard.best_comm(self.localhost) end else if (self.comm == nil and self.peerhost) self.comm = Rex::Socket::SwitchBoard.best_comm(self.peerhost) end end # If we still haven't found a comm, we default to the local comm. self.comm = Rex::Socket::Comm::Local if (self.comm == nil) # If we are a UDP server, turn off the server flag as it was only set when # creating the UDP socket in order to avail of the switch board above. if( self.server and self.proto == 'udp' ) self.server = false end # The number of connection retries to make (client only) if hash['Retries'] self.retries = hash['Retries'].to_i else self.retries = 0 end # The number of seconds before a connect attempt times out (client only) if hash['Timeout'] self.timeout = hash['Timeout'].to_i else self.timeout = 5 end # Whether to force IPv6 addressing self.v6 = hash['IPv6'] || false end |
Instance Attribute Details
#bare ⇒ Bool
Whether or not this is a bare (non-extended) socket instance that should be created.
326 327 328 |
# File 'lib/rex/socket/parameters.rb', line 326 def @bare end |
#comm ⇒ Comm
The Comm instance that should be used to create the underlying socket.
309 310 311 |
# File 'lib/rex/socket/parameters.rb', line 309 def comm @comm end |
#context ⇒ Hash
The context hash that was passed in to the structure. (default: {})
313 314 315 |
# File 'lib/rex/socket/parameters.rb', line 313 def context @context end |
#localhost ⇒ String Also known as: localaddr
The local host. Equivalent to the LocalHost parameter hash key.
291 292 293 |
# File 'lib/rex/socket/parameters.rb', line 291 def localhost @localhost end |
#localport ⇒ Fixnum
The local port. Equivalent to the LocalPort parameter hash key.
295 296 297 |
# File 'lib/rex/socket/parameters.rb', line 295 def localport @localport end |
#peerhost ⇒ String Also known as: peeraddr
The remote host information, equivalent to the PeerHost parameter hash key.
283 284 285 |
# File 'lib/rex/socket/parameters.rb', line 283 def peerhost @peerhost end |
#peerport ⇒ Fixnum
The remote port. Equivalent to the PeerPort parameter hash key.
287 288 289 |
# File 'lib/rex/socket/parameters.rb', line 287 def peerport @peerport end |
#proto ⇒ String
The protocol to to use, such as TCP. Equivalent to the Proto parameter hash key.
300 301 302 |
# File 'lib/rex/socket/parameters.rb', line 300 def proto @proto end |
#proxies ⇒ String
List of proxies to use
368 369 370 |
# File 'lib/rex/socket/parameters.rb', line 368 def proxies @proxies end |
#retries ⇒ Fixnum
The number of attempts that should be made.
317 318 319 |
# File 'lib/rex/socket/parameters.rb', line 317 def retries @retries end |
#server ⇒ Bool
Whether or not this is a server. Equivalent to the Server parameter hash key.
305 306 307 |
# File 'lib/rex/socket/parameters.rb', line 305 def server @server end |
#ssl ⇒ Bool
Whether or not SSL should be used to wrap the connection.
330 331 332 |
# File 'lib/rex/socket/parameters.rb', line 330 def ssl @ssl end |
#ssl_cert ⇒ String
The SSL certificate, in pem format, stored as a string. See SslTcpServer#makessl
349 350 351 |
# File 'lib/rex/socket/parameters.rb', line 349 def ssl_cert @ssl_cert end |
#ssl_cipher ⇒ String, Array
What specific SSL Cipher(s) to use, may be a string containing the cipher name or an array of strings containing cipher names e.g.
- “DHE-RSA-AES256-SHA”, “DHE-DSS-AES256-SHA”
344 345 346 |
# File 'lib/rex/socket/parameters.rb', line 344 def ssl_cipher @ssl_cipher end |
#ssl_compression ⇒ Bool
Enables SSL/TLS-level compression
353 354 355 |
# File 'lib/rex/socket/parameters.rb', line 353 def ssl_compression @ssl_compression end |
#ssl_verify_mode ⇒ Object
The SSL context verification mechanism
358 359 360 |
# File 'lib/rex/socket/parameters.rb', line 358 def ssl_verify_mode @ssl_verify_mode end |
#ssl_version ⇒ String, Symbol
What version of SSL to use (Auto, SSL2, SSL3, SSL23, TLS1)
338 339 340 |
# File 'lib/rex/socket/parameters.rb', line 338 def ssl_version @ssl_version end |
#sslctx ⇒ OpenSSL::SSL::SSLContext
Pre configured SSL Context to use
334 335 336 |
# File 'lib/rex/socket/parameters.rb', line 334 def sslctx @sslctx end |
#timeout ⇒ Fixnum
The number of seconds before a connection attempt should time out.
321 322 323 |
# File 'lib/rex/socket/parameters.rb', line 321 def timeout @timeout end |
#v6 ⇒ Bool
Whether we should use IPv6
363 364 365 |
# File 'lib/rex/socket/parameters.rb', line 363 def v6 @v6 end |
Class Method Details
.from_hash(hash) ⇒ Object
Creates an instance of the Parameters class using the supplied hash.
37 38 39 |
# File 'lib/rex/socket/parameters.rb', line 37 def self.from_hash(hash) return self.new(hash) end |
Instance Method Details
#bare? ⇒ Boolean
Returns true if the socket is a bare socket that does not inherit from any extended Rex classes.
255 256 257 |
# File 'lib/rex/socket/parameters.rb', line 255 def return ( == true) end |
#client? ⇒ Boolean
Returns true if this represents parameters for a client.
226 227 228 |
# File 'lib/rex/socket/parameters.rb', line 226 def client? return (server == false) end |
#ip? ⇒ Boolean
Returns true if the protocol for the parameters is IP.
247 248 249 |
# File 'lib/rex/socket/parameters.rb', line 247 def ip? return (proto == 'ip') end |
#server? ⇒ Boolean
Returns true if this represents parameters for a server.
219 220 221 |
# File 'lib/rex/socket/parameters.rb', line 219 def server? return (server == true) end |
#ssl? ⇒ Boolean
Returns true if SSL has been requested.
262 263 264 |
# File 'lib/rex/socket/parameters.rb', line 262 def ssl? return ssl end |
#tcp? ⇒ Boolean
Returns true if the protocol for the parameters is TCP.
233 234 235 |
# File 'lib/rex/socket/parameters.rb', line 233 def tcp? return (proto == 'tcp') end |
#udp? ⇒ Boolean
Returns true if the protocol for the parameters is UDP.
240 241 242 |
# File 'lib/rex/socket/parameters.rb', line 240 def udp? return (proto == 'udp') end |
#v6? ⇒ Boolean
Returns true if IPv6 has been enabled
269 270 271 |
# File 'lib/rex/socket/parameters.rb', line 269 def v6? return v6 end |