Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
// Top-level build file where you can add configuration options common to all sub-projects/modules.
plugins {
alias(libs.plugins.android.library) apply false
alias(libs.plugins.kotlin.android) apply false
alias(libs.plugins.dokka) apply false
alias(libs.plugins.dependency.license.report) apply false
alias(libs.plugins.dependencycheck) apply false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

# Companion

[androidJvm]\
[release]\
object [Companion](index.md)

## Functions

| Name | Summary |
|---|---|
| [invoke](invoke.md) | [androidJvm]<br>operator fun [invoke](invoke.md)(format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialCertification](../index.md) |
| [invoke](invoke.md) | [release]<br>operator fun [invoke](invoke.md)(format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialCertification](../index.md) |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# invoke

[androidJvm]\
operator fun [invoke](invoke.md)(format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialCertification](../index.md)
[release]\
operator fun [invoke](invoke.md)(format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialCertification](../index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# certifyCredential

[androidJvm]\
abstract suspend fun [certifyCredential](certify-credential.md)(credential: SecureAreaBoundCredential, issuedCredential: [IssuerProvidedCredential](../-issuer-provided-credential/index.md), forceKeyCheck: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html))
[release]\
abstract suspend fun [certifyCredential](certify-credential.md)(credential: SecureAreaBoundCredential, issuedCredential: [IssuerProvidedCredential](../-issuer-provided-credential/index.md))
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ fun interface [CredentialCertification](index.md)

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [androidJvm]<br>object [Companion](-companion/index.md) |
| [Companion](-companion/index.md) | [release]<br>object [Companion](-companion/index.md) |

## Functions

| Name | Summary |
|---|---|
| [certifyCredential](certify-credential.md) | [androidJvm]<br>abstract suspend fun [certifyCredential](certify-credential.md)(credential: SecureAreaBoundCredential, issuedCredential: [IssuerProvidedCredential](../-issuer-provided-credential/index.md), forceKeyCheck: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html)) |
| [certifyCredential](certify-credential.md) | [release]<br>abstract suspend fun [certifyCredential](certify-credential.md)(credential: SecureAreaBoundCredential, issuedCredential: [IssuerProvidedCredential](../-issuer-provided-credential/index.md)) |
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

# Companion

[androidJvm]\
[release]\
object [Companion](index.md)

## Functions

| Name | Summary |
|---|---|
| [invoke](invoke.md) | [androidJvm]<br>operator fun [invoke](invoke.md)(domain: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html), format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialFactory](../index.md)<br>Creates an appropriate credential factory implementation based on the document format. |
| [invoke](invoke.md) | [release]<br>operator fun [invoke](invoke.md)(domain: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialFactory](../index.md)<br>Creates an appropriate credential factory implementation based on the document format. |
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# invoke

[androidJvm]\
operator fun [invoke](invoke.md)(domain: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html), format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialFactory](../index.md)
[release]\
operator fun [invoke](invoke.md)(domain: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), format: [DocumentFormat](../../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md)): [CredentialFactory](../index.md)

Creates an appropriate credential factory implementation based on the document format.

Expand All @@ -13,9 +13,9 @@ a credential factory implementation specific to the document format

#### Parameters

androidJvm
release

| | |
|---|---|
| domain | the domain for the credentials |
| format | the document format that determines which factory implementation to use |
| format | the document format that determines which factory implementation to use |
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# createCredentials

[androidJvm]\
abstract suspend fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;SecureAreaBoundCredential&gt;, [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)?&gt;
[release]\
abstract suspend fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;SecureAreaBoundCredential&gt;, [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?&gt;

Creates a list of credentials for a document based on the given format and settings.

Expand All @@ -13,11 +13,11 @@ a list of credentials bound to the secure area

#### Parameters

androidJvm
release

| | |
|---|---|
| format | the document format that determines the type of credential to create |
| document | the document that will contain the credentials |
| createDocumentSettings | settings for creating the document credentials |
| secureArea | the secure area for storing cryptographic keys |
| secureArea | the secure area for storing cryptographic keys |
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Factory interface for creating credentials based on document format. Provides fu

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [androidJvm]<br>object [Companion](-companion/index.md) |
| [Companion](-companion/index.md) | [release]<br>object [Companion](-companion/index.md) |

## Functions

| Name | Summary |
|---|---|
| [createCredentials](create-credentials.md) | [androidJvm]<br>abstract suspend fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;SecureAreaBoundCredential&gt;, [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)?&gt;<br>Creates a list of credentials for a document based on the given format and settings. |
| [createCredentials](create-credentials.md) | [release]<br>abstract suspend fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;SecureAreaBoundCredential&gt;, [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?&gt;<br>Creates a list of credentials for a document based on the given format and settings. |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# MsoMdoc

[androidJvm]\
constructor(nameSpacedData: NameSpacedData, staticAuthData: StaticAuthDataParser.StaticAuthData)
[release]\
constructor(nameSpacedData: NameSpacedData, staticAuthData: StaticAuthDataParser.StaticAuthData)
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# MsoMdoc

[androidJvm]\
[release]\
data class [MsoMdoc](index.md)(val nameSpacedData: NameSpacedData, val staticAuthData: StaticAuthDataParser.StaticAuthData) : [CredentialIssuedData](../index.md)

Represents Mobile Security Object (MSO) data for Mobile Driving License (mDL) credential format.
Expand All @@ -11,11 +11,11 @@ Represents Mobile Security Object (MSO) data for Mobile Driving License (mDL) cr

| | |
|---|---|
| [MsoMdoc](-mso-mdoc.md) | [androidJvm]<br>constructor(nameSpacedData: NameSpacedData, staticAuthData: StaticAuthDataParser.StaticAuthData) |
| [MsoMdoc](-mso-mdoc.md) | [release]<br>constructor(nameSpacedData: NameSpacedData, staticAuthData: StaticAuthDataParser.StaticAuthData) |

## Properties

| Name | Summary |
|---|---|
| [nameSpacedData](name-spaced-data.md) | [androidJvm]<br>val [nameSpacedData](name-spaced-data.md): NameSpacedData<br>The structured data containing namespace-organized credential attributes |
| [staticAuthData](static-auth-data.md) | [androidJvm]<br>val [staticAuthData](static-auth-data.md): StaticAuthDataParser.StaticAuthData<br>Authentication data provided by the issuer for verification purposes |
| [nameSpacedData](name-spaced-data.md) | [release]<br>val [nameSpacedData](name-spaced-data.md): NameSpacedData<br>The structured data containing namespace-organized credential attributes |
| [staticAuthData](static-auth-data.md) | [release]<br>val [staticAuthData](static-auth-data.md): StaticAuthDataParser.StaticAuthData<br>Authentication data provided by the issuer for verification purposes |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# nameSpacedData

[androidJvm]\
val [nameSpacedData](name-spaced-data.md): NameSpacedData
[release]\
val [nameSpacedData](name-spaced-data.md): NameSpacedData
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# staticAuthData

[androidJvm]\
val [staticAuthData](static-auth-data.md): StaticAuthDataParser.StaticAuthData
[release]\
val [staticAuthData](static-auth-data.md): StaticAuthDataParser.StaticAuthData
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# SdJwtVc

[androidJvm]\
constructor(issuedSdJwt: SdJwt&lt;&lt;Error class: unknown class&gt;&gt;)
[release]\
constructor(issuedSdJwt: SdJwt&lt;JwtAndClaims&gt;)
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

# SdJwtVc

[androidJvm]\
data class [SdJwtVc](index.md)(val issuedSdJwt: SdJwt&lt;&lt;Error class: unknown class&gt;&gt;) : [CredentialIssuedData](../index.md)
[release]\
data class [SdJwtVc](index.md)(val issuedSdJwt: SdJwt&lt;JwtAndClaims&gt;) : [CredentialIssuedData](../index.md)

Represents a Selective Disclosure JWT Verifiable Credential format.

## Constructors

| | |
|---|---|
| [SdJwtVc](-sd-jwt-vc.md) | [androidJvm]<br>constructor(issuedSdJwt: SdJwt&lt;&lt;Error class: unknown class&gt;&gt;) |
| [SdJwtVc](-sd-jwt-vc.md) | [release]<br>constructor(issuedSdJwt: SdJwt&lt;JwtAndClaims&gt;) |

## Properties

| Name | Summary |
|---|---|
| [issuedSdJwt](issued-sd-jwt.md) | [androidJvm]<br>val [issuedSdJwt](issued-sd-jwt.md): SdJwt&lt;&lt;Error class: unknown class&gt;&gt;<br>The SD-JWT with claims as issued by the credential provider |
| [issuedSdJwt](issued-sd-jwt.md) | [release]<br>val [issuedSdJwt](issued-sd-jwt.md): SdJwt&lt;JwtAndClaims&gt;<br>The SD-JWT with claims as issued by the credential provider |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# issuedSdJwt

[androidJvm]\
val [issuedSdJwt](issued-sd-jwt.md): SdJwt&lt;&lt;Error class: unknown class&gt;&gt;
[release]\
val [issuedSdJwt](issued-sd-jwt.md): SdJwt&lt;JwtAndClaims&gt;
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ Sealed interface representing different types of credential data provided by iss

| Name | Summary |
|---|---|
| [MsoMdoc](-mso-mdoc/index.md) | [androidJvm]<br>data class [MsoMdoc](-mso-mdoc/index.md)(val nameSpacedData: NameSpacedData, val staticAuthData: StaticAuthDataParser.StaticAuthData) : [CredentialIssuedData](index.md)<br>Represents Mobile Security Object (MSO) data for Mobile Driving License (mDL) credential format. |
| [SdJwtVc](-sd-jwt-vc/index.md) | [androidJvm]<br>data class [SdJwtVc](-sd-jwt-vc/index.md)(val issuedSdJwt: SdJwt&lt;&lt;Error class: unknown class&gt;&gt;) : [CredentialIssuedData](index.md)<br>Represents a Selective Disclosure JWT Verifiable Credential format. |
| [MsoMdoc](-mso-mdoc/index.md) | [release]<br>data class [MsoMdoc](-mso-mdoc/index.md)(val nameSpacedData: NameSpacedData, val staticAuthData: StaticAuthDataParser.StaticAuthData) : [CredentialIssuedData](index.md)<br>Represents Mobile Security Object (MSO) data for Mobile Driving License (mDL) credential format. |
| [SdJwtVc](-sd-jwt-vc/index.md) | [release]<br>data class [SdJwtVc](-sd-jwt-vc/index.md)(val issuedSdJwt: SdJwt&lt;JwtAndClaims&gt;) : [CredentialIssuedData](index.md)<br>Represents a Selective Disclosure JWT Verifiable Credential format. |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# IssuerProvidedCredential

[androidJvm]\
constructor(publicKeyAlias: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html), data: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html))
[release]\
constructor(publicKeyAlias: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), data: [ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html))
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# data

[androidJvm]\
val [data](data.md): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)
[release]\
val [data](data.md): [ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

# IssuerProvidedCredential

[androidJvm]\
data class [IssuerProvidedCredential](index.md)(val publicKeyAlias: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html), val data: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html))
[release]\
data class [IssuerProvidedCredential](index.md)(val publicKeyAlias: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val data: [ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html))

## Constructors

| | |
|---|---|
| [IssuerProvidedCredential](-issuer-provided-credential.md) | [androidJvm]<br>constructor(publicKeyAlias: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html), data: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html)) |
| [IssuerProvidedCredential](-issuer-provided-credential.md) | [release]<br>constructor(publicKeyAlias: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), data: [ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html)) |

## Properties

| Name | Summary |
|---|---|
| [data](data.md) | [androidJvm]<br>val [data](data.md): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-byte-array/index.html) |
| [publicKeyAlias](public-key-alias.md) | [androidJvm]<br>val [publicKeyAlias](public-key-alias.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html) |
| [data](data.md) | [release]<br>val [data](data.md): [ByteArray](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html) |
| [publicKeyAlias](public-key-alias.md) | [release]<br>val [publicKeyAlias](public-key-alias.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# publicKeyAlias

[androidJvm]\
val [publicKeyAlias](public-key-alias.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)
[release]\
val [publicKeyAlias](public-key-alias.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# MdocCredentialFactory

[androidJvm]\
constructor(domain: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html))
[release]\
constructor(domain: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html))
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# createCredentials

[androidJvm]\
open suspend override fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;MdocCredential&gt;, [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)?&gt;
[release]\
open suspend override fun [createCredentials](create-credentials.md)(format: [DocumentFormat](../../eu.europa.ec.eudi.wallet.document.format/-document-format/index.md), document: Document, createDocumentSettings: [CreateDocumentSettings](../../eu.europa.ec.eudi.wallet.document/-create-document-settings/index.md), secureArea: SecureArea): [Pair](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html)&lt;[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)&lt;MdocCredential&gt;, [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?&gt;

Creates mDL credentials for a document based on MSO mDOC format settings.

Expand All @@ -13,7 +13,7 @@ a list of MdocCredential instances bound to the document

#### Parameters

androidJvm
release

| | |
|---|---|
Expand All @@ -26,4 +26,4 @@ androidJvm

| | |
|---|---|
| [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html) | if the provided format is not an instance of MsoMdocFormat |
| [IllegalArgumentException](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html) | if the provided format is not an instance of MsoMdocFormat |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

# domain

[androidJvm]\
val [domain](domain.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html)
[release]\
val [domain](domain.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
Loading
Loading