Skip to content

Commit

Permalink
ES-372 (mosip#455)
Browse files Browse the repository at this point in the history
Signed-off-by: ase-101 <[email protected]>
  • Loading branch information
ase-101 committed Nov 5, 2023
1 parent d9933c8 commit 75e5af1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ e-Signet repository contains following:
4. client-management-service-impl - Client management implementations classes.
5. oidc-service-impl - Oauth and OIDC implementation classes.
6. binding-service-impl - key and individualId binding service implementation classes.
7. db_scripts - Contains all the db scripts required to setup or upgrade the DB for esignet module.
7. consent-service-impl - Service to manage user consent per client.
8. vci-service-impl - Credential issuance service implementation classes.
9. db_scripts - Contains all the db scripts required to setup or upgrade the DB for esignet module.


## Databases
Expand All @@ -36,7 +38,7 @@ The project requires JDK 11.
1. Add / merge below mentioned properties files into existing config branch:
* [esignet-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/esignet-default.properties)
* [application-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/application-default.properties)
1. Below are the dependent services required for esignet service:
1. Below are the dependent services required for esignet service integrated with MOSIP IDA:
| Chart | Chart version |
|---|---|
|[Keycloak](https://github.com/mosip/mosip-infra/tree/v1.2.0.1-B3/deployment/v3/external/iam) | 7.1.18 |
Expand Down
11 changes: 6 additions & 5 deletions esignet-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@
* OpenIdController - Endpoints specific to OIDC protocol like /userinfo and /.well-known/openid-configuration
* SystemInfoController - Endpoints to get the pet public part of the keys managed in the keystore by keymanager.
* KeyBindingController - Endpoints used by wallets to bind a key to an individual ID to support wallet local authentication.
* VCIController - Wallet initiated /credential endpoint returning just in time credential and /.well-known/openid-credential-issuer endpoint specific to [OpenID4VCI specification Draft 13](https://openid.github.io/OpenID4VCI/openid-4-verifiable-credential-issuance-wg-draft.html)

## e-Signet Plugins
1. We have well-defined plugin interfaces in esignet-intergration-api.
2. Mock plugin implementations and the MOSIP specific plugin implementations are available.
3. Check the below URL for more details:

> https://github.com/mosip/esignet-mock-services/tree/develop/mock-esignet-integration-impl
> https://github.com/mosip/esignet-mock-services/tree/master/mock-esignet-integration-impl
> https://github.com/mosip/id-authentication/tree/develop/authentication/esignet-integration-impl
> https://github.com/mosip/id-authentication/tree/master/authentication/esignet-integration-impl
4. All the required plugins are runtime dependency to esignet-service.

Expand All @@ -39,7 +40,7 @@
4. Build the plugin jar from below repo and add the built plugin jar as runtime dependency in esignet-service

> https://github.com/mosip/esignet-mock-services/tree/develop/mock-esignet-integration-impl
> https://github.com/mosip/esignet-mock-services/tree/master/mock-esignet-integration-impl
5. Build the current esignet repository with the below command:

Expand All @@ -55,7 +56,7 @@
8. Mock plugins connect to mock-identity-system, refer below document to start mock-identity-system in parallel

> https://github.com/mosip/esignet-mock-services/tree/develop/mock-identity-system#local-setup-of-mock-identity-system
> https://github.com/mosip/esignet-mock-services/tree/master/mock-identity-system#local-setup-of-mock-identity-system
9. Also find the latest postman collection under "docs/postman-collections" folder with environment json

Expand Down Expand Up @@ -93,7 +94,7 @@ Linked transactions
| linkStatus | | |
| authenticate | linkedauth (k: linkTransactionId, v: OIDCTransaction) | linked (k: linkTransactionId, v: OIDCTransaction) | |
| saveConsent | consented (k: linkedTransactionId, v: OIDCTransaction) | linkedauth (k: linkTransactionId, v: OIDCTransaction) | topic: consented, v: linkTransactionId |
| linkAuthCode | authcodegenerated (k: codeHash, v: OIDCTransaction) | ||
| linkAuthCode | authcodegenerated (k: codeHash, v: OIDCTransaction) | ||
| token | userinfo (k: accessTokenHash) | authcodegenerated (k: codeHash, v: OIDCTransaction), consented (k: linkedTransactionId, v: OIDCTransaction), linkedcode (k: linkCodeHash, v: LinkTransactionMetadata) | |
| userinfo | | |

Expand Down

0 comments on commit 75e5af1

Please sign in to comment.