From 8ecde28cf8c06da1fd071183be47b068f84654a3 Mon Sep 17 00:00:00 2001 From: Mohd Kaif Siddique Date: Wed, 20 Mar 2024 14:28:19 +0530 Subject: [PATCH 1/5] modified the readme file to add sunbird configuration details for esignet Signed-off-by: Mohd Kaif Siddique --- sunbird-rc-esignet-integration-impl/README.md | 35 ++++++++----------- 1 file changed, 15 insertions(+), 20 deletions(-) diff --git a/sunbird-rc-esignet-integration-impl/README.md b/sunbird-rc-esignet-integration-impl/README.md index c070cea..c6be0dd 100644 --- a/sunbird-rc-esignet-integration-impl/README.md +++ b/sunbird-rc-esignet-integration-impl/README.md @@ -1,7 +1,7 @@ # sunbird-rc-esignet-integration-impl ## About -Implementation for all the interfaces defined in esignet-integration-api. This libaray is built as a wrapper for [sunbird-registry-system](sunbird-registry-url) service. +Implementation for all the interfaces defined in esignet-integration-api. This libaray is built as a wrapper for [sunbird-registry-system](https://github.com/Sunbird-RC) service. This library should be added as a runtime dependency to [esignet-service](https://github.com/mosip/esignet) @@ -15,32 +15,27 @@ mosip.esignet.integration.key-binder=MockKeyBindingWrapperService mosip.esignet.integration.audit-plugin=LoggerAuditService mosip.esignet.integration.captcha-validator=GoogleRecaptchaValidatorService +## -------------------------------------------- IDP-UI config -----------------------------------------------------------------## +mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}} +mosip.esignet.authenticator.default.auth-factor.kba.individual-id-field=policyNumber -mosip.esignet.captcha-validator.url=https://www.google.com/recaptcha/api/siteverify -mosip.esignet.captcha-validator.secret=${esignet.captcha.secret.key} -mosip.esignet.captcha-validator.site-key=${esignet.captcha.site.key} -##--------------------sunbird registry authentication related demo configuration-------------------------## +##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## -mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field='policyNumber' -mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.field-details={{"id":"policyNumber", "type":"text", "format":""},{"id":"name", "type":"text", "format":""},{"id":"dob", "type":"date", "format":"dd/mm/yyyy"}} +mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber +mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.field-details={{"id":"policyNumber", "type":"text", "format":""},{"id":"fullName", "type":"text", "format":""},{"id":"dob", "type":"date", "format":"dd/mm/yyyy"}} mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search mosip.esignet.authenticator.sunbird-rc.kba.entity-id-field=osid -##-----------------------------VCI related demo configuration---------------------------------------------## - -mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=http://164.52.205.87/credentials/issue -mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential,HealthCardCredential -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.static-value-map.issuerId=did:web:esignet-mock.dev.mosip.net -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.template-url=requestTemplete.json -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url=http://10.3.148.107/api/v1/Insurance/ -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-id=did:schema:1e4d93df-4047-4dd7-8515-9ad46796009f +mosip.esignet.vciplugin.sunbird-rc.enable-psut-based-registry-search=false +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search +mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=http://10.3.148.107/credential/credentials/issue +mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322 +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url=http://10.3.148.107/registry/api/v1/Insurance/ +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-version=1.0.0 -mosip.esignet.vciplugin.sunbird-rc.credential-type.HealthCardCredential.static-value-map.issuerId=did:web:esignet-mock.dev.mosip.net -mosip.esignet.vciplugin.sunbird-rc.credential-type.HealthCardCredential.template-url=requestTemplete.json -mosip.esignet.vciplugin.sunbird-rc.credential-type.HealthCardCredential.registry-get-url=http://10.3.148.107/api/v1/Insurance/ -mosip.esignet.vciplugin.sunbird-rc.credential-type.HealthCardCredential.cred-schema-id=did:schema:1e4d93df-4047-4dd7-8515-9ad46796009f -mosip.esignet.vciplugin.sunbird-rc.credential-type.HealthCardCredential.cred-schema-version=1.0.0 ```` From 2a81f34177f4e1623fd527b858dd3a2309a4e43a Mon Sep 17 00:00:00 2001 From: Mohd Kaif Siddique Date: Wed, 20 Mar 2024 17:38:33 +0530 Subject: [PATCH 2/5] review changes Signed-off-by: Mohd Kaif Siddique --- sunbird-rc-esignet-integration-impl/README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/sunbird-rc-esignet-integration-impl/README.md b/sunbird-rc-esignet-integration-impl/README.md index c6be0dd..78d2e3f 100644 --- a/sunbird-rc-esignet-integration-impl/README.md +++ b/sunbird-rc-esignet-integration-impl/README.md @@ -1,7 +1,7 @@ # sunbird-rc-esignet-integration-impl ## About -Implementation for all the interfaces defined in esignet-integration-api. This libaray is built as a wrapper for [sunbird-registry-system](https://github.com/Sunbird-RC) service. +Implementation for Authenticator, VCIssuancePlugin interfaces defined in esignet-integration-api. This libaray is built as a wrapper for [sunbird-registry-system](https://github.com/Sunbird-RC) service. This library should be added as a runtime dependency to [esignet-service](https://github.com/mosip/esignet) @@ -15,13 +15,11 @@ mosip.esignet.integration.key-binder=MockKeyBindingWrapperService mosip.esignet.integration.audit-plugin=LoggerAuditService mosip.esignet.integration.captcha-validator=GoogleRecaptchaValidatorService -## -------------------------------------------- IDP-UI config -----------------------------------------------------------------## +##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## +mosip.esinet.sunbird-rc.base-url=http://localhost mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}} mosip.esignet.authenticator.default.auth-factor.kba.individual-id-field=policyNumber - -##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## - mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.field-details={{"id":"policyNumber", "type":"text", "format":""},{"id":"fullName", "type":"text", "format":""},{"id":"dob", "type":"date", "format":"dd/mm/yyyy"}} mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search @@ -29,11 +27,11 @@ mosip.esignet.authenticator.sunbird-rc.kba.entity-id-field=osid mosip.esignet.vciplugin.sunbird-rc.enable-psut-based-registry-search=false mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search -mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=http://10.3.148.107/credential/credentials/issue +mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=${mosip.esinet.sunbird-rc.base-url}/credential/credentials/issue mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url=http://10.3.148.107/registry/api/v1/Insurance/ +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url={mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/ mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-version=1.0.0 ```` From 6eac03c7eda13d69437d5a96477bb3e18ff25331 Mon Sep 17 00:00:00 2001 From: Mohd Kaif Siddique Date: Tue, 26 Mar 2024 21:38:47 +0530 Subject: [PATCH 3/5] added config of vci wellknown into sunbird-rc-esignet-integration-impl into readme.md file Signed-off-by: Mohd Kaif Siddique --- sunbird-rc-esignet-integration-impl/README.md | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/sunbird-rc-esignet-integration-impl/README.md b/sunbird-rc-esignet-integration-impl/README.md index 78d2e3f..abcc352 100644 --- a/sunbird-rc-esignet-integration-impl/README.md +++ b/sunbird-rc-esignet-integration-impl/README.md @@ -15,6 +15,40 @@ mosip.esignet.integration.key-binder=MockKeyBindingWrapperService mosip.esignet.integration.audit-plugin=LoggerAuditService mosip.esignet.integration.captcha-validator=GoogleRecaptchaValidatorService +mosip.esignet.vci.key-values={ 'credential_issuer': '${mosip.esignet.vci.identifier}', \ + 'credential_endpoint': '${mosipbox.public.url}${server.servlet.path}/vci/credential', \ + 'credentials_supported': {{\ + 'format': 'ldp_vc',\ + 'id': 'InsuranceCredential', \ + 'scope' : 'sunbird_rc_insurance_vc_ldp',\ + 'cryptographic_binding_methods_supported': {'did:jwk'},\ + 'cryptographic_suites_supported': {'Ed25519Signature2020'},\ + 'proof_types_supported': {'jwt'},\ + 'credential_definition': {\ + 'type': {'VerifiableCredential'},\ + 'credentialSubject': {\ + 'fullName': {'display': {{'name': 'Name','locale': 'en'}}}, \ + 'mobile': {'display': {{'name': 'Phone Number','locale': 'en'}}},\ + 'dob': {'display': {{'name': 'Date of Birth','locale': 'en'}}},\ + 'gender': {'display': {{'name': 'Gender','locale': 'en'}}},\ + 'benefits': {'display': {{'name': 'Benefits','locale': 'en'}}},\ + 'email': {'display': {{'name': 'Email Id','locale': 'en'}}},\ + 'policyIssuedOn': {'display': {{'name': 'Policy Issued On','locale': 'en'}}},\ + 'policyExpiresOn': {'display': {{'name': 'Policy Expires On','locale': 'en'}}},\ + 'policyName': {'display': {{'name': 'Policy Name','locale': 'en'}}},\ + 'policyNumber': {'display': {{'name': 'Policy Number','locale': 'en'}}}\ + }},\ + 'display': {{'name': 'Sunbird RC Insurance Verifiable Credential', \ + 'locale': 'en', \ + 'logo': {'url': 'https://sunbird.org/images/sunbird-logo-new.png',\ + 'alt_text': 'a square logo of a Sunbird'},\ + 'background_color': '#FDFAF9',\ + 'text_color': '#7C4616'}},\ + 'order' : {'fullName','policyName','policyExpiresOn','policyIssuedOn','policyNumber','mobile','dob','gender','benefits','email'}\ + \ }},\ + 'display': {{'name': 'Insurance', 'locale': 'en'}}\ + } + ##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## mosip.esinet.sunbird-rc.base-url=http://localhost mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}} From 10d5ef2ed8a03b2a9a19dbbf6a1c67299861fc90 Mon Sep 17 00:00:00 2001 From: Kaif Siddique <74772315+kaifk468@users.noreply.github.com> Date: Thu, 28 Mar 2024 11:53:51 +0530 Subject: [PATCH 4/5] Update README.md Signed-off-by: Kaif Siddique <74772315+kaifk468@users.noreply.github.com> --- sunbird-rc-esignet-integration-impl/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sunbird-rc-esignet-integration-impl/README.md b/sunbird-rc-esignet-integration-impl/README.md index abcc352..bec4d2a 100644 --- a/sunbird-rc-esignet-integration-impl/README.md +++ b/sunbird-rc-esignet-integration-impl/README.md @@ -50,6 +50,7 @@ mosip.esignet.vci.key-values={ 'credential_issuer': '${mosip.esignet.vci.identif } ##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## + mosip.esinet.sunbird-rc.base-url=http://localhost mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}} mosip.esignet.authenticator.default.auth-factor.kba.individual-id-field=policyNumber From 61faffc8de69e6277038e2d64f4eaa34a19d4080 Mon Sep 17 00:00:00 2001 From: Mohd Kaif Siddique Date: Fri, 29 Mar 2024 12:04:19 +0530 Subject: [PATCH 5/5] added comments on readme file Signed-off-by: Mohd Kaif Siddique --- sunbird-rc-esignet-integration-impl/README.md | 37 +++++++++++++++++-- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/sunbird-rc-esignet-integration-impl/README.md b/sunbird-rc-esignet-integration-impl/README.md index bec4d2a..df62d09 100644 --- a/sunbird-rc-esignet-integration-impl/README.md +++ b/sunbird-rc-esignet-integration-impl/README.md @@ -51,24 +51,53 @@ mosip.esignet.vci.key-values={ 'credential_issuer': '${mosip.esignet.vci.identif ##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------## +# Base url of registry system mosip.esinet.sunbird-rc.base-url=http://localhost + +# These two are the default fields required to generate the dynamic authentication form mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}} mosip.esignet.authenticator.default.auth-factor.kba.individual-id-field=policyNumber -mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber +# Mandatory fields required for KBA are described here mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.field-details={{"id":"policyNumber", "type":"text", "format":""},{"id":"fullName", "type":"text", "format":""},{"id":"dob", "type":"date", "format":"dd/mm/yyyy"}} -mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search +# Amoung mandatory fields, which field is Indentity field is described here +mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber + +# This is the field which is used to get the entity id from the registry object mosip.esignet.authenticator.sunbird-rc.kba.entity-id-field=osid +# This is the field is used to enable the registry search based on the PSUT mosip.esignet.vciplugin.sunbird-rc.enable-psut-based-registry-search=false -mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search + +# Url for the verifiable credential issuance mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=${mosip.esinet.sunbird-rc.base-url}/credential/credentials/issue -mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential +# Specifies the types of verifiable credentials supported by the system. +# Based on the supported credentiels type the subsequent properties are defined +mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential,ExampleVerifiableCredential + +# Properties for the Insurance Credential + +# Url for object based registry search +mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=${mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/search +# Here we define the verifiable credential issuer DID mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322 +# Here we provide the template url for the credential mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json +# Url to get registry object based on the entity id mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url={mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/ +# Here we define the schema id for the verfiable credential mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba +# Here we define the schema version for the verfiable credential mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-version=1.0.0 + +# Properies for the Mosip Verifiable Credential + +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.registry-search-url=${mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/search +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322 +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.registry-get-url={mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/# Here we define the schema id for the verfiable credential +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba# Here we define the schema version for the verfiable credential +mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.cred-schema-version=1.0.0 ````