Merge pull request mosip#41 from ase-101/develop

ES-842 updated readme and config comments

mock-plugin/README.md

@@ -1,33 +1,15 @@
-# mock-esignet-integration-impl
+# Mock plugin
 
 ## About
 
-Implementation for all the interfaces defined in esignet-integration-api. This libaray is built as a wrapper for [mock-identity-system](mock-identity-system) service.
+Implementation for all the interfaces defined in esignet-integration-api.
 
 This library should be added as a runtime dependency to [esignet-service](https://github.com/mosip/esignet) for development purpose only.
 Note: This is not production use implementation.
 
-## Configurations required to added in esignet-default.properties
-
-````
-mosip.esignet.integration.scan-base-package=io.mosip.esignet.mock.integration
-mosip.esignet.integration.authenticator=MockAuthenticationService
-mosip.esignet.integration.key-binder=MockKeyBindingWrapperService
-mosip.esignet.integration.audit-plugin=LoggerAuditService
-mosip.esignet.integration.captcha-validator=GoogleRecaptchaValidatorService
-
-mosip.esignet.send-otp.captcha-required=true
-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}
-
-mosip.esignet.mock.authenticator.get-identity-url=https://${mosip.api.public.host}/v1/mock-identity-system/identity
-mosip.esignet.mock.authenticator.kyc-auth-url=https://${mosip.api.public.host}/v1/mock-identity-system/kyc-auth
-mosip.esignet.mock.authenticator.kyc-exchange-url=https://${mosip.api.public.host}/v1/mock-identity-system/kyc-exchange
-mosip.esignet.mock.authenticator.send-otp=https://${mosip.api.public.host}/v1/mock-identity-system/send-otp
-mosip.esignet.mock.supported.bind-auth-factor-types={'WLA'}
-mosip.esignet.mock.authenticator.ida.otp-channels=email,phone
-````
+## Configurations
+
+Refer [application.properties](src/main/resources/application.properties) for all the configurations required to use this plugin implementation.
 
 Add "bindingtransaction" cache name in "mosip.esignet.cache.names" property.
 

mock-plugin/src/main/resources/application.properties

@@ -1,9 +1,9 @@
-## Mock plugin configuration
-#Comma separated list of third party packages to scan
+## eSignet mock plugin configuration
 mosip.esignet.integration.scan-base-package=io.mosip.esignet.plugin.mock
 mosip.esignet.integration.authenticator=MockAuthenticationService
 mosip.esignet.integration.key-binder=MockKeyBindingWrapperService
 
+## Configuration required for Authenticator interface implementation
 mosip.esignet.mock.domain.url=http://mock-identity-system.mockid
 mosip.esignet.mock.authenticator.kyc-exchange-url=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/kyc-exchange
 mosip.esignet.mock.authenticator.kyc-exchange-v2-url=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/v2/kyc-exchange
@@ -13,11 +13,14 @@ mosip.esignet.mock.authenticator.ida.otp-channels=email,phone
 mosip.esignet.mock.supported.bind-auth-factor-types={'WLA'}
 
 
-## Signup plugin configuration
+## Signup mock plugin configuration
 mosip.signup.integration.impl.basepackage=io.mosip.signup.plugin.mock
 mosip.signup.integration.profile-registry-plugin=MockProfileRegistryPluginImpl
 
+## Name of the json file which defines the identity verification process. Refer `mock-idv-user-story.json` for the structure.
 mosip.signup.mock.identity-verification.story-name=mock-idv-user-story.json
+
+## File defined in the property `mosip.signup.mock.identity-verification.story-name` is loaded with below defined URL
 mosip.signup.mock.config-server-url=classpath:
 
 mosip.signup.mock.mandatory-attributes.CREATE=fullName,phone,password,preferredLang
@@ -27,4 +30,9 @@ mosip.signup.mock.username.field=phone
 
 mosip.signup.mock.identity.endpoint=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/identity
 mosip.signup.mock.get-identity.endpoint=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/identity/
-mosip.signup.mock.add-verified-claims.endpoint=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/identity/add-verified-claim
+mosip.signup.mock.add-verified-claims.endpoint=${mosip.esignet.mock.domain.url}/v1/mock-identity-system/identity/add-verified-claim
+
+## Disable authz & authn with mock-plugin
+mosip.esignet.security.auth.post-urls={}
+mosip.esignet.security.auth.put-urls={}
+mosip.esignet.security.auth.get-urls={}