rcon 0.1.0 → 0.2.0

data/bin/rcontool

@@ -0,0 +1,296 @@
+#!/usr/bin/env ruby
+################################################################
+#
+# rcontool - shell interface to rcon commands
+#
+# (C) 2006 Erik Hollensbe, License details below
+#
+# Use 'rcontool -h' for usage instructions.
+#
+# The compilation of software known as rcontool is distributed under the
+# following terms:
+# Copyright (C) 2005-2006 Erik Hollensbe. All rights reserved.
+#
+# Redistribution and use in source form, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+#
+# THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+#
+################################################################
+
+#
+# rubygems hack
+#
+
+begin
+  require 'rubygems'
+rescue LoadError => e
+end
+begin
+  require 'rcon'
+  require 'ip'
+rescue LoadError => e
+  $stderr.puts "rcontool requires the rcon and ip libraries be installed."
+  $stderr.puts "You can find them both via rubygems or at http://rubyforge.org."
+  exit -1
+end
+
+RCONTOOL_VERSION = '0.1.0'
+
+require 'optparse'
+require 'ostruct'
+
+#
+# Manages our options
+#
+
+def get_options
+  options = OpenStruct.new
+  # ip address (IP::Address object)
+  options.ip_address = nil
+  # port (integer)
+  options.port = nil
+  # password
+  options.password = nil
+  # protocol type (one of :hlds, :source, :oldquake, :newquake)
+  options.protocol_type = nil
+  # verbose, spit out extra information
+  options.verbose = false
+  # command to execute on the server
+  options.command = nil
+
+  optparse = OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename $0} <ip_address:port> <command> [options]"
+    opts.separator ""
+    opts.separator "Options:"
+
+    opts.on("--ip-address [ADDRESS]",
+            "Provide an IP address to connect to. Does not take a port.") do |ip_address|
+      if ! options.ip_address.nil?
+        $stderr.puts "Error: you have already provided an IP Address."
+        $stderr.puts opts
+        exit -1
+      end
+
+      options.ip_address = IP::Address.new(ip_address)
+    end
+
+    opts.on("-r", "--port [PORT]",
+            "Port to connect to.") do |port|
+      if ! options.port.nil?
+        $stderr.puts "Error: you have already provided a port."
+        $stderr.puts opts
+        exit -1
+      end
+
+      options.port = port.to_i
+    end
+
+    opts.on("-c", "--command [COMMAND]",
+            "Command to run on the server.") do |command|
+      if ! options.command.nil?
+        $stderr.puts "Error: you have already provided a command."
+        $stderr.puts opts
+        exit -1
+      end
+      
+      options.command = command
+    end
+
+    opts.on("-p", "--password [PASSWORD]",
+            "Provide a password on the command line.") do |password|
+      options.password = password
+    end
+
+    opts.on("-f", "--password-from [FILENAME]",
+            "Get the password from a file (use '/dev/fd/0' or '/dev/stdin' to read from Standard Input).") do |filename|
+      if !filename.nil?
+        f = File.open(filename)
+        options.password = f.gets.chomp
+        f.close
+      else
+        $stderr.puts "Error: filename (from -f) is not valid."
+        $stderr.puts opts
+        exit -1
+      end
+    end
+
+    opts.on("-t", "--protocol-type [TYPE]", [:hlds, :source, :oldquake, :newquake],
+            "Type of rcon connection to make: (hlds, source, oldquake, newquake).",
+            "   Note: oldquake is quake1/quakeworld, newquake is quake2/3.") do |protocol_type|
+      options.protocol_type = protocol_type
+    end
+
+    opts.on("-v", "--[no-]verbose", 
+            "Run verbosely, print information about each packet recieved and turnaround times.") do |verbose|
+      options.verbose = verbose
+    end
+
+    opts.on("-h", "--help",
+                 "This help message.") do
+      $stderr.puts opts
+      exit -1
+    end
+
+    opts.on("--version", "Print the version information.") do
+      $stderr.puts "This is rcontool version #{RCONTOOL_VERSION},"
+      $stderr.puts "it is located at #{File.expand_path $0}."
+      exit -1
+    end
+
+    opts.separator ""
+    opts.separator "Note: IP, port, protocol type, password and command are required to function."
+    opts.separator ""
+    opts.separator "Examples (all are equivalent):"
+    opts.separator "\t#{File.basename($0)} 10.0.0.11 status -t hlds -r 27015 -p foobar"
+    opts.separator "\techo 'foobar' | #{File.basename($0)} 10.0.0.11:27015 status -t hlds -f /dev/stdin"
+    opts.separator "\t#{File.basename($0)} --ip-address 10.0.0.11 --port 27015 -c status -t hlds -f file_with_password"
+    opts.separator ""
+
+  end
+
+  ################################################################
+  #
+  # This hackery is to help facilitate the bareword options if
+  # they exist, while still allowing for the option parser
+  # to work properly.
+  #
+  ################################################################
+
+  s1 = ARGV.shift
+  s2 = ARGV.shift
+
+  begin
+    options.ip_address = IP::Address.new(s1)
+    options.command = s2
+  rescue IP::AddressException => e
+    # attempt to split it first... not sure how to best handle this situation
+    begin
+      ip,port = s1.split(/:/, 2)
+      options.ip_address = IP::Address.new(ip)
+      options.port = port.to_i
+      options.command = s2
+    rescue Exception => e
+    end
+
+    if [options.ip_address, options.port].include? nil
+      ARGV.unshift(s2)
+      ARGV.unshift(s1)
+    end
+  end
+  
+  optparse.parse!
+
+  if [options.ip_address, options.protocol_type, options.port, options.password, options.command].include? nil
+    $stderr.puts optparse
+    exit -1
+  end
+
+  return options
+end
+
+def verbose(string)
+  $stderr.puts string if $options.verbose
+end
+
+def dump_source_packet(packet)
+  if $options.verbose
+    verbose "Request ID: #{packet.request_id}"
+    verbose "Packet Size: #{packet.packet_size}"
+    verbose "Response Type: #{packet.command_type}"
+  end
+end
+
+################################################################
+#
+# start main block
+#
+################################################################
+
+$options = get_options
+
+################################################################
+#
+# Source query
+#
+################################################################
+
+if $options.protocol_type == :source
+  verbose "Protocol type 'SOURCE' selected."
+
+  rcon = RCon::Query::Source.new($options.ip_address.ip_address, $options.port)
+
+  # if we have a verbose request, give all the information we can about
+  # the query, including the packet information.
+  rcon.return_packets = $options.verbose
+
+  verbose "Attempting authentication to #{$options.ip_address.ip_address}:#{$options.port} with password '#{$options.password}'"
+
+  value = rcon.auth $options.password
+
+  dump_source_packet value
+
+  if ($options.verbose && value.command_type == RCon::Packet::Source::RESPONSE_AUTH) || value
+    verbose "Authentication succeeded. Sending command: '#{$options.command}'"
+
+    value = rcon.command $options.command
+
+    dump_source_packet value
+    verbose ""
+
+    if $options.verbose
+      puts value.string1
+    else
+      puts value
+    end
+    
+    exit 0
+  else
+    $stderr.puts "Authentication failed."
+    exit 1
+  end
+
+################################################################
+#
+# Original Query
+#
+################################################################
+
+else
+  rcon = nil
+  case $options.protocol_type
+  when :hlds
+    verbose "Protocol type 'HLDS' selected"
+    rcon = RCon::Query::Original.new($options.ip_address.ip_address, $options.port, $options.password,
+                                     RCon::Query::Original::HLDS)
+  when :oldquake
+    verbose "Protocol type 'OLDQUAKE' selected"
+    rcon = RCon::Query::Original.new($options.ip_address.ip_address, $options.port, $options.password,
+                                     RCon::Query::Original::QUAKEWORLD)
+  when :newquake
+    verbose "Protocol type 'NEWQUAKE' selected"
+    rcon = RCon::Query::Original.new($options.ip_address.ip_address, $options.port, $options.password,
+                                     RCon::Query::Original::NEWQUAKE)
+  end
+  verbose "Attempting transmission to #{$options.ip_address.ip_address}:#{$options.port}"
+  verbose "Using password: '#{$options.password}' and sending command: '#{$options.command}'"
+  verbose ""
+  string = rcon.command($options.command)
+
+  puts string
+  exit 0
+end
+

data/lib/rcon.rb

@@ -4,7 +4,7 @@ require 'socket'
 # RCon is a module to work with Quake 1/2/3, Half-Life, and Half-Life
 # 2 (Source Engine) RCon (Remote Console) protocols.
 #
-# Version:: 0.1.0
+# Version:: 0.2.0
 #
 # Author:: Erik Hollensbe <erik@hollensbe.org>
 #
@@ -20,9 +20,13 @@ require 'socket'
 # Usage is fairly simple:
 #
 # # Note: Other classes have different constructors
+#
 # rcon = RCon::Query::Source.new("10.0.0.1", 27015)
+#
 # rcon.auth("foobar") # source only
+#
 # rcon.command("mp_friendlyfire") => "mp_friendlyfire = 1"
+#
 # rcon.cvar("mp_friendlyfire") => 1
 #
 # ================================================================
@@ -34,8 +38,7 @@ require 'socket'
 # Redistribution and use in source form, with or without
 # modification, are permitted provided that the following conditions
 # are met:
-# 1. Redistributions of source code must retain the above copyright
-#   notice, this list of conditions and the following disclaimer.
+# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 #
 # THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
@@ -104,8 +107,8 @@ class RCon::Packet::Source
   attr_accessor :packet_size
   # Request Identifier, used in managing multiple requests at once
   attr_accessor :request_id
-  # Type of command, normally COMMAND_AUTH or COMMAND_EXEC
-  attr_accessor :type
+  # Type of command, normally COMMAND_AUTH or COMMAND_EXEC. In response packets, RESPONSE_AUTH or RESPONSE_NORM
+  attr_accessor :command_type
   # First string, the only used one in the protocol, contains
   # commands and responses. Null terminated.
   attr_accessor :string1
@@ -121,7 +124,7 @@ class RCon::Packet::Source
     @request_id = rand(1000)
     @string1 = string
     @string2 = TRAILER
-    @type = COMMAND_EXEC
+    @command_type = COMMAND_EXEC
 
     @packet_size = build_packet.length
 
@@ -137,7 +140,7 @@ class RCon::Packet::Source
     @request_id = rand(1000)
     @string1 = string
     @string2 = TRAILER
-    @type = COMMAND_AUTH
+    @command_type = COMMAND_AUTH
     
     @packet_size = build_packet.length
     
@@ -150,7 +153,7 @@ class RCon::Packet::Source
   # that srcds actually needs.
   #
   def build_packet
-    return [@request_id, @type, @string1, @string2].pack("VVa#{@string1.length}a2")
+    return [@request_id, @command_type, @string1, @string2].pack("VVa#{@string1.length}a2")
   end
 
   # Returns a string representation of the packet, useful for
@@ -197,6 +200,8 @@ class RCon::Query::Original < RCon::Query
   attr_reader :port
   # RCon password
   attr_reader :password
+  # type of server
+  attr_reader :server_type
   
   #
   # Creates a RCon::Query::Original object for use.
@@ -205,7 +210,9 @@ class RCon::Query::Original < RCon::Query
   # values:
   # 
   # HLDS - Half Life 1 (will not work with older versions of HLDS)
+  #
   # QUAKEWORLD - QuakeWorld/Quake 1
+  #
   # NEWQUAKE - Quake 2/3 (and many derivatives)
   #
 
@@ -213,7 +220,7 @@ class RCon::Query::Original < RCon::Query
     @host = host
     @port = port
     @password = password
-    @type = type
+    @server_type = type
   end
   
   #
@@ -241,7 +248,7 @@ class RCon::Query::Original < RCon::Query
     @socket.print "\xFF" * 4 + "rcon #{@challenge_id} \"#{@password}\" #{@request}\n\x00"
     @response = retrieve_socket_data
 
-    @response.sub! /^\xFF\xFF\xFF\xFF#{@type}/, ""
+    @response.sub! /^\xFF\xFF\xFF\xFF#{@server_type}/, ""
     @response.sub! /\x00+$/, ""
     
     return @response
@@ -316,7 +323,7 @@ class RCon::Query::Source < RCon::Query
   # Authentication Status
   attr_reader :authed
   # return full packet, or just data?
-  attr :return_packets
+  attr_accessor :return_packets
   
   #
   # Given a host and a port (dotted-quad or hostname OK), creates
@@ -367,8 +374,8 @@ class RCon::Query::Source < RCon::Query
     @socket.print @packet.to_s
     rpacket = build_response_packet
 
-    if rpacket.type != RCon::Packet::Source::RESPONSE_NORM
-      raise RCon::NetworkException.new("error sending command: #{rpacket.type}")
+    if rpacket.command_type != RCon::Packet::Source::RESPONSE_NORM
+      raise RCon::NetworkException.new("error sending command: #{rpacket.command_type}")
     end
 
     if @return_packets
@@ -398,12 +405,12 @@ class RCon::Query::Source < RCon::Query
     rpacket = nil
     2.times { rpacket = build_response_packet }
 
-    if rpacket.type != RCon::Packet::Source::RESPONSE_AUTH
-      raise RCon::NetworkException.new("error authenticating: #{rpacket.type}")
+    if rpacket.command_type != RCon::Packet::Source::RESPONSE_AUTH
+      raise RCon::NetworkException.new("error authenticating: #{rpacket.command_type}")
     end
 
     @authed = true
-    if @return_packet
+    if @return_packets
       return rpacket
     else
       return true
@@ -463,7 +470,7 @@ class RCon::Query::Source < RCon::Query
     
     rpacket.packet_size = total_size
     rpacket.request_id = request_id
-    rpacket.type = type
+    rpacket.command_type = type
     
     # strip nulls (this is actually the end of string1 and string2)
     rpacket.string1 = response.sub /\x00\x00$/, ""

metadata

@@ -3,12 +3,11 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rcon
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-01-28 00:00:00 -08:00
-summary: "Ruby class to work with Quake 1/2/3, Half-Life and Source Engine rcon (remote
-  console)"
+  version: 0.2.0
+date: 2006-02-08 00:00:00 -08:00
+summary: Ruby class to work with Quake 1/2/3, Half-Life and Source Engine rcon (remote console)
 require_paths: 
-  - lib
+- lib
 email: erik@hollensbe.org
 homepage: 
 rubyforge_project: 
@@ -19,22 +18,37 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Erik Hollensbe
+- Erik Hollensbe
 files: 
-  - lib/rcon.rb
+- lib/rcon.rb
+- bin/rcontool
 test_files: []
+
 rdoc_options: []
+
 extra_rdoc_files: []
-executables: []
+
+executables: 
+- rcontool
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ip
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: