Refactor document creation settings to ensure credential count does not exceed batch size

Author: vkanellopoulos

README.md

@@ -559,11 +559,30 @@ val onIssueEvent = OnIssueEvent { event ->
 
         is IssueEvent.DocumentRequiresCreateSettings -> {
             // Need to provide settings for document creation
-            val offeredDocument = event.offeredDocument
-            val createSettings = wallet.getDefaultCreateDocumentSettings(offeredDocument)
-
+            // Create document settings can be varied depending on the document type
+            
+            val format = event.offeredDocument.documentFormat
+            val isEuPid = when(format) {
+                is MsoMdocFormat -> format.docType == "eu.europa.ec.eudi.pid.1"
+                is SdJwtVcFormat -> format.vct == "urn:eudi:pid:1"
+                else -> false
+            }
+            val createDocumentSettings = when {
+                isEuPid -> eudiWallet.getDefaultCreateDocumentSettings(
+                    offeredDocument = event.offeredDocument,
+                    numberOfCredentials = 5,
+                    credentialPolicy = CreateDocumentSettings.CredentialPolicy.OneTimeUse
+                )
+
+
+                else -> eudiWallet.getDefaultCreateDocumentSettings(
+                    offeredDocument = event.offeredDocument,
+                    numberOfCredentials = 1,
+                    credentialPolicy = CreateDocumentSettings.CredentialPolicy.RotateUse
+                )
+            }
             // Resume with settings
-            event.resume(createSettings)
+            event.resume(createDocumentSettings)
 
             // Or cancel
             // event.cancel("User cancelled")

docs/wallet-core/eu.europa.ec.eudi.wallet.document/-document-extensions/get-default-create-document-settings.md

@@ -10,28 +10,33 @@
 
 @[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)
 
-fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, numberOfCredentials: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html) = 1, credentialPolicy: CreateDocumentSettings.CredentialPolicy = RotateUse, configure: AndroidKeystoreCreateKeySettings.Builder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings
+fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(offeredDocument: [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md), attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, numberOfCredentials: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html) = 1, credentialPolicy: CreateDocumentSettings.CredentialPolicy = RotateUse, configure: AndroidKeystoreCreateKeySettings.Builder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings
 
-Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance. The default settings are based on the [EudiWalletConfig](../../eu.europa.ec.eudi.wallet/-eudi-wallet-config/index.md) and the presence of an available AndroidKeystoreSecureArea implementation. The [attestationChallenge](get-default-create-document-settings.md) is generated using a [SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html) instance if not provided. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings.
+Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance. The default settings are based on the [EudiWalletConfig](../../eu.europa.ec.eudi.wallet/-eudi-wallet-config/index.md) and the presence of an available AndroidKeystoreSecureArea implementation.
+
+The number of credentials in the returned settings is limited to the [Offer.OfferedDocument.batchCredentialIssuanceSize](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/batch-credential-issuance-size.md), ensuring compatibility with issuer capabilities.
+
+The [attestationChallenge](get-default-create-document-settings.md) is generated using a [SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html) instance if not provided. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings.
 
 #### Receiver
 
 The [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance.
 
 #### Return
 
-The default CreateDocumentSettings.
+The default CreateDocumentSettings configured for the offered document.
 
 #### Parameters
 
 androidJvm
 
 | | |
 |---|---|
+| offeredDocument | The [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md) for which to create the default settings.     Used to determine the maximum number of credentials allowed. |
 | attestationChallenge | The attestation challenge to use when creating the keys. If `null`, a random challenge will be generated. |
-| numberOfCredentials | The number of credentials to pre-generate for the document. Defaults to 1. |
+| numberOfCredentials | The number of credentials to pre-generate for the document.     Will be limited to not exceed [Offer.OfferedDocument.batchCredentialIssuanceSize](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/batch-credential-issuance-size.md). Defaults to 1. |
 | credentialPolicy | The policy for credential usage (OneTimeUse or RotateUse). Defaults to RotateUse. |
-| configure | A lambda to further customize the AndroidKeystoreCreateKeySettings. |
+| configure | A lambda to further customize the AndroidKeystoreCreateKeySettings.     If not provided, settings will use values from [EudiWalletConfig](../../eu.europa.ec.eudi.wallet/-eudi-wallet-config/index.md). |
 
 #### See also
 
@@ -47,37 +52,3 @@ androidJvm
 | | |
 |---|---|
 | NoSuchElementException | if no AndroidKeystoreSecureArea implementation is available. |
-
-[androidJvm]\
-
-@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-overloads/index.html)
-
-@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)
-
-fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(offeredDocument: [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md), attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, configure: AndroidKeystoreCreateKeySettings.Builder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings
-
-Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance based on an [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md). The settings are derived from the issuer metadata and the document configuration within the offer. The [attestationChallenge](get-default-create-document-settings.md) is generated using a [SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html) instance if not provided. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings.
-
-#### Receiver
-
-The [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance.
-
-#### Return
-
-The default CreateDocumentSettings tailored for the offered document.
-
-#### Parameters
-
-androidJvm
-
-| | |
-|---|---|
-| offeredDocument | The [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md) from which to derive settings. |
-| attestationChallenge | The attestation challenge to use when creating the keys. If `null`, a random challenge will be generated. |
-| configure | A lambda to further customize the AndroidKeystoreCreateKeySettings. |
-
-#### Throws
-
-| | |
-|---|---|
-| NoSuchElementException | if no AndroidKeystoreSecureArea implementation is available. |

docs/wallet-core/eu.europa.ec.eudi.wallet.document/-document-extensions/get-default-key-unlock-data.md

@@ -3,6 +3,34 @@
 # getDefaultKeyUnlockData
 
 [androidJvm]\
+suspend fun IssuedDocument.[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(): AndroidKeystoreKeyUnlockData?
+
+Returns the default AndroidKeystoreKeyUnlockData for the IssuedDocument. The default key unlock data is based on the IssuedDocument.findCredential
+
+#### Receiver
+
+The IssuedDocument instance.
+
+#### Return
+
+The default AndroidKeystoreKeyUnlockData for the IssuedDocument if it requires user authentication, otherwise `null`.
+
+#### See also
+
+| |
+|---|
+| [DocumentExtensions.getDefaultKeyUnlockData](get-default-key-unlock-data.md) |
+
+#### Throws
+
+| | |
+|---|---|
+| [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html) | if the document is not managed by AndroidKeystoreSecureArea. |
+
+[androidJvm]\
+
+@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getDefaultKeyUnlockDataForDocument")
+
 suspend fun [getDefaultKeyUnlockData](get-default-key-unlock-data.md)(document: IssuedDocument): AndroidKeystoreKeyUnlockData?
 
 Returns the default AndroidKeystoreKeyUnlockData for the given IssuedDocument. The key unlock data is retrieved based on the document's associated credential.
@@ -30,7 +58,7 @@ androidJvm
 
 | | |
 |---|---|
-| [IllegalStateException](https://developer.android.com/reference/kotlin/java/lang/IllegalStateException.html) | if the document is not managed by AndroidKeystoreSecureArea. |
+| [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html) | if the document is not managed by AndroidKeystoreSecureArea. |
 
 [androidJvm]\
 

docs/wallet-core/eu.europa.ec.eudi.wallet.document/-document-extensions/index.md

@@ -17,5 +17,5 @@ Provides extension functions for Document and [EudiWallet](../../eu.europa.ec.eu
 
 | Name | Summary |
 |---|---|
-| [getDefaultCreateDocumentSettings](get-default-create-document-settings.md) | [androidJvm]<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-overloads/index.html)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)<br>fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(offeredDocument: [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md), attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, configure: AndroidKeystoreCreateKeySettings.Builder.() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings<br>Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance based on an [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md). The settings are derived from the issuer metadata and the document configuration within the offer. The [attestationChallenge](get-default-create-document-settings.md) is generated using a [SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html) instance if not provided. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings.<br>[androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultCreateDocumentSettings&quot;)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-overloads/index.html)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)<br>fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, numberOfCredentials: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html) = 1, credentialPolicy: CreateDocumentSettings.CredentialPolicy = RotateUse, configure: AndroidKeystoreCreateKeySettings.Builder.() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings<br>Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance. The default settings are based on the [EudiWalletConfig](../../eu.europa.ec.eudi.wallet/-eudi-wallet-config/index.md) and the presence of an available AndroidKeystoreSecureArea implementation. The [attestationChallenge](get-default-create-document-settings.md) is generated using a [SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html) instance if not provided. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings. |
-| [getDefaultKeyUnlockData](get-default-key-unlock-data.md) | [androidJvm]<br>suspend fun [getDefaultKeyUnlockData](get-default-key-unlock-data.md)(document: IssuedDocument): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given IssuedDocument. The key unlock data is retrieved based on the document's associated credential.<br>[androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockData&quot;)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)<br>fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(documentId: DocumentId): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given DocumentId. The default key unlock data is based on the Document.keyAlias of the found document. This is applicable only if the document's key requires user authentication.<br>[androidJvm]<br>fun [getDefaultKeyUnlockData](get-default-key-unlock-data.md)(secureArea: SecureArea, keyAlias: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given SecureArea and [keyAlias](get-default-key-unlock-data.md) if the [secureArea](get-default-key-unlock-data.md) is an instance of AndroidKeystoreSecureArea. |
+| [getDefaultCreateDocumentSettings](get-default-create-document-settings.md) | [androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultCreateDocumentSettings&quot;)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-overloads/index.html)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)<br>fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultCreateDocumentSettings](get-default-create-document-settings.md)(offeredDocument: [Offer.OfferedDocument](../../eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/index.md), attestationChallenge: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)? = null, numberOfCredentials: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html) = 1, credentialPolicy: CreateDocumentSettings.CredentialPolicy = RotateUse, configure: AndroidKeystoreCreateKeySettings.Builder.() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html)? = null): CreateDocumentSettings<br>Returns the default CreateDocumentSettings for the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance. The default settings are based on the [EudiWalletConfig](../../eu.europa.ec.eudi.wallet/-eudi-wallet-config/index.md) and the presence of an available AndroidKeystoreSecureArea implementation. |
+| [getDefaultKeyUnlockData](get-default-key-unlock-data.md) | [androidJvm]<br>suspend fun IssuedDocument.[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the IssuedDocument. The default key unlock data is based on the IssuedDocument.findCredential<br>[androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockDataForDocument&quot;)<br>suspend fun [getDefaultKeyUnlockData](get-default-key-unlock-data.md)(document: IssuedDocument): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given IssuedDocument. The key unlock data is retrieved based on the document's associated credential.<br>[androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockData&quot;)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.jvm/-jvm-static/index.html)<br>fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(documentId: DocumentId): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given DocumentId. The default key unlock data is based on the Document.keyAlias of the found document. This is applicable only if the document's key requires user authentication.<br>[androidJvm]<br>fun [getDefaultKeyUnlockData](get-default-key-unlock-data.md)(secureArea: SecureArea, keyAlias: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the given SecureArea and [keyAlias](get-default-key-unlock-data.md) if the [secureArea](get-default-key-unlock-data.md) is an instance of AndroidKeystoreSecureArea. |

docs/wallet-core/eu.europa.ec.eudi.wallet.issue.openid4vci/-offer/-offered-document/batch-credential-issuance-size.md

@@ -0,0 +1,8 @@
+//[wallet-core](../../../../index.md)/[eu.europa.ec.eudi.wallet.issue.openid4vci](../../index.md)/[Offer](../index.md)/[OfferedDocument](index.md)/[batchCredentialIssuanceSize](batch-credential-issuance-size.md)
+
+# batchCredentialIssuanceSize
+
+[androidJvm]\
+val [batchCredentialIssuanceSize](batch-credential-issuance-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html)
+
+Returns the batch credential issuance size based on the issuer metadata. If the issuer does not support batch credential issuance, returns 1.