openc3-cosmos-cfdp 1.0.0

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

@@ -0,0 +1,237 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# 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.
+
+class CfdpPdu < OpenC3::Packet
+  # Table 5-4: Directive Codes
+  DIRECTIVE_CODES = {
+    "EOF" => 4,
+    "FINISHED" => 5,
+    "ACK" => 6,
+    "METADATA" => 7,
+    "NAK" => 8,
+    "PROMPT" => 9,
+    "KEEP_ALIVE" => 0x0C
+    # 0D-FF are Reserved
+  }
+
+  # Table 5-5: Condition Codes
+  CONDITION_CODES = {
+    "NO_ERROR" => 0, # Not a fault
+    "ACK_LIMIT_REACHED" => 1,
+    "KEEP_ALIVE_LIMIT_REACHED" => 2,
+    "INVALID_TRANSMISSION_MODE" => 3, # Not implemented because we support both modes
+    "FILESTORE_REJECTION" => 4,
+    "FILE_CHECKSUM_FAILURE" => 5,
+    "FILE_SIZE_ERROR" => 6,
+    "NAK_LIMIT_REACHED" => 7,
+    "INACTIVITY_DETECTED" => 8,
+    "INVALID_FILE_STRUCTURE" => 9, # Not implemented because no segmentation control
+    "CHECK_LIMIT_REACHED" => 10,
+    "UNSUPPORTED_CHECKSUM_TYPE" => 11,
+    "SUSPEND_REQUEST_RECEIVED" => 14, # Not a fault
+    "CANCEL_REQUEST_RECEIVED" => 15 # Not a fault
+  }
+
+  # Table 5-7: Finished PDU Contents
+  DELIVERY_CODES = {
+    "DATA_COMPLETE" => 0,
+    "DATA_INCOMPLETE" => 1
+  }
+
+  # Table 5-7: Finished PDU Contents
+  FILE_STATUS_CODES = {
+    "FILE_DISCARDED" => 0,
+    "FILESTORE_REJECTION" => 1,
+    "FILESTORE_SUCCESS" => 2,
+    "UNREPORTED" => 3
+  }
+
+  # Paragraph 5.2.4 ACK PDU
+  TRANSACTION_STATUS_CODES = {
+    "UNDEFINED" => 0,
+    "ACTIVE" => 1,
+    "TERMINATED" => 2,
+    "UNRECOGNIZED" => 3
+  }
+
+  # Table 5-16: Filestore Request TLV Action Codes
+  ACTION_CODES = {
+    "CREATE_FILE" => 0,
+    "DELETE_FILE" => 1,
+    "RENAME_FILE" => 2,
+    "APPEND_FILE" => 3,
+    "REPLACE_FILE" => 4,
+    "CREATE_DIRECTORY" => 5,
+    "REMOVE_DIRECTORY" => 6,
+    "DENY_FILE" => 7,
+    "DENY_DIRECTORY" => 8
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  CREATE_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "NOT_ALLOWED" => 1,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  DELETE_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "FILE_DOES_NOT_EXIST" => 1,
+    "NOT_ALLOWED" => 2,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  RENAME_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "OLD_FILE_DOES_NOT_EXIST" => 1,
+    "NEW_FILE_ALREADY_EXISTS" => 2,
+    "NOT_ALLOWED" => 3,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  APPEND_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "FILE_1_DOES_NOT_EXIST" => 1,
+    "FILE_2_DOES_NOT_EXIST" => 2,
+    "NOT_ALLOWED" => 3,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  REPLACE_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "FILE_1_DOES_NOT_EXIST" => 1,
+    "FILE_2_DOES_NOT_EXIST" => 2,
+    "NOT_ALLOWED" => 3,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  CREATE_DIRECTORY_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "CANNOT_BE_CREATED" => 1,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  REMOVE_DIRECTORY_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "DOES_NOT_EXIST" => 1,
+    "NOT_ALLOWED" => 2,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  DENY_FILE_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "NOT_ALLOWED" => 2,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  DENY_DIRECTORY_STATUS_CODES = {
+    "SUCCESSFUL" => 0,
+    "NOT_ALLOWED" => 2,
+    "NOT_PERFORMED" => 15
+  }
+
+  # Special for unknown action codes
+  UNKNOWN_STATUS_CODES = {
+    "NOT_PERFORMED" => 15
+  }
+
+  # Table 5-18: Filestore Response Status Codes
+  FILESTORE_RESPONSE_STATUS_CODES = {
+    "CREATE_FILE" => CREATE_FILE_STATUS_CODES,
+    "DELETE_FILE" => DELETE_FILE_STATUS_CODES,
+    "RENAME_FILE" => RENAME_FILE_STATUS_CODES,
+    "APPEND_FILE" => APPEND_FILE_STATUS_CODES,
+    "REPLACE_FILE" => REPLACE_FILE_STATUS_CODES,
+    "CREATE_DIRECTORY" => CREATE_DIRECTORY_STATUS_CODES,
+    "REMOVE_DIRECTORY" => REMOVE_DIRECTORY_STATUS_CODES,
+    "DENY_FILE" => DENY_FILE_STATUS_CODES,
+    "DENY_DIRECTORY" => DENY_DIRECTORY_STATUS_CODES
+  }
+
+  # Table 5-14: File Data PDU Contents
+  RECORD_CONTINUATION_STATES = {
+    "NEITHER_START_NOR_END" => 0,
+    "START" => 1,
+    "END" => 2,
+    "START_AND_END" => 3
+  }
+
+  # Defined in Section 5.4
+  TLV_TYPES = {
+    "FILESTORE_REQUEST" => 0,
+    "FILESTORE_RESPONSE" => 1,
+    "MESSAGE_TO_USER" => 2,
+    "FAULT_HANDLER_OVERRIDE" => 4,
+    "FLOW_LABEL" => 5,
+    "ENTITY_ID" => 6
+  }
+
+  # Table 5-19
+  HANDLER_CODES = {
+    "ISSUE_NOTICE_OF_CANCELLATION" => 1,
+    "ISSUE_NOTICE_OF_SUSPENSION" => 2,
+    "IGNORE_ERROR" => 3,
+    "ABONDON_TRANSACTION" => 4
+  }
+
+  # 6.1.5, Table 6-3, Table 6-14, Table 6-17, Table 6-20, Table 6-23,
+  USER_MESSAGE_TYPES = {
+    "PROXY_PUT_REQUEST" => 0x00,
+    "PROXY_MESSAGE_TO_USER" => 0x01,
+    "PROXY_FILESTORE_REQUEST" => 0x02,
+    "PROXY_FAULT_HANDLER_OVERRIDE" => 0x03,
+    "PROXY_TRANSMISSION_MODE" => 0x04,
+    "PROXY_FLOW_LABEL" => 0x05,
+    "PROXY_SEGMENTATION_CONTROL" => 0x06,
+    "PROXY_PUT_RESPONSE" => 0x07,
+    "PROXY_FILESTORE_RESPONSE" => 0x08,
+    "PROXY_PUT_CANCEL" => 0x09,
+    "ORIGINATING_TRANSACTION_ID" => 0x0A,
+    "PROXY_CLOSURE_REQUEST" => 0x0B,
+    "DIRECTORY_LISTING_REQUEST" => 0x10,
+    "DIRECTORY_LISTING_RESPONSE" => 0x11,
+    "REMOTE_STATUS_REPORT_REQUEST" => 0x20,
+    "REMOTE_STATUS_REPORT_RESPONSE" => 0x21,
+    "REMOTE_SUSPEND_REQUEST" => 0x30,
+    "REMOTE_SUSPEND_RESPONSE" => 0x31,
+    "REMOTE_RESUME_REQUEST" => 0x38,
+    "REMOTE_RESUME_RESPONSE" => 0x39,
+  }
+
+  # Table 5-1
+  TRANSMISSION_MODES = {
+    "ACKNOWLEDGED" => 0,
+    "UNACKNOWLEDGED" => 1
+  }
+
+  CLOSURE_MODES = {
+    "CLOSURE_NOT_REQUESTED" => 0,
+    "CLOSURE_REQUESTED" => 1
+  }
+
+  SEGMENTATION_MODES = {
+    "NOT_PRESERVED" => 0,
+    "PRESERVED" => 1
+  }
+end

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

@@ -0,0 +1,87 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# 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.
+
+class CfdpPdu < OpenC3::Packet
+  def self.decom_eof_pdu_contents(pdu, pdu_hash, variable_data)
+    s = pdu.define_eof_pdu_contents()
+    s.buffer = variable_data[0..(s.defined_length - 1)]
+    pdu_hash["CONDITION_CODE"] = s.read("CONDITION_CODE")
+    pdu_hash["FILE_CHECKSUM"] = s.read("FILE_CHECKSUM")
+    pdu_hash["FILE_SIZE"] = s.read("FILE_SIZE")
+    if pdu_hash['CONDITION_CODE'] != "NO_ERROR"
+      variable_data = variable_data[s.defined_length..-1]
+      decom_tlv(pdu, pdu_hash, variable_data)
+    end
+  end
+
+  def self.build_eof_pdu(
+    source_entity:,
+    transaction_seq_num:,
+    destination_entity:,
+    file_size:,
+    file_checksum:,
+    condition_code:,
+    segmentation_control: "NOT_PRESERVED",
+    transmission_mode: nil,
+    canceling_entity_id: nil)
+
+    pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    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: "EOF")
+    pdu_header_part_2_length = pdu_header.length
+    pdu_contents = pdu.build_eof_pdu_contents(condition_code: condition_code, file_checksum: file_checksum, file_size: file_size, canceling_entity_id: canceling_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']
+      crc16 = OpenC3::Crc16.new
+      pdu.write("CRC", crc16.calc(pdu.buffer(false)[0..-3]))
+    end
+    return pdu.buffer(false)
+  end
+
+  def define_eof_pdu_contents
+    s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
+    item = s.append_item("CONDITION_CODE", 4, :UINT)
+    item.states = CONDITION_CODES
+    s.append_item("SPARE", 4, :UINT)
+    s.append_item("FILE_CHECKSUM", 32, :UINT)
+    large_file = read("LARGE_FILE_FLAG")
+    if large_file == "SMALL_FILE"
+      s.append_item("FILE_SIZE", 32, :UINT)
+    else
+      s.append_item("FILE_SIZE", 64, :UINT)
+    end
+    return s
+  end
+
+  def build_eof_pdu_contents(condition_code:, file_checksum:, file_size:, canceling_entity_id: nil)
+    s = define_eof_pdu_contents()
+    s.write("CONDITION_CODE", condition_code)
+    s.write("SPARE", 0)
+    s.write("FILE_CHECKSUM", file_checksum)
+    s.write("FILE_SIZE", file_size)
+    if canceling_entity_id
+      entity_id_length = read("ENTITY_ID_LENGTH") + 1
+      s2 = CfdpPdu.define_entity_id_tlv(entity_id_length: entity_id_length)
+      s2.write("TLV_TYPE", 0x06)
+      s2.write("TLV_LENGTH", entity_id_length)
+      s2.write("ENTITY_ID", canceling_entity_id)
+      return s.buffer(false) + s2.buffer(false)
+    else
+      return s.buffer(false)
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# 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.
+
+class CfdpPdu < OpenC3::Packet
+  def self.decom_file_data_pdu_contents(pdu, pdu_hash, variable_data)
+    s, s2 = pdu.define_file_data_pdu_contents
+    if s
+      s.buffer = variable_data
+      pdu_hash["RECORD_CONTINUATION_STATE"] = s.read("RECORD_CONTINUATION_STATE")
+      pdu_hash["SEGMENT_METADATA_LENGTH"] = s.read("SEGMENT_METADATA_LENGTH")
+      s.buffer = variable_data[0..pdu_hash["SEGMENT_METADATA_LENGTH"]]
+      pdu_hash["SEGMENT_METADATA"] = s.read("SEGMENT_METADATA")
+      variable_data = variable_data[(s.length)..-1]
+    end
+    s2.buffer = variable_data
+    pdu_hash['OFFSET'] = s2.read("OFFSET")
+    pdu_hash['FILE_DATA'] = s2.read("FILE_DATA")
+  end
+
+  def self.build_file_data_pdu(
+    source_entity:,
+    transaction_seq_num:,
+    destination_entity:,
+    file_size:,
+    segmentation_control: "NOT_PRESERVED",
+    transmission_mode: nil,
+    offset:,
+    file_data:,
+    record_continuation_state: nil,
+    segment_metadata: nil)
+
+    pdu = build_initial_pdu(type: "FILE_DATA", destination_entity: destination_entity, file_size: file_size, segmentation_control: segmentation_control, transmission_mode: transmission_mode)
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    pdu_header = pdu.build_variable_header(source_entity_id: source_entity['id'], transaction_seq_num: transaction_seq_num, destination_entity_id: destination_entity['id'])
+    pdu_header_part_2_length = pdu_header.length
+    pdu_contents = pdu.build_file_data_pdu_contents(offset: offset, file_data: file_data, record_continuation_state: record_continuation_state, segment_metadata: segment_metadata)
+    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']
+      crc16 = OpenC3::Crc16.new
+      pdu.write("CRC", crc16.calc(pdu.buffer(false)[0..-3]))
+    end
+    return pdu.buffer(false)
+  end
+
+  def define_file_data_pdu_contents
+    smf = read("SEGMENT_METADATA_FLAG")
+
+    s = nil
+    if smf == "PRESENT"
+      s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
+      item = s.append_item("RECORD_CONTINUATION_STATE", 2, :UINT)
+      item.states = RECORD_CONTINUATION_STATES
+      s.append_item("SEGMENT_METADATA_LENGTH", 6, :UINT)
+      s.append_item("SEGMENT_METADATA", 0, :BLOCK)
+    end
+
+    s2 = OpenC3::Structure.new(:BIG_ENDIAN)
+    large_file = read("LARGE_FILE_FLAG")
+    if large_file == "SMALL_FILE"
+      item_size = 32
+    else
+      item_size = 64
+    end
+    s2.append_item("OFFSET", item_size, :UINT)
+    s2.append_item("FILE_DATA", 0, :BLOCK)
+
+    return s, s2
+  end
+
+  def build_file_data_pdu_contents(offset:, file_data:, record_continuation_state: nil, segment_metadata: nil)
+    s, s2 = define_file_data_pdu_contents()
+    s2.write("OFFSET", offset)
+    s2.write("FILE_DATA", file_data.to_s)
+
+    if s
+      s.write("RECORD_CONTINUATION_STATE", record_continuation_state)
+      s.write("SEGMENT_METADATA_LENGTH", segment_metadata.to_s.length)
+      s.write("SEGMENT_METADATA", segment_metadata.to_s)
+      return s.buffer(false) + s2.buffer(false)
+    else
+      return s2.buffer(false)
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# 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.
+
+class CfdpPdu < OpenC3::Packet
+  def self.decom_finished_pdu_contents(pdu, pdu_hash, variable_data)
+    s = pdu.define_finished_pdu_contents
+    s.buffer = variable_data[0..(s.defined_length - 1)]
+    pdu_hash["CONDITION_CODE"] = s.read("CONDITION_CODE")
+    pdu_hash["DELIVERY_CODE"] = s.read("DELIVERY_CODE")
+    pdu_hash["FILE_STATUS"] = s.read("FILE_STATUS")
+    variable_data = variable_data[s.defined_length..-1]
+    while variable_data.length > 0
+      variable_data = decom_tlv(pdu, pdu_hash, variable_data)
+    end
+  end
+
+  def self.build_finished_pdu(
+    source_entity:,
+    transaction_seq_num:,
+    destination_entity:,
+    condition_code:,
+    segmentation_control: "NOT_PRESERVED",
+    transmission_mode: nil,
+    delivery_code:,
+    file_status:,
+    filestore_responses: [],
+    fault_location_entity_id: nil)
+
+    pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: 0, segmentation_control: segmentation_control)
+    pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    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
+    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.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']
+      crc16 = OpenC3::Crc16.new
+      pdu.write("CRC", crc16.calc(pdu.buffer(false)[0..-3]))
+    end
+    return pdu.buffer(false)
+  end
+
+  def define_finished_pdu_contents
+    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("DELIVERY_CODE", 1, :UINT)
+    item.states = DELIVERY_CODES
+    item = s.append_item("FILE_STATUS", 2, :UINT)
+    item.states = FILE_STATUS_CODES
+    return s
+  end
+
+  def build_finished_pdu_contents(condition_code:, delivery_code:, file_status:, filestore_responses: [], fault_location_entity_id: nil)
+    structures = []
+    s = define_finished_pdu_contents()
+    s.write("CONDITION_CODE", condition_code)
+    s.write("SPARE", 0)
+    s.write("DELIVERY_CODE", delivery_code)
+    s.write("FILE_STATUS", file_status)
+    structures << s
+
+    filestore_responses.each do |filestore_response|
+      action_code = filestore_response['ACTION_CODE']
+      status_code = filestore_response['STATUS_CODE']
+      first_file_name = filestore_response['FIRST_FILE_NAME']
+      second_file_name = filestore_response['SECOND_FILE_NAME']
+      filestore_message = filestore_response['FILESTORE_MESSAGE']
+      s, s2, s3, status_code_item = CfdpPdu.define_filestore_response_tlv()
+      CfdpPdu.add_status_code_states(action_code: action_code, status_code_item: status_code_item)
+      s.write("TLV_TYPE", 0x01)
+      s.write("TLV_LENGTH", 4 + first_file_name.to_s.length + second_file_name.to_s.length + filestore_message.to_s.length)
+      s.write("ACTION_CODE", action_code)
+      s.write("STATUS_CODE", status_code)
+      s.write("FIRST_FILE_NAME_LENGTH", first_file_name.to_s.length)
+      s.write("FIRST_FILE_NAME", first_file_name.to_s) if first_file_name.to_s.length > 0
+      s2.write("SECOND_FILE_NAME_LENGTH", second_file_name.to_s.length)
+      s2.write("SECOND_FILE_NAME", second_file_name.to_s) if second_file_name.to_s.length > 0
+      s3.write("FILESTORE_MESSAGE_LENGTH", filestore_message.to_s.length)
+      s3.write("FILESTORE_MESSAGE", filestore_message.to_s) if filestore_message.to_s.length > 0
+      structures << s
+      structures << s2
+      structures << s3
+    end
+    if fault_location_entity_id
+      entity_id_length = read("ENTITY_ID_LENGTH") + 1
+      s = CfdpPdu.define_entity_id_tlv(entity_id_length: entity_id_length)
+      s.write("TLV_TYPE", 0x06)
+      s.write("TLV_LENGTH", entity_id_length)
+      s.write("ENTITY_ID", fault_location_entity_id)
+      structures << s
+    end
+    result = ''
+    structures.each do |s|
+      result << s.buffer(false)
+    end
+    return result
+  end
+end

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

@@ -0,0 +1,65 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# Licensed for Evaluation and Educational Use
+#
+# This file may only be used commercially under the terms of a commercial license
+# purchased from OpenC3, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# 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.
+
+class CfdpPdu < OpenC3::Packet
+  def self.decom_keep_alive_pdu_contents(pdu, pdu_hash, variable_data)
+    s = pdu.define_keep_alive_pdu_contents
+    s.buffer = variable_data
+    pdu_hash["PROGRESS"] = s.read("PROGRESS")
+  end
+
+  def self.build_keep_alive_pdu(
+    source_entity:,
+    transaction_seq_num:,
+    destination_entity:,
+    file_size:,
+    segmentation_control: "NOT_PRESERVED",
+    transmission_mode: nil,
+    progress:)
+
+    pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: file_size, segmentation_control: segmentation_control)
+    pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
+    pdu_header_part_1_length = pdu.length # Measured here before writing variable data
+    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: "KEEP_ALIVE")
+    pdu_header_part_2_length = pdu_header.length
+    pdu_contents = pdu.build_keep_alive_pdu_contents(progress: progress)
+    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']
+      crc16 = OpenC3::Crc16.new
+      pdu.write("CRC", crc16.calc(pdu.buffer(false)[0..-3]))
+    end
+    return pdu.buffer(false)
+  end
+
+  def define_keep_alive_pdu_contents
+    s = OpenC3::Structure.new(:BIG_ENDIAN)
+    large_file = read("LARGE_FILE_FLAG")
+    if large_file == "SMALL_FILE"
+      item_size = 32
+    else
+      item_size = 64
+    end
+    s.append_item("PROGRESS", item_size, :UINT)
+    return s
+  end
+
+  def build_keep_alive_pdu_contents(progress:)
+    s = define_keep_alive_pdu_contents()
+    s.write("PROGRESS", progress)
+    return s.buffer(false)
+  end
+end