openc3-cosmos-cfdp 2.0.0.pre.beta0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746462150840514e985ed89ed584ff64bd5ae834c99e6b9205cc2144e0f5153d
-  data.tar.gz: 2487a39e6238c64b5280b39f13f931fede9a67b42a87350da63bad3565b36764
+  metadata.gz: 79139b9f1a0842f2fda723326ecac01d214144f4e42f6fd98a807d684895dcc7
+  data.tar.gz: 2c77f4cd5d8b237b6414277ff9ae43f52739bceac27243e59808346b6dea5e90
 SHA512:
-  metadata.gz: '03559e2257ebcbfdd75ec8c9fb6c9a5c4d49d29eb854fd6a69d1c5569381ef4d2981ba69a473877d2d360443d0632f3b8d4667029bce49be1a54d5317617440e'
-  data.tar.gz: 9305b3b10e70364ed544f171d1cceecbd3ea484485c95b0b620ca3d03d2a77e8ab7591adfa72b738fb87b88f77c751714adbb58ed60c762ff459596a791d7d7f
+  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

data/microservices/CFDP/Gemfile.dev

@@ -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

data/microservices/CFDP/Gemfile.prod

@@ -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

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'

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'
 

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'
 

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'

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)

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)

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,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_metadata_pdu_contents(pdu, pdu_hash, variable_data)

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_tlv.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_tlv(pdu, pdu_hash, variable_data)

data/microservices/CFDP/lib/cfdp_pdu/cfdp_pdu_user_ops.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
 

data/microservices/CFDP/spec/controllers/cfdp_controller_spec.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
@@ -12,7 +12,8 @@
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # 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-whole or in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'rails_helper'
 

data/microservices/CFDP/spec/models/cfdp_crc_checksum_spec.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
@@ -12,7 +12,8 @@
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # 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-whole or in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'rails_helper'
 require 'tempfile'
@@ -24,7 +25,7 @@ RSpec.describe CfdpCrcChecksum do
     allow(@mock_crc32).to receive(:calc).and_return(0x12345678)
     allow(OpenC3::Crc32).to receive(:new).and_return(@mock_crc32)
   end
-  
+
   describe "initialize" do
     it "initializes with default values" do
       checksum = CfdpCrcChecksum.new
@@ -38,10 +39,10 @@ RSpec.describe CfdpCrcChecksum do
       seed = 0xFFFFFFFF
       xor = true
       reflect = true
-      
+
       # Expect it to be called with these specific parameters
       expect(OpenC3::Crc32).to receive(:new).with(poly, seed, xor, reflect).and_return(@mock_crc32)
-      
+
       checksum = CfdpCrcChecksum.new(poly, seed, xor, reflect)
       expect(checksum.crc).to eq(@mock_crc32)
     end
@@ -54,78 +55,78 @@ RSpec.describe CfdpCrcChecksum do
       expect(result).to eq(0)
     end
   end
-  
+
   describe "checksum" do
     it "calculates checksum from file" do
       # Create a tempfile with content
       file = Tempfile.new('crc_test')
       file.write("test data")
       file.rewind
-      
+
       # Expect the calc method to be called with the file data
       expect(@mock_crc32).to receive(:calc).with("test data").and_return(0xABCDEF12)
-      
+
       checksum = CfdpCrcChecksum.new
       result = checksum.checksum(file, false)
-      
+
       # The result should be masked to 32 bits
       expect(result).to eq(0xABCDEF12)
-      
+
       file.close
       file.unlink
     end
   end
-  
+
   describe "check" do
     it "returns true when checksums match" do
       # Create a tempfile with content
       file = Tempfile.new('crc_test')
       file.write("test data")
       file.rewind
-      
+
       checksum = CfdpCrcChecksum.new
-      
+
       # First, mock the internal checksum call to return a specific value
       expect(checksum).to receive(:checksum).with(file, false).and_return(0x12345678)
-      
+
       # Then check against the same value
       expect(checksum.check(file, 0x12345678, false)).to be true
-      
+
       file.close
       file.unlink
     end
-    
+
     it "returns false when checksums don't match" do
       # Create a tempfile with content
       file = Tempfile.new('crc_test')
       file.write("test data")
       file.rewind
-      
+
       checksum = CfdpCrcChecksum.new
-      
+
       # First, mock the internal checksum call to return a specific value
       expect(checksum).to receive(:checksum).with(file, false).and_return(0x12345678)
-      
+
       # Then check against a different value
       expect(checksum.check(file, 0x87654321, false)).to be false
-      
+
       file.close
       file.unlink
     end
-    
+
     it "handles an empty file" do
       # Create an empty tempfile
       file = Tempfile.new('crc_test')
       file.rewind
-      
+
       checksum = CfdpCrcChecksum.new
-      
+
       # For an empty file, mock the CRC to return a specific value
       expect(checksum).to receive(:checksum).with(file, false).and_return(0)
-      
+
       # The check should pass when comparing with the same value
       expect(checksum.check(file, 0, false)).to be true
-      
+
       file.close
       file.unlink
     end

data/microservices/CFDP/spec/models/cfdp_mib_spec.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
@@ -12,7 +12,8 @@
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # 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-whole or in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'rails_helper'
 require 'tempfile'

data/microservices/CFDP/spec/models/cfdp_pdu_metadata_spec.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 'rails_helper'
 require 'cfdp_pdu'

data/microservices/CFDP/spec/models/cfdp_pdu_user_ops_spec.rb

@@ -12,7 +12,8 @@
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 #
-# The development of this software was funded in-whole or in-part by Sandia National Laboratories
+# The development of this software was funded in-whole or in-part by Sandia National Laboratories.
+# See https://github.com/OpenC3/openc3-cosmos-cfdp/pull/12 for details
 
 require 'rails_helper'
 require 'cfdp_pdu'