openc3-cosmos-cfdp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 254a8c3fa0ae6e2ec535bc5c565ad7e376706858dbd1a87e394a70998bca8a33
+  data.tar.gz: '08d510acfdb03663b4f3426dff1a6a9dbbeada23e0b1d0b5a3ea2160341b3ac8'
+SHA512:
+  metadata.gz: 3d93dd03e13bcae8c6fea52df4ad07320ab9097c5c3e9d2241c988682189d03edfcef9f274d7a02cde434d930dc0b9b3f851a82efa7d9b6d8dbd8e34e03c877f
+  data.tar.gz: 409424118dd69bd8ee1d14fdd88bc3fcc6759f4e4edb694aa94b2af3ffac387504a70a5167b6f6aef1c2d28ea0c932ab6395af9d261a3693fca03957cabde3f1

data/LICENSE.txt

@@ -0,0 +1,18 @@
+# OpenC3 Evaluation and Educational License
+#
+# Copyright 2023 OpenC3, Inc.
+#
+# This work is licensed for evaluation and educational purposes only.
+# It may NOT be used for formal development, integration and test, operations
+# or any other commercial purpose without the purchase of a commercial license
+# from OpenC3, Inc.
+#
+# The above copyright notice and this permission notice shall be included in all copies
+# or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+# OpenC3 COSMOS CFDP Plugin
+
+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.
+
+## 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)
+
+## Usage in Scripts
+
+See: [cfdp.rb]()
+
+```
+require 'cfdp'
+
+# Send a file and wait up to 10 minutes for complete (Default mode)
+transaction_id, indication = cfdp_put(destination_entity_id: 1, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin")
+
+# Force UNACKNOWLEDGED mode
+transaction_id, indication = cfdp_put(destination_entity_id: 1, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin", transmission_mode: "UNACKNOWLEDGED")
+
+# Force UNACKNOWLEDGED mode and request closure
+transaction_id, indication = cfdp_put(destination_entity_id: 1, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin", transmission_mode: "UNACKNOWLEDGED", closure_requested: "CLOSURE_REQUESTED")
+
+# Force ACKNOWLEDGED mode
+transaction_id, indication = cfdp_put(destination_entity_id: 1, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin", transmission_mode: "ACKNOWLEDGED")
+
+# Send a file and don't wait
+continuation = cfdp_subscribe()
+transaction_id = cfdp_put(destination_entity_id: 1, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin", timeout: nil)
+...
+DO_OTHER_THINGS
+...
+indication = cfdp_indications(transaction_id: transaction_id, indication_type: 'Transaction-Finished', continuation: continuation)
+
+# Cancel a transaction
+indication = cfdp_cancel(transaction_id: transaction_id)
+
+# Suspend a transaction
+indication = cfdp_suspend(transaction_id: transaction_id)
+
+# Resume a suspended transaction
+indication = cfdp_resume(transaction_id: transaction_id)
+
+# Get a report on a transaction
+indication = cfdp_report(transaction_id: transaction_id)
+puts indication["status_report"]
+
+# Get a list of transactions
+transactions = cfdp_transactions(active: true)
+
+# Filestore requests
+requests = []
+requests << ["CREATE_FILE", file_name]
+requests << ["DELETE_FILE", file_name]
+requests << ["RENAME_FILE", old_file_name, new_file_name]
+requests << ["APPEND_FILE", file_name, appended_file_name]
+requests << ["REPLACE_FILE", replaced_file_name, contents_file_name]
+requests << ["CREATE_DIRECTORY", directory_name]
+requests << ["REMOVE_DIRECTORY", directory_name]
+requests << ["DENY_FILE", file_name]
+requests << ["DENY_DIRECTORY", directory_name]
+transaction_id, indication = cfdp_put(destination_entity_id: 1, filestore_requests: requests)
+indication["filestore_responses"].each do |response|
+  puts "Filestore failed: #{response}" if response["STATUS_CODE"] != "SUCCESSFUL"
+end
+
+# Proxy operations
+# These add remote_entity_id to specify a remote entity
+
+# Get a file (using proxy put) and wait for it to be received
+remote_entity_id = 1
+my_entity_id = 2
+transaction_id, indication = cfdp_put(remote_entity_id: remote_entity_id, destination_entity_id: my_entity_id, source_file_name: "file_to_send.bin", destination_file_name: "received_file.bin")
+
+# Cancel a proxy put transaction
+indication = cfdp_cancel(transaction_id: transaction_id, remote_entity_id: 1)
+
+# Suspend a remote transaction
+indication = cfdp_suspend(transaction_id: transaction_id, remote_entity_id: 1)
+
+# Resume a remote transaction
+indication = cfdp_resume(transaction_id: transaction_id, remote_entity_id: 1)
+
+# Get a status report on a remote transaction
+indication = cfdp_report(transaction_id: transaction_id, remote_entity_id: 1, report_file_name: "my_report.txt")
+
+# Get a remote directory listing
+indications = cfdp_directory_listing(remote_entity_id: 1, directory_name: "/files", directory_file_name: "my_listing.txt")
+
+```
+
+## MIB Configuration
+
+The CFDP Management Information Base (MIB) is configured by passing options to the CFDP microservice in plugin.txt.
+Note: This will always need to be configured for your application
+
+Most settings are associated with the most recently mentioned source_entity_id or destination_entity_id.
+
+Minimum required settings:
+
+- A source_entity_id and corresponding tlm_info must be given.
+- At least one destination_entity_id must be defined with a corresponding cmd_info.
+- root_path must be defined
+- bucket should be set if the root_path is in a bucket. Otherwise the root path is assumed to be a mounted volume.
+
+### Source Entity Configuration
+
+| Setting Name                    | Description                                                                                       | Allowed Values            | Default Value                   |
+| ------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------- | ------------------------------- |
+| root_path                       | The path to send/receive files from                                                               | Valid directory           | N/A - Must be given             |
+| bucket                          | The bucket to send/receive files from                                                             | Valid bucket Name         | nil - Serve from mounted volume |
+| source_entity_id                | The entity id for this CFDP microservice                                                          | Any integer               | N/A - Must be given             |
+| tlm_info                        | A target_name, packet_name, and item_name to receive PDUs. Multiple tlm_info options can be given | COSMOS packet information | N/A - Must be given             |
+| eof_sent_indication             | Issue EOF-Sent.indication                                                                         | true or false             | true                            |
+| eof_recv_indication             | Issue EOF-Recv.indication                                                                         | true or false             | true                            |
+| file_segment_recv_indication    | Issue File-Segment-Recv.indication                                                                | true or false             | true                            |
+| transaction_finished_indication | Issue Transaction-Finished.indication                                                             | true or false             | true                            |
+| suspended_indication            | Issue Suspended.indication                                                                        | true or false             | true                            |
+| resume_indication               | Issue Resume.indication                                                                           | true or false             | true                            |
+
+### Remote Entity Configuration
+
+| destination_entity_id         | Id of a remote entity to configure                                                                   | Any integer                                                                                                                                                                                                                                                                                                                                                           | N/A - Must be given       |
+| ----------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
+| cmd_info                      | The target_name, packet_name, and item_name to send PDUs for the destination entity                  | COSMOS packet information                                                                                                                                                                                                                                                                                                                                             | N/A - Must be given       |
+| protocol_version_number       | CFDP Version Number Needed at Destination                                                            | 0 or 1                                                                                                                                                                                                                                                                                                                                                                | 1 - CFDP Blue Book Rev 5+ |
+| ack_timer_interval            | Ack timeout in seconds                                                                               | Any integer                                                                                                                                                                                                                                                                                                                                                           | 600 seconds               |
+| nak_timer_interval            | Nak timeout in seconds                                                                               | Any integer                                                                                                                                                                                                                                                                                                                                                           | 600 seconds               |
+| keep_alive_interval           | Keep Alive Period in seconds                                                                         | Any integer                                                                                                                                                                                                                                                                                                                                                           | 600 seconds               |
+| check_interval                | Interval to check for transaction complete in seconds                                                | Any integer                                                                                                                                                                                                                                                                                                                                                           | 600 seconds               |
+| maximum_file_segment_length   | Maximum amount of file data in a segment in bytes                                                    | Any integer                                                                                                                                                                                                                                                                                                                                                           | 1024 bytes                |
+| ack_timer_expiration_limit    | Number of times to wait for the ack timeout before declaring a fault                                 | Any integer                                                                                                                                                                                                                                                                                                                                                           | 1                         |
+| transaction_inactivity_limit  | Number of times to wait for the keep alive timeout before declaring the transaction inactive fault   | Any integer                                                                                                                                                                                                                                                                                                                                                           | 1                         |
+| check_limit                   | Number of times to check for transaction complete before declaring a fault                           | Any integer                                                                                                                                                                                                                                                                                                                                                           | 1                         |
+| keep_alive_discrepancy_limit  | Maximum difference between keep alive progress and source progress allowed before declaring a fault. | Any integer                                                                                                                                                                                                                                                                                                                                                           | 1024000 bytes             |
+| immediate_nak_mode            | Send NAKs as soon as something is noticed missing                                                    | true or false                                                                                                                                                                                                                                                                                                                                                         | true                      |
+| crcs_required                 | Does this entity want PDUs with CRCs                                                                 | true or false                                                                                                                                                                                                                                                                                                                                                         | true                      |
+| enable_acks                   | Send Acks in Acknowledged mode                                                                       | true or false                                                                                                                                                                                                                                                                                                                                                         | true                      |
+| enable_keep_alive             | Send Keep Alives in Acknowledged mode                                                                | true or false                                                                                                                                                                                                                                                                                                                                                         | true                      |
+| enable_finished               | Send Finished PDU if closure requested or acknowledged mode                                          | true or false                                                                                                                                                                                                                                                                                                                                                         | true                      |
+| enable_eof_nak                | Send A NAK in response to EOF                                                                        | true of false                                                                                                                                                                                                                                                                                                                                                         | false                     |
+| default_transmission_mode     | Default put mode                                                                                     | ACKNOWLEDGED or UNACKNOWLEDGED                                                                                                                                                                                                                                                                                                                                        | UNACKNOWLEDGED            |
+| entity_id_length              | Size of entity ids in bytes minus one                                                                | 0 to 7                                                                                                                                                                                                                                                                                                                                                                | 0 = 1 byte                |
+| sequence_number_length        | Size of sequence numbers in bytes minus one                                                          | 0 to 7                                                                                                                                                                                                                                                                                                                                                                | 0 = 1 byte                |
+| default_checksum_type         | Checksum type number                                                                                 | 0 to 15                                                                                                                                                                                                                                                                                                                                                               | 0 = Default CFDP checksum |
+| transaction_closure_requested | Default closure requested setting                                                                    | CLOSURE_REQUESTED or CLOSURE_NOT_REQUESTED                                                                                                                                                                                                                                                                                                                            | CLOSURE_REQUESTED         |
+| incomplete_file_disposition   | What to do with an incomplete file                                                                   | DISCARD or RETAIN                                                                                                                                                                                                                                                                                                                                                     | DISCARD                   |
+| fault_handler                 | Fault handler setting                                                                                | (ACK_LIMIT_REACHED, KEEP_ALIVE_LIMIT_REACHED, INVALID_TRANSMISSION_MODE, FILESTORE_REJECTION, FILE_CHECKSUM_FAILURE, FILE_SIZE_ERROR, NAK_LIMIT_REACHED, INACTIVITY_DETECTED, INVALID_FILE_STRUCTURE, CHECK_LIMIT_REACHED, or UNSUPPORTED_CHECKSUM_TYPE) followed by (ISSUE_NOTICE_OF_CANCELLATION, ISSUE_NOTICE_OF_SUSPENSION, IGNORE_ERROR, or ABANDON_TRANSACTION) | See Code                  |
+
+## Known Limitations
+
+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
+
+## Contributing
+
+We encourage you to contribute to OpenC3 COSMOS and this project!
+
+Contributing is easy.
+
+1. Fork the project
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+YOU MUST AGREE TO OUR CONTRIBUTOR LICENSE AGREEMENT TO SUBMIT CODE TO THIS PROJECT: See [CONTRIBUTING.txt](CONTRIBUTING.txt)
+
+Most importantly:
+
+FOR ALL CONTRIBUTIONS TO THE OPENC3 COSMOS PROJECT AND ASSOCIATED PLUGINS, OPENC3, INC. MAINTAINS ALL RIGHTS TO ALL CODE CONTRIBUTED INCLUDING THE RIGHT TO LICENSE IT UNDER OTHER TERMS.
+
+## License
+
+OpenC3 Evaluation and Educational License
+
+See [LICENSE.txt](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,40 @@
+PLUGIN_NAME = Dir['*.gemspec'][0].split('.')[0..-2].join('.')
+
+require 'fileutils'
+
+task :require_version do
+  unless ENV['VERSION']
+    puts "VERSION is required: rake build VERSION=X.Y.Z"
+    exit 1
+  end
+end
+
+task :build => [:require_version] do
+  split_version = ENV['VERSION'].to_s.split('.')
+  major = split_version[0]
+  minor = split_version[1]
+  if ENV['VERSION'] =~ /[a-zA-Z]+/
+    # Prerelease version
+    remainder = split_version[2..-1].join(".")
+    remainder.gsub!('-', '.pre.') # Rubygems replaces dashes with .pre.
+    remainder_split = remainder.split('.')
+    patch = remainder_split[0]
+    other = remainder_split[1..-1].join('.')
+    gem_version = "#{major}.#{minor}.#{patch}.#{other}"
+  else
+    gem_version = ENV['VERSION']
+  end
+  gem_name = PLUGIN_NAME + '-' + gem_version + '.gem'
+
+  # Build using sh built into Rake:
+  # https://rubydoc.info/gems/rake/FileUtils#sh-instance_method
+  if File.exist?("./microservices/CFDP/Gemfile.lock")
+    FileUtils.rm("./microservices/CFDP/Gemfile.lock")
+  end
+  sh('gem', 'build', PLUGIN_NAME)
+  sh("openc3cli validate #{gem_name}") do |ok, status|
+    if !ok && status.exitstatus == 127 # command not found
+      puts "Install the openc3 gem to validate! (gem install openc3)"
+    end
+  end
+end

data/lib/cfdp.rb

@@ -0,0 +1,283 @@
+# 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.
+
+require_relative 'cfdp_api'
+
+def cfdp_put(
+  destination_entity_id:,
+  source_file_name: nil,
+  destination_file_name: nil,
+  closure_requested: nil,
+  transmission_mode: nil,
+  filestore_requests: [],
+  fault_handler_overrides: [],
+  flow_label: nil,
+  segmentation_control: "NOT_PRESERVED",
+  messages_to_user: [],
+  remote_entity_id: nil, # Used to indicate proxy put
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.put(
+    destination_entity_id: destination_entity_id,
+    source_file_name: source_file_name,
+    destination_file_name: destination_file_name,
+    transmission_mode: transmission_mode,
+    closure_requested: closure_requested,
+    filestore_requests: filestore_requests,
+    fault_handler_overrides: fault_handler_overrides,
+    flow_label: flow_label,
+    segmentation_control: segmentation_control,
+    messages_to_user: messages_to_user,
+    remote_entity_id: remote_entity_id, # Used to indicate proxy put
+    scope: $openc3_scope)
+  return transaction_id unless timeout
+  indication = nil
+  indication = cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Transaction-Finished', continuation: continuation, timeout: timeout, scope: scope) if timeout
+  indication ||= cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Proxy-Put-Response', continuation: continuation, timeout: timeout, scope: scope) if remote_entity_id and timeout
+  return transaction_id, indication
+end
+
+def cfdp_cancel(
+  transaction_id:,
+  remote_entity_id: nil,
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.cancel(transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: scope)
+  indication = nil
+  indication = cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Transaction-Finished', continuation: continuation, timeout: timeout, scope: scope) if timeout
+  indication ||= cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Proxy-Put-Response', continuation: continuation, timeout: timeout, scope: scope) if remote_entity_id and timeout
+  return indication
+end
+
+def cfdp_suspend(
+  transaction_id:,
+  remote_entity_id: nil,
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.suspend(transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: scope)
+  indication = nil
+  indication = cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Suspended', continuation: continuation, timeout: timeout, scope: scope) if not remote_entity_id and timeout
+  indication ||= cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Remote-Suspend-Response', continuation: continuation, timeout: timeout, scope: scope) if remote_entity_id and timeout
+  return indication
+end
+
+def cfdp_resume(
+  transaction_id:,
+  remote_entity_id: nil,
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.resume(transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: scope)
+  indication = nil
+  indication = cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Resumed', continuation: continuation, timeout: timeout, scope: scope) if not remote_entity_id and timeout
+  indication ||= cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Remote-Resume-Response', continuation: continuation, timeout: timeout, scope: scope) if remote_entity_id and timeout
+  return indication
+end
+
+def cfdp_report(
+  transaction_id:,
+  remote_entity_id: nil,
+  report_file_name: nil,
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.report(transaction_id: transaction_id, remote_entity_id: remote_entity_id, report_file_name: report_file_name, scope: scope)
+  indication = nil
+  indication = cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Report', continuation: continuation, timeout: timeout, scope: scope) if not remote_entity_id and timeout
+  indication ||= cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Remote-Report-Response', continuation: continuation, timeout: timeout, scope: scope) if remote_entity_id and timeout
+  return indication
+end
+
+def cfdp_subscribe(
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  return api.subscribe(scope: scope)
+end
+
+def cfdp_indications(
+  transaction_id: nil,
+  indication_type: nil,
+  continuation: nil,
+  include_continuation: true,
+  timeout: nil,
+  api_timeout: 5,
+  limit: 100,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  return cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: indication_type, continuation: continuation, include_continuation: include_continuation, timeout: timeout, limit: limit, scope: scope)
+end
+
+def cfdp_directory_listing(
+  remote_entity_id:,
+  directory_name:,
+  directory_file_name:,
+  timeout: 600,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  continuation = api.subscribe(scope: scope) if timeout
+  transaction_id = api.directory_listing(remote_entity_id: remote_entity_id, directory_name: directory_name, directory_file_name: directory_file_name, scope: scope)
+  indications = []
+  indications << cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Transaction-Finished', continuation: continuation, timeout: timeout, scope: scope) if timeout
+  indications << cfdp_wait_for_indication(api: api, transaction_id: transaction_id, indication_type: 'Directory-Listing-Response', continuation: continuation, timeout: timeout, scope: scope) if timeout
+  return indications.compact
+end
+
+def cfdp_transactions(
+  active: true,
+  api_timeout: 5,
+  microservice_name: 'CFDP',
+  prefix: '/cfdp',
+  schema: 'http',
+  hostname: nil,
+  port: 2905,
+  url: nil,
+  scope: $openc3_scope)
+
+  api = CfdpApi.new(timeout: api_timeout, microservice_name: microservice_name, prefix: prefix, schema: schema, hostname: hostname, port: port, url: url, scope: scope)
+  return api.transactions(active: active, scope: scope)
+end
+
+# Helper methods
+
+def cfdp_wait_for_indication(
+  api:,
+  transaction_id: nil,
+  indication_type: nil,
+  continuation: nil,
+  include_continuation: false,
+  timeout: 600,
+  limit: 1000,
+  scope: $openc3_scope)
+
+  timeout ||= 0
+  start_time = Time.now
+  end_time = start_time + timeout
+  continuation = '0-0' unless continuation
+  done = false
+  while not done
+    result = api.indications(transaction_id: transaction_id, continuation: continuation, limit: limit, scope: scope)
+    continuation = result['continuation']
+    indications = result['indications']
+    if indications and indications.length > 0
+      unless indication_type
+        if include_continuation
+          return indications, continuation
+        else
+          return indications
+        end
+      end
+      indications.each do |indication|
+        if indication['indication_type'] == indication_type
+          if include_continuation
+            return indication, continuation
+          else
+            return indication
+          end
+        end
+      end
+    end
+    if Time.now >= end_time
+      raise "CFDP Timeout" if timeout > 0
+      done = true
+    end
+    break if done
+    if defined? wait
+      wait_time = wait(1)
+      break if wait_time < 1.0 # User hit go
+    else
+      sleep(1)
+    end
+  end
+  if indication_type
+    if include_continuation
+      return nil, continuation
+    else
+      return nil
+    end
+  else
+    if include_continuation
+      return [], continuation
+    else
+      return []
+    end
+  end
+end