rename VciSessionState -> AuthCodeSessionState

JoTiTu · JoTiTu · commit 94e00b5857e6 · 2024-07-23T14:43:15.000+02:00
Signed-off-by: Johannes Tuerk &lt;johannes.tuerk@lissi.id&gt;
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Abstractions/IAuthFlowSessionStorage.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Abstractions/IAuthFlowSessionStorage.cs
@@ -14,17 +14,17 @@ public interface IAuthFlowSessionStorage
     ///     Deletes the authorization session record by the session identifier.
     /// </summary>
     /// <param name="context">Agent Context</param>
-    /// <param name="vciSessionState">Session State Identifier of a Authorization Code Flow session</param>
+    /// <param name="authFlowSessionState">Session State Identifier of a Authorization Code Flow session</param>
     /// <returns></returns>
-    Task<bool> DeleteAsync(IAgentContext context, VciSessionState vciSessionState);
+    Task<bool> DeleteAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState);
 
     /// <summary>
     ///     Retrieves the authorization session record by the session identifier.
     /// </summary>
     /// <param name="context">Agent Context</param>
-    /// <param name="vciSessionState">Session State Identifier of a Authorization Code Flow session</param>
+    /// <param name="authFlowSessionState">Session State Identifier of a Authorization Code Flow session</param>
     /// <returns></returns>
-    Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, VciSessionState vciSessionState);
+    Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState);
 
     /// <summary>
     ///     Stores the authorization session record.
@@ -35,11 +35,11 @@ public interface IAuthFlowSessionStorage
     ///     Parameters required for the authorization during the VCI authorization code
     ///     flow.
     /// </param>
-    /// <param name="vciSessionState">Session State Identifier of a Authorization Code Flow session</param>
+    /// <param name="authFlowSessionState">Session State Identifier of a Authorization Code Flow session</param>
     /// <returns></returns>
     Task<string> StoreAsync(
         IAgentContext agentContext,
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
-        VciSessionState vciSessionState);
+        AuthFlowSessionState authFlowSessionState);
 }
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/AuthFlowSessionStateError.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/AuthFlowSessionStateError.cs
@@ -0,0 +1,5 @@
+using WalletFramework.Core.Functional;
+
+namespace WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Errors;
+
+public record AuthFlowSessionStateError(string Value) : Error($"Invalid AuthFlowSessionState: {Value}");
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/VciSessionIdError.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/VciSessionIdError.cs
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/VciSessionStateError.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Errors/VciSessionStateError.cs
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Implementations/AuthFlowSessionStorage.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Implementations/AuthFlowSessionStorage.cs
@@ -26,26 +26,26 @@ public async Task<string> StoreAsync(
         IAgentContext agentContext,
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
-        VciSessionState vciSessionState)
+        AuthFlowSessionState authFlowSessionState)
     {
         var record = new AuthFlowSessionRecord(
             authorizationData,
             authorizationCodeParameters,
-            vciSessionState);
+            authFlowSessionState);
 
         await _recordService.AddAsync(agentContext.Wallet, record, AuthFlowSessionRecordFun.EncodeToJson);
             
         return record.Id;
     }
         
     /// <inheritdoc />
-    public async Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, VciSessionState vciSessionState)
+    public async Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState)
     {
-        var record = await _recordService.GetAsync(context.Wallet, vciSessionState, AuthFlowSessionRecordFun.DecodeFromJson);
+        var record = await _recordService.GetAsync(context.Wallet, authFlowSessionState, AuthFlowSessionRecordFun.DecodeFromJson);
         return record!;
     }
         
     /// <inheritdoc />
-    public async Task<bool> DeleteAsync(IAgentContext context, VciSessionState vciSessionState) => 
-        await _recordService.DeleteAsync<AuthFlowSessionRecord>(context.Wallet, vciSessionState);
+    public async Task<bool> DeleteAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState) => 
+        await _recordService.DeleteAsync<AuthFlowSessionRecord>(context.Wallet, authFlowSessionState);
 }
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/AuthFlowSessionState.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/AuthFlowSessionState.cs
@@ -0,0 +1,49 @@
+using System.Globalization;
+using Newtonsoft.Json.Linq;
+using WalletFramework.Core.Functional;
+using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Errors;
+
+namespace WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Models;
+
+/// <summary>
+///     Identifier of the authorization state during the VCI Authorization Code Flow.
+/// </summary>
+public struct AuthFlowSessionState
+{
+    /// <summary>
+    ///    Gets the value of the state identifier.
+    /// </summary>
+    private string Value { get; }
+        
+    private AuthFlowSessionState(string value) => Value = value;
+        
+    /// <summary>
+    ///     Returns the value of the state identifier.
+    /// </summary>
+    /// <param name="authFlowSessionState"></param>
+    /// <returns></returns>
+    public static implicit operator string(AuthFlowSessionState authFlowSessionState) => authFlowSessionState.Value;
+        
+    public static Validation<AuthFlowSessionState> ValidAuthFlowSessionState(string authFlowSessionState)
+    {
+        if (!Guid.TryParse(authFlowSessionState, out _))
+        {
+            return new AuthFlowSessionStateError(authFlowSessionState);
+        }
+            
+        return new AuthFlowSessionState(authFlowSessionState);
+    }
+    
+    public static AuthFlowSessionState CreateAuthFlowSessionState()
+    {
+        var guid = Guid.NewGuid().ToString();
+        return new AuthFlowSessionState(guid);
+    }
+}
+
+public static class AuthFlowSessionStateFun
+{
+    public static AuthFlowSessionState DecodeFromJson(JValue json) => AuthFlowSessionState
+        .ValidAuthFlowSessionState(json.ToString(CultureInfo.InvariantCulture))
+        .UnwrapOrThrow(new InvalidOperationException("AuthFlowSessionState is corrupt"));
+}
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/IssuanceSession.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/IssuanceSession.cs
@@ -11,14 +11,14 @@ public record IssuanceSession
     /// <summary>
     ///   Gets the session identifier.
     /// </summary>
-    public VciSessionState VciSessionState { get; }
+    public AuthFlowSessionState AuthFlowSessionState { get; }
         
     /// <summary>
     ///  Gets the actual authorization code that is received from the authorization server upon successful authorization.
     /// </summary>
     public string Code { get; }
         
-    private IssuanceSession(VciSessionState vciSessionState, string code) => (VciSessionState, Code) = (vciSessionState, code);
+    private IssuanceSession(AuthFlowSessionState authFlowSessionState, string code) => (AuthFlowSessionState, Code) = (authFlowSessionState, code);
         
     /// <summary>
     ///    Creates a new instance of <see cref="IssuanceSession"/> from the given <see cref="Uri"/>.
@@ -37,8 +37,8 @@ public static IssuanceSession FromUri(Uri uri)
         }
         
         var sessionStateParam = queryParams.Get("state");
-        var vciSessionState = VciSessionState.ValidVciSessionState(sessionStateParam).Fallback(VciSessionState.CreateVciSessionState());
+        var authFlowSessionState = AuthFlowSessionState.ValidAuthFlowSessionState(sessionStateParam).Fallback(AuthFlowSessionState.CreateAuthFlowSessionState());
 
-        return new IssuanceSession(vciSessionState, code);
+        return new IssuanceSession(authFlowSessionState, code);
     }
 }
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/PushedAuthorizationRequest.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/PushedAuthorizationRequest.cs
@@ -21,7 +21,7 @@ internal record PushedAuthorizationRequest
     public string CodeChallengeMethod { get; }
     
     [JsonProperty("state", NullValueHandling = NullValueHandling.Ignore)]
-    public string VciSessionState { get; }
+    public string AuthFlowSessionState { get; }
         
     [JsonProperty("authorization_details", NullValueHandling = NullValueHandling.Ignore)]
     public AuthorizationDetails[]? AuthorizationDetails { get; }
@@ -42,7 +42,7 @@ internal record PushedAuthorizationRequest
     public string? Resource { get; }
 
     public PushedAuthorizationRequest(
-        VciSessionState vciSessionState,
+        AuthFlowSessionState authFlowSessionState,
         ClientOptions clientOptions,
         AuthorizationCodeParameters authorizationCodeParameters,
         AuthorizationDetails[]? authorizationDetails, 
@@ -56,7 +56,7 @@ public PushedAuthorizationRequest(
         WalletIssuer = clientOptions.WalletIssuer;
         CodeChallenge = authorizationCodeParameters.Challenge;
         CodeChallengeMethod = authorizationCodeParameters.CodeChallengeMethod;
-        VciSessionState = vciSessionState;
+        AuthFlowSessionState = authFlowSessionState;
         AuthorizationDetails = authorizationDetails;
         IssuerState = issuerState;
         UserHint = userHint;
@@ -83,8 +83,8 @@ public FormUrlEncodedContent ToFormUrlEncoded()
         if (!string.IsNullOrEmpty(CodeChallengeMethod))
             keyValuePairs.Add(new KeyValuePair<string, string>("code_challenge_method", CodeChallengeMethod));
             
-        if (!string.IsNullOrEmpty(VciSessionState))
-            keyValuePairs.Add(new KeyValuePair<string, string>("state", VciSessionState));
+        if (!string.IsNullOrEmpty(AuthFlowSessionState))
+            keyValuePairs.Add(new KeyValuePair<string, string>("state", AuthFlowSessionState));
         
         if (AuthorizationDetails != null)
             keyValuePairs.Add(new KeyValuePair<string, string>("authorization_details", SerializeObject(AuthorizationDetails)));
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/VciSessionId.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/VciSessionId.cs
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/VciSessionState.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Models/VciSessionState.cs
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Records/AuthFlowSessionRecord.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Records/AuthFlowSessionRecord.cs
@@ -15,11 +15,11 @@ public sealed class AuthFlowSessionRecord : RecordBase
     ///     The session specific state id.
     /// </summary>
     [JsonIgnore]
-    public VciSessionState VciSessionState
+    public AuthFlowSessionState AuthFlowSessionState
     {
-        get => VciSessionState
-            .ValidVciSessionState(Id)
-            .UnwrapOrThrow(new InvalidOperationException("SessionId is corrupt"));
+        get => AuthFlowSessionState
+            .ValidAuthFlowSessionState(Id)
+            .UnwrapOrThrow(new InvalidOperationException("AuthFlowSessionState is corrupt"));
         set
         {
             string str = value;
@@ -56,13 +56,13 @@ public AuthFlowSessionRecord()
     /// </summary>
     /// <param name="authorizationData"></param>
     /// <param name="authorizationCodeParameters"></param>
-    /// <param name="vciSessionState"></param>
+    /// <param name="authFlowSessionState"></param>
     public AuthFlowSessionRecord(
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
-        VciSessionState vciSessionState)
+        AuthFlowSessionState authFlowSessionState)
     {
-        VciSessionState = vciSessionState;
+        AuthFlowSessionState = authFlowSessionState;
         RecordVersion = 1;
         AuthorizationCodeParameters = authorizationCodeParameters;
         AuthorizationData = authorizationData;
@@ -90,7 +90,7 @@ public static JObject EncodeToJson(this AuthFlowSessionRecord record)
     public static AuthFlowSessionRecord DecodeFromJson(JObject json)
     {
         var idJson = json[nameof(RecordBase.Id)]!.ToObject<JValue>()!;
-        var id = VciSessionStateFun.DecodeFromJson(idJson);
+        var id = AuthFlowSessionStateFun.DecodeFromJson(idJson);
 
         var authCodeParameters = JsonConvert.DeserializeObject<AuthorizationCodeParameters>(
             json[AuthorizationCodeParametersJsonKey]!.ToString()
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/Implementations/Oid4VciClientService.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/Implementations/Oid4VciClientService.cs
@@ -80,7 +80,7 @@ public Oid4VciClientService(
     public async Task<Uri> InitiateAuthFlow(CredentialOfferMetadata offer, ClientOptions clientOptions)
     {
         var authorizationCodeParameters = CreateAndStoreCodeChallenge();
-        var sessionId = VciSessionState.CreateVciSessionState();
+        var sessionId = AuthFlowSessionState.CreateAuthFlowSessionState();
         var issuerMetadata = offer.IssuerMetadata;
             
         var scopes = offer
@@ -241,7 +241,7 @@ public async Task<Validation<OneOf<SdJwtRecord, MdocRecord>>> RequestCredential(
     {
         var context = await _agentProvider.GetContextAsync();
         
-        var session = await _authFlowSessionStorage.GetAsync(context, issuanceSession.VciSessionState);
+        var session = await _authFlowSessionStorage.GetAsync(context, issuanceSession.AuthFlowSessionState);
         
         var credConfiguration = session
             .AuthorizationData
@@ -270,7 +270,7 @@ public async Task<Validation<OneOf<SdJwtRecord, MdocRecord>>> RequestCredential(
             token,
             session.AuthorizationData.ClientOptions);
         
-        await _authFlowSessionStorage.DeleteAsync(context, session.VciSessionState);
+        await _authFlowSessionStorage.DeleteAsync(context, session.AuthFlowSessionState);
         
         var result =
             from response in validResponse
diff --git a/test/WalletFramework.Oid4Vc.Tests/Oid4Vci/AuthFlow/AuthFlowSessionRecordTests.cs b/test/WalletFramework.Oid4Vc.Tests/Oid4Vci/AuthFlow/AuthFlowSessionRecordTests.cs
@@ -49,7 +49,7 @@ public void Can_Encode_To_Json()
         
         var authorizationCodeParameters = new AuthorizationCodeParameters("hello", "world");
         
-        var sessionId = VciSessionState.CreateVciSessionState();
+        var sessionId = AuthFlowSessionState.CreateAuthFlowSessionState();
         var record = new AuthFlowSessionRecord(authorizationData, authorizationCodeParameters, sessionId);
         
         // Act
@@ -58,7 +58,7 @@ public void Can_Encode_To_Json()
         
         // Assert
         recordSut[nameof(RecordBase.Id)]!.ToString().Should().Be(record.Id);
-        tagsSut[nameof(AuthFlowSessionRecord.VciSessionState)] = record.VciSessionState.ToString();
+        tagsSut[nameof(AuthFlowSessionRecord.AuthFlowSessionState)] = record.AuthFlowSessionState.ToString();
     }
 
     [Fact]

Original file line number	Diff line number	Diff line change
`@@ -26,26 +26,26 @@ public async Task<string> StoreAsync(`
`26`	`26`	`IAgentContext agentContext,`
`27`	`27`	`AuthorizationData authorizationData,`
`28`	`28`	`AuthorizationCodeParameters authorizationCodeParameters,`
`29`		`- VciSessionState vciSessionState)`
	`29`	`+ AuthFlowSessionState authFlowSessionState)`
`30`	`30`	`{`
`31`	`31`	`var record = new AuthFlowSessionRecord(`
`32`	`32`	`authorizationData,`
`33`	`33`	`authorizationCodeParameters,`
`34`		`- vciSessionState);`
	`34`	`+ authFlowSessionState);`
`35`	`35`
`36`	`36`	`await _recordService.AddAsync(agentContext.Wallet, record, AuthFlowSessionRecordFun.EncodeToJson);`
`37`	`37`
`38`	`38`	`return record.Id;`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/// <inheritdoc />`
`42`		`- public async Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, VciSessionState vciSessionState)`
	`42`	`+ public async Task<AuthFlowSessionRecord> GetAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState)`
`43`	`43`	`{`
`44`		`- var record = await _recordService.GetAsync(context.Wallet, vciSessionState, AuthFlowSessionRecordFun.DecodeFromJson);`
	`44`	`+ var record = await _recordService.GetAsync(context.Wallet, authFlowSessionState, AuthFlowSessionRecordFun.DecodeFromJson);`
`45`	`45`	`return record!;`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/// <inheritdoc />`
`49`		`- public async Task<bool> DeleteAsync(IAgentContext context, VciSessionState vciSessionState) =>`
`50`		`- await _recordService.DeleteAsync<AuthFlowSessionRecord>(context.Wallet, vciSessionState);`
	`49`	`+ public async Task<bool> DeleteAsync(IAgentContext context, AuthFlowSessionState authFlowSessionState) =>`
	`50`	`+ await _recordService.DeleteAsync<AuthFlowSessionRecord>(context.Wallet, authFlowSessionState);`
`51`	`51`	`}`