openc3-cosmos-cfdp 1.0.0

data/lib/cfdp_api.rb

@@ -0,0 +1,204 @@
+# 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 'openc3/utilities/authentication'
+require 'openc3/io/json_api'
+
+# Usage:
+#
+# Note: Recommend using the methods in cfdp.rb rather than this file directly
+#
+# In ScriptRunner:
+# require 'cfdp_api'
+# api = CfdpApi.new
+# api.put(...)
+#
+# Outside cluster - Open Source:
+# require 'cfdp_api'
+# $openc3_scope = 'DEFAULT'
+# ENV['OPENC3_API_PASSWORD'] = 'password'
+# api = CfdpApi.new(hostname: '127.0.0.1', port: 2900)
+# api.put(...)
+#
+# Outside cluster - Enterprise
+# require 'cfdp_api'
+# $openc3_scope = 'DEFAULT'
+# ENV['OPENC3_KEYCLOAK_URL'] = '127.0.0.1:2900'
+# ENV['OPENC3_API_USER'] = 'operator'
+# ENV['OPENC3_API_PASSWORD'] = 'operator'
+# api = CfdpApi.new(hostname: '127.0.0.1', port: 2900)
+# api.put(...)
+#
+class CfdpApi < OpenC3::JsonApi
+  def put(
+    destination_entity_id:,
+    source_file_name:,
+    destination_file_name:,
+    transmission_mode: nil,
+    closure_requested: 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
+    scope: $openc3_scope)
+
+    begin
+      endpoint = "/put"
+      data = {
+        "destination_entity_id" => destination_entity_id.to_i,
+        "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,
+        "messages_to_user" => messages_to_user,
+        "flow_label" => flow_label,
+        "segmentation_control" => segmentation_control
+      }
+      data["remote_entity_id"] = remote_entity_id.to_i if remote_entity_id
+      response = _request('post', endpoint, data: data, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP put error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP put failed"
+        end
+      end
+      return response.body
+    rescue => error
+      raise "CFDP put failed due to #{error.formatted}"
+    end
+  end
+
+  def cancel(transaction_id:, remote_entity_id: nil, scope: $openc3_scope)
+    transaction_id_post(method_name: "cancel", transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: $openc3_scope)
+  end
+
+  def suspend(transaction_id:, remote_entity_id: nil, scope: $openc3_scope)
+    transaction_id_post(method_name: "suspend", transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: $openc3_scope)
+  end
+
+  def resume(transaction_id:, remote_entity_id: nil, scope: $openc3_scope)
+    transaction_id_post(method_name: "resume", transaction_id: transaction_id, remote_entity_id: remote_entity_id, scope: $openc3_scope)
+  end
+
+  def report(transaction_id:, remote_entity_id: nil, report_file_name: nil, scope: $openc3_scope)
+    transaction_id_post(method_name: "report", transaction_id: transaction_id, remote_entity_id: remote_entity_id, report_file_name: report_file_name, scope: $openc3_scope)
+  end
+
+  def subscribe(scope: $openc3_scope)
+    begin
+      endpoint = "/subscribe"
+      response = _request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP subscribe error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP subscribe failed"
+        end
+      end
+      # Most recent topic id
+      return response.body
+    rescue => error
+      raise "CFDP subscribe failed due to #{error.formatted}"
+    end
+  end
+
+  def indications(transaction_id: nil, continuation: nil, limit: 100, scope: $openc3_scope)
+    begin
+      endpoint = "/indications"
+      endpoint << ('/' + transaction_id.to_s) if transaction_id
+      query = {}
+      query[:continuation] = continuation if continuation
+      query[:limit] = limit if limit
+      response = _request('get', endpoint, query: query, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP indications error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP indications failed"
+        end
+      end
+      # Hash of continuation, and indications array
+      return JSON.parse(response.body)
+    rescue => error
+      raise "CFDP indications failed due to #{error.formatted}"
+    end
+  end
+
+  def directory_listing(remote_entity_id:, directory_name:, directory_file_name:, scope: $openc3_scope)
+    begin
+      endpoint = "/directorylisting"
+      data = { "remote_entity_id" => remote_entity_id, "directory_name" => directory_name, "directory_file_name" => directory_file_name }
+      response = _request('post', endpoint, data: data, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP directory listing error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP  directory listing failed"
+        end
+      end
+      return response.body
+    rescue => error
+      raise "CFDP  directory listing failed due to #{error.formatted}"
+    end
+  end
+
+  def transactions(active: true, scope: $openc3_scope)
+    begin
+      endpoint = "/transactions"
+      query = {}
+      query[:active] = active if active
+      response = _request('get', endpoint, query: query, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP transactions error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP transactions failed"
+        end
+      end
+      # Array of Transaction Hashes
+      return JSON.parse(response.body)
+    rescue => error
+      raise "CFDP transactions failed due to #{error.formatted}"
+    end
+  end
+
+  # private
+
+  def transaction_id_post(method_name:, transaction_id:, remote_entity_id: nil, report_file_name: nil, scope: $openc3_scope)
+    begin
+      endpoint = "/#{method_name}"
+      data = { "transaction_id" => transaction_id.to_s }
+      data['remote_entity_id'] = remote_entity_id if remote_entity_id
+      data['report_file_name'] = report_file_name if report_file_name
+      response = _request('post', endpoint, data: data, scope: scope)
+      if response.nil? || response.code != 200
+        if response
+          raise "CFDP #{method_name} error: #{response.code}: #{response.body}"
+        else
+          raise "CFDP #{method_name} failed"
+        end
+      end
+      return response.body
+    rescue => error
+      raise "CFDP #{method_name} failed due to #{error.formatted}"
+    end
+  end
+end

data/microservices/CFDP/Gemfile

@@ -0,0 +1,37 @@
+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.0.0'
+
+# 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', '>= 1.1'
+
+# 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'
+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/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

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

@@ -0,0 +1,46 @@
+# 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 'openc3/utilities/authorization'
+
+class ApplicationController < ActionController::API
+  include OpenC3::Authorization
+
+  private
+
+  # Authorize and rescue the possible execeptions
+  # @return [Boolean] true if authorize successful
+  def authorization(permission, target_name: nil, packet_name: nil, interface_name: nil, router_name: nil)
+    begin
+      authorize(
+        permission: permission,
+        target_name: target_name,
+        packet_name: packet_name,
+        interface_name: interface_name,
+        router_name: router_name,
+        scope: params[:scope],
+        token: request.headers['HTTP_AUTHORIZATION'],
+      )
+    rescue OpenC3::AuthError => e
+      render(json: { status: 'error', message: e.message }, status: 401) and
+        return false
+    rescue OpenC3::ForbiddenError => e
+      render(json: { status: 'error', message: e.message }, status: 403) and
+        return false
+    end
+    true
+  end
+end

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

@@ -0,0 +1,222 @@
+# 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 'openc3/config/config_parser'
+
+class CfdpController < ApplicationController
+  # Put.request (destination CFDP entity ID,
+  #   [source file name],
+  #   [destination file name],
+  #   [segmentation control], # Not supported
+  #   [fault handler overrides],
+  #   [flow label], # Not supported
+  #   [transmission mode],
+  #   [closure requested],
+  #   [messages to user],
+  #   [filestore requests])
+  def put
+    params.require([:destination_entity_id])
+    return unless check_authorization()
+    transaction = $cfdp_user.start_source_transaction(params)
+    render json: transaction.id
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }, :status => 400
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # Cancel.request (transaction ID)
+  def cancel
+    params.require([:transaction_id])
+    return unless check_authorization()
+    transaction = $cfdp_user.cancel(params)
+    if transaction
+      render json: transaction.id
+    else
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+    end
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # Suspend.request (transaction ID)
+  def suspend
+    params.require([:transaction_id])
+    return unless check_authorization()
+    transaction = $cfdp_user.suspend(params)
+    if transaction
+      render json: transaction.id
+    else
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+    end
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # Resume.request (transaction ID)
+  def resume
+    params.require([:transaction_id])
+    return unless check_authorization()
+    transaction = $cfdp_user.resume(params)
+    if transaction
+      render json: transaction.id
+    else
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+    end
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # Report.request (transaction ID)
+  def report
+    params.require([:transaction_id])
+    return unless check_authorization()
+    transaction = $cfdp_user.report(params)
+    if transaction
+      render json: transaction.id
+    else
+      render :json => { :status => 'error', :message => "Transaction #{params[:transaction_id]} not found" }, :status => 404
+    end
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  def directory_listing
+    params.require([:remote_entity_id, :directory_name, :directory_file_name])
+    return unless check_authorization()
+    transaction = $cfdp_user.start_directory_listing(params)
+    render json: transaction.id
+  rescue ActionController::ParameterMissing => error
+    render :json => { :status => 'error', :message => error.message }, :status => 400
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  def subscribe
+    return unless check_authorization()
+    result = CfdpTopic.subscribe_indications
+    render json: result
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # Transaction.indication (transaction ID)
+  # EOF-Sent.indication (transaction ID)
+  # Transaction-Finished.indication (transaction ID,
+  #    [filestore responses],
+  #    [status report],
+  #    condition code,
+  #    file status,
+  #    delivery code)
+  # Metadata-Recv.indication (transaction ID,
+  #    source CFDP entity ID,
+  #    [file size],
+  #    [source file name],
+  #    [destination file name],
+  #    [messages to user])
+  # File-Segment-Recv.indication (transaction ID,
+  #   offset,
+  #   length,
+  #   [record continuation state,
+  #   length of segment metadata,
+  #   segment metadata])
+  # Suspended.indication (transaction ID,
+  #    condition code)
+  # Resumed.indication (transaction ID,
+  #    progress)
+  # Report.indication (transaction ID,
+  #    status report)
+  # Fault.indication (transaction ID,
+  #    condition code,
+  #    progress)
+  # Abandoned.indication (transaction ID,
+  #    condition code,
+  #    progress)
+  # EOF-Recv.indication (transaction ID)
+  def indications
+    return unless check_authorization()
+    result = CfdpTopic.read_indications(transaction_id: params[:transaction_id], continuation: params[:continuation], limit: params[:limit])
+    render json: result
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  def transactions
+    return unless check_authorization()
+    active = false
+    active = true if OpenC3::ConfigParser.handle_true_false_nil(params[:active])
+    result = []
+    transactions = CfdpMib.transactions.dup
+    transactions.each do |t_id, t|
+      if not active or t.transaction_status == "ACTIVE"
+        result << t
+      end
+    end
+    result = result.sort {|a, b| a.id <=> b.id}
+    render json: result
+  rescue => error
+    render :json => { :status => 'error', :message => error.message }, :status => 500
+  end
+
+  # private
+
+  def check_authorization
+    cmd_entity_id = nil
+    cmd_entity = nil
+
+    if params[:remote_entity_id]
+      if params[:remote_entity_id].to_i.to_s != params[:remote_entity_id].to_s
+        render :json => { :status => 'error', :message => "remote_entity_id must be numeric" }, :status => 400
+        return false
+      end
+      cmd_entity_id = Integer(params[:remote_entity_id])
+      cmd_entity = CfdpMib.entity(cmd_entity_id)
+    elsif params[:destination_entity_id]
+      if params[:destination_entity_id].to_i.to_s != params[:destination_entity_id].to_s
+        render :json => { :status => 'error', :message => "destination_entity_id must be numeric" }, :status => 400
+        return
+      end
+      cmd_entity_id = Integer(params[:destination_entity_id])
+      cmd_entity = CfdpMib.entity(cmd_entity_id)
+    else
+      cmd_entity_id = CfdpMib.source_entity_id
+      cmd_entity = CfdpMib.entity(cmd_entity_id)
+    end
+
+    if cmd_entity
+      target_name, packet_name, item_name = cmd_entity["cmd_info"]
+      unless target_name and packet_name and item_name
+        tlm_packets = cmd_entity["tlm_info"]
+        tlm_packets ||= []
+        target_name, packet_name, item_name = tlm_packets[0]
+      end
+      if target_name and packet_name and item_name
+        # Caller must be able to send this command
+        return false unless authorization('cmd', target_name: target_name, packet_name: packet_name)
+      else
+        render :json => { :status => 'error', :message => "info not configured for entity: #{cmd_entity_id}" }, :status => 400
+        return false
+      end
+    else
+      render :json => { :status => 'error', :message => "Unknown entity: #{cmd_entity_id}" }, :status => 400
+      return false
+    end
+
+    # Authorized
+    return true
+  end
+
+end

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

@@ -0,0 +1,52 @@
+# 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 CfdpChecksum
+  def initialize
+    @checksum = 0
+  end
+
+  def add(offset, data)
+    front_pad_bytes = offset % 4
+    if front_pad_bytes != 0
+      data = ("\x00" * front_pad_bytes) << data
+    end
+    end_pad_bytes = 4 - data.length % 4
+    if end_pad_bytes != 4
+      data = data + ("\x00" * end_pad_bytes)
+    end
+    values = data.unpack('N*')
+    values.each do |value|
+      @checksum += value
+    end
+    return @checksum
+  end
+
+  # Expected to be calculated as we go using add, so file unused
+  def checksum(file, full_checksum_needed)
+    if full_checksum_needed
+      file.rewind
+      data = file.read
+      @checksum = 0
+      add(0, data)
+    end
+    return @checksum & 0xFFFFFFFF
+  end
+
+  def check(file, other_checksum, full_checksum_needed)
+    checksum(file, full_checksum_needed) == other_checksum
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 'openc3/utilities/crc'
+
+class CfdpCrcChecksum
+  def initialize(poly, seed, xor, reflect)
+    @crc = OpenC3::Crc32.new(poly, seed, xor, reflect)
+    @checksum = 0
+  end
+
+  # Incremental not supported so add ignored
+  def add(offset, data)
+    return 0
+  end
+
+  # Uses file because incremental add is not supported
+  def checksum(file, full_checksum_needed)
+    file.rewind
+    data = file.read
+    @checksum = @crc.calc(data)
+    return @checksum & 0xFFFFFFFF
+  end
+
+  def check(file, other_checksum, full_checksum_needed)
+    checksum(file, full_checksum_needed) == other_checksum
+  end
+end