Merge pull request #116 from UKHO/Feature/143937-decrypt-permit-string

143937 decrypt permit string
UKHO · Mar 1, 2024 · cee76f4 · cee76f4
2 parents 32307e3 + 2491438
commit cee76f4
Show file tree

Hide file tree

Showing 58 changed files with 4,435 additions and 3,283 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -405,6 +405,20 @@ stages:
         value: $(AzureADConfigurationClientId)
       - name: "SharedKeyConfiguration.Key"
         value: $(SharedKeyConfigurationKey)
+      - name: "PermitConfiguration.PermitDecryptionHardwareId"
+        value: $(PermitDecryptionHardwareId)
+      - name: "PermitWithSameKey.Permit"
+        value: $(PermitWithSameKeyPermit)
+      - name: "PermitWithSameKey.ACTIVEKEY"
+        value: $(PermitWithSameKeyACTIVEKEY)
+      - name: "PermitWithSameKey.NEXTKEY"
+        value: $(PermitWithSameKeyNEXTKEY)
+      - name: "PermitWithDifferentKey.Permit"
+        value: $(PermitWithDifferentKeyPermit)
+      - name: "PermitWithDifferentKey.ACTIVEKEY"
+        value: $(PermitWithDifferentKeyACTIVEKEY)
+      - name: "PermitWithDifferentKey.NEXTKEY"
+        value: $(PermitWithDifferentKeyNEXTKEY)
     jobs:
       - deployment: DevDeployTerraform
         displayName: "Dev - Deploy Terraform"
@@ -675,7 +689,22 @@ stages:
         value: $[ stageDependencies.Devdeploy.DevDeployTerraform.outputs['DevDeployTerraform.TerraformDeploy.mockWebAppResourceGroupName']  ]
       - name: "SapMockConfiguration.BaseUrl"
         value: $[ stageDependencies.Devdeploy.DevDeployTerraform.outputs['DevDeployTerraform.TerraformDeploy.mockwebappurl']  ]
+      - name: "PermitConfiguration.PermitDecryptionHardwareId"
+        value: $(PermitDecryptionHardwareId)
+      - name: "PermitWithSameKey.Permit"
+        value: $(PermitWithSameKeyPermit)
+      - name: "PermitWithSameKey.ACTIVEKEY"
+        value: $(PermitWithSameKeyACTIVEKEY)
+      - name: "PermitWithSameKey.NEXTKEY"
+        value: $(PermitWithSameKeyNEXTKEY)
+      - name: "PermitWithDifferentKey.Permit"
+        value: $(PermitWithDifferentKeyPermit)
+      - name: "PermitWithDifferentKey.ACTIVEKEY"
+        value: $(PermitWithDifferentKeyACTIVEKEY)
+      - name: "PermitWithDifferentKey.NEXTKEY"
+        value: $(PermitWithDifferentKeyNEXTKEY)
     condition: and(succeeded(), or(eq(variables['Build.SourceBranch'], 'refs/heads/main'),startsWith(variables['Build.SourceBranch'], 'refs/heads/release/')))
+
     jobs:
       - deployment: QADeployTerraform
         displayName: "Qa - Deploy Terraform"

diff --git a/src/UKHO.ERPFacade.API/ConfigurationFiles/SapActions.json b/src/UKHO.ERPFacade.API/ConfigurationFiles/SapActions.json
@@ -121,6 +121,20 @@
                         "JsonPropertyName": "CurrentWeekAlphaCorrection",
                         "XmlNodeName": "CORRECTION",
                         "SortingOrder": 15
+                    },
+                    {
+                        "IsRequired": true,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": true,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -244,6 +258,20 @@
                         "JsonPropertyName": "CurrentWeekAlphaCorrection",
                         "XmlNodeName": "CORRECTION",
                         "SortingOrder": 15
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -362,6 +390,20 @@
                         "JsonPropertyName": "CurrentWeekAlphaCorrection",
                         "XmlNodeName": "CORRECTION",
                         "SortingOrder": 15
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -459,6 +501,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -561,6 +617,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -663,6 +733,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -784,6 +868,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": true,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": true,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -881,6 +979,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -983,6 +1095,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             },
@@ -1085,6 +1211,20 @@
                         "JsonPropertyName": "UnitType",
                         "XmlNodeName": "UNITTYPE",
                         "SortingOrder": 12
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "ACTIVEKEY",
+                        "SortingOrder": 16
+                    },
+                    {
+                        "IsRequired": false,
+                        "Section": "Product",
+                        "JsonPropertyName": "Permit",
+                        "XmlNodeName": "NEXTKEY",
+                        "SortingOrder": 17
                     }
                 ]
             }

diff --git a/src/UKHO.ERPFacade.API/Helpers/EncContentSapMessageBuilder.cs b/src/UKHO.ERPFacade.API/Helpers/EncContentSapMessageBuilder.cs
@@ -4,6 +4,7 @@
 using UKHO.ERPFacade.Common.Logging;
 using UKHO.ERPFacade.Common.Models;
 using UKHO.ERPFacade.Common.Providers;
+using UKHO.ERPFacade.Common.PermitDecryption;
 
 namespace UKHO.ERPFacade.API.Helpers
 {
@@ -14,6 +15,7 @@ public class EncContentSapMessageBuilder : IEncContentSapMessageBuilder
         private readonly IFileSystemHelper _fileSystemHelper;
         private readonly IOptions<SapActionConfiguration> _sapActionConfig;
         private readonly IWeekDetailsProvider _weekDetailsProvider;
+        private readonly IPermitDecryption _permitDecryption;
 
         private const string SapXmlPath = "SapXmlTemplates\\SAPRequest.xml";
         private const string XpathImMatInfo = $"//*[local-name()='IM_MATINFO']";
@@ -42,19 +44,24 @@ public class EncContentSapMessageBuilder : IEncContentSapMessageBuilder
         private const string Correction = "CORRECTION";
         private const string IsCorrectionTrue = "Y";
         private const string IsCorrectionFalse = "N";
+        private const string ActiveKey = "ACTIVEKEY";
+        private const string NextKey = "NEXTKEY";
+        private const string ProductStatusNewEdition = "New Edition";
 
         public EncContentSapMessageBuilder(ILogger<EncContentSapMessageBuilder> logger,
                                  IXmlHelper xmlHelper,
                                  IFileSystemHelper fileSystemHelper,
                                  IOptions<SapActionConfiguration> sapActionConfig,
-                                 IWeekDetailsProvider weekDetailsProvider
+                                 IWeekDetailsProvider weekDetailsProvider,
+                                 IPermitDecryption permitDecryption
                                  )
         {
             _logger = logger;
             _xmlHelper = xmlHelper;
             _fileSystemHelper = fileSystemHelper;
             _sapActionConfig = sapActionConfig;
             _weekDetailsProvider = weekDetailsProvider;
+            _permitDecryption = permitDecryption;
         }
 
         /// <summary>
@@ -302,6 +309,8 @@ private XmlElement BuildAction(XmlDocument soapXml, Product product, UnitOfSale
 
             List<(int sortingOrder, XmlElement itemNode)> actionAttributeList = new();
 
+            PermitKey? permitKey = action.ActionNumber == 1 || (action.ActionNumber == 7 && product.Status.StatusName == ProductStatusNewEdition) ? _permitDecryption.GetPermitKeys(product.Permit) : null;
+
             foreach (var node in action.Attributes.Where(x => x.Section == ProductSection))
             {
                 XmlElement itemSubNode = soapXml.CreateElement(node.XmlNodeName);
@@ -316,6 +325,22 @@ private XmlElement BuildAction(XmlDocument soapXml, Product product, UnitOfSale
                     {
                         itemSubNode.InnerText = GetXmlNodeValue(childCell.ToString());
                     }
+                    else if (node.XmlNodeName == ActiveKey)
+                    {
+                        itemSubNode.InnerText = string.Empty;
+                        if (permitKey != null && !string.IsNullOrEmpty(permitKey.ActiveKey))
+                        {
+                            itemSubNode.InnerText = permitKey.ActiveKey;
+                        }
+                    }
+                    else if (node.XmlNodeName == NextKey)
+                    {
+                        itemSubNode.InnerText = string.Empty;
+                        if (permitKey != null && !string.IsNullOrEmpty(permitKey.NextKey))
+                        {
+                            itemSubNode.InnerText = permitKey.NextKey;
+                        }
+                    }
                     else
                     {
                         object jsonFieldValue = CommonHelper.ParseXmlNode(node.JsonPropertyName, product, product.GetType());

diff --git a/src/UKHO.ERPFacade.API/Program.cs b/src/UKHO.ERPFacade.API/Program.cs
@@ -21,6 +21,7 @@
 using UKHO.ERPFacade.Common.IO.Azure;
 using UKHO.ERPFacade.Common.Models;
 using UKHO.ERPFacade.Common.Providers;
+using UKHO.ERPFacade.Common.PermitDecryption;
 using UKHO.ERPFacade.Common.Services;
 using UKHO.Logging.EventHubLogProvider;
 
@@ -172,6 +173,7 @@ void ConfigAdditionalValuesProvider(IDictionary<string, object> additionalValues
             builder.Services.Configure<SapActionConfiguration>(configuration.GetSection("SapActionConfiguration"));
             sapActionConfiguration = configuration.GetSection("SapActionConfiguration").Get<SapActionConfiguration>()!;
             builder.Services.Configure<EESHealthCheckEnvironmentConfiguration>(configuration.GetSection("EESHealthCheckEnvironmentConfiguration"));
+            builder.Services.Configure<PermitConfiguration>(configuration.GetSection("PermitConfiguration"));
 
             builder.Services.AddInfrastructure();
 
@@ -190,6 +192,7 @@ void ConfigAdditionalValuesProvider(IDictionary<string, object> additionalValues
             builder.Services.AddScoped<IEESClient, EESClient>();
             builder.Services.AddScoped<ILicenceUpdatedSapMessageBuilder, LicenceUpdatedSapMessageBuilder>();
             builder.Services.AddScoped<IWeekDetailsProvider, WeekDetailsProvider>();
+            builder.Services.AddScoped<IPermitDecryption, PermitDecryption>();
 
             builder.Services.AddHealthChecks()
                 .AddCheck<SapServiceHealthCheck>("SapServiceHealthCheck")

diff --git a/src/UKHO.ERPFacade.API/appsettings.json b/src/UKHO.ERPFacade.API/appsettings.json
@@ -69,5 +69,8 @@
         "ServerURL": "",
         "ServiceName": "",
         "Environment": ""
+    },
+    "PermitConfiguration": {
+        "PermitDecryptionHardwareId": ""
     }
 }
diff --git a/src/UKHO.ERPFacade.Common/Configuration/PermitConfiguration.cs b/src/UKHO.ERPFacade.Common/Configuration/PermitConfiguration.cs
@@ -0,0 +1,10 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace UKHO.ERPFacade.Common.Configuration
+{
+    [ExcludeFromCodeCoverage]
+    public class PermitConfiguration
+    {
+        public string PermitDecryptionHardwareId { get; set; } = string.Empty;
+    }
+}
diff --git a/src/UKHO.ERPFacade.Common/Logging/EventIds.cs b/src/UKHO.ERPFacade.Common/Logging/EventIds.cs
@@ -687,7 +687,7 @@ public enum EventIds
         /// 940137 - All related events are not present in Azure blob.
         /// </summary>
         AllRelatedEventsAreNotPresentInBlob = 940137,
-         
+
         /// <summary>
         /// 940138 - The record has been completed already.
         /// </summary>
@@ -706,7 +706,13 @@ public enum EventIds
         /// <summary>
         /// 940141 - Invalid UkhoWeekNumber field in enccontentpublished event from EES.
         /// </summary>
-        InvalidUkhoWeekNumber = 940141
+        InvalidUkhoWeekNumber = 940141,
+
+        /// <summary>
+        /// 940141 - Exception occured while decrypting the permit string.
+        /// </summary>
+        PermitDecryptionException = 940142
+
     }
 
     /// <summary>