OpenAI-DotNet-Proxy 8.2.0

- Deprecated ValidateAuthentication for ValidateAuthenticationAsync
RageAgainstThePixel · Aug 17, 2024 · 6f3da5f · 6f3da5f
1 parent 48d7d8a
commit 6f3da5f
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 42 deletions.
diff --git a/OpenAI-DotNet-Proxy/OpenAI-DotNet-Proxy.csproj b/OpenAI-DotNet-Proxy/OpenAI-DotNet-Proxy.csproj
@@ -22,8 +22,10 @@
     <IncludeSymbols>true</IncludeSymbols>
     <SignAssembly>false</SignAssembly>
     <ImplicitUsings>false</ImplicitUsings>
-    <Version>8.1.1</Version>
+    <Version>8.2.0</Version>
     <PackageReleaseNotes>
+Version 8.2.0
+- Deprecated ValidateAuthentication for ValidateAuthenticationAsync
 Version 8.1.1
 - Renamed OpenAIProxyStartup to OpenAIProxy
 Version 7.7.10

diff --git a/OpenAI-DotNet-Proxy/Proxy/AbstractAuthenticationFilter.cs b/OpenAI-DotNet-Proxy/Proxy/AbstractAuthenticationFilter.cs
@@ -1,15 +1,16 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.AspNetCore.Http;
+using System;
 using System.Threading.Tasks;
 
 namespace OpenAI.Proxy
 {
     /// <inheritdoc />
     public abstract class AbstractAuthenticationFilter : IAuthenticationFilter
     {
-        /// <inheritdoc />
-        public abstract void ValidateAuthentication(IHeaderDictionary request);
+        [Obsolete("Use ValidateAuthenticationAsync")]
+        public virtual void ValidateAuthentication(IHeaderDictionary request) { }
 
         /// <inheritdoc />
         public abstract Task ValidateAuthenticationAsync(IHeaderDictionary request);

diff --git a/OpenAI-DotNet-Proxy/Proxy/IAuthenticationFilter.cs b/OpenAI-DotNet-Proxy/Proxy/IAuthenticationFilter.cs
@@ -1,6 +1,7 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.AspNetCore.Http;
+using System;
 using System.Security.Authentication;
 using System.Threading.Tasks;
 
@@ -11,12 +12,7 @@ namespace OpenAI.Proxy
     /// </summary>
     public interface IAuthenticationFilter
     {
-        /// <summary>
-        /// Checks the headers for your user issued token.
-        /// If it's not valid, then throw <see cref="AuthenticationException"/>.
-        /// </summary>
-        /// <param name="request"></param>
-        /// <exception cref="AuthenticationException"></exception>
+        [Obsolete("Use ValidateAuthenticationAsync")]
         void ValidateAuthentication(IHeaderDictionary request);
 
         /// <summary>

diff --git a/OpenAI-DotNet-Proxy/Readme.md b/OpenAI-DotNet-Proxy/Readme.md
@@ -59,19 +59,9 @@ public partial class Program
 {
     private class AuthenticationFilter : AbstractAuthenticationFilter
     {
-        public override void ValidateAuthentication(IHeaderDictionary request)
-        {
-            // You will need to implement your own class to properly test
-            // custom issued tokens you've setup for your end users.
-            if (!request.Authorization.ToString().Contains(TestUserToken))
-            {
-                throw new AuthenticationException("User is not authorized");
-            }
-        }
-
         public override async Task ValidateAuthenticationAsync(IHeaderDictionary request)
         {
-            await Task.CompletedTask; // remote resource call
+            await Task.CompletedTask; // remote resource call to verify token
 
             // You will need to implement your own class to properly test
             // custom issued tokens you've setup for your end users.

diff --git a/OpenAI-DotNet-Tests-Proxy/Program.cs b/OpenAI-DotNet-Tests-Proxy/Program.cs
@@ -17,19 +17,10 @@ public partial class Program
 
         private class AuthenticationFilter : AbstractAuthenticationFilter
         {
-            public override void ValidateAuthentication(IHeaderDictionary request)
-            {
-                // You will need to implement your own class to properly test
-                // custom issued tokens you've setup for your end users.
-                if (!request.Authorization.ToString().Contains(TestUserToken))
-                {
-                    throw new AuthenticationException("User is not authorized");
-                }
-            }
-
+            /// <inheritdoc />
             public override async Task ValidateAuthenticationAsync(IHeaderDictionary request)
             {
-                await Task.CompletedTask; // remote resource call
+                await Task.CompletedTask; // remote resource call to verify token
 
                 // You will need to implement your own class to properly test
                 // custom issued tokens you've setup for your end users.

diff --git a/README.md b/README.md
@@ -315,19 +315,9 @@ public partial class Program
 {
     private class AuthenticationFilter : AbstractAuthenticationFilter
     {
-        public override void ValidateAuthentication(IHeaderDictionary request)
-        {
-            // You will need to implement your own class to properly test
-            // custom issued tokens you've setup for your end users.
-            if (!request.Authorization.ToString().Contains(TestUserToken))
-            {
-                throw new AuthenticationException("User is not authorized");
-            }
-        }
-
         public override async Task ValidateAuthenticationAsync(IHeaderDictionary request)
         {
-            await Task.CompletedTask; // remote resource call
+            await Task.CompletedTask; // remote resource call to verify token
 
             // You will need to implement your own class to properly test
             // custom issued tokens you've setup for your end users.