-
Notifications
You must be signed in to change notification settings - Fork 179
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1593 from JanardhanBS-SyncByte/patch-2
[MOSIP-38326]Update README.md
- Loading branch information
Showing
1 changed file
with
21 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,27 @@ | ||
| # ID Generator Service | ||
|
|
||
| ## Overview | ||
| This service is used to generates various IDs like UIN, APPID, RID, VID. | ||
| MOSIP uses the cryptographically safe SecureRandom algorithm to generate UINs (Unique Identification Numbers) with high randomness. A checksum is added using the Verhoeff Algorithm to validate the UIN/VID. Generated UINs are filtered against [predefined patterns](#uin-generation-filters) as outlined below, to eliminate easily identifiable numbers and prevent repetitions or sequences. The random number seed is refreshed every 45 minutes or as configured via `mosip.idgen.uin.secure-random-reinit-frequency` in minutes. | ||
|
|
||
| ## UIN generation logic | ||
| UIN should have the following properties: | ||
| * Only integers with length as specified in `mosip.kernel.uin.length` configuration in [application properties](https://docs.mosip.io/1.2.0/modules/module-configuration#application-properties) | ||
| * No alphanumeric characters | ||
| * No repeating numbers for 2 or more than 2 digits | ||
| * No sequential number for 3 or more than 3 digits | ||
| * Should not be generated sequentially | ||
| * Should not have repeated block of numbers for 2 or more than 2 digits | ||
| * The last digit in the number should be reserved for a checksum | ||
| * The number should not contain '0' or '1' as the first digit. | ||
| * First 5 digits should be different from the last 5 digits (example - 4345643456) | ||
| * First 5 digits should be different to the last 5 digits reversed (example - 4345665434) | ||
| * Should not be a cyclic figure (example - 4567890123, 6543210987) | ||
| * Should be different from the repetition of the first two digits 5 times (example - 3434343434) | ||
| * Should not contain three even adjacent digits (example - 3948613752) | ||
| * Should not contain admin defined restricted number | ||
| This service is used to generate various IDs like UIN and VID. | ||
|
|
||
| ## Default context-path and port | ||
| Refer [`bootstrap.properties`](src/main/resources/bootstrap.properties) | ||
| ## UIN Generation Filters | ||
| The UIN should follow the following filters and constraints: | ||
| * Only integers with length, as specified in `mosip.kernel.uin.length` configuration. | ||
| * Minimum pregenerated UINs that should be available, as specified in `mosip.kernel.uin.min-unused-threshold` configuration. If not available then the next batch of generation would start. | ||
| * Number of UINs to generate, as specified in `mosip.kernel.uin.uins-to-generate` configuration. | ||
| * Upper bound of number of digits in sequence allowed in id, as specified in `mosip.kernel.uin.length.sequence-limit` configuration. For example if limit is 3, then 12 is allowed but 123 is not allowed in id (in both ascending and descending order). | ||
| * Number of digits in repeating block allowed in id, as specified in `mosip.kernel.uin.length.repeating-block-limit` configuration. For example if limit is 2, then 4xxx4 is allowed but 48xxx48 is not allowed in id (x is any digit). | ||
| * Lower bound of number of digits allowed in between two repeating digits in id, as specified in `mosip.kernel.uin.length.repeating-limit` configuration. For example if limit is 2, then 11 and 1x1 is not allowed in id (x is any digit). | ||
| * Number of digits to check for reverse digits group limit, as specified in `mosip.kernel.uin.length.reverse-digits-limit` configuration. For example if limit is 5 and UIN is 4345665434, then first 5 digits will be 43456, reverse 65434. | ||
| * Number of digits to check for digits group limit in id, as specified in `mosip.kernel.uin.length.digits-limit` configuration. For example if limit is 5 and UIN is 4345643456, then 5 digits group will be 43456. | ||
| * Number of even adjacent digits limit in id, as specified in `mosip.kernel.uin.length.conjugative-even-digits-limit` configuration. For example, if limit is 3 then any 3 even adjacent digits is not allowed. | ||
| * List of restricted numbers with , seperation as specified in `mosip.kernel.uin.restricted-numbers` configuration. | ||
| * List of numbers that should not be the starting digits in the id. Its a , separated list, as specified in `mosip.kernel.uin.not-start-with` configuration. For example, the number should not contain '0' or '1' as the first digit. | ||
| * No alphanumeric characters allowed. | ||
| * No cyclic numbers as mentioned below are allowed. `"142857", "0588235294117647", "052631578947368421", "0434782608695652173913", "0344827586206896551724137931", "0212765957446808510638297872340425531914893617", "0169491525423728813559322033898305084745762711864406779661", "016393442622950819672131147540983606557377049180327868852459", "010309278350515463917525773195876288659793814432989690721649484536082474226804123711340206185567"`. | ||
|
|
||
| Note: Significant thought has been invested in the above design to ensure the generated numbers are both random and secure. We strongly recommend retaining the stated values to maintain the integrity and security of the same. | ||
|
|
||
| ## Default Context-path and Port | ||
| Refer [`bootstrap.properties`](src/main/resources/bootstrap.properties) |