> 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/developer-guides/ctk-validators.md). # CTK Validators ### SBI Validators | Name | Description | Test with Mock SBI | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SchemaValidator` | Validates the response for mandatory attributes and correct values. | | | `SignatureValidator` | Validates the response signature. | | | `ResponseMisMatchValidator` | Validates the response to check if bioCount, exceptions, segments and transactionId match the ones set in request. | | | `KeyRotationValidator` | Validator to validate the device key rotation. |

To verify Key Rotation testcases, we have to generate 3 set of device certificates device.p12.
• To generate device.p12 certificate, please follow the instructions given in link
• In Compliance Tool kit, create a collection only with Key Rotation test case and Run Mock MDS.
• In CTK select respective device by performing Scan Device operation and run key rotation testcase.
• Stop the Mock MDS and rotate/change second Device.p12 in Keys folder.
• Relaunch mock MDS and select Continue on CTK. Now CKT saved second device key information.
• When CTK asks to rotate the device key, then Stop the Mock MDS and rotate/change third Device.p12 in Keys folder.
• Relaunch mock MDS and select Continue on CTK. Now CKT saved third device key information.
Note: Rotate the device key in the MDS/SBI as many times as setup in project configuration
CTK will provide a result of the overall key rotation testcase once the testcase has been run.

| | `TimeoutValidator` | Validates if response is received within the given timeout period or not. |

To test Timeout testcases with Mock SBI:
Call POST API:
With request body,
{
"type": "Biometric Device",
"delay": "10000",
"method": \[
"RCAPTURE"]
}
To test Force Capture testcases with Mock SBI:
Call POST API:
With request body,
{
"type": "Biometric Device",
"delay": "9500",
"method": \[
"RCAPTURE"]
}
Please try to increase the delay gradually to execute the testcase successfully.

| | `ISOStandardsValidator` | Validates the `bioValue` in response of `rcapture` is as per ISO standards ISO19794-4:2011. |

ISO standard validation with proper ISO file by using mock MDS:
• Under an SBI project, create a collection by selecting ISO standard testcases.
• Run the mock MDS/SBI with standard ISO files. Perform a Scan and select the appropriate device.
• Run the ISO collection and verify the result status. ISO standard validation should be success.
ISO standard validation with Non-ISO files by using mock MDS:
• Under an SBI project, create a collection by selecting ISO standard testcases.
• Run the mock MDS/SBI with Non-ISO standard files (In Default folder replace standard ISO file with Non-ISO file). Perform a Scan and select the appropriate device.
• Run the ISO collection and verify the result status. ISO standard validation should be fail.

| | `BiometricsQualityCheckValidator` | Checks the quality of biometrics using all configured SDK services. |

Biometrics quality check validation with good quality biometric:
• In compliance-toolkit-default.properties, configure Bio SDK service and health check URLs under mosip.toolkit.sbi.qualitycheck.finger.sdk.urls property. Restart CTK pods/services.
Example:
mosip.toolkit.sbi.qualitycheck.finger.sdk.urls=\[{"name": "Mock SDK qa-1201-b2 Env","url": "": "", "includeInResults":true}]
• Add Biometric quality testcase in CTK for all modalities (FP, Iris and Face for both Reg and Auth).
• Run Mock MDS and increase biometric quality score to get more than threshold value.
• In CTK scan the biometric devices and run the Biometric quality check testcases.
• After testcase execution is done, please check testcase result status. Biometric quality check validator should pass.
Biometrics quality check validation with poor qualitybiometric:
• Change the biometric quality score to less than the threshold value and run the Biometric quality check testcases.
• After testcase execution is done, please check testcase result status. Biometric quality check validator should fail because quality score is less than threshold.

| | `TimeCheckValidator` | Validates if response is received within the given timestamp interval or not. | | | `HashValidator` | Validates the 'hash value' received in the response matches 'previous hash' in request. | | ### SDK Validators | Name | Description | Test with Mock SDK | | ------------------------------------- | -------------------------------------------------------------------------------- | ------------------ | | `SchemaValidator` | Validates if response has all mandatory attributes and they have allowed values. | | | `QualityCheckValidator` | Checks the quality score of the modality. | | | `QualityCheckInvalidDataValidator` | Validates the status code for invalid data. | | | `QualityCheckNoDataValidator` | Validates the status code for no data. | | | `MatchValidator` | Validates if biomterics match for the modality. | | | `MatchInvalidDataValidator` | Validates the status code for invalid data. | | | `MatchNoDataValidator` | Validates the status code for no data. | | | `MatchMultipleGalleryValidator` | Validates if biomterics match for the modality. | | | `ExtractTemplateValidator` | Validates if input BDB data present in the Probe for the modality is valid. | | | `ExtractTemplateInvalidDataValidator` | Validates if input BDB data present in the Probe for the modality is valid. | | | `ExtractTemplateNoInputDataValidator` | Validates if no input BDB data present in the Probe. | | | `ConvertDataValidator` | Validates the input BDB data present in the Probe. | | | `ConvertInvalidDataValidator` | Validates if input BDB data present in the Probe for the modality is valid. | | | `ConvertNoInputDataValidator` | Validates if no input BDB data present in the Probe. | | ### ABIS Validators | Name | Description | Test with Mock ABIS | | --------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------- | | `SchemaValidator` | Validates if response has all mandatory attributes and they have allowed values. | | | `ExpectedFailureReasonValidator` | Validates the failure reason to match the expected value | | | `IdentifyDuplicateFoundValidator` | Validates the count of duplicates found by ABIS for the given referenceId | | | `ExpectedDuplicateCountValidator` | Validates the duplicates found to match the expected value. | | | `ABISTokenValidator` | Validates that ABIS is not generating a new token for every insert request, unless token has expired. | |