openc3-cosmos-cfdp 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13e88f3556a631c2f165f5960429dea0b8ebe9d5f6984fc9de89fb1e1f4d3a74
-  data.tar.gz: e8a0e0b293c80d55508b3e1be3435eecb1d9de0e17127df7a5077c1fe7a53e2d
+  metadata.gz: 79139b9f1a0842f2fda723326ecac01d214144f4e42f6fd98a807d684895dcc7
+  data.tar.gz: 2c77f4cd5d8b237b6414277ff9ae43f52739bceac27243e59808346b6dea5e90
 SHA512:
-  metadata.gz: c115f598a06588d99ef63ab97d6d85277472de273f8212af2f93b6972769cfc1faaa23303e1695d3ab77fadb206154578cd1410d5bf264b9c3e962c65e68ea2e
-  data.tar.gz: ed1b6971ceb621525768fe60f3a0c326bcd2e1ed59a310cd615d71e4788056bc7d23df0ee6b99000ebe1f19eddc974a5e8fc02413ec1e41f6b171f4855ada68a
+  metadata.gz: c7275036dc47dd2b54d60e69bcd3091a2e05fdccd677302463cd10cba10d3d7458ff859c7a5f9ad4466407582357b798890d72bfea7f3b0b6a6a70a6fde39b36
+  data.tar.gz: 93e8b60efdf726c95b3e5bbd77c7d05297de180bdff4eadf532e80c5cbc0e2772d73ad659bc173d0903fe031cc81a01645b0d9bae889a42781800af37a055336

data/README.md

@@ -2,13 +2,21 @@
 
 This plugin provides a microservice and corresponding API for handling the CCSDS File Delivery Protocol (CFDP).
 
-This CFDP implementation is intended to be compliant with CCSDS 727.0-B-5 - Blue Book July 2020.
+This CFDP implementation is intended to be compliant with:
+
+- CCSDS 727.0-B-5 - Blue Book July 2020
+- CCSDS 727.0-B-4 - Blue Book January 2007
+- CCSDS 727.0-B-3 - Blue Book June 2005
+
+It is also potentially compliant with earlier versions but that has not been evaluated.
 
 ## Installation
 
 1. Install this plugin in the Admin Tool
 2. During installation, edit plugin.txt to configure all of your MIB settings (See MIB Configuration Below)
 
+In particular be sure to set the desired protocol_version_number for each remote entity. protocol_version_number 0 is used for all versions of the standard before the 2020 release. protocol_version_number 1 is used for the current release and potential future releases. This plugin defaults to using protocol_version_number 1.
+
 ## Usage in Scripts
 
 See: [cfdp.rb]()
@@ -158,6 +166,7 @@ Minimum required settings:
 1. Segmentation Control and Flow Label have no effect
 2. Suspension requests are not queued as specified in 6.5.4.1.2
 3. Annex B - Store and Forward Overlay Operations are not implemented
+4. Extended operations and classes 3 and 4 from the earlier CFDP standards are not implemented
 
 ## Contributing
 

data/microservices/CFDP/Gemfile

@@ -2,7 +2,7 @@ source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 7.1.0'
+gem 'rails', '~> 7.1' # Left at 7.1 to support earlier cosmos versions
 
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.9.3', require: false
@@ -13,16 +13,8 @@ gem 'rack-cors', '~> 2.0'
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data'
 
-# Run against this stable release
-group :development, :test do
-  gem 'rspec-rails', '~> 6.0'
-  gem 'simplecov', '~> 0.20'
-  gem 'simplecov-cobertura', '~> 2.1'
-end
-
-group :test do
-  gem 'mock_redis', '>0.39'
-end
+# NOTE: Since we're not using the Gemfile.lock we can't include development
+# or test groups in the Gemfile or bundler tries to install them and fails
 
 if ENV['OPENC3_DEVEL']
   gem 'openc3', :path => ENV['OPENC3_DEVEL']

data/microservices/CFDP/Gemfile.dev

@@ -0,0 +1,35 @@
+source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 7.1' # Left at 7.1 to support earlier cosmos versions
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.9.3', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+gem 'rack-cors', '~> 2.0'
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data'
+
+group :development, :test do
+  gem 'rspec-rails', '~> 6.0'
+  gem 'simplecov', '~> 0.20'
+  gem 'simplecov-cobertura', '~> 2.1'
+end
+group :test do
+  gem 'mock_redis', '>0.39'
+end
+
+if ENV['OPENC3_DEVEL']
+  gem 'openc3', :path => ENV['OPENC3_DEVEL']
+elsif ENV['OPENC3_PATH']
+  gem 'openc3', :path => ENV['OPENC3_PATH']
+else
+  gem 'openc3', '>= 5.4.2.pre'
+end
+
+if ENV['OPENC3_ENTERPRISE_TAG']
+  gem 'openc3-enterprise', '>= 5.4.2.pre'
+end

data/microservices/CFDP/Gemfile.prod

@@ -0,0 +1,29 @@
+source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 7.1' # Left at 7.1 to support earlier cosmos versions
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.9.3', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+gem 'rack-cors', '~> 2.0'
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data'
+
+# NOTE: Since we're not using the Gemfile.lock we can't include development
+# or test groups in the Gemfile or bundler tries to install them and fails
+
+if ENV['OPENC3_DEVEL']
+  gem 'openc3', :path => ENV['OPENC3_DEVEL']
+elsif ENV['OPENC3_PATH']
+  gem 'openc3', :path => ENV['OPENC3_PATH']
+else
+  gem 'openc3', '>= 5.4.2.pre'
+end
+
+if ENV['OPENC3_ENTERPRISE_TAG']
+  gem 'openc3-enterprise', '>= 5.4.2.pre'
+end

data/microservices/CFDP/app/controllers/cfdp_controller.rb

@@ -48,6 +48,8 @@ class CfdpController < ApplicationController
     else
       render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
     render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
@@ -62,6 +64,8 @@ class CfdpController < ApplicationController
     else
       render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
     render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
@@ -76,6 +80,8 @@ class CfdpController < ApplicationController
     else
       render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
     render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end
@@ -90,6 +96,8 @@ class CfdpController < ApplicationController
     else
       render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }.as_json(:allow_nan => true), :status => 404
     end
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }.as_json(:allow_nan => true), :status => 400
   rescue => error
     render :json => { :status => 'error', :message => "#{error.message}\n#{error.backtrace.join("\n")}" }.as_json(:allow_nan => true), :status => 500
   end

data/microservices/CFDP/app/models/cfdp_crc_checksum.rb

@@ -17,7 +17,9 @@
 require 'openc3/utilities/crc'
 
 class CfdpCrcChecksum
-  def initialize(poly, seed, xor, reflect)
+  attr_reader :crc
+
+  def initialize(poly = OpenC3::Crc32::DEFAULT_POLY, seed = OpenC3::Crc32::DEFAULT_SEED, xor = true, reflect = true)
     @crc = OpenC3::Crc32.new(poly, seed, xor, reflect)
     @checksum = 0
   end

data/microservices/CFDP/app/models/cfdp_mib.rb

@@ -265,7 +265,8 @@ class CfdpMib
     end
     tmp_file.unlink
     return true
-  rescue
+  rescue => error
+    OpenC3::Logger.error(error.message, scope: ENV['OPENC3_SCOPE'])
     # Something went wrong so return false
     return false
   end

data/microservices/CFDP/app/models/cfdp_pdu.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'openc3/packets/packet'
 require 'openc3/utilities/crc'
@@ -87,19 +90,32 @@ class CfdpPdu < OpenC3::Packet
     end
 
     # Static header
-    keys = [
-      "VERSION",
-      "TYPE",
-      "DIRECTION",
-      "TRANSMISSION_MODE",
-      "LARGE_FILE_FLAG",
-      "PDU_DATA_LENGTH",
-      "SEGMENTATION_CONTROL",
-      "ENTITY_ID_LENGTH",
-      "SEGMENT_METADATA_FLAG",
-      "SEQUENCE_NUMBER_LENGTH",
-      "VARIABLE_DATA"
-    ]
+    version = pdu.read("VERSION")
+    pdu_hash["VERSION"] = version
+    if version == 0
+      keys = [
+        "TYPE",
+        "DIRECTION",
+        "TRANSMISSION_MODE",
+        "PDU_DATA_LENGTH",
+        "ENTITY_ID_LENGTH",
+        "SEQUENCE_NUMBER_LENGTH",
+        "VARIABLE_DATA"
+      ]
+    else
+      keys = [
+        "TYPE",
+        "DIRECTION",
+        "TRANSMISSION_MODE",
+        "LARGE_FILE_FLAG",
+        "PDU_DATA_LENGTH",
+        "SEGMENTATION_CONTROL",
+        "ENTITY_ID_LENGTH",
+        "SEGMENT_METADATA_FLAG",
+        "SEQUENCE_NUMBER_LENGTH",
+        "VARIABLE_DATA"
+      ]
+    end
     keys.each do |key|
       pdu_hash[key] = pdu.read(key)
     end
@@ -144,8 +160,9 @@ class CfdpPdu < OpenC3::Packet
   end
 
   def self.build_initial_pdu(type:, destination_entity:, file_size:, segmentation_control: "NOT_PRESERVED", transmission_mode: nil)
+    version = destination_entity['protocol_version_number']
     pdu = self.new(crcs_required: destination_entity['crcs_required'])
-    pdu.write("VERSION", destination_entity['protocol_version_number'])
+    pdu.write("VERSION", version)
     pdu.write("TYPE", type)
     pdu.write("DIRECTION", "TOWARD_FILE_RECEIVER")
     if transmission_mode
@@ -159,14 +176,21 @@ class CfdpPdu < OpenC3::Packet
     else
       pdu.write("CRC_FLAG", "CRC_NOT_PRESENT")
     end
-    if file_size >= 4_294_967_296
+
+    # Version 0 doesn't support large files
+    if version == 0 or file_size < 4_294_967_296
+      pdu.write("LARGE_FILE_FLAG", "SMALL_FILE")  # Equals 0
+    else
       pdu.write("LARGE_FILE_FLAG", "LARGE_FILE")
+    end
+
+    if version == 0
+      pdu.write("SEGMENTATION_CONTROL", 0) # Always 0
     else
-      pdu.write("LARGE_FILE_FLAG", "SMALL_FILE")
+      pdu.write("SEGMENTATION_CONTROL", segmentation_control)
     end
-    pdu.write("SEGMENTATION_CONTROL", segmentation_control)
     pdu.write("ENTITY_ID_LENGTH", destination_entity['entity_id_length'])
-    pdu.write("SEGMENT_METADATA_FLAG", "NOT_PRESENT") # Not implemented
+    pdu.write("SEGMENT_METADATA_FLAG", "NOT_PRESENT") # Not implemented - always 0
     pdu.write("SEQUENCE_NUMBER_LENGTH", destination_entity['sequence_number_length'])
     return pdu
   end

data/microservices/CFDP/app/models/cfdp_receive_transaction.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require_relative 'cfdp_transaction'
 
@@ -485,7 +488,9 @@ class CfdpReceiveTransaction < CfdpTransaction
 
       CfdpTopic.write_indication("Metadata-Recv", **kw_args)
 
-      @checksum = get_checksum(@metadata_pdu_hash["CHECKSUM_TYPE"])
+      checksum_type = @metadata_pdu_hash["CHECKSUM_TYPE"]
+      checksum_type ||= 0 # For version 0
+      @checksum = get_checksum(checksum_type)
       unless @checksum
         # Use Null checksum if checksum type not available
         @condition_code = "UNSUPPORTED_CHECKSUM_TYPE"

data/microservices/CFDP/app/models/cfdp_source_transaction.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require_relative 'cfdp_transaction'
 
@@ -127,6 +130,8 @@ class CfdpSourceTransaction < CfdpTransaction
     @source_entity = CfdpMib.source_entity
     @destination_entity = CfdpMib.entity(destination_entity_id)
     raise "Unknown destination entity: #{destination_entity_id}" unless @destination_entity
+    version = @destination_entity['protocol_version_number']
+    raise "Closure requested not available in version 0" if version == 0 and closure_requested == "CLOSURE_REQUESTED"
     @transmission_mode = transmission_mode
     @transmission_mode = @destination_entity['default_transmission_mode'].upcase unless @transmission_mode
     @target_name, @packet_name, @item_name = @destination_entity["cmd_info"]

data/microservices/CFDP/app/models/cfdp_transaction.rb

@@ -180,7 +180,7 @@ class CfdpTransaction
 
   def get_checksum(checksum_type)
     case checksum_type
-    when 0 # Modular Checksum
+    when 0, nil # Modular Checksum
       return CfdpChecksum.new
     when 1 # Proximity-1 CRC-32 - Poly: 0x00A00805 - Reference CCSDS-211.2-B-3 - Unsure of correct xor/reflect
       return CfdpCrcChecksum.new(0x00A00805, 0x00000000, false, false)

data/microservices/CFDP/app/models/cfdp_user.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'thread'
 require 'openc3/config/config_parser'
@@ -144,6 +147,10 @@ class CfdpUser
     @source_threads.each do |st|
       st.kill if st.alive?
     end
+
+    @item_name_lookup = {}
+    @source_transactions = []
+    @source_threads = []
   end
 
   def start_source_transaction(params, proxy_response_info: nil)
@@ -155,6 +162,7 @@ class CfdpUser
         if params[:remote_entity_id] and Integer(params[:remote_entity_id]) != CfdpMib.source_entity_id
           # Proxy Put
           destination_entity = CfdpMib.entity(Integer(params[:destination_entity_id]))
+          version = destination_entity['protocol_version_number']
           pdu = CfdpPdu.build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, file_size: 0, segmentation_control: "NOT_PRESERVED", transmission_mode: nil)
           messages_to_user = []
           # messages_to_user << pdu.build_originating_transaction_id_message(source_entity_id: CfdpMib.source_entity.id, sequence_number: transaction.transaction_seq_num)
@@ -183,7 +191,7 @@ class CfdpUser
           if params[:segmentation_control]
             messages_to_user << pdu.build_proxy_segmentation_control_message(segmentation_control: params[:segmentation_control])
           end
-          if params[:closure_requested]
+          if version != 0 and params[:closure_requested]
             messages_to_user << pdu.build_proxy_closure_request_message(closure_requested: params[:closure_requested])
           end
           OpenC3::Logger.info("CFDP Transaction #{transaction.id} Proxy Put to Remote Entity #{params[:remote_entity_id]}, Destination Entity #{params[:destination_entity_id]}\nSource File Name: #{params[:source_file_name]}\nDestination File Name: #{params[:destination_file_name]}", scope: ENV['OPENC3_SCOPE'])
@@ -494,8 +502,9 @@ class CfdpUser
           end
           params[:messages_to_user] = []
           destination_entity = CfdpMib.entity(metadata_pdu_hash["SOURCE_ENTITY_ID"])
+          version = destination_entity['protocol_version_number']
           pdu = CfdpPdu.build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, file_size: 0, segmentation_control: "NOT_PRESERVED", transmission_mode: nil)
-          params[:messages_to_user] << pdu.build_directory_listing_response_message(response_code: "SUCCESSFUL", directory_name: directory_name, directory_file_name: directory_file_name)
+          params[:messages_to_user] << pdu.build_directory_listing_response_message(response_code: "SUCCESSFUL", directory_name: directory_name, directory_file_name: directory_file_name, version: version)
           params[:messages_to_user] << pdu.build_originating_transaction_id_message(source_entity_id: metadata_pdu_hash["SOURCE_ENTITY_ID"], sequence_number: metadata_pdu_hash["SEQUENCE_NUMBER"])
           start_source_transaction(params)
         else
@@ -505,8 +514,9 @@ class CfdpUser
           params[:destination_file_name] = nil
           params[:messages_to_user] = []
           destination_entity = CfdpMib.entity(metadata_pdu_hash["SOURCE_ENTITY_ID"])
+          version = destination_entity['protocol_version_number']
           pdu = CfdpPdu.build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, file_size: 0, segmentation_control: "NOT_PRESERVED", transmission_mode: nil)
-          params[:messages_to_user] << pdu.build_directory_listing_response_message(response_code: "UNSUCCESSFUL", directory_name: directory_name, directory_file_name: directory_file_name)
+          params[:messages_to_user] << pdu.build_directory_listing_response_message(response_code: "UNSUCCESSFUL", directory_name: directory_name, directory_file_name: directory_file_name, version: version)
           params[:messages_to_user] << pdu.build_originating_transaction_id_message(source_entity_id: metadata_pdu_hash["SOURCE_ENTITY_ID"], sequence_number: metadata_pdu_hash["SEQUENCE_NUMBER"])
           start_source_transaction(params)
         end

data/microservices/CFDP/config/application.rb

@@ -1,18 +1,7 @@
 require_relative "boot"
 
 require "rails"
-# Pick the frameworks you want:
-# require "active_model/railtie"
-# require "active_job/railtie"
-# require "active_record/railtie"
-# require "active_storage/engine"
 require "action_controller/railtie"
-# require "action_mailer/railtie"
-# require "action_mailbox/engine"
-# require "action_text/engine"
-# require "action_view/railtie"
-# require "action_cable/engine"
-# require "rails/test_unit/railtie"
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.

data/microservices/CFDP/config/environments/test.rb

@@ -28,7 +28,7 @@ Rails.application.configure do
   config.cache_store = :null_store
 
   # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = :none
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_file_data.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 class CfdpPdu < OpenC3::Packet
   def self.decom_file_data_pdu_contents(pdu, pdu_hash, variable_data)
@@ -58,10 +61,11 @@ class CfdpPdu < OpenC3::Packet
   end
 
   def define_file_data_pdu_contents
+    version = read("VERSION")
     smf = read("SEGMENT_METADATA_FLAG")
 
     s = nil
-    if smf == "PRESENT"
+    if version != 0 and smf == "PRESENT"
       s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
       item = s.append_item("RECORD_CONTINUATION_STATE", 2, :UINT)
       item.states = RECORD_CONTINUATION_STATES

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_finished.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,6 +13,9 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 class CfdpPdu < OpenC3::Packet
   def self.decom_finished_pdu_contents(pdu, pdu_hash, variable_data)
@@ -21,6 +24,9 @@ class CfdpPdu < OpenC3::Packet
     pdu_hash["CONDITION_CODE"] = s.read("CONDITION_CODE")
     pdu_hash["DELIVERY_CODE"] = s.read("DELIVERY_CODE")
     pdu_hash["FILE_STATUS"] = s.read("FILE_STATUS")
+    if pdu_hash['VERSION'] == 0
+      pdu_hash["END_SYSTEM_STATUS"] = s.read("END_SYSTEM_STATUS")
+    end
     variable_data = variable_data[s.defined_length..-1]
     while variable_data.length > 0
       variable_data = decom_tlv(pdu, pdu_hash, variable_data)
@@ -45,7 +51,7 @@ class CfdpPdu < OpenC3::Packet
     pdu_header_part_1_length -= CRC_BYTE_SIZE if destination_entity['crcs_required'] # PDU_DATA_LENGTH field should contain CRC length
     pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'], directive_code: "FINISHED")
     pdu_header_part_2_length = pdu_header.length - DIRECTIVE_CODE_BYTE_SIZE # Minus 1 = Directive code is part of data per 5.2.1.1
-    pdu_contents = pdu.build_finished_pdu_contents(condition_code: condition_code, delivery_code: delivery_code, file_status: file_status, filestore_responses: filestore_responses, fault_location_entity_id: fault_location_entity_id)
+    pdu_contents = pdu.build_finished_pdu_contents(destination_entity: destination_entity, condition_code: condition_code, delivery_code: delivery_code, file_status: file_status, filestore_responses: filestore_responses, fault_location_entity_id: fault_location_entity_id)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)
     if destination_entity['crcs_required']
@@ -59,7 +65,7 @@ class CfdpPdu < OpenC3::Packet
     s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
     item = s.append_item("CONDITION_CODE", 4, :UINT)
     item.states = CONDITION_CODES
-    s.append_item("SPARE", 1, :UINT)
+    item = s.append_item("END_SYSTEM_STATUS", 1, :UINT) # This is SPARE in version 1
     item = s.append_item("DELIVERY_CODE", 1, :UINT)
     item.states = DELIVERY_CODES
     item = s.append_item("FILE_STATUS", 2, :UINT)
@@ -67,11 +73,17 @@ class CfdpPdu < OpenC3::Packet
     return s
   end
 
-  def build_finished_pdu_contents(condition_code:, delivery_code:, file_status:, filestore_responses: [], fault_location_entity_id: nil)
+  def build_finished_pdu_contents(destination_entity:, condition_code:, delivery_code:, file_status:, filestore_responses: [], fault_location_entity_id: nil)
+    version = destination_entity['protocol_version_number']
+
     structures = []
     s = define_finished_pdu_contents()
     s.write("CONDITION_CODE", condition_code)
-    s.write("SPARE", 0)
+    if version >= 1
+      s.write("END_SYSTEM_STATUS", 0) # This Spare bit should probably be 0 - not specified in the standard
+    else
+      s.write("END_SYSTEM_STATUS", 1) # 1 = Generated by End System
+    end
     s.write("DELIVERY_CODE", delivery_code)
     s.write("FILE_STATUS", file_status)
     structures << s

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_metadata.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # Licensed for Evaluation and Educational Use
@@ -13,13 +13,20 @@
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
 # The development of this software was funded in-whole or in-part by MethaneSAT LLC.
+#
+# The development of this software was funded in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 class CfdpPdu < OpenC3::Packet
   def self.decom_metadata_pdu_contents(pdu, pdu_hash, variable_data)
     s, s2 = pdu.define_metadata_pdu_contents
     s.buffer = variable_data
-    pdu_hash["CLOSURE_REQUESTED"] = s.read("CLOSURE_REQUESTED")
-    pdu_hash["CHECKSUM_TYPE"] = s.read("CHECKSUM_TYPE")
+    if pdu_hash['VERSION'] >= 1
+      pdu_hash["CLOSURE_REQUESTED"] = s.read("CLOSURE_REQUESTED")
+      pdu_hash["CHECKSUM_TYPE"] = s.read("CHECKSUM_TYPE")
+    else
+      pdu_hash["SEGMENTATION_CONTROL"] = s.read("SEGMENTATION_CONTROL")
+    end
     pdu_hash["FILE_SIZE"] = s.read("FILE_SIZE")
     source_file_name_length = s.read("SOURCE_FILE_NAME_LENGTH")
     s.buffer = variable_data[0..(s.defined_length + source_file_name_length - 1)]
@@ -59,7 +66,8 @@ class CfdpPdu < OpenC3::Packet
     else
       checksum_type = 0
     end
-    pdu_contents = pdu.build_metadata_pdu_contents(source_entity: source_entity, closure_requested: closure_requested, checksum_type: checksum_type, file_size: file_size, source_file_name: source_file_name, destination_file_name: destination_file_name, options: options)
+    # This always sets the checksum type to 0 if version is 0
+    pdu_contents = pdu.build_metadata_pdu_contents(destination_entity: destination_entity, segmentation_control: segmentation_control, source_entity: source_entity, closure_requested: closure_requested, checksum_type: checksum_type, file_size: file_size, source_file_name: source_file_name, destination_file_name: destination_file_name, options: options)
     pdu.write("VARIABLE_DATA", pdu_header + pdu_contents)
     pdu.write("PDU_DATA_LENGTH", pdu.length - pdu_header_part_1_length - pdu_header_part_2_length)
     if destination_entity['crcs_required']
@@ -71,7 +79,8 @@ class CfdpPdu < OpenC3::Packet
 
   def define_metadata_pdu_contents
     s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
-    s.append_item("RESERVED", 1, :UINT)
+    item = s.append_item("SEGMENTATION_CONTROL", 1, :UINT) # RESERVED in version 1
+    item.states = SEGMENTATION_MODES
     item = s.append_item("CLOSURE_REQUESTED", 1, :UINT)
     item.states = CLOSURE_MODES
     s.append_item("RESERVED2", 2, :UINT)
@@ -92,16 +101,24 @@ class CfdpPdu < OpenC3::Packet
     return s, s2
   end
 
-  def build_metadata_pdu_contents(source_entity:, closure_requested:, checksum_type:, file_size:, source_file_name: nil, destination_file_name: nil, options: [])
+  def build_metadata_pdu_contents(destination_entity:, segmentation_control:, source_entity:, closure_requested:, checksum_type:, file_size:, source_file_name: nil, destination_file_name: nil, options: [])
+    version = destination_entity['protocol_version_number']
     s, s2 = define_metadata_pdu_contents()
-    s.write("RESERVED", 0)
-    if closure_requested
-      s.write("CLOSURE_REQUESTED", closure_requested)
+    if version >= 1
+      s.write("SEGMENTATION_CONTROL", 0) # Always 0 in version 1
+      if closure_requested
+        s.write("CLOSURE_REQUESTED", closure_requested)
+      else
+        s.write("CLOSURE_REQUESTED", source_entity['transaction_closure_requested'])
+      end
+      s.write("CHECKSUM_TYPE", checksum_type)
     else
-      s.write("CLOSURE_REQUESTED", source_entity['transaction_closure_requested'])
+      s.write("SEGMENTATION_CONTROL", segmentation_control)
+      s.write("CLOSURE_REQUESTED", 0)
+      s.write("CHECKSUM_TYPE", 0)
     end
     s.write("RESERVED2", 0)
-    s.write("CHECKSUM_TYPE", checksum_type)
+
     s.write("FILE_SIZE", file_size)
     s.write("SOURCE_FILE_NAME_LENGTH", source_file_name.to_s.length)
     s.write("SOURCE_FILE_NAME", source_file_name.to_s) if source_file_name.to_s.length > 0