feat(fingerprint): add api for fingerprint (#76)

Co-authored-by: Nishant Joshi <[email protected]>
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
Co-authored-by: Shankar Singh C <[email protected]>

Author: 4 people

docs/openapi/spec.yml

@@ -156,6 +156,27 @@ paths:
                 oneOf:
                   - $ref: "#/components/schemas/RetrieveDataRes"
                   - $ref: "#/components/schemas/JWERes"
+  /data/fingerprint:
+    post:
+      tags:
+        - Cards
+        - Data
+      summary: Get or insert the card fingerprint
+      description: Get or insert the card fingerprint
+      requestBody:
+        description: Provide card number and hash key
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/FingerprintReq"
+        required: true
+      responses:
+        "200":
+          description: Fingerprint Response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FingerprintRes"
 components:
   schemas:
     Key:
@@ -207,6 +228,14 @@ components:
         card_reference:
           type: string
           example: 3ffdf1e5-7f38-4f26-936f-c66a6f4296fa
+    FingerprintReq:
+      type: object
+      properties:
+        card:
+          $ref: "#/components/schemas/FingerprintCardData"
+        hash_key:
+          type: string
+          example: Hash1
     JWEReq:
       type: object
       properties:
@@ -249,6 +278,12 @@ components:
           type: string
         nick_name:
           type: string
+    FingerprintCardData:
+      type: object 
+      properties:
+        card_number:
+          type: string
+          example: 4242424242424242
     Key1Set:
       type: string
       description: Response after setting key1
@@ -293,6 +328,18 @@ components:
         status:
           type: string
           enum: [Ok]
+    FingerprintRes:
+      type: object
+      description: Response received if the fingerprint insertion or retrieval was successful
+      properties:
+        status:
+          type: string
+          enum: [Ok]
+        payload:
+          type: object
+          properties:
+            fingerprint:
+              type: string
     JWERes:
       type: object
       description: JWE encrypted response equivalent

src/error/transforms.rs

@@ -113,6 +113,19 @@ impl<'a> From<&'a super::CryptoError> for super::FingerprintDBError {
     }
 }
 
+error_transform!(super::FingerprintDBError => super::ApiError);
+impl<'a> From<&'a super::FingerprintDBError> for super::ApiError {
+    fn from(value: &'a super::FingerprintDBError) -> Self {
+        match value {
+            super::FingerprintDBError::EncodingError => Self::EncodingError,
+            super::FingerprintDBError::DBError => Self::DatabaseError,
+            super::FingerprintDBError::DBFilterError => Self::RetrieveDataFailed("fingerprint"),
+            super::FingerprintDBError::DBInsertError => Self::DatabaseInsertFailed("fingerprint"),
+            super::FingerprintDBError::UnknownError => Self::UnknownError,
+        }
+    }
+}
+
 error_transform!(super::CryptoError => super::HashDBError);
 impl<'a> From<&'a super::CryptoError> for super::HashDBError {
     fn from(value: &'a super::CryptoError) -> Self {

src/routes/data.rs

@@ -14,7 +14,7 @@ use crate::{
     app::AppState,
     crypto::{aes::GcmAes256, sha::Sha512},
     error::{self, ContainerError, ResultContainerExt},
-    storage::{HashInterface, LockerInterface, MerchantInterface},
+    storage::{FingerprintInterface, HashInterface, LockerInterface, MerchantInterface},
 };
 
 #[cfg(feature = "middleware")]
@@ -59,7 +59,8 @@ pub fn serve(
     let router = axum::Router::new()
         .route("/delete", delete_route)
         .route("/add", post(add_card))
-        .route("/retrieve", post(retrieve_card));
+        .route("/retrieve", post(retrieve_card))
+        .route("/fingerprint", post(get_or_insert_fingerprint));
 
     #[cfg(feature = "middleware")]
     {
@@ -217,3 +218,18 @@ pub async fn retrieve_card(
 
     Ok(Json(card.try_into()?))
 }
+
+/// `/cards/fingerprint` handling the creation and retrieval of card fingerprint
+pub async fn get_or_insert_fingerprint(
+    extract::State(state): extract::State<AppState>,
+    Json(request): Json<types::FingerprintRequest>,
+) -> Result<Json<types::FingerprintResponse>, ContainerError<error::ApiError>> {
+    request.validate()?;
+
+    let fingerprint = state
+        .db
+        .insert_fingerprint(request.card.card_number, request.hash_key)
+        .await?;
+
+    Ok(Json(fingerprint.into()))
+}

src/routes/data/transformers.rs

@@ -76,6 +76,14 @@ impl TryFrom<storage::types::Locker> for super::types::RetrieveCardResponse {
     }
 }
 
+impl From<storage::types::Fingerprint> for super::types::FingerprintResponse {
+    fn from(value: storage::types::Fingerprint) -> Self {
+        Self {
+            card_fingerprint: value.card_fingerprint,
+        }
+    }
+}
+
 impl std::cmp::PartialEq<types::Data> for super::types::StoredData {
     fn eq(&self, other: &types::Data) -> bool {
         match (self, other) {

src/routes/data/types.rs

@@ -7,9 +7,9 @@
 //     hash2_reference: Option<String>,
 // }
 
-use masking::PeekInterface;
+use masking::{PeekInterface, Secret};
 
-use crate::error;
+use crate::{error, storage};
 
 #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Eq)]
 pub struct Card {
@@ -102,6 +102,22 @@ pub struct DeleteCardResponse {
     pub status: Status,
 }
 
+#[derive(serde::Deserialize)]
+pub struct FingerprintRequest {
+    pub card: FingerprintCardData,
+    pub hash_key: Secret<String>,
+}
+
+#[derive(serde::Deserialize)]
+pub struct FingerprintCardData {
+    pub card_number: storage::types::CardNumber,
+}
+
+#[derive(serde::Serialize, serde::Deserialize)]
+pub struct FingerprintResponse {
+    pub card_fingerprint: Secret<String>,
+}
+
 #[derive(serde::Serialize, serde::Deserialize, PartialEq, Eq)]
 pub enum StoredData {
     EncData(String),
@@ -132,3 +148,11 @@ impl Validation for StoreCardRequest {
         }
     }
 }
+
+impl Validation for FingerprintRequest {
+    type Error = error::ApiError;
+
+    fn validate(&self) -> Result<(), Self::Error> {
+        self.card.card_number.validate()
+    }
+}

src/storage/types.rs

@@ -6,7 +6,11 @@ use diesel::{
 };
 use masking::{ExposeInterface, PeekInterface, Secret};
 
-use crate::crypto::{self, Encryption};
+use crate::{
+    crypto::{self, Encryption},
+    error,
+    routes::data::types::Validation,
+};
 
 use super::schema;
 
@@ -108,6 +112,16 @@ pub struct Fingerprint {
 #[derive(Debug, serde::Deserialize)]
 pub struct CardNumber(masking::StrongSecret<String>);
 
+impl Validation for CardNumber {
+    type Error = error::ApiError;
+
+    fn validate(&self) -> Result<(), Self::Error> {
+        crate::validations::luhn_on_string(self.0.peek())
+            .then_some(())
+            .ok_or(error::ApiError::ValidationError("card number invalid"))
+    }
+}
+
 impl CardNumber {
     pub fn into_bytes(self) -> Vec<u8> {
         self.0.peek().clone().into_bytes()