Class: Ronin::CLI::Commands::Netcat Private
- Inherits:
-
Ronin::CLI::Command
- Object
- Core::CLI::Command
- Ronin::CLI::Command
- Ronin::CLI::Commands::Netcat
- Includes:
- CommandKit::Options::Verbose, Core::CLI::Logging
- Defined in:
- lib/ronin/cli/commands/netcat.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
A netcat
clone written in Ruby using the async-io gem.
Usage
[options] [--tcp | --udp | --ssl | --tls] {HOST PORT | -l [HOST] PORT | --unix PATH}
Options
-v, --verbose Enables verbose output
--tcp Uses the TCP protocol
--udp Uses the UDP protocol
-U, --unix PATH Uses the UNIX socket protocol
-l, --listen Listens for incoming connections
-s, --source HOST Source address to bind to
-p, --source-port PORT Source port to bind to
-b, --buffer-size INT Buffer size to use (Default: 4096)
-x, --hexdump Hexdumps each message that is received
--ssl Enables SSL mode
--tls Enables TLS mode
--ssl-version 1|1.1|1.2 Specifies the required SSL version
--ssl-cert FILE Specifies the SSL certificate file
--ssl-key FILE Specifies the SSL key file
--ssl-verify none|peer|fail-if-no-peer-cert|client-once|true|false
SSL verification mode
--ssl-ca-bundle PATH Path to the file or directory of CA certificates
-h, --help Print help information
Arguments
[HOST] The host to connect to or listen on
[POST] The port to connect to
Instance Attribute Summary collapse
-
#mode ⇒ :connect, :listen
readonly
private
Whether to connect or listen for connections.
-
#protocol ⇒ :tcp, ...
readonly
private
The protocol to use.
Instance Method Summary collapse
-
#async_endpoint ⇒ Async::IO::Endpoint
private
Creates the async endpoint object.
-
#async_stdin ⇒ Async::IO::Stream
private
Creates the async stdin stream.
-
#client_loop ⇒ Object
private
The client event loop.
-
#initialize(**kwargs) ⇒ Netcat
constructor
private
Initializes the command.
-
#load_async ⇒ Object
private
Loads the async-io library.
-
#print_data(data) ⇒ Object
private
Prints or hexdumps data to stdout.
-
#run(*args) ⇒ Object
private
Runs the
ronin netcat
command. -
#server_loop ⇒ Object
private
The server event loop.
-
#ssl_context ⇒ Ronin::Support::Network::SSL
private
Creates an SSL context.
Constructor Details
#initialize(**kwargs) ⇒ Netcat
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Initializes the command.
176 177 178 179 180 181 |
# File 'lib/ronin/cli/commands/netcat.rb', line 176 def initialize(**kwargs) super(**kwargs) @protocol = :tcp @mode = :connect end |
Instance Attribute Details
#mode ⇒ :connect, :listen (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Whether to connect or listen for connections.
168 169 170 |
# File 'lib/ronin/cli/commands/netcat.rb', line 168 def mode @mode end |
#protocol ⇒ :tcp, ... (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The protocol to use.
163 164 165 |
# File 'lib/ronin/cli/commands/netcat.rb', line 163 def protocol @protocol end |
Instance Method Details
#async_endpoint ⇒ Async::IO::Endpoint
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Creates the async endpoint object.
278 279 280 281 282 283 284 285 286 287 |
# File 'lib/ronin/cli/commands/netcat.rb', line 278 def async_endpoint case @protocol when :tcp then Async::IO::Endpoint.tcp(@host,@port) when :udp then Async::IO::Endpoint.udp(@host,@port) when :unix then Async::IO::Endpoint.unix([:unix]) when :ssl Async::IO::Endpoint.ssl(@host,@port, hostname: @host, ssl_context: ssl_context) end end |
#async_stdin ⇒ Async::IO::Stream
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Creates the async stdin stream.
294 295 296 |
# File 'lib/ronin/cli/commands/netcat.rb', line 294 def async_stdin Async::IO::Stream.new(Async::IO::Generic.new(self.stdin)) end |
#client_loop ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The client event loop.
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/ronin/cli/commands/netcat.rb', line 301 def client_loop finished = Async::Notification.new endpoint = async_endpoint stdin = async_stdin buffer_size = [:buffer_size] Async do |task| socket = begin endpoint.connect rescue StandardError => error print_error(error.) exit(1) end stream = Async::IO::Stream.new(socket) begin client = task.async do while (data = stream.read_partial(buffer_size)) print_data(data) end rescue EOFError # ignore EOFError ensure finished.signal end user = task.async do while (data = stdin.read_partial(buffer_size)) socket.write(data) end rescue EOFError # ignore EOFError ensure finished.signal end finished.wait ensure client.stop user.stop socket.close end end end |
#load_async ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Loads the async-io library.
252 253 254 255 256 |
# File 'lib/ronin/cli/commands/netcat.rb', line 252 def load_async require 'async/notification' require 'async/io' require 'async/io/stream' end |
#print_data(data) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Prints or hexdumps data to stdout.
406 407 408 409 410 411 412 |
# File 'lib/ronin/cli/commands/netcat.rb', line 406 def print_data(data) if @hexdump @hexdump.hexdump(data) else print(data) end end |
#run(*args) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Runs the ronin netcat
command.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/ronin/cli/commands/netcat.rb', line 189 def run(*args) if [:hexdump] require 'hexdump' @hexdump = Hexdump::Hexdump.new end case @mode when :connect @host, @port = *args unless @host print_error "host argument required" exit(-1) end unless @port print_error "port argument required" exit(-1) end if [:verbose] if @protocol == :unix log_info "Connecting to #{[:unix]} ..." else log_info "Connecting to #{@host}:#{@port} ..." end end load_async client_loop when :listen case args.length when 0 @port = .fetch(:port,0) @host = nil when 1 @port = args[0].to_i @host = nil when 2 @host = args[0] @port = args[1].to_i end if [:verbose] if @protocol == :unix log_info "Listening on #{[:unix]} ..." else if @host log_info "Listening #{@host}:#{@port} ..." else log_info "Listening port #{@port} ..." end end end load_async server_loop end end |
#server_loop ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The server event loop.
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/ronin/cli/commands/netcat.rb', line 350 def server_loop finished = Async::Notification.new endpoint = async_endpoint stdin = async_stdin clients = [] buffer_size = [:buffer_size] Async do |task| endpoint.accept do |socket| if [:verbose] log_info "Client #{socket} connected" end clients << socket stream = Async::IO::Stream.new(socket) begin while (data = stream.read_partial(buffer_size)) print_data(data) end rescue EOFError # ignore EOFError end clients.delete(socket) if [:verbose] log_warn "Client #{socket} disconnected" end end task.async do while (data = stdin.read_partial(buffer_size)) clients.each { |client| client.write(data) } end rescue EOFError # ignore EOFError ensure finished.signal end finished.wait rescue StandardError => error print_error(error.) exit(1) ensure clients.each(&:close) end end |
#ssl_context ⇒ Ronin::Support::Network::SSL
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Creates an SSL context.
263 264 265 266 267 268 269 270 271 |
# File 'lib/ronin/cli/commands/netcat.rb', line 263 def ssl_context Support::Network::SSL.context( version: [:ssl_version], verify: [:ssl_verify], key_file: [:ssl_key], cert_file: [:ssl_cert], ca_bundle: [:ssl_ca_bundle] ) end |