add sex verification (#9)

* add sex verification * fix migrations and delete callback-url from links * fix migrations and delete callback-url from links
rarimo · Sep 17, 2024 · 8c21d4b · 8c21d4b
1 parent d27e74f
commit 8c21d4b
Show file tree

Hide file tree

Showing 22 changed files with 72 additions and 31 deletions.
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/spec/components/parameters/pathID.yaml b/docs/spec/components/parameters/pathID.yaml
@@ -1,6 +1,7 @@
 in: path
 name: 'user_id'
 required: true
+description: "User identifier (e.g., email, address)."
 example: "[email protected]"
 schema:
   type: string

diff --git a/docs/spec/components/schemas/GetProofKey.yaml b/docs/spec/components/schemas/GetProofKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "18493889724322d9aba2d93238ae60c2638946737bbe8eaecd6e5efdc0b6f4ff"
+    description: "User hash identifier"
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/Links.yaml b/docs/spec/components/schemas/Links.yaml
@@ -9,9 +9,7 @@ allOf:
         required:
           - get_proof_params
         properties:
-          callback_url:
-            type: string
-            example: "https://example.com/integrations/verificator-svc/public/callback/c15ad8f88949"
           get_proof_params:
             type: string
-            example: "https://example.com/integrations/verificator-svc/public/proof-params/c15ad8f88949"
+            example: "https://example.com/integrations/verificator-svc/public/proof-params/c15ad8f88949"
+            description: "Returns proof-parameters and callback_url"
diff --git a/docs/spec/components/schemas/LinksKey.yaml b/docs/spec/components/schemas/LinksKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "18493889724322d9aba2d93238ae60c2638946737bbe8eaecd6e5efdc0b6f4ff"
+    description: "User hash identifier"
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/ParametersKey.yaml b/docs/spec/components/schemas/ParametersKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "[email protected]"
+    description: "User identifier (e.g., email, address)."
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/ProofKey.yaml b/docs/spec/components/schemas/ProofKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "18493889724322d9aba2d93238ae60c2638946737bbe8eaecd6e5efdc0b6f4ff"
+    description: "User hash identifier"
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/ProofParamsKey.yaml b/docs/spec/components/schemas/ProofParamsKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "[email protected]"
+    description: "User identifier (e.g., email, address)."
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/StatusKey.yaml b/docs/spec/components/schemas/StatusKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "[email protected]"
+    description: "User identifier (e.g., email, address)."
   type:
     type: string
     enum:

diff --git a/docs/spec/components/schemas/User.yaml b/docs/spec/components/schemas/User.yaml
@@ -10,12 +10,20 @@ allOf:
           age_lower_bound:
             type: integer
             example: 18
+            description: "Lower user age limit"
           uniqueness:
             type: boolean
             example: true
+            description: "Parameters for checking user uniqueness"
           nationality:
             type: string
             example: "UKR"
+            description: "User nationality"
           event_id:
             type: string
-            example: "2234556494903931186902189494613533900917417361106374681011849132651019822199"
+            example: "2234556494903931186902189494613533900917417361106374681011849132651019822199"
+            description: "Event ID of event"
+          sex:
+            type: boolean
+            example: true
+            description: "Enable verification of sex param"
diff --git a/docs/spec/components/schemas/UserKey.yaml b/docs/spec/components/schemas/UserKey.yaml
@@ -6,6 +6,7 @@ properties:
   id:
     type: string
     example: "[email protected]"
+    description: "User identifier (e.g., email, address)."
   type:
     type: string
     enum:

diff --git a/docs/spec/paths/integrations@verificator-svc@[email protected] b/docs/spec/paths/integrations@verificator-svc@[email protected]
@@ -3,7 +3,7 @@ post:
     - User verification
   summary: Request verification links for qr-code generation
   description: |
-    Requests verification links for user to generate qr-code, returns: callback_url and get_proof_params.
+    Requests verification links for user to generate qr-code, returns: get_proof_params.
   operationId: getVerificationLink
   requestBody:
     required: true

diff --git a/docs/spec/paths/integrations@verificator-svc@public@proof-params@{user_id_hash}.yaml b/docs/spec/paths/integrations@verificator-svc@public@proof-params@{user_id_hash}.yaml
@@ -3,7 +3,7 @@ get:
     - Proof
   summary: Get Proof Parameters(mobile)
   description: |
-    Get proof parameters by userIDHash.
+    Get proof parameters by userIDHash, returns: proof-params and callback_url.
   operationId: getProofParameters
   parameters:
     - $ref: '#/components/parameters/pathIDHash'

diff --git a/internal/assets/migrations/002_sex.sql b/internal/assets/migrations/002_sex.sql
@@ -0,0 +1,4 @@
+-- +migrate Up
+ALTER TABLE verify_users ADD COLUMN sex BOOLEAN NOT NULL DEFAULT FALSE;
+-- +migrate Down
+ALTER TABLE verify_users DROP COLUMN sex;
diff --git a/internal/data/pg/verify_users.go b/internal/data/pg/verify_users.go
@@ -77,6 +77,7 @@ func (q *VerifyUsersQ) Insert(VerifyUsers *data.VerifyUsers) error {
 		"event_id":        VerifyUsers.EventId,
 		"status":          VerifyUsers.Status,
 		"proof":           proofJSON,
+		"sex":             VerifyUsers.Sex,
 	})
 
 	if err = q.db.Exec(stmt); err != nil {

diff --git a/internal/data/verify_users.go b/internal/data/verify_users.go
@@ -14,6 +14,7 @@ type VerifyUsers struct {
 	EventId       string    `db:"event_id"`
 	Status        string    `db:"status"`
 	Proof         []byte    `db:"proof"`
+	Sex           bool      `db:"sex"`
 }
 
 type VerifyUsersQ interface {

diff --git a/internal/service/handlers/get_proof_parameters.go b/internal/service/handlers/get_proof_parameters.go
@@ -25,7 +25,7 @@ func GetProofParameters(w http.ResponseWriter, r *http.Request) {
 		IdentityCounterUpperBound int32
 		TimestampUpperBound       = "0"
 		eventID                   = Verifiers(r).EventID
-		proofSelector             = helpers.CalculateProofSelector(userInputs.Uniqueness, userInputs.AgeLowerBound, userInputs.Nationality)
+		proofSelector             = helpers.CalculateProofSelector(userInputs.Uniqueness, userInputs.AgeLowerBound, userInputs.Nationality, true)
 	)
 
 	if userInputs.EventID != "" {

diff --git a/internal/service/handlers/helpers/proof_params.go b/internal/service/handlers/helpers/proof_params.go
@@ -13,6 +13,7 @@ import (
 const (
 	NullifierBit                 = 0
 	CitizenshipBit               = 5
+	SexBit                       = 6
 	TimestampUpperBoundBit       = 9
 	IdentityCounterUpperBoundBit = 11
 	ExpirationDateLowerboundBit  = 12
@@ -58,12 +59,15 @@ func ExtractEventData(getter zk.PubSignalGetter) (string, error) {
 	return fmt.Sprintf("0x%s", hex.EncodeToString(userIDHash[:])), nil
 }
 
-func CalculateProofSelector(uniqueness bool, ageLowerBound int, nationality string) int {
+func CalculateProofSelector(uniqueness bool, ageLowerBound int, nationality string, sexEnable bool) int {
 	var bitLine uint32
 	bitLine |= 1 << NullifierBit
 	if nationality != "" {
 		bitLine |= 1 << CitizenshipBit
 	}
+	if sexEnable {
+		bitLine |= 1 << SexBit
+	}
 	if ageLowerBound != -1 {
 		bitLine |= 1 << BirthDateUpperboundBit
 	}

diff --git a/internal/service/handlers/proof_params.go b/internal/service/handlers/proof_params.go
@@ -36,7 +36,7 @@ func GetProofParamsById(w http.ResponseWriter, r *http.Request) {
 		TimestampUpperBound       = "0"
 		eventID                   = Verifiers(r).EventID
 		birthDateUpperBound       = helpers.CalculateBirthDateHex(existingUser.AgeLowerBound)
-		proofSelector             = helpers.CalculateProofSelector(existingUser.Uniqueness, existingUser.AgeLowerBound, existingUser.Nationality)
+		proofSelector             = helpers.CalculateProofSelector(existingUser.Uniqueness, existingUser.AgeLowerBound, existingUser.Nationality, existingUser.Sex)
 		callbackURL               = fmt.Sprintf("%s/integrations/verificator-svc/public/callback/%s", Callback(r).URL, userIDHash)
 	)
 

diff --git a/internal/service/handlers/verification_link.go b/internal/service/handlers/verification_link.go
@@ -50,6 +50,10 @@ func VerificationLink(w http.ResponseWriter, r *http.Request) {
 		user.Uniqueness = *req.Data.Attributes.Uniqueness
 	}
 
+	if req.Data.Attributes.Sex != nil {
+		user.Sex = *req.Data.Attributes.Sex
+	}
+
 	existingUser, err := VerifyUsersQ(r).WhereHashID(user.UserIDHash).Get()
 	if err != nil {
 		Log(r).WithError(err).Errorf("failed to query user with userID [%s]", userIdHash)

diff --git a/resources/model_links_attributes.go b/resources/model_links_attributes.go
@@ -5,6 +5,6 @@
 package resources
 
 type LinksAttributes struct {
-	CallbackUrl    *string `json:"callback_url,omitempty"`
-	GetProofParams string  `json:"get_proof_params"`
+	// Returns proof-parameters and callback_url
+	GetProofParams string `json:"get_proof_params"`
 }
diff --git a/resources/model_user_attributes.go b/resources/model_user_attributes.go
@@ -5,8 +5,14 @@
 package resources
 
 type UserAttributes struct {
-	AgeLowerBound *int32  `json:"age_lower_bound,omitempty"`
-	EventId       *string `json:"event_id,omitempty"`
-	Nationality   *string `json:"nationality,omitempty"`
-	Uniqueness    *bool   `json:"uniqueness,omitempty"`
+	// Lower user age limit
+	AgeLowerBound *int32 `json:"age_lower_bound,omitempty"`
+	// Event ID of event
+	EventId *string `json:"event_id,omitempty"`
+	// User nationality
+	Nationality *string `json:"nationality,omitempty"`
+	// Enable verification of sex param
+	Sex *bool `json:"sex,omitempty"`
+	// Parameters for checking user uniqueness
+	Uniqueness *bool `json:"uniqueness,omitempty"`
 }