ES-753 (mosip#67)

Signed-off-by: ase-101 <[email protected]>
mengleang-0090 · Feb 12, 2024 · 721e3ef · 721e3ef
1 parent 3fbfc38
commit 721e3ef
Show file tree

Hide file tree

Showing 3 changed files with 249 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,61 @@
 
 signup-service is part of the esignet modules, but has a separate Helm chart so as to install and manage it in a completely independent namespace.
 
+Below diagram depicts the high level deployment architecture for signup service with MOSIP ID-repo.
+
+![](docs/signup-with-mosip-id-repo.png)
+
+### Configurations
+Signup service and signup UI currently supports default [ID schema](docs/id-schema.json) only.
+
+**Note:**
+Work is in progress to support any ID schema and also to connect with any registry services.
+
+With respect to the default ID schema, below MOSIP configurations are required to be updated.
+
+#### admin-default.properties
+``
+mosip.admin.masterdata.lang-code=eng,khm
+``
+
+#### application-default.properties
+```
+mosip.mandatory-languages=eng,khm
+
+mosip.optional-languages=
+
+mosip.default.template-languages=eng,khm
+```
+
+#### id-authentication-default.properties
+```
+request.idtypes.allowed=UIN,HANDLE
+
+request.idtypes.allowed.internalauth=UIN
+
+ida.mosip.external.auth.filter.classes.in.execution.order=io.mosip.authentication.hotlistfilter.impl.PartnerIdHotlistFilterImpl,io.mosip.authentication.hotlistfilter.impl.IndividualIdHotlistFilterImpl,io.mosip.authentication.hotlistfilter.impl.DeviceProviderHotlistFilterImpl,io.mosip.authentication.hotlistfilter.impl.DeviceHotlistFilterImpl,io.mosip.authentication.authtypelockfilter.impl.AuthTypeLockFilterImpl
+
+mosip.ida.handle-types.regex={ '@phone' : '^\\+91[1-9][0-9]{7,9}@phone$' }
+```
+
+####  id-repository-default.properties
+```
+mosip.idrepo.credential.request.enable-convention-based-id=true
+
+mosip.idrepo.identity.disable-uin-based-credential-request=true
+
+mosip.idrepo.vid.disable-support=true
+
+mosip.identity.fieldid.handle-postfix.mapping={'phone':'@phone'}
+```
+
+#### kernel-default.properties
+``
+mosip.kernel.sms.country.code=+91
+``
+
+
+
 ## Installing in k8s cluster using helm
 ### Pre-requisites
 1. Set the kube config file of the Mosip cluster having dependent services is set correctly in PC.
@@ -53,6 +108,7 @@ signup-service is part of the esignet modules, but has a separate Helm chart so
   cd helm
   ./restart-all.sh
   ```
+
 
 ## APIs
 API documentation is available [here](https://mosip.stoplight.io/docs/identity-provider/branches/signupV1/t9tvfbteqqokf-e-signet-signup-portal-ap-is).

diff --git a/docs/id-schema.json b/docs/id-schema.json
@@ -0,0 +1,193 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Identity schema for sign up",
+  "additionalProperties": false,
+  "title": "signup identity",
+  "type": "object",
+  "definitions": {
+    "simpleType": {
+      "uniqueItems": true,
+      "additionalItems": false,
+      "type": "array",
+      "items": {
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "language",
+          "value"
+        ],
+        "properties": {
+          "language": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "documentType": {
+      "additionalProperties": false,
+      "type": "object",
+      "properties": {
+        "format": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      }
+    },
+    "biometricsType": {
+      "additionalProperties": false,
+      "type": "object",
+      "properties": {
+        "format": {
+          "type": "string"
+        },
+        "version": {
+          "type": "number",
+          "minimum": 0
+        },
+        "value": {
+          "type": "string"
+        }
+      }
+    },
+    "hashType": {
+      "additionalProperties": false,
+      "type": "object",
+      "properties": {
+        "hash": {
+          "type": "string"
+        },
+        "salt": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "properties": {
+    "identity": {
+      "additionalProperties": false,
+      "type": "object",
+      "required": [
+        "IDSchemaVersion",
+        "fullName",
+        "phone",
+        "password",
+        "preferredLang",
+        "registrationType"
+      ],
+      "properties": {
+        "UIN": {
+          "bioAttributes": [],
+          "fieldCategory": "none",
+          "format": "none",
+          "type": "string",
+          "fieldType": "default"
+        },
+        "IDSchemaVersion": {
+          "bioAttributes": [],
+          "fieldCategory": "none",
+          "format": "none",
+          "type": "number",
+          "fieldType": "default",
+          "minimum": 0
+        },
+        "selectedHandles" : {
+          "fieldCategory": "none",
+          "format": "none",
+          "type": "array",
+          "items" : { "type" : "string" },
+          "fieldType": "default"
+        },
+        "fullName": {
+          "bioAttributes": [],
+          "validators": [
+            {
+              "validator": "^(?=.{3,50}$).",
+              "arguments": [],
+              "type": "regex"
+            }
+          ],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "$ref": "#/definitions/simpleType"
+        },
+        "phone": {
+          "bioAttributes": [],
+          "validators": [
+            {
+              "validator": "^[+]91([0-9]{8,9})$",
+              "arguments": [],
+              "type": "regex"
+            }
+          ],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "type": "string",
+          "fieldType": "default",
+          "requiredOn" : "",
+          "handle" : true
+        },
+        "password": {
+          "bioAttributes": [],
+          "validators": [],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "$ref": "#/definitions/hashType"
+        },
+        "preferredLang": {
+          "bioAttributes": [],
+          "validators": [
+            {
+              "validator": "(^eng$)",
+              "arguments": [],
+              "type": "regex"
+            }
+          ],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "type": "string"
+        },
+        "registrationType": {
+          "bioAttributes": [],
+          "validators": [
+            {
+              "validator": "^L[1-2]{1}$",
+              "arguments": [],
+              "type": "regex"
+            }
+          ],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "type": "string"
+        },
+        "phoneVerified": {
+          "bioAttributes": [],
+          "validators": [],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "type": "boolean"
+        },
+        "updatedAt": {
+          "bioAttributes": [],
+          "validators": [],
+          "fieldCategory": "pvt",
+          "format": "none",
+          "fieldType": "default",
+          "type": "number"
+        }
+      }
+    }
+  }
+}
diff --git a/docs/signup-with-mosip-id-repo.png b/docs/signup-with-mosip-id-repo.png