openc3 6.9.1 → 6.10.0

data/lib/openc3/system/target.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -68,12 +68,6 @@ module OpenC3
     # @return [Integer] The number of telemetry packets received from this target
     attr_accessor :tlm_cnt
 
-    # @return [Boolean] Indicates if all command packets identify using different fields
-    attr_accessor :cmd_unique_id_mode
-
-    # @return [Boolean] Indicates if telemetry packets identify using different fields
-    attr_accessor :tlm_unique_id_mode
-
     # @return [String] Id of the target configuration
     attr_accessor :id
 
@@ -91,13 +85,10 @@ module OpenC3
       @ignored_parameters = []
       @ignored_items = []
       @cmd_tlm_files = []
-      # @auto_screen_substitute = false
       @interface = nil
       @routers = []
       @cmd_cnt = 0
       @tlm_cnt = 0
-      @cmd_unique_id_mode = false
-      @tlm_unique_id_mode = false
       @name = target_name.clone.upcase.freeze
       get_target_dir(path, gem_path)
       process_target_config_file()
@@ -174,20 +165,8 @@ module OpenC3
 
           @cmd_tlm_files << filename
 
-          # when 'AUTO_SCREEN_SUBSTITUTE'
-          # usage = "#{keyword}"
-          # parser.verify_num_parameters(0, 0, usage)
-          # @auto_screen_substitute = true
-
-        when 'CMD_UNIQUE_ID_MODE'
-          usage = "#{keyword}"
-          parser.verify_num_parameters(0, 0, usage)
-          @cmd_unique_id_mode = true
-
-        when 'TLM_UNIQUE_ID_MODE'
-          usage = "#{keyword}"
-          parser.verify_num_parameters(0, 0, usage)
-          @tlm_unique_id_mode = true
+        when 'CMD_UNIQUE_ID_MODE', 'TLM_UNIQUE_ID_MODE'
+          # Deprecated - Now autodetected
 
         else
           # blank lines will have a nil keyword and should not raise an exception
@@ -202,15 +181,7 @@ module OpenC3
       config['requires'] = @requires
       config['ignored_parameters'] = @ignored_parameters
       config['ignored_items'] = @ignored_items
-      # config['auto_screen_substitute'] = true if @auto_screen_substitute
       config['cmd_tlm_files'] = @cmd_tlm_files
-      # config['filename'] = @filename
-      # config['interface'] = @interface.name if @interface
-      # config['dir'] = @dir
-      # config['cmd_cnt'] = @cmd_cnt
-      # config['tlm_cnt'] = @tlm_cnt
-      config['cmd_unique_id_mode'] = true if @cmd_unique_id_mode
-      config['tlm_unique_id_mode'] = true if @tlm_unique_id_mode
       config['id'] = @id
       config
     end

data/lib/openc3/tools/table_manager/table_config.rb

@@ -226,7 +226,7 @@ module OpenC3
     # (see PacketConfig#start_item)
     def start_item(parser)
       finish_item
-      @current_item = TableItemParser.parse(parser, @current_packet, @warnings)
+      @current_item = TableItemParser.parse(parser, self, @current_packet, @warnings)
     end
 
     # If the table is ROW_COLUMN all currently defined items are
@@ -266,6 +266,14 @@ module OpenC3
               item.default = @defaults[index].to_f
             when :STRING, :BLOCK
               item.default = @defaults[index]
+            when :BOOL
+              item.default = ConfigParser.handle_true_false(@defaults[index])
+            when :ARRAY, :OBJECT, :ANY
+              begin
+                item.default = JSON.parse(@defaults[index], allow_nan: true)
+              rescue Exception
+                item.default = @defaults[index]
+              end
             end
           end
         end

data/lib/openc3/tools/table_manager/table_item_parser.rb

@@ -30,8 +30,8 @@ module OpenC3
     # @param parser [ConfigParser] Configuration parser
     # @param table [Table] Table all parsed items should be added to
     # # @param warnings [Array<String>] Array of warning strings from PacketConfig
-    def self.parse(parser, table, warnings)
-      parser = TableItemParser.new(parser, warnings)
+    def self.parse(parser, table_config, table, warnings)
+      parser = TableItemParser.new(parser, table_config, warnings)
       parser.verify_parameters(PacketConfig::COMMAND)
       parser.create_table_item(table)
     end

data/lib/openc3/top_level.rb

@@ -26,7 +26,6 @@ require 'digest'
 require 'open3'
 require 'openc3/core_ext'
 require 'openc3/version'
-require 'openc3/utilities/logger'
 require 'socket'
 require 'pathname'
 
@@ -107,6 +106,8 @@ module OpenC3
     end
   end
 
+  require 'openc3/utilities/logger'
+
   # Creates a marshal file by serializing the given obj
   #
   # @param marshal_filename [String] Name of the marshal file to create
@@ -551,30 +552,55 @@ module OpenC3
   end
 end
 
-# The following code makes most older COSMOS 5 plugins still work with OpenC3
+# The following code makes most older COSMOS plugins still work with OpenC3
 # New plugins should only use openc3 paths and module OpenC3
 unless ENV['OPENC3_NO_COSMOS_COMPATIBILITY']
   Cosmos = OpenC3
   ENV['COSMOS_SCOPE'] = ENV['OPENC3_SCOPE']
-  module CosmosCompatibility
-    def require(*args)
-      filename = args[0]
-      if filename[0..6] == "cosmos/"
-        filename[0..6] = "openc3/"
+
+  # Don't apply the compatibility layer in test environments to avoid conflicts with RSpec
+  unless defined?(RSpec) || ENV['RAILS_ENV'] == 'test' || ENV['RACK_ENV'] == 'test'
+    module CosmosCompatibility
+      # Validates the filename after cosmos->openc3 transformation
+      def safe_openc3_path?(filename)
+        return false unless filename.is_a?(String)
+        # Only validate paths that start with "openc3/" (transformed from "cosmos/")
+        return true unless filename.start_with?("openc3/")
+        # Disallow any ".." or "." path traversal
+        return false if filename.include?("..") || filename.include?("./") || filename.include?("/.") || filename.include?("\\") || filename.include?("//")
+        # Disallow absolute paths (Unix and Windows)
+        return false if filename.start_with?("/") || filename =~ /^[a-zA-Z]:[\\\/]/
+        # Disallow special characters (allow word chars, dash, slash, dot)
+        return false unless filename =~ /\A[\w\-\/\.]+\z/
+        true
       end
-      args[0] = filename
-      super(*args)
-    end
-    def load(*args)
-      filename = args[0]
-      if filename[0..6] == "cosmos/"
-        filename[0..6] = "openc3/"
+
+      def require(*args)
+        filename = args[0]
+        if filename.is_a?(String) && filename.start_with?("cosmos/")
+          filename = filename.sub(/^cosmos\//, "openc3/")
+          unless safe_openc3_path?(filename)
+            raise ArgumentError, "Unsafe path in require after cosmos->openc3 transformation: #{filename.inspect}"
+          end
+          args[0] = filename
+        end
+        super(*args)
+      end
+
+      def load(*args)
+        filename = args[0]
+        if filename.is_a?(String) && filename.start_with?("cosmos/")
+          filename = filename.sub(/^cosmos\//, "openc3/")
+          unless safe_openc3_path?(filename)
+            raise ArgumentError, "Unsafe path in load after cosmos->openc3 transformation: #{filename.inspect}"
+          end
+          args[0] = filename
+        end
+        super(*args)
       end
-      args[0] = filename
-      super(*args)
     end
-  end
-  class Object
-    include CosmosCompatibility
+    class Object
+      include CosmosCompatibility
+    end
   end
 end

data/lib/openc3/topics/decom_interface_topic.rb

@@ -17,6 +17,7 @@
 # if purchased from OpenC3, Inc.
 
 require 'openc3/topics/topic'
+require 'openc3/config/config_parser'
 
 module OpenC3
   class DecomInterfaceTopic < Topic
@@ -58,5 +59,35 @@ module OpenC3
       Topic.write_topic("#{scope}__DECOMINTERFACE__{#{target_name}}",
           { 'inject_tlm' => JSON.generate(data, allow_nan: true) }, '*', 100)
     end
+
+    def self.get_tlm_buffer(target_name, packet_name, timeout: 5, scope:)
+      data = {}
+      data['target_name'] = target_name.to_s.upcase
+      data['packet_name'] = packet_name.to_s.upcase
+      # DecomMicroservice is listening to the DECOMINTERFACE topic and has
+      # the most recent decommed packets including subpackets
+      ack_topic = "{#{scope}__ACKCMD}TARGET__#{target_name}"
+      Topic.update_topic_offsets([ack_topic])
+      decom_id = Topic.write_topic("#{scope}__DECOMINTERFACE__{#{target_name}}",
+          { 'get_tlm_buffer' => JSON.generate(data, allow_nan: true) }, '*', 100)
+      time = Time.now
+      while (Time.now - time) < timeout
+        Topic.read_topics([ack_topic]) do |_topic, _msg_id, msg_hash, _redis|
+          if msg_hash["id"] == decom_id
+            if msg_hash["result"] == "SUCCESS"
+              msg_hash["stored"] = ConfigParser.handle_true_false(msg_hash["stored"])
+              extra = msg_hash["extra"]
+              if extra and extra.length > 0
+                msg_hash["extra"] = JSON.parse(extra, allow_nan: true, create_additions: true)
+              end
+              return msg_hash
+            else
+              raise msg_hash["message"]
+            end
+          end
+        end
+      end
+      raise "Timeout of #{timeout}s waiting for ack. Does target '#{target_name}' exist?"
+    end
   end
 end

data/lib/openc3/utilities/authentication.rb

@@ -23,6 +23,7 @@
 require 'openc3/version'
 require 'openc3/io/json_drb'
 require 'faraday'
+require 'uri'
 
 module OpenC3
   # Basic exception for known errors
@@ -112,9 +113,13 @@ module OpenC3
       client_id = ENV['OPENC3_API_CLIENT'] || 'api'
       if ENV['OPENC3_API_USER'] and ENV['OPENC3_API_PASSWORD']
         # Username and password
-        data = "username=#{ENV['OPENC3_API_USER']}&password=#{ENV['OPENC3_API_PASSWORD']}"
-        data << "&client_id=#{client_id}"
-        data << "&grant_type=password&scope=#{openid_scope}"
+        data = {
+          'username' => ENV['OPENC3_API_USER'],
+          'password' => ENV['OPENC3_API_PASSWORD'],
+          'client_id' => client_id,
+          'grant_type' => 'password',
+          'scope' => openid_scope
+        }
         headers = {
           'Content-Type' => 'application/x-www-form-urlencoded',
           'User-Agent' => "OpenC3KeycloakAuthorization / #{OPENC3_VERSION} (ruby/openc3/lib/utilities/authentication)",
@@ -134,7 +139,11 @@ module OpenC3
     # Refresh the token and save token to instance
     def _refresh_token(current_time)
       client_id = ENV['OPENC3_API_CLIENT'] || 'api'
-      data = "client_id=#{client_id}&refresh_token=#{@refresh_token}&grant_type=refresh_token"
+      data = {
+        'client_id' => client_id,
+        'refresh_token' => @refresh_token,
+        'grant_type' => 'refresh_token'
+      }
       headers = {
         'Content-Type' => 'application/x-www-form-urlencoded',
         'User-Agent' => "OpenC3KeycloakAuthorization / #{OPENC3_VERSION} (ruby/openc3/lib/utilities/authentication)",
@@ -150,11 +159,21 @@ module OpenC3
     def _make_request(headers, data)
       realm = ENV['OPENC3_KEYCLOAK_REALM'] || 'openc3'
       uri = URI("#{@url}/realms/#{realm}/protocol/openid-connect/token")
-      @log[0] = "request uri: #{uri} header: #{headers} body: #{data}"
+      # Obfuscate password and refresh token in logs unless debug mode is enabled
+      if JsonDRb.debug?
+        log_data = data.inspect
+      else
+        # Create a copy of the hash with sensitive values obfuscated
+        log_data = data.dup
+        log_data['password'] = '***' if log_data.key?('password')
+        log_data['refresh_token'] = '***' if log_data.key?('refresh_token')
+        log_data = log_data.inspect
+      end
+      @log[0] = "request uri: #{uri} header: #{headers} body: #{log_data}"
       STDOUT.puts @log[0] if JsonDRb.debug?
       saved_verbose = $VERBOSE; $VERBOSE = nil
       begin
-        resp = @http.post(uri, data, headers)
+        resp = @http.post(uri, URI.encode_www_form(data), headers)
       ensure
         $VERBOSE = saved_verbose
       end