Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Injimob - 2367] add details about openid4vp online sharing feature in docs #506

Merged
merged 6 commits into from
Feb 11, 2025

Conversation

PuBHARGAVI
Copy link

No description provided.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…ji mobile technical overview document

Signed-off-by: PuBHARGAVI <46226958+PuBHARGAVI@users.noreply.github.com>
…n integration-guide section

Signed-off-by: PuBHARGAVI <46226958+PuBHARGAVI@users.noreply.github.com>
@PuBHARGAVI PuBHARGAVI marked this pull request as draft January 9, 2025 09:28
Comment on lines 1 to 3
# OpenID4VP - Online Sharing

## OpenID4VP - Online Sharing

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are duplicate headings

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added it to keep it consistent with other library pages and thought of removing it after getting it reviewed by you swati. I will remove it now.

## OpenID4VP - Online Sharing

This library enables consumer applications (mobile wallet) to share users Verifiable Credentials with
Verifiers who request them online. It adheres to the OpenID4VP specification which outlines the standards for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a link to OpenId4VP specification

### APIs

Below are the APIs provided by this library:
**1. authenticateVerifier**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to new line just above 1st point
Uploading Screenshot 2025-01-13 at 11.45.41 AM.png…

| Name | Type | Description | Sample |
|------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| verifiableCredentials | Map<String, List<String>> | A Map which contains input descriptor id as key and corresponding matching Verifiable Credentials list as value. | `mapOf("id_123" to listOf("vc1","vc2"))` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.
Uploading Screenshot 2025-01-13 at 11.45.37 AM.png…

| Name | Type | Description | Sample |
|---------------------|---------------------|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| vpResponseMetadata | VPResponseMetadata | This contains domain & proof details such as jws, signatureAlgorithm, publicKey, domain | `VPResponseMetadata(jws = "eyJiweyrtwegrfwwaBKCGSwxjpa5suaMtgnQ",signatureAlgorithm = "RsaSignature2018",publicKey = "publicKey",domain = "https://domain.net")")` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

| Name | Type | Description | Sample |
|-----------|-----------|------------------------------------|----------------------------------|
| exception | Exception | This contains the exception object | `new Exception("exception message")` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

|-----------------------------|------------|--------------------------------------------------------------------------------------|------------------------------------------------------|
| encodedAuthorizationRequest | String | Base64 encoded string containing the Verifier's authorization request | `"T1BFTklENFZQOi8vYXV0"` |
| trustedVerifierJSON | [Verifier] | A list of trusted Verifier objects each containing a clientId and a responseUri list | `Verifier(clientId: String, responseUris: [String])` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

| Name | Type | Description | Sample |
|----------------|--------------------|-----------------------------------------------------------------------------------------------------------------|--------------------------------|
| credentialsMap | [String: [String]] | A Map which contains input descriptor id as key and corresponding matching Verifiable Credentials list as value | `["bank_input":["VC1","VC2"]]` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

| Name | Type | Description | Sample |
|---------------------|---------------------|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| vpResponseMetadata | VPResponseMetadata | This contains domain & proof details such as jws, signatureAlgorithm, publicKey, domain | `VPResponseMetadata(jws: "jws", signatureAlgorithm: "signatureAlgoType", publicKey: "publicKey", domain: "domain")` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

| Name | Type | Description | Sample |
|-------|-------|------------------------------------|-----------------------------------------------------------------------------------|
| error | Error | This contains the exception object | `AuthorizationConsent.consentRejectedError(message: "User rejected the consent")` |
**Exceptions**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add new line above Exceptions heading. It is becoming part of table.

PuBHARGAVI and others added 2 commits January 15, 2025 15:07
…technical overview section

Signed-off-by: PuBHARGAVI <46226958+PuBHARGAVI@users.noreply.github.com>
Signed-off-by: swatigoel <meet2swati@gmail.com>
Verifiers who request them online. It adheres to the OpenID4VP [specification](https://openid.net/specs/openid-4-verifiable-presentations-1_0-21.html) which outlines the standards for
requesting and presenting Verifiable Credentials.

### Functionalities / steps that are performed by the library from decoding the Request to sending the response to the Verifier:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PuBHARGAVI update the heading
"Library Functionalities: Processing the Request from Decoding to Verifier Response"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

7. Below sections details on the steps for integrating the Kotlin and Swift packages into the app.
Below sections details on the steps for integrating the Kotlin and Swift packages into the app.

## Android: Kotlin package for openid4vp:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PuBHARGAVI Please check the usage of openid4vp word across this PR it should be "OpenID4VP"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Kotlin and Swift libraries the snapshot names are given as openid4vp to keep it consistent with other libraries so it can't be changed and in other places (headings) I have changed it to "OpenID4VP" as suggested.

### **7. Telemetry**
### **6. OpenID4VP - Online Sharing SDK**
This OpenID4VP library enables consumer applications (mobile wallet) to share users Verifiable Credentials with
Verifiers who request them online. It adheres to the OpenID4VP specification which outlines the standards for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PuBHARGAVI Please add the link to the standard for OpenIDVP draft 21 specification

Signed-off-by: PuBHARGAVI <46226958+PuBHARGAVI@users.noreply.github.com>
@PuBHARGAVI PuBHARGAVI marked this pull request as ready for review February 6, 2025 12:26
Signed-off-by: PuBHARGAVI <46226958+PuBHARGAVI@users.noreply.github.com>
@swahsek swahsek merged commit 018372d into mosip:inji Feb 11, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants