[ES-558] Update handles

.github/workflows/push-trigger.yml

@@ -20,6 +20,7 @@ on:
       - 1.*
       - develop
       - MOSIP*
+      - ES-842
 
 jobs:
   build-maven-id-repository:

db_release_scripts/mosip_idrepo/ddl/idrepo-handle.sql

@@ -17,6 +17,7 @@ CREATE TABLE idrepo.handle(
 	uin_hash character varying NOT NULL,
 	handle character varying NOT NULL,
 	handle_hash character varying NOT NULL,
+	status character varying(32) NOT NULL,
 	cr_by character varying(256) NOT NULL,
 	cr_dtimes timestamp NOT NULL,
 	CONSTRAINT pk_handle PRIMARY KEY (id),
@@ -31,6 +32,8 @@ COMMENT ON COLUMN idrepo.handle.handle IS 'Handle : Unique username of the indiv
 -- ddl-end --
 COMMENT ON COLUMN idrepo.handle.handle_hash IS 'Handle Hash: Hash value of Unique username of the individual.';
 -- ddl-end --
+COMMENT ON COLUMN idrepo.handle.status IS 'Status:  Current Status of the Handle.';
+-- ddl-end --
 COMMENT ON COLUMN idrepo.handle.cr_by IS 'Created By : ID or name of the user who create / insert record';
 -- ddl-end --
 COMMENT ON COLUMN idrepo.handle.cr_dtimes IS 'Created DateTimestamp : Date and Timestamp when the record is created/inserted';

db_scripts/mosip_idrepo/ddl/idrepo-handle.sql

@@ -17,6 +17,7 @@ CREATE TABLE idrepo.handle(
 	uin_hash character varying NOT NULL,
 	handle character varying NOT NULL,
 	handle_hash character varying NOT NULL,
+	status character varying(32) NOT NULL,
 	cr_by character varying(256) NOT NULL,
 	cr_dtimes timestamp NOT NULL,
 	CONSTRAINT pk_handle PRIMARY KEY (id),
@@ -31,6 +32,8 @@ COMMENT ON COLUMN idrepo.handle.handle IS 'Handle : Unique username of the indiv
 -- ddl-end --
 COMMENT ON COLUMN idrepo.handle.handle_hash IS 'Handle Hash: Hash value of Unique username of the individual.';
 -- ddl-end --
+COMMENT ON COLUMN idrepo.handle.status IS 'Status:  Current Status of the Handle.';
+-- ddl-end --
 COMMENT ON COLUMN idrepo.handle.cr_by IS 'Created By : ID or name of the user who create / insert record';
 -- ddl-end --
 COMMENT ON COLUMN idrepo.handle.cr_dtimes IS 'Created DateTimestamp : Date and Timestamp when the record is created/inserted';

db_upgrade_scripts/mosip_credential/sql/1.2.1.0_to_1.2.2.0_rollback.sql

@@ -0,0 +1 @@
+\echo 'Upgrade Queries not required for transition from $CURRENT_VERSION to $UPGRADE_VERSION'

db_upgrade_scripts/mosip_credential/sql/1.2.1.0_to_1.2.2.0_upgrade.sql

@@ -0,0 +1 @@
+\echo 'Upgrade Queries not required for transition from $CURRENT_VERSION to $UPGRADE_VERSION'

db_upgrade_scripts/mosip_idmap/sql/1.2.1.0_to_1.2.2.0_rollback.sql

@@ -0,0 +1 @@
+\echo 'Upgrade Queries not required for transition from $CURRENT_VERSION to $UPGRADE_VERSION'

db_upgrade_scripts/mosip_idmap/sql/1.2.1.0_to_1.2.2.0_upgrade.sql

@@ -0,0 +1 @@
+\echo 'Upgrade Queries not required for transition from $CURRENT_VERSION to $UPGRADE_VERSION'

db_upgrade_scripts/mosip_idrepo/sql/1.2.1.0_to_1.2.2.0_rollback.sql

@@ -0,0 +1,16 @@
+-- -------------------------------------------------------------------------------------------------
+-- Database Name: mosip_idrepo
+-- Purpose    	: Revoking Database alter scripts for release of ID Repository DB.       
+-- Create By   	: Ritik Jain
+-- Created Date	: May-2024
+-- 
+-- Modified Date        Modified By         Comments / Remarks
+-- -------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------
+
+\c mosip_idrepo sysadmin
+---------------------------------------------------------------------------------------------------
+
+ALTER TABLE idrepo.handle DROP COLUMN IF EXISTS status;
+
+------------------------------------------------------------------------------------------------

db_upgrade_scripts/mosip_idrepo/sql/1.2.1.0_to_1.2.2.0_upgrade.sql

@@ -0,0 +1,16 @@
+-- -------------------------------------------------------------------------------------------------
+-- Database Name: mosip_idrepo
+-- Purpose    	: Database alter scripts for release of ID Repository DB.       
+-- Create By   	: Ritik Jain
+-- Created Date	: May-2024
+-- 
+-- Modified Date        Modified By         Comments / Remarks
+-- -------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------
+
+\c mosip_idrepo sysadmin
+---------------------------------------------------------------------------------------------------
+
+ALTER TABLE idrepo.handle ADD COLUMN status character varying(32) NOT NULL DEFAULT 'ACTIVATED';
+
+------------------------------------------------------------------------------------------------

docs/design/handle_support.md

@@ -25,11 +25,28 @@ As handles are revocable they provide strong privacy by default. If a user feels
     4. Get the salt for the input handle and generate the selected handle salted hash.
     5. Check if an entry exists with the same handle hash in the `mosip_idrepo.handle` table.
     6. Fails the `add_identity` request if an entry exists.
-    7. Otherwise, create an identity with UIN and Create an entry in the `mosip_idrepo.handle` table for each selected handle.
+    7. Otherwise, create an identity with UIN and Create an entry in the `mosip_idrepo.handle` table for each selected handle with status `ACTIVATED`.
     8. Issue credentials with the UIN. As part of handle support, we have made this issuance configurable.
     9. Issue credentials with the handle for each selected handle.
 * There were changes in IDA to support handle as a new IDType and also introduced regex-based handle validation.
-* Changes in `update_identity` API: (Not implemented)
+* Changes in `update_identity` API:
+	1. Identify if any handle is selected in the input.
+	2. Check if the selected handles are configured as a HANDLE in `identity_schema`(JSON schema validation).
+	3. If no handles are selected, proceed with step 6.
+	4. If selected, get the salt for the input handles and generate the selected handles salted hash.
+	5. Follow below operations in `mosip_idrepo.handle` table.  
+		a) If the handle is selected and the same handle is mapped to DIFFERENT user then fail the `update_identity` request.  
+		b) If the handle is selected and the same handle is mapped to SAME user then do nothing.  
+		c) If the handle is selected and the handle does NOT EXIST in `mosip_idrepo.handle` table, create entry in handle table.  
+		d) If there are any unselected handles (when compared with stored selectedHandles and input selectedHandles), mark the handle status as `DELETE` in the `mosip_idrepo.handle` table.  
+	Note: Add `status` column in the `mosip_idrepo.handle` table.
+	6. Update identity data (demo, docs & bio) in the uin table.
+
+	In CredentialServiceManager, when we fetch the list of handles for a UIN to issue credentials:
+	1. Issue credential event to be raised if the handle status is `ACTIVATED`.
+	2. If the handle status is `DELETE`, then send `REMOVE_ID` event to IDA and mark the handle status as `DELETE_REQUESTED`.  
+	Note: If the UIN will be blocked or deactivated, then revoke credentials for all selected handles for a UIN.
+	3. We should change in the IDA to acknowledge `REMOVE_ID` event to identity-service as `REMOVE_ID_STATUS` event. On receiving successful acknowledgment from `REMOVE_ID_STATUS` event, delete the entry from `mosip_idrepo.handle` table.
 
 ### How is the credential request ID created for handles?
 

id-repository/id-repository-core/src/main/java/io/mosip/idrepository/core/constant/AuditEvents.java

@@ -59,7 +59,9 @@ public enum AuditEvents {
 
 	GET_RID_BY_INDIVIDUALID("IDR-026", "System Event"),
 
-	GET_DRAFT_UIN_REQUEST_RESPONSE("IDR-027", "System Event"),;
+	GET_DRAFT_UIN_REQUEST_RESPONSE("IDR-027", "System Event"),
+
+	REMOVE_ID_STATUS("IDR-028", "System Event");
 
 
 

id-repository/id-repository-core/src/main/java/io/mosip/idrepository/core/constant/HandleStatusLifecycle.java

@@ -0,0 +1,9 @@
+package io.mosip.idrepository.core.constant;
+
+/**
+ * @author Ritik Jain
+ *
+ */
+public enum HandleStatusLifecycle {
+	ACTIVATED, DELETE, DELETE_REQUESTED;
+}

id-repository/id-repository-core/src/main/java/io/mosip/idrepository/core/constant/IdRepoConstants.java

@@ -132,7 +132,15 @@ public class IdRepoConstants {
 	public static final String  VID_EVENT_CALLBACK_URL = "mosip.idrepo.websub.vid-credential-update.callback-url";
 
 	public static final String CREDENTIAL_STATUS_UPDATE_TOPIC = "mosip.idrepo.websub.credential-status-update.topic";
-
+
+	public static final String REMOVE_ID_STATUS_EVENT_TOPIC = "mosip.idrepo.websub.remove-id-status.topic";
+
+	public static final String REMOVE_ID_STATUS_EVENT_SECRET = "mosip.idrepo.websub.remove-id-status.secret";
+
+	public static final String REMOVE_ID_STATUS_EVENT_CALLBACK_RELATIVE_URL = "idrepo.websub.callback.remove-id-status.relative.url";
+
+	public static final String REMOVE_ID_STATUS_EVENT_CALLBACK_URL = "mosip.idrepo.websub.remove-id-status.callback-url";
+
 	public static final String FACE_EXTRACTION_FORMAT = "faceExtractionFormat";
 
 	public static final String IRIS_EXTRACTION_FORMAT = "irisExtractionFormat";
@@ -214,6 +222,9 @@ public class IdRepoConstants {
 	/** The Constant CREATE. */
 	public static final String CREATE = "create";
 
+	/** The Constant UPDATE. */
+	public static final String UPDATE = "update";
+
 	/** The Constant READ. */
 	public static final String READ = "read";
 

id-repository/id-repository-core/src/main/java/io/mosip/idrepository/core/entity/Handle.java

@@ -28,6 +28,9 @@ public class Handle implements HandleInfo {
     @Column(name = "handle_hash")
     private String handleHash;
 
+    @Column(name = "status")
+    private String status;
+
     @Column(name = "cr_by")
     private String createdBy;
 

id-repository/id-repository-core/src/main/java/io/mosip/idrepository/core/helper/IdRepoWebSubHelper.java

@@ -3,6 +3,9 @@
 import static io.mosip.idrepository.core.constant.IdRepoConstants.EXPIRY_TIMESTAMP;
 import static io.mosip.idrepository.core.constant.IdRepoConstants.ID_HASH;
 import static io.mosip.idrepository.core.constant.IdRepoConstants.ID_REPO;
+import static io.mosip.idrepository.core.constant.IdRepoConstants.REMOVE_ID_STATUS_EVENT_CALLBACK_URL;
+import static io.mosip.idrepository.core.constant.IdRepoConstants.REMOVE_ID_STATUS_EVENT_SECRET;
+import static io.mosip.idrepository.core.constant.IdRepoConstants.REMOVE_ID_STATUS_EVENT_TOPIC;
 import static io.mosip.idrepository.core.constant.IdRepoConstants.TRANSACTION_LIMIT;
 import static io.mosip.idrepository.core.constant.IdRepoConstants.VID_EVENT_CALLBACK_URL;
 import static io.mosip.idrepository.core.constant.IdRepoConstants.VID_EVENT_SECRET;
@@ -80,6 +83,15 @@ public class IdRepoWebSubHelper {
 	@Value("${" + VID_EVENT_CALLBACK_URL + "}")
 	private String vidEventUrl;
 
+	@Value("${" + REMOVE_ID_STATUS_EVENT_TOPIC + "}")
+	private String removeIdStatusEventTopic;
+
+	@Value("${" + REMOVE_ID_STATUS_EVENT_SECRET + "}")
+	private String removeIdStatusEventSecret;
+
+	@Value("${" + REMOVE_ID_STATUS_EVENT_CALLBACK_URL + "}")
+	private String removeIdStatusEventCallbackUrl;
+
 	/** The ida event type namespace. */
 	@Value("${id-repo-ida-event-type-namespace:mosip}")
 	private String idaEventTypeNamespace;
@@ -250,6 +262,23 @@ public void subscribeForVidEvent() {
 		}
 	}
 
+	public void subscribeForRemoveIdStatusEvent() {
+		try {
+			SubscriptionChangeRequest subscriptionRequest = new SubscriptionChangeRequest();
+			subscriptionRequest.setCallbackURL(removeIdStatusEventCallbackUrl);
+			subscriptionRequest.setHubURL(hubURL);
+			subscriptionRequest.setSecret(removeIdStatusEventSecret);
+			subscriptionRequest.setTopic(removeIdStatusEventTopic);
+			subscribe.subscribe(subscriptionRequest);
+			mosipLogger.info(IdRepoSecurityManager.getUser(), this.getClass().getCanonicalName(),
+					"subscribeForRemoveIdStatusEvent", "subscribed event topic: " + removeIdStatusEventTopic);
+		} catch (Exception e) {
+			mosipLogger.warn(IdRepoSecurityManager.getUser(), this.getClass().getCanonicalName(),
+					"subscribeForRemoveIdStatusEvent",
+					"Error subscribing topic: " + removeIdStatusEventTopic + "\n" + e.getMessage());
+		}
+	}
+
 	public void publishEvent(EventModel event) {
 		this.publishEvent(event.getTopic(), event);
 	}