Bump Microsoft.NET.Test.Sdk from 17.5.0 to 17.10.0

.github/workflows/monthly-scan.yml

@@ -0,0 +1,51 @@
+name: Trufflehog Monthly Deep Scan
+
+
+on:
+  schedule:
+    - cron: "0 0 28-31 * *" 
+
+    #This scan will run on the last day of every month
+
+  push:
+    branches: [main, p3sprint/*, feature/*]
+jobs:
+  trufflehog-scan:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Install Trufflehog-latest
+        run: |
+          pip3 install trufflehog
+      - name: Run Trufflehog Monthly Deep Scan
+
+        #Configure the correct git url of the repo to be scanned
+        run: |
+          trufflehog https://github.com/Crown-Commercial-Service/ccs-ppg-notification-api.git --regex --entropy=FALSE
+
+      - name: Send email notification
+        uses: 
+          dawidd6/[email protected]
+        if: always()
+
+        with: 
+         server_address: ${{ secrets.SERVER_ADDRESS }}
+         server_port: ${{ secrets.SERVER_PORT }}
+         username: ${{ secrets.USER_NAME }}
+         password: ${{ secrets.PASSWORD }}
+         subject: Trufflehog Monthly Deep Scan
+         to: "[email protected],[email protected]"
+         from: "[email protected]"
+         body: |
+
+           Hi,
+
+            The Trufflehog Monthly Deep Scan has completed for "${{ github.repository }}". Please review the results below:
+
+            Scan Job URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+            Scan Status: **${{ job.status }}**              
+
+           Thank You.           
+           Brickendon SecOps

.github/workflows/secrets-scan.yml

@@ -0,0 +1,64 @@
+name: Git Secrets Scan
+
+on:
+  schedule:
+    - cron: "0 0 * * *" 
+  push:
+    branches: [main, feature/*, p3sprint/*]
+
+jobs:
+  git-secrets-scan:
+    name: Git Secrets Scan
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install git secrets
+      run: sudo apt-get update && sudo apt-get install git-secrets -y
+
+    - name: Add custom secrets patterns
+      run: git secrets --add '(\bBEGIN\b).*(PRIVATE KEY\b)'
+           && git secrets --add 'AKIA[0-9A-Z]{16}'
+           && git secrets --add '^([A-Za-z0-9/+=]{40,})$'
+           && git secrets --add '^ghp_[a-zA-Z0-9]{36}'
+           && git secrets --add '^github_pat_[a-zA-Z0-9]{22}_[a-zA-Z0-9]{59}'
+           && git secrets --add '^v[0-9]\\.[0-9a-f]{40}'
+           && git secrets --add '[A-Za-z0-9+/]{88}=='
+           && git secrets --add '[A-Za-z0-9_-]{32}$'           
+           && git secrets --add 'conclavesso[0-9a-z-]{84}'
+           && git secrets --add '\\b[a-z0-9]{80}\\b'
+           && git secrets --add '\\b[A-Z0-9]{50}\\b'
+           && git secrets --add '\\b[A-Z0-9]{58}\\b'
+           && git secrets --add '^[a-zA-Z0-9_-]{32,64}$'
+
+    - name: Run git secrets scan
+      run: |      
+        git secrets --scan
+
+    - name: Send email notification
+      uses: 
+        dawidd6/[email protected]
+      if: always()
+
+      with: 
+         server_address: ${{ secrets.SERVER_ADDRESS }}
+         server_port: ${{ secrets.SERVER_PORT }}
+         username: ${{ secrets.USER_NAME }}
+         password: ${{ secrets.PASSWORD }}
+         subject: Git Secrets Scan Results
+         to: "[email protected], [email protected]"
+         from: "[email protected]"
+         body: |
+
+           Hi,
+
+            The Git Secrets scan has completed for "${{ github.repository }}". Please review the results below:
+
+            Scan Job URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+            Scan Status: **${{ job.status }}**              
+
+           Thank You.           
+           Brickendon SecOps

Ccs.Ppg.NotificationService.API/Ccs.Ppg.NotificationService.API.csproj

@@ -12,20 +12,26 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-	  <Content Remove="appsecrets.json" />
+		<Content Remove="appsecrets.json" />
 	</ItemGroup>
 
 	<ItemGroup>
-	  <EmbeddedResource Include="appsecrets.json" />
+		<EmbeddedResource Include="appsecrets.json" />
 	</ItemGroup>
 
 	<ItemGroup>
-	  <PackageReference Include="VaultSharp" Version="1.7.1" />
+		<PackageReference Include="System.Net.Http" Version="4.3.4" />
+		<PackageReference Include="VaultSharp" Version="1.7.1" />
+		<PackageReference Include="AWSXRayRecorder.Core" Version="2.14.0" />
+		<PackageReference Include="AWSXRayRecorder.Handlers.AspNetCore" Version="2.11.0" />
+		<PackageReference Include="AWSXRayRecorder.Handlers.AwsSdk" Version="2.12.0" />
 	</ItemGroup>
 
 	<ItemGroup>
 		<ProjectReference Include="..\Ccs.Ppg.NotificationService\Ccs.Ppg.NotificationService.csproj" />
 		<ProjectReference Include="..\Ccs.Ppg.Utility.Authorization\Ccs.Ppg.Utility.Authorization.csproj" />
+		<ProjectReference Include="..\Ccs.Ppg.Utility.Constants\Ccs.Ppg.Utility.Constants.csproj" />
+		<ProjectReference Include="..\Ccs.Ppg.Utility.Exceptions\Ccs.Ppg.Utility.Exceptions.csproj" />
 		<ProjectReference Include="..\Ccs.Ppg.Utility.Logging\Ccs.Ppg.Utility.Logging.csproj" />
 		<ProjectReference Include="..\Ccs.Ppg.Utility.Swagger\Ccs.Ppg.Utility.Swagger.csproj" />
 	</ItemGroup>

Ccs.Ppg.NotificationService.API/Controllers/NotificationController.cs

@@ -12,10 +12,12 @@ namespace Ccs.Ppg.NotificationService.API.Controllers
     public class NotificationController : ControllerBase
     {
         private readonly IMessageProviderService _messageProviderService;
-        public NotificationController(IMessageProviderService messageProviderService)
+		    private readonly IEmailProviderService _emailProviderService;		
+		    public NotificationController(IMessageProviderService messageProviderService, IEmailProviderService emailProviderService)
         {
             _messageProviderService = messageProviderService;
-        }
+			      _emailProviderService = emailProviderService;
+		    }
         /// <summary>
         /// Allows a user to send SMS
         /// </summary>
@@ -39,11 +41,42 @@ public NotificationController(IMessageProviderService messageProviderService)
         /// </remarks>
 
         [HttpPost("sms")]
-        [SwaggerOperation(Tags = new[] { "notification/sms" })]
+        [SwaggerOperation(Tags = new[] { "Notification - SMS" })]
         [ProducesResponseType(typeof(bool), 200)]
         public async Task<bool> Post(MessageRequestModel message)
         {
             return await _messageProviderService.SendMessage(message);
-        }
-    }
+		    }
+
+		    /// <summary>
+		    /// Allows a user to send email
+		    /// </summary>
+		    /// <response  code="200">Ok</response>
+		    /// <response  code="401">Unauthorised</response>
+		    /// <response  code="403">Forbidden</response>
+		    /// <response  code="404">Not found</response>
+		    /// <response  code="400">Bad request. </response>
+		    /// <remarks>
+		    /// Sample request:
+		    ///
+		    ///     POST /notification/email
+		    ///        {
+		    ///        "to": "[email protected]",
+		    ///        "templateId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+		    ///        "bodyContent": {
+		    ///                 "email": "[email protected]",
+		    ///                 "additionalProp3": "string",
+		    ///                 "additionalProp3": "string"
+        ///                 }
+		    ///         }
+		    ///
+		    /// </remarks>
+
+		    [HttpPost("email")]
+		    [SwaggerOperation(Tags = new[] { "Notification - Email" })]
+	      public async Task SendEmailAsync(EmailInfo emailInfo)
+		    {
+           await _emailProviderService.SendEmailAsync(emailInfo);
+        }			      
+		}
 }

Ccs.Ppg.NotificationService.API/CustomOptions/ParameterStoreConfigurationProvider.cs

@@ -39,7 +39,9 @@ public async Task GetSecrets()
       configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "Message/ApiKey", "Message:ApiKey"));
       configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "Message/TemplateId", "Message:TemplateId"));
 
-      var dbName = _awsParameterStoreService.FindParameterByName(parameters, path + "ConnectionStrings/Name");
+			configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "Email/ApiKey", "Email:ApiKey"));
+
+			var dbName = _awsParameterStoreService.FindParameterByName(parameters, path + "ConnectionStrings/Name");
       var dbConnection = _awsParameterStoreService.FindParameterByName(parameters, path + "ConnectionStrings/CcsSso");
 
       if (!string.IsNullOrEmpty(dbName))
@@ -53,6 +55,22 @@ public async Task GetSecrets()
       }
 
       configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "apis/OrganisationUrl", "apis:OrganisationUrl"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "EnableXRay", "EnableXRay"));
+
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "WrapperApiSettings/ConfigApiKey", "WrapperApiSettings:ConfigApiKey"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "WrapperApiSettings/ApiGatewayEnabledConfigUrl", "WrapperApiSettings:ApiGatewayEnabledConfigUrl"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "WrapperApiSettings/ApiGatewayDisabledConfigUrl", "WrapperApiSettings:ApiGatewayDisabledConfigUrl"));
+
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/EnableValidation", "NotificationValidationConfigurations:EnableValidation"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/SmsMsgLength", "NotificationValidationConfigurations:SmsMsgLength"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/OrgNameLegnth", "NotificationValidationConfigurations:OrgNameLegnth"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/EmailRegex", "NotificationValidationConfigurations:EmailRegex"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/FirstNameLength", "NotificationValidationConfigurations:FirstNameLength"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/LastNameLength", "NotificationValidationConfigurations:LastNameLength"));
+      configurations.AddRange(_awsParameterStoreService.GetParameterFromCommaSeparated(parameters, path + "NotificationValidationConfigurations/SignInProviders", "NotificationValidationConfigurations:SignInProviders"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/LinkRegex", "NotificationValidationConfigurations:LinkRegex"));
+      configurations.Add(_awsParameterStoreService.GetParameter(parameters, path + "NotificationValidationConfigurations/CcsMsg", "NotificationValidationConfigurations:CcsMsg"));
+
 
       foreach (var configuration in configurations)
       {

Ccs.Ppg.NotificationService.API/CustomOptions/VaultConfiguration.cs

@@ -56,7 +56,13 @@ public async Task GetSecrets()
         Data.Add("Message:TemplateId", messageSettingsVault.TemplateId);
       }
 
-      if (_secrets.Data.ContainsKey("ConnectionStrings"))
+			if (_secrets.Data.ContainsKey("Email"))
+			{
+				var messageSettingsVault = JsonConvert.DeserializeObject<MessageSettingsVault>(_secrets.Data["Email"].ToString());
+				Data.Add("Email:ApiKey", messageSettingsVault.ApiKey);
+			}
+
+			if (_secrets.Data.ContainsKey("ConnectionStrings"))
       {
         var connectionStringsSettingsVault = JsonConvert.DeserializeObject<ConnectionStringsSettingsVault>(_secrets.Data["ConnectionStrings"].ToString());
         Data.Add("ConnectionStrings:CcsSso", connectionStringsSettingsVault.CcsSso);

Ccs.Ppg.NotificationService.API/Program.cs

@@ -1,3 +1,5 @@
+using Amazon.XRay.Recorder.Core;
+using Amazon.XRay.Recorder.Handlers.AwsSdk;
 using Ccs.Ppg.NotificationService.API;
 using Ccs.Ppg.NotificationService.API.CustomOptions;
 
@@ -30,9 +32,22 @@
 // Add services to the container.
 builder.Services.ConfigureServices(builder.Configuration);
 
+string startupUrl = Environment.GetEnvironmentVariable("STARTUP_URL");
+if (!string.IsNullOrWhiteSpace(startupUrl))
+{
+  builder.WebHost.UseUrls(startupUrl);
+}
+
 var app = builder.Build();
 
-app.ConfigurePipeline();
+if (!string.IsNullOrEmpty(builder.Configuration["EnableXRay"]) && Convert.ToBoolean(builder.Configuration["EnableXRay"]))
+{
+  Console.WriteLine("x-ray is enabled.");
+  AWSXRayRecorder.InitializeInstance(configuration: builder.Configuration);
+  app.UseXRay("NotificationApi");
+  AWSSDKHandler.RegisterXRayForAllServices();
+}
 
+app.ConfigurePipeline();
 
-app.Run();
+app.Run();

Ccs.Ppg.NotificationService.API/Properties/launchSettings.json

@@ -13,7 +13,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "notification-service/swagger",
       "applicationUrl": "https://localhost:7247;http://localhost:5247",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

Ccs.Ppg.NotificationService.API/Startup.cs

@@ -1,13 +1,15 @@
-using Ccs.Ppg.Utility.Authorization;
+using Ccs.Ppg.NotificationService.Model;
+using Ccs.Ppg.Utility.Authorization;
 using Ccs.Ppg.Utility.Cache;
+using Ccs.Ppg.Utility.Exceptions;
 using Ccs.Ppg.Utility.Logging;
 using Ccs.Ppg.Utility.Swagger;
 using System.Reflection;
 
 namespace Ccs.Ppg.NotificationService.API
 {
   public static class Startup
-  {
+  {    
     public static void ConfigureServices(this IServiceCollection services, ConfigurationManager config)
     {
       services.AddCustomLogging();
@@ -18,6 +20,60 @@ public static void ConfigureServices(this IServiceCollection services, Configura
       services.AddServices(config);
       services.AddControllers();
       services.AddRedis(config);
+      services.AddSingleton(s =>
+      {
+        bool.TryParse(config["IsApiGatewayEnabled"], out bool isApiGatewayEnabled);
+        bool.TryParse(config["EnableXRay"], out bool enableXray);
+        bool.TryParse(config["RedisCache:IsEnabled"], out bool redisCacheEnabled);
+        bool.TryParse(config["NotificationValidationConfigurations:EnableValidation"], out bool validationEnabled);
+        int.TryParse(config["NotificationValidationConfigurations:SmsMsgLength"], out int smsMsgLength);
+        int.TryParse(config["NotificationValidationConfigurations:OrgNameLegnth"], out int orgNameLegnth);
+        int.TryParse(config["NotificationValidationConfigurations:FirstNameLength"], out int firstNameLength);
+        int.TryParse(config["NotificationValidationConfigurations:LastNameLength"], out int LastNameLength);
+        ApplicationConfigurationInfo appConfigInfo = new ApplicationConfigurationInfo()
+        {
+          IsApiGatewayEnabled = isApiGatewayEnabled,
+          ApiKey = config["ApiKey"],
+          OrganisationApiUrl = config["OrganisationApiUrl"],
+          EnableXRay = enableXray,
+          RedisCacheSettings = new RedisCacheSettings()
+          {
+            IsEnabled = redisCacheEnabled
+          },
+          MessageSettings = new MessageSettings()
+          {
+            ApiKey = config["Message:ApiKey"],
+            TemplateId = config["Message:TemplateId"]
+          },
+          ConnectionStrings = new ConnectionStrings()
+          {
+            CcsSso = config["ConnectionStrings:CcsSso"]
+          },
+          EmailSettings = new EmailSettings()
+          {
+            ApiKey = config["Email:ApiKey"]
+          },
+          WrapperApiSettings = new WrapperApiSettings()
+          {
+            ApiGatewayDisabledConfigUrl = config["WrapperApiSettings:ApiGatewayDisabledConfigUrl"],
+            ApiGatewayEnabledConfigUrl = config["WrapperApiSettings:ApiGatewayEnabledConfigUrl"],
+            ConfigApiKey = config["WrapperApiSettings:ConfigApiKey"]
+          },
+          NotificationValidationConfigurations = new NotificationValidationConfigurations()
+          {
+            EnableValidation = validationEnabled,
+            SmsMsgLength = smsMsgLength,
+            OrgNameLegnth = orgNameLegnth,
+            FirstNameLength = firstNameLength,
+            LastNameLength = LastNameLength,
+            EmailRegex = config["NotificationValidationConfigurations:EmailRegex"],
+            LinkRegex = config["NotificationValidationConfigurations:LinkRegex"],
+            CcsMsg = config["NotificationValidationConfigurations:CcsMsg"],
+            SignInProviders = config.GetSection("NotificationValidationConfigurations:SignInProviders").Get<List<string>>(),
+          }
+        };
+        return appConfigInfo;
+      });
 
       // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
       services.AddEndpointsApiExplorer();
@@ -29,10 +85,9 @@ public static void ConfigureServices(this IServiceCollection services, Configura
 
     public static void ConfigurePipeline(this WebApplication app)
     {
-      if (app.Environment.IsDevelopment())
-      {
-        app.ConfigureSwagger();
-      }
+      app.ConfigureSwagger();
+
+      app.UseMiddleware<CommonExceptionHandlerMiddleware>();
 
       app.UseHttpsRedirection();