From 327cf8e3f1081dc9032f9034937fc13561f2a204 Mon Sep 17 00:00:00 2001
From: Dennis Haney <davh@davh.dk>
Date: Mon, 23 Oct 2023 19:33:45 +0700
Subject: [PATCH] Update the client authentication results to expose the access
 token expiration date

---
 .../OpenIddictClientModels.cs                 | 30 +++++++++++++++++++
 .../OpenIddictClientService.cs                |  6 ++++
 2 files changed, 36 insertions(+)

diff --git a/src/OpenIddict.Client/OpenIddictClientModels.cs b/src/OpenIddict.Client/OpenIddictClientModels.cs
index 24740a1d4..617a0edb6 100644
--- a/src/OpenIddict.Client/OpenIddictClientModels.cs
+++ b/src/OpenIddict.Client/OpenIddictClientModels.cs
@@ -66,6 +66,11 @@ public sealed record class InteractiveAuthenticationResult
         /// </summary>
         public required string? BackchannelAccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the backchannel access token, if available.
+        /// </summary>
+        public required DateTimeOffset? BackchannelAccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the backchannel identity token, if available.
         /// </summary>
@@ -82,6 +87,11 @@ public sealed record class InteractiveAuthenticationResult
         /// </summary>
         public required string? FrontchannelAccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the frontchannel access token, if available.
+        /// </summary>
+        public required DateTimeOffset? FrontchannelAccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the frontchannel identity token, if available.
         /// </summary>
@@ -253,6 +263,11 @@ public sealed record class ClientCredentialsAuthenticationResult
         /// </summary>
         public required string AccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the access token, if available.
+        /// </summary>
+        public required DateTimeOffset? AccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the identity token, if available.
         /// </summary>
@@ -394,6 +409,11 @@ public sealed record class DeviceAuthenticationResult
         /// </summary>
         public required string AccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the access token, if available.
+        /// </summary>
+        public required DateTimeOffset? AccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the identity token, if available.
         /// </summary>
@@ -605,6 +625,11 @@ public sealed record class PasswordAuthenticationResult
         /// </summary>
         public required string AccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the access token, if available.
+        /// </summary>
+        public required DateTimeOffset? AccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the identity token, if available.
         /// </summary>
@@ -714,6 +739,11 @@ public sealed record class RefreshTokenAuthenticationResult
         /// </summary>
         public required string AccessToken { get; init; }
 
+        /// <summary>
+        /// Gets or sets the expiration date of the access token, if available.
+        /// </summary>
+        public required DateTimeOffset? AccessTokenExpirationDate { get; init; }
+
         /// <summary>
         /// Gets or sets the identity token, if available.
         /// </summary>
diff --git a/src/OpenIddict.Client/OpenIddictClientService.cs b/src/OpenIddict.Client/OpenIddictClientService.cs
index 84bcc88ee..4fdb6e0c0 100644
--- a/src/OpenIddict.Client/OpenIddictClientService.cs
+++ b/src/OpenIddict.Client/OpenIddictClientService.cs
@@ -265,9 +265,11 @@ public async ValueTask<InteractiveAuthenticationResult> AuthenticateInteractivel
                     AuthorizationCode = context.AuthorizationCode,
                     AuthorizationResponse = context.Request is not null ? new(context.Request.GetParameters()) : new(),
                     BackchannelAccessToken = context.BackchannelAccessToken,
+                    BackchannelAccessTokenExpirationDate = context.BackchannelAccessTokenExpirationDate,
                     BackchannelIdentityToken = context.BackchannelIdentityToken,
                     BackchannelIdentityTokenPrincipal = context.BackchannelIdentityTokenPrincipal,
                     FrontchannelAccessToken = context.FrontchannelAccessToken,
+                    FrontchannelAccessTokenExpirationDate = context.FrontchannelAccessTokenExpirationDate,
                     FrontchannelIdentityToken = context.FrontchannelIdentityToken,
                     FrontchannelIdentityTokenPrincipal = context.FrontchannelIdentityTokenPrincipal,
                     Principal = context.MergedPrincipal,
@@ -448,6 +450,7 @@ public async ValueTask<ClientCredentialsAuthenticationResult> AuthenticateWithCl
             return new()
             {
                 AccessToken = context.BackchannelAccessToken!,
+                AccessTokenExpirationDate = context.BackchannelAccessTokenExpirationDate,
                 IdentityToken = context.BackchannelIdentityToken,
                 IdentityTokenPrincipal = context.BackchannelIdentityTokenPrincipal,
                 Principal = context.MergedPrincipal,
@@ -551,6 +554,7 @@ public async ValueTask<DeviceAuthenticationResult> AuthenticateWithDeviceAsync(D
                         return new()
                         {
                             AccessToken = context.BackchannelAccessToken!,
+                            AccessTokenExpirationDate = context.BackchannelAccessTokenExpirationDate,
                             IdentityToken = context.BackchannelIdentityToken,
                             IdentityTokenPrincipal = context.BackchannelIdentityTokenPrincipal,
                             Principal = context.MergedPrincipal,
@@ -753,6 +757,7 @@ public async ValueTask<PasswordAuthenticationResult> AuthenticateWithPasswordAsy
             return new()
             {
                 AccessToken = context.BackchannelAccessToken!,
+                AccessTokenExpirationDate = context.BackchannelAccessTokenExpirationDate,
                 IdentityToken = context.BackchannelIdentityToken,
                 IdentityTokenPrincipal = context.BackchannelIdentityTokenPrincipal,
                 Principal = context.MergedPrincipal,
@@ -846,6 +851,7 @@ public async ValueTask<RefreshTokenAuthenticationResult> AuthenticateWithRefresh
             return new()
             {
                 AccessToken = context.BackchannelAccessToken!,
+                AccessTokenExpirationDate = context.BackchannelAccessTokenExpirationDate,
                 IdentityToken = context.BackchannelIdentityToken,
                 IdentityTokenPrincipal = context.BackchannelIdentityTokenPrincipal,
                 Principal = context.MergedPrincipal,