cosmos 4.2.4 → 4.5.0

data/lib/cosmos/interfaces/tcpip_server_interface.rb

@@ -132,7 +132,7 @@ module Cosmos
             end
           rescue Exception => err
             shutdown_interfaces(@write_interface_infos)
-            Logger.instance.error("Tcpip server write thread unexpectedly died")
+            Logger.instance.error("#{@name}: Tcpip server write thread unexpectedly died")
             Logger.instance.error(err.formatted)
           end
         end
@@ -144,7 +144,7 @@ module Cosmos
             end
           rescue Exception => err
             shutdown_interfaces(@write_interface_infos)
-            Logger.instance.error("Tcpip server write raw thread unexpectedly died")
+            Logger.instance.error("#{@name}: Tcpip server write raw thread unexpectedly died")
             Logger.instance.error(err.formatted)
           end
         end
@@ -346,7 +346,7 @@ module Cosmos
             break if @cancel_threads
           end
         rescue => err
-          Logger.instance.error("Tcpip server listen thread unexpectedly died")
+          Logger.instance.error("#{@name}: Tcpip server listen thread unexpectedly died")
           Logger.instance.error(err.formatted)
         end
       end
@@ -372,7 +372,7 @@ module Cosmos
         if not System.instance.acl.allow_addr?(addr)
           # Reject connection
           Cosmos.close_socket(socket)
-          Logger.instance.info "Tcpip server rejected connection from #{hostname}(#{host_ip}):#{port}"
+          Logger.instance.info "#{@name}: Tcpip server rejected connection from #{hostname}(#{host_ip}):#{port}"
           return
         end
       end
@@ -417,7 +417,7 @@ module Cosmos
         end
         start_read_thread(@read_interface_infos[-1])
       end
-      Logger.instance.info "Tcpip server accepted connection from #{hostname}(#{host_ip}):#{port}"
+      Logger.instance.info "#{@name}: Tcpip server accepted connection from #{hostname}(#{host_ip}):#{port}"
     end
 
     def start_read_thread(interface_info)
@@ -427,10 +427,10 @@ module Cosmos
           begin
             read_thread_body(interface_info.interface)
           rescue Exception => err
-            Logger.instance.error "Tcpip server read thread unexpectedly died"
+            Logger.instance.error "#{@name}: Tcpip server read thread unexpectedly died"
             Logger.instance.error err.formatted
           end
-          Logger.instance.info "Tcpip server lost read connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
+          Logger.instance.info "#{@name}: Tcpip server lost read connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
           @read_threads.delete(Thread.current)
 
           index_to_delete = nil
@@ -453,7 +453,7 @@ module Cosmos
             end
           end
         rescue Exception => err
-          Logger.instance.error "Tcpip server read thread unexpectedly died"
+          Logger.instance.error "#{@name}: Tcpip server read thread unexpectedly died"
           Logger.instance.error err.formatted
         end
       end
@@ -500,7 +500,7 @@ module Cosmos
     end
 
     def interface_disconnect(interface_info)
-      Logger.instance.info "Tcpip server lost write connection to "\
+      Logger.instance.info "#{@name}: Tcpip server lost write connection to "\
         "#{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
       interface_info.interface.disconnect
       interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
@@ -552,13 +552,13 @@ module Cosmos
               next
             end
             # Client has disconnected (or is invalidly sending data on the socket)
-            Logger.instance.info "Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
+            Logger.instance.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
             interface_info.interface.disconnect
             interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
             indexes_to_delete.unshift(index) # Put later indexes at front of array
           rescue Errno::ECONNRESET, Errno::ECONNABORTED, IOError
             # Client has disconnected
-            Logger.instance.info "Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
+            Logger.instance.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
             interface_info.interface.disconnect
             interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
             indexes_to_delete.unshift(index) # Put later indexes at front of array
@@ -600,13 +600,13 @@ module Cosmos
             need_disconnect = true
           rescue Exception => err
             if err.message != "Stream not connected for write_raw"
-              Logger.instance.error "Error sending to client: #{err.class} #{err.message}"
+              Logger.instance.error "#{@name}: Error sending to client: #{err.class} #{err.message}"
             end
             need_disconnect = true
           end
 
           if need_disconnect
-            Logger.instance.info "Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
+            Logger.instance.info "#{@name}: Tcpip server lost write connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
             interface_info.interface.disconnect
             interface_info.interface.raw_logger_pair.stop if interface_info.interface.raw_logger_pair
             indexes_to_delete.unshift(index) # Put later indexes at front of array

data/lib/cosmos/io/json_drb.rb

@@ -44,14 +44,19 @@ module Puma
 end
 
 module Cosmos
-
   # JsonDRb implements the JSON-RPC 2.0 Specification to provide an interface
   # for both internal and external tools to access the COSMOS server. It
   # provides methods to install an access control list to control access to the
   # API. It also limits the available methods to a known list of allowable API
   # methods.
   class JsonDRb
+    # Minimum amount of time in seconds to receive the JSON request,
+    # process it, and send the response. Requests for less than this amount
+    # will be set to the minimum
     MINIMUM_REQUEST_TIME = 0.0001
+    STOP_SERVICE_TIMEOUT = 10.0 # seconds to wait when stopping the service
+    PUMA_THREAD_TIMEOUT  = 10.0 # seconds to wait for the puma threads to die
+    SERVER_START_TIMEOUT = 15.0 # seconds to wait for the server to start
 
     @@debug = false
 
@@ -94,9 +99,9 @@ module Cosmos
 
     # Stops the DRb service by closing the socket and the processing thread
     def stop_service
-      # Kill the server thread; it can take a while, so use
-      # graceful_timeout = 5, timeout_interval = 0.1, hard_timeout = 5
-      Cosmos.kill_thread(self, @thread, 5, 0.1, 5)
+      # Kill the server thread
+      # parameters are owner, thread, graceful_timeout, timeout_interval, hard_timeout
+      Cosmos.kill_thread(self, @thread, STOP_SERVICE_TIMEOUT, 0.1, STOP_SERVICE_TIMEOUT)
       @thread = nil
       @server_mutex.synchronize do
         @server = nil
@@ -118,7 +123,7 @@ module Cosmos
     # @param object [Object] The object to send the DRb requests to. This
     #   object must either include the Cosmos::Script module or be the
     #   CmdTlmServer.
-    def start_service(hostname = nil, port = nil, object = nil, max_threads = 1000)
+    def start_service(hostname = nil, port = nil, object = nil, max_threads = 1000, system = nil)
       server_started = false
       @server_mutex.synchronize do
         server_started = true if @server
@@ -142,7 +147,7 @@ module Cosmos
             }
 
             # The run call will block until the server is stopped.
-            Rack::Handler::Puma.run(JsonDrbRack.new(self), server_config) do |server|
+            Rack::Handler::Puma.run(JsonDrbRack.new(self, system), server_config) do |server|
               @server_mutex.synchronize do
                 @server = server
               end
@@ -155,7 +160,7 @@ module Cosmos
               puma_threads = false
               Thread.list.each {|thread| puma_threads = true if thread.inspect.match(/puma/)}
               break if !puma_threads
-              break if (Time.now - start_time) > 10.0
+              break if (Time.now - start_time) > PUMA_THREAD_TIMEOUT
               sleep 0.25
             end
 
@@ -184,7 +189,7 @@ module Cosmos
 
         # Wait for the server to be started in the thread before returning.
         start_time = Time.now
-        while ((Time.now - start_time) < 5.0) and !server_started
+        while ((Time.now - start_time) < SERVER_START_TIMEOUT) and !server_started
           sleep(0.1)
           @server_mutex.synchronize do
             server_started = true if @server and @server.running
@@ -254,10 +259,10 @@ module Cosmos
         error_code = nil
         response_data = nil
 
-        if (@method_whitelist and @method_whitelist.include?(request.method)) or
-           (!@method_whitelist and !JsonRpcRequest::DANGEROUS_METHODS.include?(request.method))
+        if (@method_whitelist and @method_whitelist.include?(request.method.downcase())) or
+           (!@method_whitelist and !JsonRpcRequest::DANGEROUS_METHODS.include?(request.method.downcase()))
           begin
-            result = @object.send(request.method.intern, *request.params)
+            result = @object.send(request.method.downcase().intern, *request.params)
             if request.id
               response = JsonRpcSuccessResponse.new(result, request.id)
             end
@@ -308,4 +313,3 @@ module Cosmos
 
   end
 end
-

data/lib/cosmos/io/json_drb_object.rb

@@ -38,7 +38,7 @@ module Cosmos
     # @param hostname [String] The name of the machine which has started
     #   the JSON service
     # @param port [Integer] The port number of the JSON service
-    def initialize(hostname, port, connect_timeout = 1.0)
+    def initialize(hostname, port, connect_timeout = 1.0, x_csrf_token = nil)
       hostname = '127.0.0.1' if (hostname.to_s.upcase == 'LOCALHOST')
       begin
         Socket.pack_sockaddr_in(port, hostname)
@@ -61,6 +61,7 @@ module Cosmos
       @connect_timeout = connect_timeout
       @connect_timeout = @connect_timeout.to_f if @connect_timeout
       @shutdown = false
+      @x_csrf_token = x_csrf_token
     end
 
     # Disconnects from http server
@@ -127,7 +128,11 @@ module Cosmos
         STDOUT.puts "\nRequest:\n" if JsonDRb.debug?
         STDOUT.puts @request_data if JsonDRb.debug?
         @request_in_progress = true
-        headers = {'Content-Type' => 'application/json-rpc'}
+        if @x_csrf_token
+          headers = {'Content-Type' => 'application/json-rpc', 'X-Csrf-Token' => @x_csrf_token}
+        else
+          headers = {'Content-Type' => 'application/json-rpc'}
+        end
         res = @http.post(@uri,
                          :body   => @request_data,
                          :header => headers)

data/lib/cosmos/io/json_drb_rack.rb

@@ -17,8 +17,9 @@ module Cosmos
   class JsonDrbRack
     # @param drb [JsonDRb] - An instance of the JsonDRb class that'll be used
     #   to process the JSON request and generate a response
-    def initialize(drb)
+    def initialize(drb, system = nil)
       @drb = drb
+      @system = system
     end
 
     # Handles a request.
@@ -32,22 +33,41 @@ module Cosmos
       # ACL allow_addr? function takes address in the form returned by
       # IPSocket.peeraddr.
       req_addr = ["AF_INET", request.port, request.host.to_s, request.ip.to_s]
+      status = nil
 
       if @drb.acl and !@drb.acl.allow_addr?(req_addr)
         status       = 403
         content_type = "text/plain"
         body         = "Forbidden"
       elsif request.post?
-        status, content_type, body = handle_post(request)
+        if @system
+          if @system.x_csrf_token and (request.env['HTTP_X_CSRF_TOKEN'] != @system.x_csrf_token)
+            status       = 403
+            content_type = "text/plain"
+            body         = "Forbidden: Bad X-Csrf-Token: #{request.env['HTTP_X_CSRF_TOKEN']}"
+          end
+          if !@system.allowed_hosts.include?(request.env['HTTP_HOST'])
+            status       = 403
+            content_type = "text/plain"
+            body         = "Forbidden: #{request.env['HTTP_HOST']} not in allowed hosts"
+          end
+          if request.env['HTTP_ORIGIN'] and !@system.allowed_origins.include?(request.env['HTTP_ORIGIN'])
+            status       = 403
+            content_type = "text/plain"
+            body         = "Forbidden: #{request.env['HTTP_ORIGIN']} not in allowed origins"
+          end
+        end
+
+        status, content_type, body = handle_post(request) unless status
       else
         status       = 405
         content_type = "text/plain"
         body         = "Request not allowed"
       end
-  
+
       return status, {'Content-Type' => content_type}, [body]
     end
-    
+
     # Handles an http post.
     #
     # @param request [Rack::Request] - A rack post request
@@ -57,7 +77,7 @@ module Cosmos
       request_data = request.body.read
       start_time = Time.now.sys
       response_data, error_code = @drb.process_request(request_data, start_time)
-  
+
       # Convert json error code into html status code
       # see http://www.jsonrpc.org/historical/json-rpc-over-http.html#errors
       if error_code

data/lib/cosmos/io/json_rpc.rb

@@ -269,7 +269,7 @@ module Cosmos
     # @param response_data [String] JSON encoded string representing the response
     # @return [JsonRpcResponse]
     def self.from_json(response_data)
-      msg = "Invalid JSON-RPC 2.0 Response"
+      msg = "Invalid JSON-RPC 2.0 Response: #{response_data.inspect}"
       begin
         hash = JSON.parse(response_data, :allow_nan => true, :create_additions => true)
       rescue

data/lib/cosmos/io/posix_serial_driver.rb

@@ -25,19 +25,20 @@ module Cosmos
                    write_timeout = 10.0,
                    read_timeout = nil,
                    flow_control = :NONE,
-                   data_bits = 8)
+                   data_bits = 8,
+                   struct = [])
 
       # Convert Baud Rate into Termios constant
       begin
         baud_rate = Object.const_get("Termios::B#{baud_rate}")
       rescue NameError
-        raise(ArgumentError, "Invalid Baud Rate, Not Defined by Termios: #{baud_rate}")
+        raise(ArgumentError, "Invalid baud rate: #{baud_rate}")
       end
 
       # Verify Parameters
-      raise(ArgumentError, "Invalid Data Bits: #{data_bits}") unless [5,6,7,8].include?(data_bits)
+      raise(ArgumentError, "Invalid data bits: #{data_bits}") unless [5,6,7,8].include?(data_bits)
       raise(ArgumentError, "Invalid parity: #{parity}") if parity and !SerialDriver::VALID_PARITY.include?(parity)
-      raise(ArgumentError, "Invalid Stop Bits: #{stop_bits}") unless [1,2].include?(stop_bits)
+      raise(ArgumentError, "Invalid stop bits: #{stop_bits}") unless [1,2].include?(stop_bits)
       @write_timeout = write_timeout
       @read_timeout = read_timeout
 
@@ -51,22 +52,61 @@ module Cosmos
 
       # Configure the serial Port
       tio = Termios::new_termios()
-      iflags = 0
-      iflags |= Termios::IGNPAR unless parity
-      cflags = 0
-      cflags |= Termios::CREAD # Enable receiver
-      cflags |= Termios.const_get("CS#{data_bits}") # data bits
-      cflags |= Termios::CLOCAL # Ignore Modem Control Lines
-      cflags |= Termios::CSTOPB if stop_bits == 2
-      cflags |= Termios::PARENB if parity
-      cflags |= Termios::PADODD if parity == :ODD
-      cflags |= Termios::CRTSCTS if flow_control == :RTSCTS
-      tio.iflag = iflags
-      tio.oflag = 0
-      tio.cflag = cflags
-      tio.lflag = 0
+      iflag = 0
+      iflag |= Termios::IGNPAR unless parity
+      oflag = 0
+      cflag = 0
+      cflag |= Termios::CREAD # Enable receiver
+      cflag |= Termios.const_get("CS#{data_bits}") # data bits
+      cflag |= Termios::CLOCAL # Ignore Modem Control Lines
+      cflag |= Termios::CSTOPB if stop_bits == 2
+      cflag |= Termios::PARENB if parity
+      cflag |= Termios::PARODD if parity == :ODD
+      cflag |= Termios::CRTSCTS if flow_control == :RTSCTS
+      lflag = 0
       tio.cc[Termios::VTIME] = 0
       tio.cc[Termios::VMIN] = 1
+      unless struct.empty?
+        struct.each do |field, key, value|
+          case field
+          when 'iflag'
+            if value == "0"
+              iflag &= ~Termios.const_get(key)
+            else
+              iflag |= Termios.const_get(key)
+            end
+          when 'oflag'
+            if value == "0"
+              oflag &= ~Termios.const_get(key)
+            else
+              oflag |= Termios.const_get(key)
+            end
+          when 'cflag'
+            if value == "0"
+              cflag &= ~Termios.const_get(key)
+            else
+              cflag |= Termios.const_get(key)
+            end
+          when 'lflag'
+            if value == "0"
+              lflag &= ~Termios.const_get(key)
+            else
+              lflag |= Termios.const_get(key)
+            end
+          when 'cc'
+            begin
+              value = Integer(value) # Try to convert to int
+            rescue ArgumentError
+              # Ignore this error and use the string
+            end
+            tio.cc[Termios.const_get(key)] = value
+          end
+        end
+      end
+      tio.iflag = iflag
+      tio.oflag = oflag
+      tio.cflag = cflag
+      tio.lflag = lflag
       tio.ispeed = baud_rate
       tio.ospeed = baud_rate
       @handle.tcflush(Termios::TCIOFLUSH)
@@ -143,7 +183,5 @@ module Cosmos
 
       data
     end
-
-  end # class PosixSerialDriver
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/io/serial_driver.rb

@@ -32,8 +32,10 @@ module Cosmos
     #   complete or nil to block
     # @param read_timeout [Float|nil] Number of seconds to wait for the read to
     #   complete or nil to block
-    # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
+    # @param flow_control [Symbol] Currently supported :NONE, :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
+    # @param struct [Array] Array of arrays of fields and values to set in the
+    #   Windows DCB or POSIX structure
     def initialize(port_name,
                    baud_rate,
                    parity = :NONE,
@@ -41,7 +43,8 @@ module Cosmos
                    write_timeout = 10.0,
                    read_timeout = nil,
                    flow_control = :NONE,
-                   data_bits = 8)
+                   data_bits = 8,
+                   struct = [])
       raise(ArgumentError, "Invalid parity: #{parity}") unless VALID_PARITY.include? parity
       if Kernel.is_windows?
         @driver = Win32SerialDriver.new(port_name,
@@ -53,7 +56,8 @@ module Cosmos
                                         0.01,
                                         1000,
                                         flow_control,
-                                        data_bits)
+                                        data_bits,
+                                        struct)
       elsif RUBY_ENGINE == 'ruby'
         @driver = PosixSerialDriver.new(port_name,
                                         baud_rate,
@@ -62,7 +66,8 @@ module Cosmos
                                         write_timeout,
                                         read_timeout,
                                         flow_control,
-                                        data_bits)
+                                        data_bits,
+                                        struct)
       else
         @driver = nil # JRuby Serial on Linux not currently supported
       end
@@ -92,7 +97,5 @@ module Cosmos
     def read_nonblock
       @driver.read_nonblock
     end
-
-  end # class SerialDriver
-
-end # module Cosmos
+  end
+end