Open API GitHub Plugin Skill + Frontend Auth (MSAL + Basic / PAT)

dotnet/src/SemanticKernel.Abstractions/Connectors/WebApi/Rest/RestApiOperationRunner.cs

@@ -29,14 +29,21 @@ internal sealed class RestApiOperationRunner : IRestApiOperationRunner
     /// </summary>
     private readonly AuthenticateRequestAsyncCallback _authCallback;
 
+    /// <summary>
+    /// Request-header field containing information about the user agent originating the request
+    /// </summary>
+    private readonly string? _userAgent;
+
     /// <summary>
     /// Creates an instance of a <see cref="RestApiOperationRunner"/> class.
     /// </summary>
     /// <param name="httpClient">An instance of the HttpClient class.</param>
     /// <param name="authCallback">Optional callback for adding auth data to the API requests.</param>
-    public RestApiOperationRunner(HttpClient httpClient, AuthenticateRequestAsyncCallback? authCallback = null)
+    /// <param name="userAgent">Optional request-header field containing information about the user agent originating the request</param>
+    public RestApiOperationRunner(HttpClient httpClient, AuthenticateRequestAsyncCallback? authCallback = null, string? userAgent = null)
     {
         this._httpClient = httpClient;
+        this._userAgent = userAgent;
 
         // If no auth callback provided, use empty function
         if (authCallback == null)
@@ -84,6 +91,11 @@ public RestApiOperationRunner(HttpClient httpClient, AuthenticateRequestAsyncCal
             requestMessage.Content = payload;
         }
 
+        if (!string.IsNullOrWhiteSpace(this._userAgent))
+        {
+            requestMessage.Headers.Add("User-Agent", this._userAgent);
+        }
+
         if (headers != null)
         {
             foreach (var header in headers)

dotnet/src/SemanticKernel.UnitTests/Connectors/WebApi/Rest/RestApiOperationRunnerTests.cs

@@ -206,6 +206,39 @@ public async Task ItShouldAddHeadersToHttpRequestAsync()
         Assert.Contains(this._httpMessageHandlerStub.RequestHeaders, h => h.Key == "fake-header" && h.Value.Contains("fake-header-value"));
     }
 
+    [Fact]
+    public async Task ItShouldAddUserAgentHeaderToHttpRequestIfConfiguredAsync()
+    {
+        // Arrange
+        var headers = new Dictionary<string, string>();
+        headers.Add("fake-header", string.Empty);
+
+        var operation = new RestApiOperation(
+            "fake-id",
+            "https://fake-random-test-host",
+            "fake-path",
+            HttpMethod.Get,
+            "fake-description",
+            new List<RestApiOperationParameter>(),
+            headers
+        );
+
+        var arguments = new Dictionary<string, string>();
+        arguments.Add("fake-header", "fake-header-value");
+
+        var sut = new RestApiOperationRunner(this._httpClient, this._authenticationHandlerMock.Object, "fake-user-agent");
+
+        // Act
+        await sut.RunAsync(operation, arguments);
+
+        // Assert
+        Assert.NotNull(this._httpMessageHandlerStub.RequestHeaders);
+        Assert.Equal(2, this._httpMessageHandlerStub.RequestHeaders.Count());
+
+        Assert.Contains(this._httpMessageHandlerStub.RequestHeaders, h => h.Key == "fake-header" && h.Value.Contains("fake-header-value"));
+        Assert.Contains(this._httpMessageHandlerStub.RequestHeaders, h => h.Key == "User-Agent" && h.Value.Contains("fake-user-agent"));
+    }
+
     [Fact]
     public async Task ItShouldUsePayloadAndContentTypeArgumentsIfPayloadMetadataIsMissingAsync()
     {

dotnet/src/Skills/Skills.OpenAPI/Extensions/KernelOpenApiExtensions.cs

@@ -129,14 +129,14 @@ public static class KernelOpenApiExtensions
         AuthenticateRequestAsyncCallback? authCallback = null,
         CancellationToken cancellationToken = default)
     {
-        const string OpenAPIFile = "openapi.json";
+        const string OPENAPI_FILE = "openapi.json";
 
         Verify.ValidSkillName(skillDirectoryName);
 
         var skillDir = Path.Combine(parentDirectory, skillDirectoryName);
         Verify.DirectoryExists(skillDir);
 
-        var openApiDocumentPath = Path.Combine(skillDir, OpenAPIFile);
+        var openApiDocumentPath = Path.Combine(skillDir, OPENAPI_FILE);
         if (!File.Exists(openApiDocumentPath))
         {
             throw new FileNotFoundException($"No OpenApi document for the specified path - {openApiDocumentPath} is found.");
@@ -214,7 +214,7 @@ public static class KernelOpenApiExtensions
             try
             {
                 kernel.Log.LogTrace("Registering Rest function {0}.{1}", skillName, operation.Id);
-                var function = kernel.RegisterRestApiFunction(skillName, operation, authCallback, cancellationToken);
+                var function = kernel.RegisterRestApiFunction(skillName, operation, authCallback, cancellationToken: cancellationToken);
                 skill[function.Name] = function;
             }
             catch (Exception ex) when (!ex.IsCriticalException())
@@ -238,21 +238,27 @@ public static class KernelOpenApiExtensions
     /// <param name="operation">The REST API operation.</param>
     /// <param name="authCallback">Optional callback for adding auth data to the API requests.</param>
     /// <param name="cancellationToken">The cancellation token.</param>
+    /// <param name="userAgent">Optional override for request-header field containing information about the user agent originating the request</param>
     /// <returns>An instance of <see cref="SKFunction"/> class.</returns>
     private static ISKFunction RegisterRestApiFunction(
         this IKernel kernel,
         string skillName,
         RestApiOperation operation,
         AuthenticateRequestAsyncCallback? authCallback = null,
-        CancellationToken cancellationToken = default)
+        string? userAgent = "Microsoft-Semantic-Kernel",
+        CancellationToken cancellationToken = default
+        )
     {
         var restOperationParameters = operation.GetParameters();
 
+        // User Agent may be a required request header fields for some Rest APIs,
+        // but this detail isn't specified in OpenAPI specs, so defaulting for all Rest APIs imported.
+        // Other applications can override this value by passing it as a parameter on execution.
         async Task<SKContext> ExecuteAsync(SKContext context)
         {
             try
             {
-                var runner = new RestApiOperationRunner(new HttpClient(), authCallback);
+                var runner = new RestApiOperationRunner(new HttpClient(), authCallback, userAgent);
 
                 // Extract function arguments from context
                 var arguments = new Dictionary<string, string>();

dotnet/src/Skills/Skills.OpenAPI/OpenApi/OpenApiDocumentParser.cs

@@ -9,12 +9,14 @@
 using System.Text;
 using System.Text.Json;
 using System.Text.Json.Nodes;
+using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
 using Microsoft.SemanticKernel.Connectors.WebApi.Rest.Model;
+using Microsoft.SemanticKernel.Diagnostics;
 using Microsoft.SemanticKernel.Text;
 
 namespace Microsoft.SemanticKernel.Skills.OpenAPI.OpenApi;
@@ -145,6 +147,15 @@ private static List<RestApiOperation> CreateRestApiOperations(string serverUrl,
 
             var operationItem = operationPair.Value;
 
+            try
+            {
+                Verify.ValidFunctionName(operationItem.OperationId);
+            }
+            catch (KernelException)
+            {
+                operationItem.OperationId = ConvertOperationIdToValidFunctionName(operationItem.OperationId);
+            }
+
             var operation = new RestApiOperation(
                 operationItem.OperationId,
                 serverUrl,
@@ -373,5 +384,32 @@ private static List<RestApiOperationParameter> CreateRestApiOperationParameters(
     /// </summary>
     private const string OpenApiVersionPropertyName = "openapi";
 
+    /// <summary>
+    /// Converts operation id to valid SK Function name.
+    /// A function name can contain only ASCII letters, digits, and underscores.
+    /// </summary>
+    /// <param name="operationId">The operation id.</param>
+    /// <returns>Valid SK Function name.</returns>
+    private static string ConvertOperationIdToValidFunctionName(string operationId)
+    {
+
+        // Tokenize operation id on forward and back slashes
+        string[] tokens = operationId.Split('/', '\\');
+        string result = "";
+
+        foreach (string token in tokens)
+        {
+            // Removes all characters that are not ASCII letters, digits, and underscores.
+            string formattedToken = Regex.Replace(token, "[^0-9A-Za-z_]", "");
+            result += CultureInfo.CurrentCulture.TextInfo.ToTitleCase(formattedToken.ToLower(CultureInfo.CurrentCulture));
+        }
+
+        Console.ForegroundColor = ConsoleColor.Yellow;
+        Console.WriteLine("Operation name \"{0}\" converted to \"{1}\" to comply with SK Function name requirements. Use \"{1}\" when invoking function.", operationId, result);
+        Console.ResetColor();
+
+        return result;
+    }
+
     #endregion
 }

samples/apps/copilot-chat-app/webapi/Controllers/SemanticKernelController.cs

@@ -8,9 +8,11 @@
 using Microsoft.SemanticKernel.AI;
 using Microsoft.SemanticKernel.Orchestration;
 using Microsoft.SemanticKernel.SkillDefinition;
+using Microsoft.SemanticKernel.Skills.OpenAPI.Authentication;
 using SemanticKernel.Service.Config;
 using SemanticKernel.Service.Model;
 using SemanticKernel.Service.Skills;
+using SemanticKernel.Service.Skills.OpenAPI.Authentication;
 using SemanticKernel.Service.Storage;
 
 namespace SemanticKernel.Service.Controllers;
@@ -47,6 +49,7 @@ public class SemanticKernelController : ControllerBase
     /// <param name="planner">Planner to use to create function sequences.</param>
     /// <param name="plannerOptions">Options for the planner.</param>
     /// <param name="ask">Prompt along with its parameters</param>
+    /// <param name="openApiSkillsAuthHeaders">Authentication headers to connect to OpenAPI Skills</param>
     /// <param name="skillName">Skill in which function to invoke resides</param>
     /// <param name="functionName">Name of function to invoke</param>
     /// <returns>Results consisting of text generated by invoked function along with the variable in the SK that generated it</returns>
@@ -64,6 +67,7 @@ public class SemanticKernelController : ControllerBase
         [FromServices] CopilotChatPlanner planner,
         [FromServices] IOptions<PlannerOptions> plannerOptions,
         [FromBody] Ask ask,
+        [FromHeader] OpenApiSkillsAuthHeaders openApiSkillsAuthHeaders,
         string skillName, string functionName)
     {
         this._logger.LogDebug("Received call to invoke {SkillName}/{FunctionName}", skillName, functionName);
@@ -82,7 +86,7 @@ public class SemanticKernelController : ControllerBase
         // Register skills with the planner if enabled.
         if (plannerOptions.Value.Enabled)
         {
-            await this.RegisterPlannerSkillsAsync(planner, plannerOptions.Value);
+            await this.RegisterPlannerSkillsAsync(planner, plannerOptions.Value, openApiSkillsAuthHeaders);
         }
 
         // Register native skills with the chat's kernel
@@ -131,10 +135,22 @@ public class SemanticKernelController : ControllerBase
     /// <summary>
     /// Register skills with the planner's kernel.
     /// </summary>
-    private async Task RegisterPlannerSkillsAsync(CopilotChatPlanner planner, PlannerOptions options)
+    private async Task RegisterPlannerSkillsAsync(CopilotChatPlanner planner, PlannerOptions options, OpenApiSkillsAuthHeaders openApiSkillsAuthHeaders)
     {
         await planner.Kernel.ImportChatGptPluginSkillFromUrlAsync("KlarnaShopping", new Uri("https://www.klarna.com/.well-known/ai-plugin.json"));
 
+        // Register authenticated OpenAPI skills with the planner's kernel
+        // if the request includes an auth header for an OpenAPI skill.
+        // Else, don't register the skill as it'll fail on auth.
+        if (openApiSkillsAuthHeaders.GithubAuthentication != null)
+        {
+            var authenticationProvider = new BearerAuthenticationProvider(() => { return Task.FromResult(openApiSkillsAuthHeaders.GithubAuthentication); });
+            this._logger.LogInformation("Registering GitHub Skill");
+
+            var filePath = Path.Combine(Directory.GetCurrentDirectory(), @"Skills/OpenApiSkills/GitHubSkill/openapi.json");
+            var skill = await planner.Kernel.ImportOpenApiSkillFromFileAsync("GitHubSkill", filePath, authenticationProvider.AuthenticateRequestAsync);
+        }
+
         planner.Kernel.ImportSkill(new Microsoft.SemanticKernel.CoreSkills.TextSkill(), "text");
         planner.Kernel.ImportSkill(new Microsoft.SemanticKernel.CoreSkills.TimeSkill(), "time");
         planner.Kernel.ImportSkill(new Microsoft.SemanticKernel.CoreSkills.MathSkill(), "math");

samples/apps/copilot-chat-app/webapi/CopilotChatApi.csproj

@@ -44,6 +44,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\..\..\dotnet\src\Connectors\Connectors.AI.OpenAI\Connectors.AI.OpenAI.csproj" />
+    <ProjectReference Include="..\..\..\..\dotnet\src\Skills\Skills.OpenAPI\Skills.OpenAPI.csproj" />
     <ProjectReference Include="..\..\..\..\dotnet\src\Connectors\Connectors.Memory.Qdrant\Connectors.Memory.Qdrant.csproj" />
     <ProjectReference Include="..\..\..\..\dotnet\src\Extensions\Planning.SequentialPlanner\Planning.SequentialPlanner.csproj" />
     <ProjectReference Include="..\..\..\..\dotnet\src\SemanticKernel\SemanticKernel.csproj" />

samples/apps/copilot-chat-app/webapi/Model/OpenApiSkillsAuthHeaders.cs

@@ -0,0 +1,27 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace SemanticKernel.Service.Skills.OpenAPI.Authentication;
+
+/// /// <summary>
+/// Represents the authentication headers for imported OpenAPI Plugin Skills.
+/// </summary>
+public class OpenApiSkillsAuthHeaders
+{
+    /// <summary>
+    /// Gets or sets the MS Graph authentication header value.
+    /// </summary>
+    [FromHeader(Name = "x-sk-copilot-graph-auth")]
+    public string? GraphAuthentication { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Jira authentication header value.
+    /// </summary>
+    [FromHeader(Name = "x-sk-copilot-jira-auth")]
+    public string? JiraAuthentication { get; set; }
+
+    /// <summary>
+    /// Gets or sets the GitHub authentication header value.
+    /// </summary>
+    [FromHeader(Name = "x-sk-copilot-github-auth")]
+    public string? GithubAuthentication { get; set; }
+}