openc3-cosmos-cfdp 1.0.0

data/microservices/CFDP/config/application.rb

@@ -0,0 +1,55 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+# require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module CfdpApi
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 7.0
+    # Add to hosts to prevent "Blocked host" errors
+    config.hosts.clear
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+
+    # Only loads a smaller set of middleware suitable for API only apps.
+    # Middleware like session, flash, cookies can be added back manually.
+    # Skip views, helpers and assets when generating a new resource.
+    config.api_only = true
+
+    # config.action_cable.disable_request_forgery_protection = true
+    # config.action_cable.mount_path = '/script-api/cable'
+
+    OpenC3::Logger.microservice_name = ENV['OPENC3_MICROSERVICE_NAME']
+
+    require 'openc3/utilities/open_telemetry'
+    OpenC3.setup_open_telemetry(ENV['OPENC3_MICROSERVICE_NAME'], true)
+    if OpenC3.otel_enabled
+      config.middleware.insert_before(
+        0,
+        OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware
+      )
+    end
+  end
+end

data/microservices/CFDP/config/boot.rb

@@ -0,0 +1,4 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.

data/microservices/CFDP/config/credentials.yml.enc

@@ -0,0 +1 @@
++pvZ3Zik3uIaWS3QvCTYrHQW+EI3A+w9lM8FkYGFnYfuciByseArZe/5Bf3G7NnEcJ4vt+d67pQxCWeitmNxU7fAyz5WXGAWUrb80wrB8Exh3jjaCW8WpQNdIMtiHwubTudj+hDSiXtpYbiulpN9xfUBSpZ5H1hO6QH5768tSiTOva6xa51vK6W0/v8gyxzED/kXwbdAr6LqbLBvoFt3+6OQcyb7tLtzU0LQAQq+u1Q/usvOgw48S7KTpLgCzjeXhoHUFi7BVcCaJtk1nmZVbrtlYNfYDuyfks13NGleL2sk0EevVHfb4PDKXBaH1PgqCTFEigxIQHTu05FYwJxfwmTZ9jh/YqLBM3nIF/V98Q2O5IPfeQqNa1jeWUmKVHS4AjsC+mVWE07v8am9NhjZFQBWhTb9ythYtIwn--XltxEGXRgR3F+f1d--CI0Ramf8SPg+CThji22tFQ==

data/microservices/CFDP/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

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

@@ -0,0 +1,53 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable server timing
+  config.server_timing = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Disable ActionCable logging
+  # ActionCable.server.config.logger = Logger.new(STDOUT, level: Logger::ERROR)
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end

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

@@ -0,0 +1,75 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = "http://assets.example.com"
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
+  # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
+
+  # Mount Action Cable outside main process or domain.
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = "wss://example.com/cable"
+  # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Include generic and useful information about system operation, but avoid logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII).
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "script_runner_api_production"
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require "syslog/logger"
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name")
+
+  logger           = ActiveSupport::Logger.new(STDOUT)
+  logger.formatter = config.log_formatter
+  config.logger    = ActiveSupport::TaggedLogging.new(logger)
+
+  # Disable ActionCable logging
+  # ActionCable.server.config.logger = Logger.new(STDOUT, level: Logger::ERROR)
+end

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

@@ -0,0 +1,50 @@
+require "active_support/core_ext/integer/time"
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Turn false under Spring and add config.action_view.cache_template_loading = true.
+  config.cache_classes = true
+
+  # Eager loading loads your whole application. When running a single test locally,
+  # this probably isn't necessary. It's a good idea to do in a continuous integration
+  # system, or in some way before deploying your code.
+  config.eager_load = ENV["CI"].present?
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+end

data/microservices/CFDP/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/microservices/CFDP/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/microservices/CFDP/config/initializers/cfdp_initializer.rb

@@ -0,0 +1,26 @@
+# 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 'cfdp_mib'
+require 'cfdp_user'
+
+if ENV['RAILS_ENV'] != 'test'
+  CfdpMib.setup
+  $cfdp_user = CfdpUser.new
+  $cfdp_user.start
+else
+  $cfdp_user = CfdpUser.new
+end

data/microservices/CFDP/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+  allow do
+    origins "*"
+
+    resource "*",
+      headers: :any,
+      methods: [:get, :post, :put, :patch, :delete, :options, :head]
+  end
+end

data/microservices/CFDP/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be filtered from the log file. Use this to limit dissemination of
+# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
+# notations and behaviors.
+Rails.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]

data/microservices/CFDP/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/microservices/CFDP/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/microservices/CFDP/config/initializers/wrap_parameters.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end

data/microservices/CFDP/config/locales/en.yml

@@ -0,0 +1,29 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/microservices/CFDP/config/puma.rb

@@ -0,0 +1,38 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { <%= cfdp_port %> }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/microservices/CFDP/config/routes.rb

@@ -0,0 +1,16 @@
+Rails.application.routes.draw do
+  prefix = ENV['OPENC3_ROUTE_PREFIX'] || "/cfdp"
+  prefix = prefix[1..-1] if prefix[0] == '/'
+  scope prefix do
+    post "/put" => "cfdp#put"
+    post "/cancel" => "cfdp#cancel"
+    post "/suspend" => "cfdp#suspend"
+    post "/resume" => "cfdp#resume"
+    post "/report" => "cfdp#report"
+    post "/directorylisting" => "cfdp#directory_listing"
+    get "/subscribe" => "cfdp#subscribe"
+    get "/indications/:transaction_id" => "cfdp#indications"
+    get "/indications" => "cfdp#indications"
+    get "/transactions" => "cfdp#transactions"
+  end
+end

data/microservices/CFDP/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+run Rails.application
+Rails.application.load_server

data/microservices/CFDP/init.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+# set -x
+
+# Fail on errors
+set -e
+
+bundle config set --local without 'development test'
+bundle install --quiet
+rails s -b 0.0.0.0 -p <%= cfdp_port %>

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

@@ -0,0 +1,82 @@
+# 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_ack_pdu_contents(pdu, pdu_hash, variable_data)
+    s = pdu.define_ack_pdu_contents
+    s.buffer = variable_data
+    pdu_hash["ACK_DIRECTIVE_CODE"] = s.read("ACK_DIRECTIVE_CODE")
+    pdu_hash["ACK_DIRECTIVE_SUBTYPE"] = s.read("ACK_DIRECTIVE_SUBTYPE")
+    pdu_hash["CONDITION_CODE"] = s.read("CONDITION_CODE")
+    pdu_hash["TRANSACTION_STATUS"] = s.read("TRANSACTION_STATUS")
+  end
+
+  def self.build_ack_pdu(
+    source_entity:,
+    transaction_seq_num:,
+    destination_entity:,
+    segmentation_control: "NOT_PRESERVED",
+    transmission_mode: nil,
+    condition_code:,
+    ack_directive_code:,
+    transaction_status:)
+
+    pdu = build_initial_pdu(type: "FILE_DIRECTIVE", destination_entity: destination_entity, transmission_mode: transmission_mode, file_size: 0, 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: "ACK")
+    pdu_header_part_2_length = pdu_header.length
+    if ack_directive_code == "FINISHED" or ack_directive_code == 5
+      pdu.write("DIRECTION", "TOWARD_FILE_RECEIVER")
+    else
+      pdu.write("DIRECTION", "TOWARD_FILE_SENDER")
+    end
+    pdu_contents = pdu.build_ack_pdu_contents(ack_directive_code: ack_directive_code, condition_code: condition_code, transaction_status: transaction_status)
+    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_ack_pdu_contents
+    s = OpenC3::Packet.new(nil, nil, :BIG_ENDIAN)
+    item = s.append_item("ACK_DIRECTIVE_CODE", 4, :UINT)
+    item.states = DIRECTIVE_CODES
+    s.append_item("ACK_DIRECTIVE_SUBTYPE", 4, :UINT)
+    item = s.append_item("CONDITION_CODE", 4, :UINT)
+    item.states = CONDITION_CODES
+    s.append_item("SPARE", 2, :UINT)
+    item = s.append_item("TRANSACTION_STATUS", 2, :UINT)
+    item.states = TRANSACTION_STATUS_CODES
+    return s
+  end
+
+  def build_ack_pdu_contents(ack_directive_code:, condition_code:, transaction_status:)
+    s = define_ack_pdu_contents()
+    s.write("ACK_DIRECTIVE_CODE", ack_directive_code)
+    if s.read("ACK_DIRECTIVE_CODE") == "FINISHED"
+      s.write("ACK_DIRECTIVE_SUBTYPE", 1)
+    else
+      s.write("ACK_DIRECTIVE_SUBTYPE", 0)
+    end
+    s.write("CONDITION_CODE", condition_code)
+    s.write("SPARE", 0)
+    s.write("TRANSACTION_STATUS", transaction_status)
+    return s.buffer(false)
+  end
+end