Add Audit Logging To SecreteManager.exe

Directory.Packages.props

@@ -57,15 +57,15 @@
     <PackageVersion Include="Microsoft.DotNet.SwaggerGenerator.MSBuild" Version="$(MicrosoftDotNetSwaggerGeneratorMSBuildVersion)" />
     <PackageVersion Include="Microsoft.DotNet.VersionTools" Version="$(MicrosoftDotNetVersionToolsVersion)" />
     <PackageVersion Include="Microsoft.DotNet.Web.Authentication" Version="$(MicrosoftDotNetWebAuthenticationVersion)" />
-    <PackageVersion Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
-    <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="6.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Http" Version="6.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging" Version="6.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Http" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Logging.ApplicationInsights" Version="2.21.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Options" Version="6.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Options" Version="8.0.0" />
     <PackageVersion Include="Microsoft.Identity.Client" Version="4.62.0-preview" />
     <PackageVersion Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.0.0" />
     <PackageVersion Include="Microsoft.NET.Sdk.Functions" Version="4.1.1" />
@@ -81,6 +81,7 @@
     <PackageVersion Include="NUnit" Version="4.2.2" />
     <PackageVersion Include="NUnit3TestAdapter" Version="4.6.0" />
     <PackageVersion Include="Octokit" Version="13.0.1" />
+    <PackageVersion Include="OpenTelemetry.Audit.Geneva" Version="2.2.3" />
     <PackageVersion Include="ServiceFabricMocks" Version="$(ServiceFabricMocksVersion)" />
     <PackageVersion Include="System.CommandLine" Version="2.0.0-beta1.21308.1" />
     <PackageVersion Include="System.Data.SqlClient" Version="4.8.6" />

NuGet.config

@@ -1,7 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
     <clear />
+    <add key="AzureGenevaMonitoring" value="https://msblox.pkgs.visualstudio.com/_packaging/AzureGenevaMonitoring/nuget/v3/index.json" />
     <add key="dotnet-public" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public/nuget/v3/index.json" />
     <add key="dotnet-eng" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json" />
     <add key="dotnet-tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json" />

src/SecretManager/Microsoft.DncEng.SecretManager.ScenarioTests/ScenarioTestsBase.cs

@@ -44,6 +44,11 @@ public ScenarioTestsBase()
         protected async Task ExecuteSynchronizeCommand(string manifest)
         {
             ServiceCollection services = new ServiceCollection();
+            // Dependency injection instruction needed to support properties used for Geneval Logging operations
+            services.AddSingleton(new GlobalCommand());
+            services.AddSingleton(new SecurityAuditLogger(Guid.Empty));
+
+            // Original dependency injection instructions
             services.AddSingleton<SynchronizeCommand>();
 
             Program program = new Program();

src/SecretManager/Microsoft.DncEng.SecretManager.ScenarioTests/WrappedTokenProvider.cs

@@ -1,3 +1,6 @@
+using System.IdentityModel.Tokens.Jwt;
+using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Azure.Core;
 
@@ -7,9 +10,29 @@ public sealed class WrappedTokenProvider : ITokenCredentialProvider
     {
         private readonly TokenCredential _tokenCredential;
 
+        /// <inheritdoc/>
+        public string ApplicationId { get; internal set; }
+        /// <inheritdoc/>
+        public string TenantId { get; internal set; }
+
         public WrappedTokenProvider(TokenCredential tokenCredential)
         {
             _tokenCredential = tokenCredential;
+            SetCredentialIdentityValues();
+        }
+
+        /// <inheritdoc/>
+        internal void SetCredentialIdentityValues()
+        {
+            // Get a token from the crendential provider
+            var tokenRequestContext = new TokenRequestContext(new[] { "https://management.azure.com/.default" });
+            var token = _tokenCredential.GetToken(tokenRequestContext, CancellationToken.None);
+
+            // Decode the JWT to get user identity information
+            var handler = new JwtSecurityTokenHandler();
+            var jsonToken = handler.ReadToken(token.Token) as JwtSecurityToken;
+            ApplicationId = jsonToken?.Claims?.FirstOrDefault(claim => claim.Type == "oid")?.Value ?? "Claim Oid Not Found";
+            TenantId = jsonToken?.Claims?.FirstOrDefault(claim => claim.Type == "tenant_id")?.Value ?? "Claim tenant_id Not Found";
         }
 
         public Task<TokenCredential> GetCredentialAsync() => Task.FromResult(_tokenCredential);

src/SecretManager/Microsoft.DncEng.SecretManager.Tests/SynchronizeCommandTests.cs

@@ -1,8 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
-using System.Diagnostics.CodeAnalysis;
-using System.Globalization;
 using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
@@ -26,6 +24,11 @@ private async Task TestCommand(DateTimeOffset now, string manifestText, string l
         var cancellationToken = cts.Token;
 
         var services = new ServiceCollection();
+        // Dependency injection instruction needed to support properties used for Geneval Logging operations
+        services.AddSingleton(new GlobalCommand());
+        services.AddSingleton(new SecurityAuditLogger(Guid.Empty));
+
+        // Original dependency injection instructions
         services.AddSingleton(Mock.Of<IConsole>());
 
         var storageLocationTypeRegistry = new Mock<StorageLocationTypeRegistry>(MockBehavior.Strict);

src/SecretManager/Microsoft.DncEng.SecretManager/InfoCommand.cs → src/SecretManager/Microsoft.DncEng.SecretManager/Commands/InfoCommand.cs

@@ -3,21 +3,25 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.DncEng.CommandLineLib;
+using Microsoft.DncEng.SecretManager.Commands;
 
 namespace Microsoft.DncEng.SecretManager;
 
 [Command("info")]
-class InfoCommand : Command
+class InfoCommand : ProjectBaseCommand
 {
     private readonly IConsole _console;
 
-    public InfoCommand(IConsole console)
+    public InfoCommand(GlobalCommand globalCommand, IConsole console): base(globalCommand)
     {
         _console = console;
     }
 
     public override Task RunAsync(CancellationToken cancellationToken)
     {
+        // Provides a courtesy warning message if the ServiceTreeId option is set to a empty guid
+        ValidateServiceTreeIdOption();
+
         var exeName = Process.GetCurrentProcess().ProcessName;
         var version = Assembly.GetEntryAssembly()
             ?.GetCustomAttribute<AssemblyInformationalVersionAttribute>()

src/SecretManager/Microsoft.DncEng.SecretManager/Commands/ProjectBaseCommand.cs

@@ -0,0 +1,92 @@
+
+using System;
+using Microsoft.DncEng.CommandLineLib;
+using Mono.Options;
+
+namespace Microsoft.DncEng.SecretManager.Commands
+{
+    /// <summary>
+    /// This class is used to extend the CommandLineLib.GlobalCommand class to add a global options spacific to this project
+    /// </summary>
+    public class ProjectBaseCommand : GlobalCommand
+    {
+        /// <summary>
+        /// Indicates if the global option for 'quiet' is set
+        /// </summary>
+        public bool Quiet { get { return Verbosity == VerbosityLevel.Quiet; } }
+
+        /// <summary>
+        /// Check for local environment values to indicate you are running for Azure DevOps
+        /// SYSTEM_COLLECTIONURI is a default environment variable in Azure DevOps
+        /// </summary>
+        private bool RunningInAzureDevOps = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("SYSTEM_COLLECTIONURI"));
+
+        /// <summary>
+        /// Provides the ServiceTreeId set with global options
+        /// The ID is a guid and is set to Guid.Empty if not set
+        /// </summary>
+        private Guid _ServiceTreeId = Guid.Empty;
+
+        /// <summary>
+        /// Provides read only access to the _ServiceTreeId
+        /// </summary>
+        public Guid ServiceTreeId { get { return _ServiceTreeId; } }
+
+        /// <summary>
+        /// Base constructor for the ProjectBaseCommand class
+        /// </summary>
+        public ProjectBaseCommand(GlobalCommand globalCommand)
+        {
+            Verbosity = globalCommand.Verbosity;
+            Help = globalCommand.Help;
+        }
+
+        /// <summary>
+        /// Overrides the GetOptions method from the base class to add a custom option for the ServiceTreeId
+        /// </summary>
+        public override OptionSet GetOptions()
+        {
+            return new OptionSet()
+            {
+                {"servicetreeid=", "The service tree ID (must be a valid GUID id from aka.ms/servicetree)", id =>
+                    {
+                        if (Guid.TryParse(id, out var guid))
+                        {
+                            _ServiceTreeId = guid;
+                        }
+                        else
+                        {
+                            throw new ArgumentException($"Failed to parse a valid Guid value from ServiceTreeId value '{id}'!");
+                        }
+                    }
+                } 
+            };
+        }
+
+        /// <summary>
+        /// Provides a non-volitie warning message if the ServiceTreeId option is set to a empty guid value and argments have been parsed
+        internal void ValidateServiceTreeIdOption()
+        {
+            if (!Quiet && ServiceTreeId == Guid.Empty)
+            {
+                // If running in Azure DevOps use VSO tagging in the console output to the warning message will be handled by the Azure DevOps build system
+                if (RunningInAzureDevOps)
+                {
+                    WriteWarningMessage("##vso[task.logissue type=warning]ServiceTreeId is set to an Empty Guid! Security Audit logging will be suppressed!");
+                }
+                // Else write a general warning messgae to console
+                else
+                {
+                    WriteWarningMessage("ServiceTreeId is set to an Empty Guid! Security Audit logging will be suppressed!");
+                }
+            }
+        }
+
+        internal void WriteWarningMessage(string message)
+        {
+            Console.ForegroundColor = ConsoleColor.Yellow;
+            Console.WriteLine(message);
+            Console.ResetColor();
+        }
+    }
+}

src/SecretManager/Microsoft.DncEng.SecretManager/Commands/SynchronizeCommand.cs

@@ -7,13 +7,16 @@
 using ConsoleTables;
 using Microsoft.DncEng.CommandLineLib;
 using Microsoft.DncEng.SecretManager.StorageTypes;
+using Microsoft.VisualStudio.Services.Common;
+
 using Mono.Options;
+
 using Command = Microsoft.DncEng.CommandLineLib.Command;
 
 namespace Microsoft.DncEng.SecretManager.Commands;
 
 [Command("synchronize")]
-public class SynchronizeCommand : Command
+public class SynchronizeCommand : ProjectBaseCommand
 {
     private readonly StorageLocationTypeRegistry _storageLocationTypeRegistry;
     private readonly SecretTypeRegistry _secretTypeRegistry;
@@ -24,7 +27,7 @@ public class SynchronizeCommand : Command
     private bool _verifyOnly = false;
     private readonly List<string> _forcedSecrets = new();
 
-    public SynchronizeCommand(StorageLocationTypeRegistry storageLocationTypeRegistry, SecretTypeRegistry secretTypeRegistry, ISystemClock clock, IConsole console)
+    public SynchronizeCommand(GlobalCommand globalCommand, StorageLocationTypeRegistry storageLocationTypeRegistry, SecretTypeRegistry secretTypeRegistry, ISystemClock clock, IConsole console) : base(globalCommand)
     {
         _storageLocationTypeRegistry = storageLocationTypeRegistry;
         _secretTypeRegistry = secretTypeRegistry;
@@ -42,19 +45,22 @@ public override List<string> HandlePositionalArguments(List<string> args)
 
     public override OptionSet GetOptions()
     {
-        return new OptionSet
+        return base.GetOptions().AddRange(new OptionSet()
         {
             {"f|force", "Force rotate all secrets", f => _force = !string.IsNullOrEmpty(f)},
             {"force-secret=", "Force rotate the specified secret", _forcedSecrets.Add},
             {"skip-untracked", "Skip untracked secrets", f => _skipUntracked = !string.IsNullOrEmpty(f)},
             {"verify-only", "Does not rotate any secrets, instead, produces an error for every secret that needs to be rotated.", v => _verifyOnly = !string.IsNullOrEmpty(v)},
-        };
+        });
     }
 
     public override async Task RunAsync(CancellationToken cancellationToken)
     {
         try
         {
+            // Provides a curtisy warning message if the ServiceTreeId option is set to a empty guid
+            ValidateServiceTreeIdOption();
+
             Console.OutputEncoding = System.Text.Encoding.UTF8;
             _console.WriteLine($"🔁 Synchronizing secrets contained in {_manifestFile}");
             if (_force || _forcedSecrets.Any())

src/SecretManager/Microsoft.DncEng.SecretManager/TestCommand.cs → src/SecretManager/Microsoft.DncEng.SecretManager/Commands/TestCommand.cs

@@ -4,22 +4,25 @@
 using Azure.Core;
 using Microsoft.DncEng.CommandLineLib;
 
-namespace Microsoft.DncEng.SecretManager;
+namespace Microsoft.DncEng.SecretManager.Commands;
 
 [Command("test")]
-class TestCommand : Command
+class TestCommand : ProjectBaseCommand
 {
     private readonly IConsole _console;
     private readonly ITokenCredentialProvider _tokenProvider;
 
-    public TestCommand(IConsole console, ITokenCredentialProvider tokenProvider)
+    public TestCommand(GlobalCommand globalCommand, IConsole console, ITokenCredentialProvider tokenProvider) : base(globalCommand)
     {
         _console = console;
         _tokenProvider = tokenProvider;
     }
 
     public override async Task RunAsync(CancellationToken cancellationToken)
     {
+        // Provides a curtisy warning message if the ServiceTreeId option is set to a empty guid
+        ValidateServiceTreeIdOption();
+
         var creds = await _tokenProvider.GetCredentialAsync();
 
         var token = await creds.GetTokenAsync(new TokenRequestContext(new[]

src/SecretManager/Microsoft.DncEng.SecretManager/Commands/ValidateAllCommand.cs

@@ -4,8 +4,10 @@
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+
 using Microsoft.DncEng.CommandLineLib;
 using Microsoft.DncEng.SecretManager.StorageTypes;
+using Microsoft.VisualStudio.Services.Common;
 using Mono.Options;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
@@ -14,15 +16,15 @@
 namespace Microsoft.DncEng.SecretManager.Commands;
 
 [Command("validate-all")]
-public class ValidateAllCommand : Command
+public class ValidateAllCommand : ProjectBaseCommand
 {
     private readonly IConsole _console;
     private readonly SettingsFileValidator _settingsFileValidator;
     private readonly StorageLocationTypeRegistry _storageLocationTypeRegistry;
     private readonly List<string> _manifestFiles = new List<string>();
     private string _basePath;
 
-    public ValidateAllCommand(IConsole console, SettingsFileValidator settingsFileValidator, StorageLocationTypeRegistry storageLocationTypeRegistry)
+    public ValidateAllCommand(GlobalCommand globalCommand, IConsole console, SettingsFileValidator settingsFileValidator, StorageLocationTypeRegistry storageLocationTypeRegistry) : base(globalCommand)
     {
         _console = console;
         _settingsFileValidator = settingsFileValidator;
@@ -31,11 +33,11 @@ public ValidateAllCommand(IConsole console, SettingsFileValidator settingsFileVa
 
     public override OptionSet GetOptions()
     {
-        return new OptionSet
+        return base.GetOptions().AddRange(new OptionSet()
         {
             {"m|manifest-file=", "A secret manifest file. Can be specified more than once.", m => _manifestFiles.Add(m)},
             {"b|base-path=", "The base path to search for settings files.", b => _basePath = b},
-        };
+        });
     }
 
     public override bool AreRequiredOptionsSet()
@@ -45,6 +47,9 @@ public override bool AreRequiredOptionsSet()
 
     public override async Task RunAsync(CancellationToken cancellationToken)
     {
+        // Provides a courtesy warning message if the ServiceTreeId option is set to an empty guid
+        ValidateServiceTreeIdOption();
+
         bool haveErrors = false;
         var manifestFiles = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
         foreach (string manifestFile in _manifestFiles)