> For the complete documentation index, see [llms.txt](https://docs.mosip.io/compliance-tool-kit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mosip.io/compliance-tool-kit/how-to-guides/how-to-set-up-ctk/setup-steps-1.4.0.md). # 1.4.0 ## Pre-requisites CTK should be deployed along with the required dockers as mentioned below. * compliance-toolkit-service: 1.4.0 * compliance-toolkit-ui: 1.4.0 * compliance-toolkit-batch-job: 1.4.0 To successfully deploy Compliance Toolkit, below mentioned services are mandatorily required. ## Dependent Service (dockers) * Artifactory: mosipid/artifactory-ref-impl: 1.2.0.1-B2 * Audit manager: mosipid/kernel-auditmanager-service: 1.2.0.1-B1 * Auth Manager: mosipid/kernel-authmanager: 1.2.0.1-B1 * Key Manager: modipid/kernel-keymanager-service: 1.2.0.1-B1 * Partner Management: mosipid/partner-management-service: 1.2.0.1-B1 * KeyCloak: mosipid/keycloak-init: 1.2.0.1-B1 * Postgres: mosipid/postgres-init: 1.2.0.1-B1 * Config Server: config-server: mosipid/config-server: 1.1.2 * Notification Service: mosipid/kernel-notification-service: 1.2.0.1-B1 * ClamAV: clamav/clamav: latest * MinIO **The Setup guide serves as a checklist for the following three categories.** 1. Configuration checks 2. Steps to load testdata, schemas, testcases and terms and conditions templates 3. Steps to generate Android APK ### Configuration checks 1. Make sure that the `kernel-default.properties` file includes the `mosip-toolkit-client` and `mosip-toolkit-android-client` values in the `auth.server.admin.allowed.audience` setting. If these values are not set by default, configure them and then restart the `kernel-auth-service` and `compliance-toolkit-service`. 2. Ensure that in `compliance-toolkit-default.properties`, CORS is enabled to allow access to `mosip-toolkit-android-client`: ``` mosip.security.cors-enable=true mosip.security.origins=http://localhost auth.server.admin.allowed.audience=mosip-toolkit-client,mosip-toolkit-android-client ``` If this was not set by default, then set it and restart `compliance-toolkit-service`. 3. Check if the roles given to `mosip-pms-client` match with any of the roles for the following config property: `mosip.role.keymanager.postverifycertificatetrust=XXX` This config property is available [here](https://github.com/mosip/mosip-config/blob/$%7BENV_NAME%7D/kernel-default.properties). *For Example*: mosip.role.keymanager.postverifycertificatetrust=`ZONAL_ADMIN`, `GLOBAL_ADMIN`, `PMS_ADMIN`, `PMS_USER` Ensure that the `mosip-pms-client` possesses any of the roles mentioned above. 4. Check that `mosip-pms-client` has the role `REGISTRATION_PROCESSOR`, `PARTNER_ADMIN`, `PMS_ADMIN` in Key Cloak. If this was not set by default, then set it and restart `keymanager` and `compliance-toolkit-service`. 5. It is also needed to generate an encryption key for CTK. * Insert the following row to create a new app ID. `INSERT INTO keymgr.key_policy_def(app_id, key_validity_duration, is_active,pre_expire_days, access_allowed, cr_by, cr_dtimes, upd_by, upd_dtimes, is_deleted, del_dtimes) VALUES ('COMPLIANCE_TOOLKIT', 1095, true, 60, 'NA', 'mosipadmin', '2022-11-28 09:00:40.822625', null, null, false, null);` * Using the auth manager swagger URL, obtain the client token. Swagger URL: ``` `https://api-internal.${env}.mosip.net/v1/authmanager/swagger-ui/index.html?configUrl=/v1/authmanager/v3/api-docs/swagger-config` ``` Endpoint: ``` `/authenticate/clientidsecretkey` ``` Request: ``` { "id": "string", "version": "string", "requesttime": "2022-12-22T07:13:35.010Z", "metadata": {}, "request": { "clientId": " mosip-pms-client ", "secretKey": " XXXXXX ", "appId": " partner " } } ``` * Now using the key manager swagger URL, generate module level certificate. Swagger URL: ``` `https://api-internal.${env}.mosip.net/v1/keymanager/swagger-ui/index.html?configUrl=/v1/keymanager/v3/api-docs/swagger-config` ``` Endpoint: ``` `/generateMasterKey/Certificate` ``` Request: ![](/files/TddYpGVhhFz4MlULT759) * Directly download the certificate through key manager swagger URL and `getCertificate` endpoint, with App Id as `COMPLIANCE_TOOLKIT` and Ref Id as `COMP-FIR`. ![](/files/9ulg7FXXHbpbCuvPMt4t) * This certificate serves as the encryption key specifically for **SBI** devices. For Mock **MDS**, when running in **Auth** mode: update the below values in the `application.properties` file. ``` mosip.auth.appid=regproc mosip.auth.clientid=mosip-pms-client mosip.auth.secretkey=XXXXXXXXXXXXXXXX mosip.auth.server.url=https://api-internal.${env}.mosip.net/v1/authmanager/authenticate/clientidsecretkey mosip.ida.server.url=https://api-internal.${env}.mosip.net/v1/keymanager/getCertificate?applicationId=COMPLIANCE_TOOLKIT&referenceId=COMP-FIR ``` For real MDS/SBI, the vendors can download the new encryption key from the UI and test with the updated **SBI** which uses this encryption key. It can be downloaded for **Auth SBI** projects from UI. ![](/files/Nk2QKNSe1rGncColx98v) 6. Ensure that `reporting` module is deployed from the `develop` branch. This is required for the **Kibana Dashboard**. 7. Ensure that the `kernel-auth-adapter-1.2.0.1` has been successfully deployed in the `compliance-toolkit-service`, and verify that the identical authentication adapter was utilized to configure the mock ABIS. 8. Check datashare configurations for **ABIS3030** and **ABIS3031** testcases. * Ensure that in `data-share-default.properties` and `compliance-toolkit-default.properties`, the value of `mosip-abis-client` is set in `auth.server.admin.allowed.audience`. If this was not set by default, then set it and restart `data-share-service` and `compliance-toolkit-service`. * For handle CTK datashare token flow, add the below values in `data-share-default.properties`. ``` auth.handle.ctk.flow=true mosip.api.internal.toolkit.url=https://${mosip.api.internal.host}/v1/toolkit mosip.compliance.toolkit.saveDataShareToken.url=${mosip.api.internal.toolkit.url}/saveDataShareToken mosip.compliance.toolkit.invalidateDataShareToken.url=${mosip.api.internal.toolkit.url}/invalidateDataShareToken mosip.compliance.toolkit.invalidateDataShareToken.testCaseId=ABIS3031 ``` ### Steps to load testdata, schemas in MINIO 1\. Browse [mosip-compliance-toolkit](https://github.com/mosip-compliance-toolkit.git) 2\. Project structure will be displayed as mentioned below. ![](/files/h6KvA4oHlGBKnhu5EAz3) 3\. The resources folder has schemas and test data that need to be added to MinIO. ![](/files/fBEl7Ih63ziixbxRSnxk) #### Steps to load testdata and schemas directly in MinIO 1\. Log in to MinIO from the browser. 2\. Create a `compliance-toolkit` bucket. 3\. Create a new folder named `testdata` in the above bucket.Upload MOSIP\_DEFAULT\_XXX.zip files from resources to it. 4\. Create a new folder named `schemas` in the above bucket. Upload all **SBI**, **SDK** and **ABIS** schemas along with subfolders in it. 5\. Upload `testcase_schema.json` from resources folder to `schemas` folder. 6\. Please restart the compliance pods after adding new files in minio to refresh the cache. **Alternately, swagger endpoint can also be used to upload data in Minio. In this case there is no need to restart CTK services.** #### Steps to upload resources to Minio using Swagger 1\. The swagger url is: `https://{api-internal-env-url}/v1/toolkit/swagger-ui/index.html?configUrl=/v1/toolkit/v3/api-docs/swagger-config` 2\. Using keycloak/ register option in CTK UI, create a new user for compliance toolkit. 3\. Make sure to add the email ID. Also, give the role `CTK_ADMIN`. 4\. Login to compliance toolkit in your environment from browser with the above Keycloak user. 5\. Go to `ResourceManagementController` in swagger and upload the schema alongwith testdata files. 6\. Then, select any one of type mentioned above and also mention the version (SBI/SDK/ABIS Version). 7\. Select the type of required file which you want to upload from `resources` folder in project. ![](/files/fCRFNcWhjdKRlw6iMII7) 8\. After execution you can see the response. 9\. Check inside the Minio, in dev environment, whether the files have been uploaded into it. ![](/files/R5ZtJeTkUVjKUWwmDkX8) #### Steps to upload test cases to the Database 1\. Open [swagger](https://{api-internal-env-url}/v1/toolkit/swagger-ui/index.html?configUrl=/v1/toolkit/v3/api-docs/swagger-config) and go to `saveTestCases` endpoint in `test-cases-controller`. 2\. Currently, CTK has a separate repository called `compliance-toolkit-testcases`, which includes the testcases for the **SBI**, **SDK** and **ABIS**. ![](/files/ReYFlymWQqzA6LAhAftC) 3\. Open [compliance-toolkit-testcases](https://github.com/mosip/compliance-toolkit-testcases/tree/release-1.4.0) repo. 4\. `compliance_test_definitions_sbi.json` file have all the test cases in it. 5\. Copy test cases array from this file and prepare a request as shown below. 6\. Request body for `saveTestCases` request. ``` { "id": "mosip.toolkit.projects.retrieve", "version": "1.0", "requesttime": "2022-10-29T06:06:51.174Z", "metadata": null, "request": { "testCases": [ ] } } ``` 7\. Then, execute it. ![](/files/a68NEXKu9SWrRCHWb5WQ) 8\. The same should be done for `compliance_test_definitions_sdk.json` and `compliance_test_definitions_abis.json`. #### Steps to upload terms and conditions velocity templates to the Database 1. Open [swagger](https://{api-internal-env-url}/v1/toolkit/swagger-ui/index.html?configUrl=/v1/toolkit/v3/api-docs/swagger-config) and go to `uploadTemplate` endpoint in `resource-management-controller`. 2. Provide the required parameters: * Specify the language for the template using ISO 639 standard language codes. * Enter the version of the template. (the template version should be in format as v1,v2,v3 and so on) * Enter the template name as **terms\_and\_conditions\_template**. 3. The template file extension should be`.vm`(Velocity Template Language). 4. Then , execute it ![](/files/URZIeQua4qXnvmv3uojo) ### Steps to generate Android APK * Once all the steps mentioned above are completed, you can trigger the Android APK build for your environment. * You may need GitHub repository write access. * Add values for the URL’s according to your deployment env. ![](/files/iyDh05VISUK1nUmmyRfX)