cyber_trackr_live 1.0.0

data/lib/cyber_trackr_client/api/rmf_controls_api.rb

@@ -0,0 +1,272 @@
+=begin
+#Cyber Trackr API
+
+#Complete OpenAPI 3.1.1 specification for cyber.trackr.live API. This API provides access to DISA STIGs, SRGs, RMF controls, CCIs, and SCAP data.  ## DISA Cybersecurity Ecosystem Hierarchy  ``` NIST RMF Controls (high-level policy framework)     ↓ (decomposed into atomic, testable statements) CCIs (Control Correlation Identifiers - bridge policy to implementation)     ↓ (grouped by technology class into generic requirements)   SRGs (Security Requirements Guides - technology class \"what\" to do)     ↓ (implemented as vendor-specific \"how\" to do it) STIGs (Security Technical Implementation Guides - vendor/product specific)     ↓ (automated versions for scanning tools) SCAP (Security Content Automation Protocol documents) ```  ## Critical Relationships  - **RMF Controls** contain assessment procedures that reference **CCIs** - **CCIs** map back to **RMF Controls** and forward to **STIG/SRG requirements** - **SRGs** define generic technology requirements that **STIGs** implement specifically - **V-IDs** can appear in both SRG and corresponding STIG (same requirement, different specificity) - **SV-IDs** are XCCDF rule identifiers with revision tracking across document releases 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module CyberTrackrClient
+  class RMFControlsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get RMF revision 4 control details
+    # Returns complete RMF control details including CCI mappings
+    # @param control [String] RMF control identifier (family-number format)
+    # @param [Hash] opts the optional parameters
+    # @return [RmfControlDetail]
+    def get_rmf_control_v4(control, opts = {})
+      data, _status_code, _headers = get_rmf_control_v4_with_http_info(control, opts)
+      data
+    end
+
+    # Get RMF revision 4 control details
+    # Returns complete RMF control details including CCI mappings
+    # @param control [String] RMF control identifier (family-number format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RmfControlDetail, Integer, Hash)>] RmfControlDetail data, response status code and response headers
+    def get_rmf_control_v4_with_http_info(control, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RMFControlsApi.get_rmf_control_v4 ...'
+      end
+      # verify the required parameter 'control' is set
+      if @api_client.config.client_side_validation && control.nil?
+        fail ArgumentError, "Missing the required parameter 'control' when calling RMFControlsApi.get_rmf_control_v4"
+      end
+      pattern = Regexp.new(/^[A-Z]+-\d+$/)
+      if @api_client.config.client_side_validation && control !~ pattern
+        fail ArgumentError, "invalid value for 'control' when calling RMFControlsApi.get_rmf_control_v4, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/rmf/4/{control}'.sub('{' + 'control' + '}', CGI.escape(control.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RmfControlDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RMFControlsApi.get_rmf_control_v4",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RMFControlsApi#get_rmf_control_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get RMF revision 5 control details
+    # Returns complete RMF control details including CCI mappings
+    # @param control [String] RMF control identifier (family-number format)
+    # @param [Hash] opts the optional parameters
+    # @return [RmfControlDetail]
+    def get_rmf_control_v5(control, opts = {})
+      data, _status_code, _headers = get_rmf_control_v5_with_http_info(control, opts)
+      data
+    end
+
+    # Get RMF revision 5 control details
+    # Returns complete RMF control details including CCI mappings
+    # @param control [String] RMF control identifier (family-number format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RmfControlDetail, Integer, Hash)>] RmfControlDetail data, response status code and response headers
+    def get_rmf_control_v5_with_http_info(control, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RMFControlsApi.get_rmf_control_v5 ...'
+      end
+      # verify the required parameter 'control' is set
+      if @api_client.config.client_side_validation && control.nil?
+        fail ArgumentError, "Missing the required parameter 'control' when calling RMFControlsApi.get_rmf_control_v5"
+      end
+      pattern = Regexp.new(/^[A-Z]+-\d+$/)
+      if @api_client.config.client_side_validation && control !~ pattern
+        fail ArgumentError, "invalid value for 'control' when calling RMFControlsApi.get_rmf_control_v5, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/rmf/5/{control}'.sub('{' + 'control' + '}', CGI.escape(control.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RmfControlDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RMFControlsApi.get_rmf_control_v5",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RMFControlsApi#get_rmf_control_v5\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List RMF revision 4 controls
+    # Returns all Risk Management Framework revision 4 controls with titles
+    # @param [Hash] opts the optional parameters
+    # @return [RmfControlList]
+    def list_rmf_controls_v4(opts = {})
+      data, _status_code, _headers = list_rmf_controls_v4_with_http_info(opts)
+      data
+    end
+
+    # List RMF revision 4 controls
+    # Returns all Risk Management Framework revision 4 controls with titles
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RmfControlList, Integer, Hash)>] RmfControlList data, response status code and response headers
+    def list_rmf_controls_v4_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RMFControlsApi.list_rmf_controls_v4 ...'
+      end
+      # resource path
+      local_var_path = '/rmf/4'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RmfControlList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RMFControlsApi.list_rmf_controls_v4",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RMFControlsApi#list_rmf_controls_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List RMF revision 5 controls
+    # Returns all Risk Management Framework revision 5 controls with titles
+    # @param [Hash] opts the optional parameters
+    # @return [RmfControlList]
+    def list_rmf_controls_v5(opts = {})
+      data, _status_code, _headers = list_rmf_controls_v5_with_http_info(opts)
+      data
+    end
+
+    # List RMF revision 5 controls
+    # Returns all Risk Management Framework revision 5 controls with titles
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RmfControlList, Integer, Hash)>] RmfControlList data, response status code and response headers
+    def list_rmf_controls_v5_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RMFControlsApi.list_rmf_controls_v5 ...'
+      end
+      # resource path
+      local_var_path = '/rmf/5'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RmfControlList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"RMFControlsApi.list_rmf_controls_v5",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RMFControlsApi#list_rmf_controls_v5\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cyber_trackr_client/api/scap_api.rb

@@ -0,0 +1,276 @@
+=begin
+#Cyber Trackr API
+
+#Complete OpenAPI 3.1.1 specification for cyber.trackr.live API. This API provides access to DISA STIGs, SRGs, RMF controls, CCIs, and SCAP data.  ## DISA Cybersecurity Ecosystem Hierarchy  ``` NIST RMF Controls (high-level policy framework)     ↓ (decomposed into atomic, testable statements) CCIs (Control Correlation Identifiers - bridge policy to implementation)     ↓ (grouped by technology class into generic requirements)   SRGs (Security Requirements Guides - technology class \"what\" to do)     ↓ (implemented as vendor-specific \"how\" to do it) STIGs (Security Technical Implementation Guides - vendor/product specific)     ↓ (automated versions for scanning tools) SCAP (Security Content Automation Protocol documents) ```  ## Critical Relationships  - **RMF Controls** contain assessment procedures that reference **CCIs** - **CCIs** map back to **RMF Controls** and forward to **STIG/SRG requirements** - **SRGs** define generic technology requirements that **STIGs** implement specifically - **V-IDs** can appear in both SRG and corresponding STIG (same requirement, different specificity) - **SV-IDs** are XCCDF rule identifiers with revision tracking across document releases 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module CyberTrackrClient
+  class SCAPApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get SCAP document details
+    # Returns complete SCAP document with all requirements (same structure as STIG)
+    # @param title [String] Document title exactly as it appears in the list endpoint
+    # @param version [String] Major version number of the document
+    # @param release [String] Release number within the version
+    # @param [Hash] opts the optional parameters
+    # @return [DocumentDetail]
+    def get_scap_document(title, version, release, opts = {})
+      data, _status_code, _headers = get_scap_document_with_http_info(title, version, release, opts)
+      data
+    end
+
+    # Get SCAP document details
+    # Returns complete SCAP document with all requirements (same structure as STIG)
+    # @param title [String] Document title exactly as it appears in the list endpoint
+    # @param version [String] Major version number of the document
+    # @param release [String] Release number within the version
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DocumentDetail, Integer, Hash)>] DocumentDetail data, response status code and response headers
+    def get_scap_document_with_http_info(title, version, release, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SCAPApi.get_scap_document ...'
+      end
+      # verify the required parameter 'title' is set
+      if @api_client.config.client_side_validation && title.nil?
+        fail ArgumentError, "Missing the required parameter 'title' when calling SCAPApi.get_scap_document"
+      end
+      if @api_client.config.client_side_validation && title.to_s.length > 200
+        fail ArgumentError, 'invalid value for "title" when calling SCAPApi.get_scap_document, the character length must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title" when calling SCAPApi.get_scap_document, the character length must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SCAPApi.get_scap_document"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && version !~ pattern
+        fail ArgumentError, "invalid value for 'version' when calling SCAPApi.get_scap_document, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'release' is set
+      if @api_client.config.client_side_validation && release.nil?
+        fail ArgumentError, "Missing the required parameter 'release' when calling SCAPApi.get_scap_document"
+      end
+      pattern = Regexp.new(/^\d+(\.\d+)?$/)
+      if @api_client.config.client_side_validation && release !~ pattern
+        fail ArgumentError, "invalid value for 'release' when calling SCAPApi.get_scap_document, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/scap/{title}/{version}/{release}'.sub('{' + 'title' + '}', CGI.escape(title.to_s)).sub('{' + 'version' + '}', CGI.escape(version.to_s)).sub('{' + 'release' + '}', CGI.escape(release.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DocumentDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SCAPApi.get_scap_document",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SCAPApi#get_scap_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get individual SCAP requirement details
+    # Returns complete details for specific SCAP requirement (same structure as STIG requirement)
+    # @param title [String] Document title exactly as it appears in the list endpoint
+    # @param version [String] Major version number of the document
+    # @param release [String] Release number within the version
+    # @param vuln [String] Vulnerability/Requirement ID (V-XXXXXX format)
+    # @param [Hash] opts the optional parameters
+    # @return [RequirementDetail]
+    def get_scap_requirement(title, version, release, vuln, opts = {})
+      data, _status_code, _headers = get_scap_requirement_with_http_info(title, version, release, vuln, opts)
+      data
+    end
+
+    # Get individual SCAP requirement details
+    # Returns complete details for specific SCAP requirement (same structure as STIG requirement)
+    # @param title [String] Document title exactly as it appears in the list endpoint
+    # @param version [String] Major version number of the document
+    # @param release [String] Release number within the version
+    # @param vuln [String] Vulnerability/Requirement ID (V-XXXXXX format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RequirementDetail, Integer, Hash)>] RequirementDetail data, response status code and response headers
+    def get_scap_requirement_with_http_info(title, version, release, vuln, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SCAPApi.get_scap_requirement ...'
+      end
+      # verify the required parameter 'title' is set
+      if @api_client.config.client_side_validation && title.nil?
+        fail ArgumentError, "Missing the required parameter 'title' when calling SCAPApi.get_scap_requirement"
+      end
+      if @api_client.config.client_side_validation && title.to_s.length > 200
+        fail ArgumentError, 'invalid value for "title" when calling SCAPApi.get_scap_requirement, the character length must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title" when calling SCAPApi.get_scap_requirement, the character length must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SCAPApi.get_scap_requirement"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && version !~ pattern
+        fail ArgumentError, "invalid value for 'version' when calling SCAPApi.get_scap_requirement, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'release' is set
+      if @api_client.config.client_side_validation && release.nil?
+        fail ArgumentError, "Missing the required parameter 'release' when calling SCAPApi.get_scap_requirement"
+      end
+      pattern = Regexp.new(/^\d+(\.\d+)?$/)
+      if @api_client.config.client_side_validation && release !~ pattern
+        fail ArgumentError, "invalid value for 'release' when calling SCAPApi.get_scap_requirement, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'vuln' is set
+      if @api_client.config.client_side_validation && vuln.nil?
+        fail ArgumentError, "Missing the required parameter 'vuln' when calling SCAPApi.get_scap_requirement"
+      end
+      pattern = Regexp.new(/^V-\d{6}$/)
+      if @api_client.config.client_side_validation && vuln !~ pattern
+        fail ArgumentError, "invalid value for 'vuln' when calling SCAPApi.get_scap_requirement, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/scap/{title}/{version}/{release}/{vuln}'.sub('{' + 'title' + '}', CGI.escape(title.to_s)).sub('{' + 'version' + '}', CGI.escape(version.to_s)).sub('{' + 'release' + '}', CGI.escape(release.to_s)).sub('{' + 'vuln' + '}', CGI.escape(vuln.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RequirementDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SCAPApi.get_scap_requirement",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SCAPApi#get_scap_requirement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all SCAP documents
+    # Returns list of Security Content Automation Protocol documents. These are automated scanning versions of STIGs. 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Array<DocumentVersion>>]
+    def list_scap_documents(opts = {})
+      data, _status_code, _headers = list_scap_documents_with_http_info(opts)
+      data
+    end
+
+    # List all SCAP documents
+    # Returns list of Security Content Automation Protocol documents. These are automated scanning versions of STIGs. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Array<DocumentVersion>>, Integer, Hash)>] Hash<String, Array<DocumentVersion>> data, response status code and response headers
+    def list_scap_documents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SCAPApi.list_scap_documents ...'
+      end
+      # resource path
+      local_var_path = '/scap'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Array<DocumentVersion>>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SCAPApi.list_scap_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SCAPApi#list_scap_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end