Skip to content

Commit

Permalink
Bump eudi-lib-jvm-siop-openid4vp-kt to v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
marinaioannou committed Dec 13, 2024
1 parent 6a808b7 commit 9730fdb
Show file tree
Hide file tree
Showing 235 changed files with 1,297 additions and 1,765 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ file.

```groovy
dependencies {
implementation "eu.europa.ec.eudi:eudi-lib-android-wallet-core:0.12.3"
implementation "eu.europa.ec.eudi:eudi-lib-android-wallet-core:0.12.4"
// required when using the built-in AndroidKeystoreSecureArea implementation provided by the library
// for user authentication with biometrics
implementation "androidx.biometric:biometric-ktx:1.2.0-alpha05"
Expand Down
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

## Packages

| Name |
|-----------------------------------------------------------------------------------------------------------------|
| [eu.europa.ec.eudi.wallet](wallet-core/eu.europa.ec.eudi.wallet/index.md) |
| [eu.europa.ec.eudi.wallet.document](wallet-core/eu.europa.ec.eudi.wallet.document/index.md) |
| [eu.europa.ec.eudi.wallet.issue.openid4vci](wallet-core/eu.europa.ec.eudi.wallet.issue.openid4vci/index.md) |
| [eu.europa.ec.eudi.wallet.logging](wallet-core/eu.europa.ec.eudi.wallet.logging/index.md) |
| [eu.europa.ec.eudi.wallet.presentation](wallet-core/eu.europa.ec.eudi.wallet.presentation/index.md) |
| Name |
|---|
| [eu.europa.ec.eudi.wallet](wallet-core/eu.europa.ec.eudi.wallet/index.md) |
| [eu.europa.ec.eudi.wallet.document](wallet-core/eu.europa.ec.eudi.wallet.document/index.md) |
| [eu.europa.ec.eudi.wallet.issue.openid4vci](wallet-core/eu.europa.ec.eudi.wallet.issue.openid4vci/index.md) |
| [eu.europa.ec.eudi.wallet.logging](wallet-core/eu.europa.ec.eudi.wallet.logging/index.md) |
| [eu.europa.ec.eudi.wallet.presentation](wallet-core/eu.europa.ec.eudi.wallet.presentation/index.md) |
| [eu.europa.ec.eudi.wallet.transfer.openId4vp](wallet-core/eu.europa.ec.eudi.wallet.transfer.openId4vp/index.md) |
| [eu.europa.ec.eudi.wallet.util](wallet-core/eu.europa.ec.eudi.wallet.util/index.md) |
| [eu.europa.ec.eudi.wallet.util](wallet-core/eu.europa.ec.eudi.wallet.util/index.md) |
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,31 @@

[androidJvm]\

@get:[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name =
"getDefaultKeyUnlockData")
@get:[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getDefaultKeyUnlockData")

@get:[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)

val Document.[DefaultKeyUnlockData](-default-key-unlock-data.md): AndroidKeystoreKeyUnlockData?

Returns the default AndroidKeystoreKeyUnlockData for the Document instance. The default key unlock
data is based on the Document.keyAlias.
Returns the default AndroidKeystoreKeyUnlockData for the Document instance. The default key unlock data is based on the Document.keyAlias.

#### Receiver

the Document instance

#### Return

the default AndroidKeystoreKeyUnlockData for the Document instance if document requires user
authentication
the default AndroidKeystoreKeyUnlockData for the Document instance if document requires user authentication

#### See also

| |
|------------------------------|
| |
|---|
| AndroidKeystoreKeyUnlockData |
| Document |
| Document |

#### Throws

| | |
|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| | |
|---|---|
| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if the Document is not managed by AndroidKeystoreSecureArea |
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,15 @@

[androidJvm]\

@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name =
"getDefaultCreateDocumentSettings")
@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getDefaultCreateDocumentSettings")

@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)

@[JvmStatic](https://kotlinlang.org/api/latest/jvm/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/-byte-array/index.html)? =
null, configure: AndroidKeystoreCreateKeySettings.Builder.()
-> [Unit](https://kotlinlang.org/api/latest/jvm/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 first
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. The [configure](get-default-create-document-settings.md) lambda can be used to further
customize the AndroidKeystoreCreateKeySettings. The first available AndroidKeystoreSecureArea
implementation is used.
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/-byte-array/index.html)? = null, configure: AndroidKeystoreCreateKeySettings.Builder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/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 first 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. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings. The first available AndroidKeystoreSecureArea implementation is used.

#### Receiver

Expand All @@ -36,22 +22,22 @@ the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance

androidJvm

| | |
|----------------------|--------------------------------------------------------------------|
| attestationChallenge | the attestation challenge to use when creating the keys |
| configure | a lambda to further customize the AndroidKeystoreCreateKeySettings |
| | |
|---|---|
| attestationChallenge | the attestation challenge to use when creating the keys |
| configure | a lambda to further customize the AndroidKeystoreCreateKeySettings |

#### See also

| |
|------------------------------------------|
| |
|---|
| AndroidKeystoreCreateKeySettings.Builder |
| AndroidKeystoreCreateKeySettings |
| AndroidKeystoreSecureArea |
| CreateDocumentSettings |
| AndroidKeystoreCreateKeySettings |
| AndroidKeystoreSecureArea |
| CreateDocumentSettings |

#### Throws

| | |
|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| | |
|---|---|
| [NoSuchElementException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-no-such-element-exception/index.html) | if no AndroidKeystoreSecureArea implementation is available |
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,40 @@

[androidJvm]\

@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name =
"getDefaultKeyUnlockData")
@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getDefaultKeyUnlockData")

@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)

fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(
documentId: DocumentId): AndroidKeystoreKeyUnlockData?
fun [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md).[getDefaultKeyUnlockData](get-default-key-unlock-data.md)(documentId: DocumentId): AndroidKeystoreKeyUnlockData?

Returns the default AndroidKeystoreKeyUnlockData for the given DocumentId. The default key unlock
data is based on the Document.keyAlias.
Returns the default AndroidKeystoreKeyUnlockData for the given DocumentId. The default key unlock data is based on the Document.keyAlias.

#### Receiver

the [EudiWallet](../../eu.europa.ec.eudi.wallet/-eudi-wallet/index.md) instance

#### Return

the default AndroidKeystoreKeyUnlockData for the given DocumentId or null if the document requires
no user authentication
the default AndroidKeystoreKeyUnlockData for the given DocumentId or null if the document requires no user authentication

#### Parameters

androidJvm

| | |
|------------|--------------------------------|
| | |
|---|---|
| documentId | the DocumentId of the document |

#### See also

| |
|------------------------------|
| |
|---|
| AndroidKeystoreKeyUnlockData |
| Document |
| Document |

#### Throws

| | |
|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if the Document is not managed by AndroidKeystoreSecureArea |
| [NoSuchElementException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-no-such-element-exception/index.html) | if the document is not found by the DocumentId |
| | |
|---|---|
| [IllegalStateException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html) | if the Document is not managed by AndroidKeystoreSecureArea |
| [NoSuchElementException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-no-such-element-exception/index.html) | if the document is not found by the DocumentId |
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ object [DocumentExtensions](index.md)

## Properties

| Name | Summary |
|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Name | Summary |
|---|---|
| [DefaultKeyUnlockData](-default-key-unlock-data.md) | [androidJvm]<br>@get:[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockData&quot;)<br>@get:[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)<br>val Document.[DefaultKeyUnlockData](-default-key-unlock-data.md): AndroidKeystoreKeyUnlockData?<br>Returns the default AndroidKeystoreKeyUnlockData for the Document instance. The default key unlock data is based on the Document.keyAlias. |

## Functions

| Name | Summary |
|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Name | Summary |
|---|---|
| [getDefaultCreateDocumentSettings](get-default-create-document-settings.md) | [androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultCreateDocumentSettings&quot;)<br>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/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/-byte-array/index.html)? = null, configure: AndroidKeystoreCreateKeySettings.Builder.() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/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 first 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. The [configure](get-default-create-document-settings.md) lambda can be used to further customize the AndroidKeystoreCreateKeySettings. The first available AndroidKeystoreSecureArea implementation is used. |
| [getDefaultKeyUnlockData](get-default-key-unlock-data.md) | [androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockData&quot;)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/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. |
| [getDefaultKeyUnlockData](get-default-key-unlock-data.md) | [androidJvm]<br>@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = &quot;getDefaultKeyUnlockData&quot;)<br>@[JvmStatic](https://kotlinlang.org/api/latest/jvm/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. |
Loading

0 comments on commit 9730fdb

Please sign in to comment.