improve vci draft version handling

kenkosmowski · kenkosmowski · commit 4fb7ef5cb1b1 · 2025-06-02T11:43:07.000+02:00
Signed-off-by: kenkosmowski &lt;ken.kosmowski@gmx.de&gt;
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/Abstractions/IOid4VciClientService.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/Abstractions/IOid4VciClientService.cs
@@ -33,7 +33,7 @@ public interface IOid4VciClientService
     /// <param name="credentialType">Specifies whether Sd-Jwt or MDoc should be issued</param>
     /// <param name="specVersion">Optional language tag</param>
     /// <returns></returns>
-    Task<Uri> InitiateAuthFlow(Uri uri, ClientOptions clientOptions, Option<Locale> language, Option<OneOf<Vct, DocType>> credentialType, int specVersion);
+    Task<Uri> InitiateAuthFlow(Uri uri, ClientOptions clientOptions, Option<Locale> language, Option<OneOf<Vct, DocType>> credentialType, Option<int> specVersion);
         
     /// <summary>
     ///     Requests a verifiable credential using the authorization code flow.
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Abstractions/IAuthFlowSessionStorage.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Abstractions/IAuthFlowSessionStorage.cs
@@ -1,4 +1,5 @@
 using Hyperledger.Aries.Agents;
+using LanguageExt;
 using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Models;
 using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Records;
 
@@ -51,5 +52,5 @@ Task<string> StoreAsync(
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
         AuthFlowSessionState authFlowSessionState,
-        int specVersion = 15);
+        Option<int> specVersion);
 }
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Implementations/AuthFlowSessionStorage.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Implementations/AuthFlowSessionStorage.cs
@@ -1,5 +1,6 @@
 using Hyperledger.Aries.Agents;
 using Hyperledger.Aries.Storage;
+using LanguageExt;
 using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Abstractions;
 using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Models;
 using WalletFramework.Oid4Vc.Oid4Vci.AuthFlow.Records;
@@ -22,18 +23,17 @@ public AuthFlowSessionStorage(IWalletRecordService recordService)
     private readonly IWalletRecordService _recordService;
         
     /// <inheritdoc />
-    public async Task<string> StoreAsync(
-        IAgentContext agentContext,
+    public async Task<string> StoreAsync(IAgentContext agentContext,
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
         AuthFlowSessionState authFlowSessionState,
-        int specVersion)
+        Option<int> specVersion)
     {
         var record = new AuthFlowSessionRecord(
             authorizationData,
             authorizationCodeParameters,
             authFlowSessionState,
-            specVersion);
+            specVersion.ToNullable());
 
         await _recordService.AddAsync(agentContext.Wallet, record);
             
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Records/AuthFlowSessionRecord.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/AuthFlow/Records/AuthFlowSessionRecord.cs
@@ -41,7 +41,7 @@ public AuthFlowSessionState AuthFlowSessionState
     /// <summary>
     ///     Used to track the VCI Specification verison
     /// </summary>
-    public int SpecVersion { get; }
+    public int? SpecVersion { get; }
 
     /// <summary>
     ///    Initializes a new instance of the <see cref="AuthFlowSessionRecord" /> class.
@@ -68,7 +68,7 @@ public AuthFlowSessionRecord(
         AuthorizationData authorizationData,
         AuthorizationCodeParameters authorizationCodeParameters,
         AuthFlowSessionState authFlowSessionState,
-        int specVersion)
+        int? specVersion)
     {
         AuthFlowSessionState = authFlowSessionState;
         RecordVersion = 1;
@@ -130,7 +130,7 @@ public static AuthFlowSessionRecord DecodeFromJson(JObject json)
         var authorizationData = AuthorizationDataFun
             .DecodeFromJson(json[AuthorizationDataJsonKey]!.ToObject<JObject>()!);
         
-        var specVersion = json[SpecVersionJsonKey]!.ToObject<int>();
+        var specVersion = json[SpecVersionJsonKey]!.ToObject<int?>();
         
         var result = new AuthFlowSessionRecord(authorizationData, authCodeParameters!, id, specVersion);
 
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/CredOffer/Errors/ScopeIsNullOrWhitespaceError.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/CredOffer/Errors/ScopeIsNullOrWhitespaceError.cs
@@ -0,0 +1,6 @@
+using WalletFramework.Core.Functional;
+
+namespace WalletFramework.Oid4Vc.Oid4Vci.CredOffer.Errors;
+
+public record ScopeIsNullOrWhitespaceError()
+    : Error("The scope is null or whitespace");
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/CredOffer/Models/ScopedCredentialConfiguration.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/CredOffer/Models/ScopedCredentialConfiguration.cs
@@ -0,0 +1,31 @@
+using LanguageExt;
+using Newtonsoft.Json.Linq;
+using WalletFramework.Core.Functional;
+using WalletFramework.Oid4Vc.Oid4Vci.CredConfiguration.Models;
+
+namespace WalletFramework.Oid4Vc.Oid4Vci.CredOffer.Models;
+
+public record ScopedCredentialConfiguration(CredentialConfigurationId CredentialConfigurationId, Option<Scope> Scope);
+
+public static class ScopedCredentialConfigurationExtensions
+{
+    private const string ScopeJsonKey = "scope";
+    private const string CredentialConfigurationIdJsonKey = "credential_configuration_id";
+
+    public static JObject EncodeToJson(this ScopedCredentialConfiguration scopedCredentialConfiguration)
+    {
+        return new JObject
+        {
+            { ScopeJsonKey, scopedCredentialConfiguration.Scope.MatchUnsafe(scope => scope.ToString(), () => null) },
+            { CredentialConfigurationIdJsonKey, scopedCredentialConfiguration.CredentialConfigurationId.ToString() }
+        };
+    }
+
+    public static ScopedCredentialConfiguration DecodeFromJson(JObject json)
+    {
+        var scope = Scope.OptionalScope(json[ScopeJsonKey]!);
+        var credentialConfigurationId = CredentialConfigurationId.ValidCredentialConfigurationId(json[CredentialConfigurationIdJsonKey]!.ToString()).UnwrapOrThrow();
+
+        return new ScopedCredentialConfiguration(credentialConfigurationId, scope);
+    }
+}
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Abstractions/ICredentialRequestService.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Abstractions/ICredentialRequestService.cs
@@ -20,5 +20,5 @@ public Task<Validation<IEnumerable<CredentialResponse>>> RequestCredentials(
         OneOf<OAuthToken, DPopToken> token,
         Option<ClientOptions> clientOptions,
         Option<AuthorizationRequest> authorizationRequest,
-        int specVersion = 15);
+        Option<int> specVersion);
 }
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Implementations/CredentialRequestService.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Implementations/CredentialRequestService.cs
@@ -51,7 +51,7 @@ private async Task<CredentialRequest> CreateCredentialRequest(
         Format format,
         OneOf<CredentialIdentifier, CredentialConfigurationId> credentialIdentification,
         OneOf<OAuthToken, DPopToken> token,
-        int specVersion,
+        Option<int> specVersion,
         IssuerMetadata issuerMetadata,
         Option<ClientOptions> clientOptions,
         Option<AuthorizationRequest> authorizationRequest)
@@ -139,7 +139,7 @@ async Task<Validation<IEnumerable<CredentialResponse>>> ICredentialRequestServic
         OneOf<OAuthToken, DPopToken> token,
         Option<ClientOptions> clientOptions,
         Option<AuthorizationRequest> authorizationRequest,
-        int specVersion)
+        Option<int> specVersion)
     {
         var credentialIdentifications = 
             token.Match(
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Models/CredentialRequest.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/CredRequest/Models/CredentialRequest.cs
@@ -14,30 +14,13 @@ namespace WalletFramework.Oid4Vc.Oid4Vci.CredRequest.Models;
 ///     This request contains the format of the credential, the type of credential,
 ///     and a proof of possession of the key material the issued credential shall be bound to.
 /// </summary>
-public record CredentialRequest(OneOf<CredentialIdentifier, CredentialConfigurationId> CredentialIdentification, Format Format, int specVersion, Option<ProofOfPossession> Proof, Option<ProofsOfPossession> Proofs, Option<SessionTranscript> SessionTranscript)
-{
-    /// <summary>
-    ///     Gets the proof of possession of the key material the issued credential shall be bound to.
-    /// </summary>
-    public Option<ProofOfPossession> Proof { get; } = Proof;
-    
-    /// <summary>
-    ///     Gets one or more proof of possessions of the key material the issued credential shall be bound to.
-    /// </summary>
-    public Option<ProofsOfPossession> Proofs { get; } = Proofs;
-
-    //TODO: Remove when backward compatibility is not needed anymore
-    /// <summary>
-    ///     Gets the format of the credential to be issued.
-    /// </summary>
-    public Format Format { get; } = Format;
-
-    public Option<SessionTranscript> SessionTranscript { get; } = SessionTranscript;
-    
-    public OneOf<CredentialIdentifier, CredentialConfigurationId> CredentialIdentification { get; } = CredentialIdentification;
-    
-    public int SpecVersion { get; } = specVersion;
-}
+public record CredentialRequest(
+    OneOf<CredentialIdentifier, CredentialConfigurationId> CredentialIdentification,
+    Format Format,
+    Option<int> SpecVersion,
+    Option<ProofOfPossession> Proof,
+    Option<ProofsOfPossession> Proofs,
+    Option<SessionTranscript> SessionTranscript);
 
 public static class CredentialRequestFun
 {
@@ -75,10 +58,28 @@ public static JObject EncodeToJson(this CredentialRequest request)
             },
             configurationId =>
             {
-                if (request.SpecVersion == 15)
-                    result.Add(CredentialConfigurationIdKey, configurationId.ToString());
-                else
-                    result.Add(FormatJsonKey, request.Format.ToString());
+                request.SpecVersion.Match(specVersion =>
+                    {
+                        switch (specVersion)
+                        {
+                            case 14:
+                                result.Add(FormatJsonKey, request.Format.ToString());
+                                break;
+                            case 15:
+                                result.Add(CredentialConfigurationIdKey, configurationId.ToString());
+                                break;
+                            default:
+                                result.Add(FormatJsonKey, request.Format.ToString());
+                                result.Add(CredentialConfigurationIdKey, configurationId.ToString());
+                                break;
+                        }
+                    },
+                    () =>
+                    {
+                        result.Add(FormatJsonKey, request.Format.ToString());
+                        result.Add(CredentialConfigurationIdKey, configurationId.ToString());
+                    }
+                );
                 
                 return Unit.Default;
             });
diff --git a/src/WalletFramework.Oid4Vc/Oid4Vci/Implementations/Oid4VciClientService.cs b/src/WalletFramework.Oid4Vc/Oid4Vci/Implementations/Oid4VciClientService.cs
@@ -164,12 +164,13 @@ await _authFlowSessionStorage.StoreAsync(
             context,
             authorizationData,
             authorizationCodeParameters,
-            sessionId);
+            sessionId,
+            Option<int>.None);
             
         return authorizationRequestUri;
     }
 
-    public async Task<Uri> InitiateAuthFlow(Uri uri, ClientOptions clientOptions, Option<Locale> language, Option<OneOf<Vct, DocType>> credentialType, int specVersion)
+    public async Task<Uri> InitiateAuthFlow(Uri uri, ClientOptions clientOptions, Option<Locale> language, Option<OneOf<Vct, DocType>> credentialType, Option<int> specVersion)
     {
         var locale = language.Match(
             some => some,
@@ -297,7 +298,8 @@ from preAuthCode in grants.PreAuthorizedCode
             issuerMetadata,
             token,
             Option<ClientOptions>.None,
-            Option<AuthorizationRequest>.None);
+            Option<AuthorizationRequest>.None,
+            Option<int>.None);
 
         var credentialSets = new List<CredentialSetRecord>();
         var result =
@@ -414,7 +416,7 @@ public async Task<Validation<IEnumerable<CredentialSetRecord>>> RequestCredentia
                 token,
                 session.AuthorizationData.ClientOptions,
                 Option<AuthorizationRequest>.None,
-                session.SpecVersion);
+                session.SpecVersion.ToOption());
             
             var result =
                 from responses in validResponses
@@ -543,8 +545,7 @@ public async Task<Validation<IEnumerable<OnDemandCredentialSet>>> RequestOnDeman
                 token,
                 session.AuthorizationData.ClientOptions,
                 authorizationRequest,
-                session.SpecVersion
-                );
+                session.SpecVersion.ToOption());
             
             var result =
                 from responses in validResponses

Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,5 @@ public Task<Validation<IEnumerable<CredentialResponse>>> RequestCredentials(`
`20`	`20`	`OneOf<OAuthToken, DPopToken> token,`
`21`	`21`	`Option<ClientOptions> clientOptions,`
`22`	`22`	`Option<AuthorizationRequest> authorizationRequest,`
`23`		`- int specVersion = 15);`
	`23`	`+ Option<int> specVersion);`
`24`	`24`	`}`