Merge pull request #175 from Mainframe-Renewal-Project/dev

Author: Y-Innovate

CMakeLists.txt

@@ -43,7 +43,7 @@
 cmake_minimum_required(VERSION 3.24)
 
 project(sear C CXX ASM)
-set(CXX_STANDARD 14)
+set(CXX_STANDARD 17)
 
 # This option is used when building the Python wheel
 option(SEAR_ENABLE_PYTHON "Enables building the Python language module." OFF)

README.md

@@ -50,7 +50,7 @@ from sear import sear
 
 result = sear(
     {
-        "operation": "extract",
+        "operation": "add",
         "admin_type": "user",
         "userid": "FDEGILIO",
         "traits": {

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools >= 78.1.0", "setuptools-scm >= 8.2"]
+requires = ["setuptools >= 80.9.0", "setuptools-scm >= 9.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -33,6 +33,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     'Programming Language :: Python :: 3 :: Only',
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
@@ -44,7 +45,7 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 dev = [
-  "pytest>=8.4.0",
+  "pytest>=8.4.2",
   "pytest-md>=0.2.0",
 ]
 

python_tests/test_user.py

@@ -220,6 +220,18 @@ def test_extract_user(create_user):
     assert "errors" not in str(extract_result.result)
     assert extract_result.result["return_codes"] == successful_return_codes
 
+def test_extract_user_empty_string():
+    """This test is supposed to fail"""
+    extract_result = sear(
+            {
+            "operation": "extract",
+            "admin_type": "user",
+            "userid": "",
+            },
+        )
+    assert "errors" in str(extract_result.result)
+    assert extract_result.result["return_codes"] != successful_return_codes
+
 def test_user_extract_not_found():
     """This test is supposed to fail"""
     user_not_found_result = sear(

sear/irrseq00/irrseq00.hpp

@@ -276,7 +276,8 @@ const uint32_t RRSF_PRIVILEGED_ATTRIBUTE        = 0x00040000;
 
 typedef struct {
   uint32_t length;
-} offset_field_t;
+  char data[];
+} racf_rrsf_offset_field_t;
 
 typedef struct {
   char rrsf_node_name[8];
@@ -291,43 +292,43 @@ typedef struct {
   uint32_t partner_node_os_version;
   uint32_t binary_partner_node_template_release_level;
   uint32_t binary_partner_node_template_service_level;
-  offset_field_t offset_partner_node_parse_level;
-  offset_field_t offset_rrsf_node_description;
-  offset_field_t offset_rrsf_node_workspace_dataset_prefix;
-  offset_field_t offset_rrsf_workspace_sms_management_class;
-  offset_field_t offset_rrsf_workspace_sms_storage_class;
-  offset_field_t offset_rrsf_workspace_data_class;
-  offset_field_t offset_rrsf_workspace_dataset_volume;
+  uint32_t offset_partner_node_parse_level;
+  uint32_t offset_rrsf_node_description;
+  uint32_t offset_rrsf_node_workspace_dataset_prefix;
+  uint32_t offset_rrsf_workspace_sms_management_class;
+  uint32_t offset_rrsf_workspace_sms_storage_class;
+  uint32_t offset_rrsf_workspace_data_class;
+  uint32_t offset_rrsf_workspace_dataset_volume;
   uint32_t rrsf_workspace_file_size;
-  offset_field_t offset_workspace_dataset_wdsqual;
+  uint32_t offset_workspace_dataset_wdsqual;
   uint32_t bit_flags;
-  offset_field_t offset_inmsg_dataset_name;
+  uint32_t offset_inmsg_dataset_name;
   uint32_t inmsg_records;
   uint32_t inmsg_extents;
-  offset_field_t offset_outmsg_dataset_name;
+  uint32_t offset_outmsg_dataset_name;
   uint32_t outmsg_records;
   uint32_t outmsg_extents;
-  offset_field_t offset_inmsg2_dataset_name;
+  uint32_t offset_inmsg2_dataset_name;
   uint32_t inmsg2_records;
   uint32_t inmsg2_extents;
-  offset_field_t offset_outmsg2_dataset_name;
+  uint32_t offset_outmsg2_dataset_name;
   uint32_t outmsg2_records;
   uint32_t outmsg2_extents;
   uint32_t node_requests_denied;
-  offset_field_t offset_tcpip_address_target_command;
-  offset_field_t offset_tcpip_address_resolved_by_system;
-  offset_field_t offset_tcpip_port;
-  offset_field_t offset_tcpip_tls_rule;
-  offset_field_t offset_tcpip_cipher_policy;
-  offset_field_t offset_tcpip_certificate_user;
+  uint32_t offset_tcpip_address_target_command;
+  uint32_t offset_tcpip_address_resolved_by_system;
+  uint32_t offset_tcpip_port;
+  uint32_t offset_tcpip_tls_rule;
+  uint32_t offset_tcpip_cipher_policy;
+  uint32_t offset_tcpip_certificate_user;
   uint8_t offset_tcpip_client_authentication;
   uint8_t tcpip_listener_status;
   uint16_t appc_listener_status;
   uint16_t reserved[2];
-  offset_field_t offset_appc_lu_name;
-  offset_field_t offset_appc_modename;
-  offset_field_t offset_appc_tp_name;
-  offset_field_t offset_appc_netname;
+  uint32_t offset_appc_lu_name;
+  uint32_t offset_appc_modename;
+  uint32_t offset_appc_tp_name;
+  uint32_t offset_appc_netname;
   uint32_t reserved2[4];
 } racf_rrsf_node_definitions_t;
 

sear/irrseq00/profile_post_processor.cpp

@@ -117,9 +117,13 @@ void ProfilePostProcessor::postProcessSearchGeneric(SecurityRequest &request) {
 
   for (int i = 0; i < found_profiles.size(); i++) {
     int len = std::strlen(found_profiles[i]);
-    std::string profile_name =
-        ProfilePostProcessor::decodeEBCDICBytes(found_profiles[i], len);
-    repeat_group_profiles.push_back(profile_name);
+    if (len > 0) {
+      std::string profile_name =
+          ProfilePostProcessor::decodeEBCDICBytes(found_profiles[i], len);
+      if (profile_name != " " && profile_name != "") {
+        repeat_group_profiles.push_back(profile_name);
+      }
+    }
     free(found_profiles[i]);
   }
 
@@ -208,6 +212,18 @@ void ProfilePostProcessor::postProcessRACFOptions(SecurityRequest &request) {
   request.setIntermediateResultJSON(profile);
 }
 
+// There are a bunch of these weird offset fields
+// This function allow offset fields to easily be processed
+void ProfilePostProcessor::postprocessRRSFOffsetField(nlohmann::json &profile, const std::string &key, const char *p_profile, int offset) {
+  const racf_rrsf_offset_field_t *p_field =
+    reinterpret_cast<const racf_rrsf_offset_field_t *>(p_profile + offset);
+  
+  // Only create the key if there actually is any data in the offset field, avoids empty quotes
+  if (p_field->length > 0) {
+    profile[key] = ProfilePostProcessor::decodeEBCDICBytes(p_field->data,p_field->length);
+  }
+}
+
 //////////////////////////////////////////////////////////////////////////
 // RRSF post processing                                                 //
 //////////////////////////////////////////////////////////////////////////
@@ -262,6 +278,35 @@ void ProfilePostProcessor::postProcessRACFRRSF(SecurityRequest &request) {
       node_definition["base:time_of_last_sent_work"] = ProfilePostProcessor::decodeEBCDICBytes(p_nodes->time_of_last_sent_work,8);
       node_definition["base:node_state"] = p_nodes->rrsf_node_state;
 
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:node_description", p_profile, p_nodes->offset_rrsf_node_description);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:partner_node_dynamic_parse_level",p_profile, p_nodes->offset_partner_node_parse_level);
+
+      // Workspace dataset information
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_prefix", p_profile, p_nodes->offset_rrsf_node_workspace_dataset_prefix);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_name", p_profile, p_nodes->offset_workspace_dataset_wdsqual);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_sms_management_class", p_profile, p_nodes->offset_rrsf_workspace_sms_management_class);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_sms_storage_class", p_profile, p_nodes->offset_rrsf_workspace_sms_storage_class);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_sms_data_class", p_profile, p_nodes->offset_rrsf_workspace_data_class);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:workspace_dataset_volume", p_profile, p_nodes->offset_rrsf_workspace_dataset_volume);
+
+      node_definition["base:workspace_file_size"] = p_nodes->rrsf_workspace_file_size;
+
+      // inmsg and outmsg dataset information
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:in_message_dataset_name", p_profile, p_nodes->offset_inmsg_dataset_name);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:out_message_dataset_name", p_profile, p_nodes->offset_outmsg_dataset_name);
+
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:temporary_in_message_dataset_name", p_profile, p_nodes->offset_inmsg2_dataset_name);
+      ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:temporary_out_message_dataset_name", p_profile, p_nodes->offset_outmsg2_dataset_name);
+
+      node_definition["base:in_message_records"] = p_nodes->inmsg_records;
+      node_definition["base:out_message_records"] = p_nodes->outmsg_records;
+      node_definition["base:temporary_in_message_records"] = p_nodes->inmsg2_records;
+      node_definition["base:temporary_out_message_records"] = p_nodes->outmsg2_records;
+      node_definition["base:in_message_extents"] = p_nodes->inmsg_extents;
+      node_definition["base:out_message_extents"] = p_nodes->outmsg_extents;
+      node_definition["base:in_message2_extents"] = p_nodes->inmsg2_extents;
+      node_definition["base:out_message2_extents"] = p_nodes->outmsg2_extents;
+
       // Partner node information
       node_definition["base:partner_node_operating_system_version"] = p_nodes->partner_node_os_version;
       node_definition["base:partner_node_template_release_level"] = p_nodes->binary_partner_node_template_release_level;
@@ -282,8 +327,22 @@ void ProfilePostProcessor::postProcessRACFRRSF(SecurityRequest &request) {
       // Determines which protocol the RRSF node is using and adds it to the result JSON
       if (p_nodes->rrsf_protocol == 01) {
         node_definition["base:node_protocol"] = "appc";
+
+        // These are only relevant if system is using APPC, instead of the modern TCP/IP
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:appc_modename", p_profile, p_nodes->offset_appc_modename);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:appc_lu_name", p_profile, p_nodes->offset_appc_lu_name);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:appc_tp_name", p_profile, p_nodes->offset_appc_tp_name);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:appc_netname", p_profile, p_nodes->offset_appc_netname);
       } else if (p_nodes->rrsf_protocol == 02) {
         node_definition["base:node_protocol"] = "tcpip";
+
+        // These are only relevant if system is using TCPIP for RRSF
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:resolved_tcpip_address", p_profile, p_nodes->offset_tcpip_address_resolved_by_system);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:target_tcpip_address", p_profile, p_nodes->offset_tcpip_address_target_command);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:tcpip_port", p_profile, p_nodes->offset_tcpip_port);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:tcpip_attls_rule", p_profile, p_nodes->offset_tcpip_tls_rule);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:tcpip_attls_cipher", p_profile, p_nodes->offset_tcpip_cipher_policy);
+        ProfilePostProcessor::postprocessRRSFOffsetField(node_definition, "base:tcpip_attls_certificate_user", p_profile, p_nodes->offset_tcpip_certificate_user);
       } else {
         node_definition["base:node_protocol"] = "none";
       }

sear/irrseq00/profile_post_processor.hpp

@@ -17,6 +17,7 @@ class ProfilePostProcessor {
   static void postProcessRACFRRSF(SecurityRequest &request);
 
  private:
+  static void postprocessRRSFOffsetField(nlohmann::json &profile, const std::string &key, const char *p_profile, int offset);
   static void processGenericField(nlohmann::json &json_field,
                                   const generic_field_descriptor_t *p_field,
                                   const char *p_profile,

sear/security_request.cpp

@@ -328,10 +328,14 @@ void SecurityRequest::load(const nlohmann::json& request) {
   }
 
   if (request.contains("run_as_userid")) {
-    std::string surrogate_userid_string = request.get<std::string>();
+    std::string surrogate_userid_string = request["run_as_userid"].get<std::string>();
     surrogate_userid_string = fromUTF8(surrogate_userid_string);
     Logger::getInstance().debug("Running under the authority of user: " +
                                 surrogate_userid_string);
+    const int userid_length = surrogate_userid_string.length();
+    std::strncpy(surrogate_userid_,
+                 surrogate_userid_string.c_str(),
+                 userid_length );
   }
 }
 

setup.py

@@ -71,7 +71,7 @@ def run(self):
         os.environ["CC"] = "ibm-clang64"
         os.environ["CFLAGS"] = "-std=c99"
         os.environ["CXX"] = "ibm-clang++64"
-        os.environ["CXXFLAGS"] = "-std=c++14"
+        os.environ["CXXFLAGS"] = "-std=c++17"
         sear_source_path = Path("sear")
         assemble("irrseq00.s", sear_source_path / "irrseq00")
         super().run()