Added optional shared key authentication for BPP Webhook communication

beckn · Jun 26, 2024 · 041caa4 · 041caa4
1 parent adaa914
commit 041caa4
Show file tree

Hide file tree

Showing 12 changed files with 198 additions and 151 deletions.
diff --git a/config/config-sample-client-localhost.yaml b/config/config-sample-client-localhost.yaml
@@ -21,13 +21,13 @@ responseCache:
 # 2. webhook
 # 3. pubSub
 client:
-  synchronous: 
+  synchronous:
     mongoURL: "mongodb://127.0.0.1:27017/protocolserver-v2-response-cache"
 
   #webhook:
   #  url: "https://beckn.free.beeceptor.com/clientURL"
-  
-  #messageQueue: 
+
+  #messageQueue:
   #  amqpURL: "amqp://guest:guest@localhost:5672"
   #  incomingQueue: "protocol-server-incoming"
   #  outgoingQueue: "protocol-server-outgoing"
@@ -49,25 +49,24 @@ app:
   actions:
     requests:
       search:
-        ttl : "PT10S"
+        ttl: "PT10S"
       init:
-        ttl : "PT10S"
+        ttl: "PT10S"
       select:
-        ttl : "PT10S"
+        ttl: "PT10S"
       confirm:
-        ttl : "PT10S"
+        ttl: "PT10S"
       status:
         ttl: "PT10S"
       get_cancellation_reasons:
         ttl: "PT10S"
       get_rating_categories:
         ttl: "PT10S"
-
-
-    responses: 
+
+    responses:
       on_search:
         ttl: "PT10S"
-      
+
       on_init:
         ttl: "PT10S"
       on_select:
@@ -80,20 +79,20 @@ app:
         ttl: "PT10S"
       rating_categories:
         ttl: "PT10S"
-  
+
   # Mandatory.
   privateKey: "private key"
   publicKey: "public key"
 
   # Mandatory.
   subscriberId: "dev.bap.faiz.protocol-server.com.dsep:jobs.BAP"
   subscriberUri: "https://410e-45-248-79-20.ngrok.io/"
-  
+
   # Mandatory.
   registryUrl: https://registry.becknprotocol.io/subscribers
   auth: false
   uniqueKey: "dev.bap.faiz.protocol-server.key"
-  
+
   # Mandatory.
   city: "std:080"
   country: "IND"
@@ -111,3 +110,6 @@ app:
     # In minutes
     syncInterval: 30
     redis_db: 3
+
+  useHMACForWebhook: false
+  sharedKeyForWebhookHMAC: ""
diff --git a/config/config-sample-network-localhost.yaml b/config/config-sample-network-localhost.yaml
@@ -21,13 +21,13 @@ responseCache:
 # 2. webhook
 # 3. pubSub
 client:
-  synchronous: 
+  synchronous:
     mongoURL: "mongodb://127.0.0.1:27017/protocolserver-v2-response-cache"
 
   #webhook:
   #  url: "https://beckn.free.beeceptor.com/clientURL"
-  
-  #messageQueue: 
+
+  #messageQueue:
   #  amqpURL: "amqp://guest:guest@localhost:5672"
   #  incomingQueue: "protocol-server-incoming"
   #  outgoingQueue: "protocol-server-outgoing"
@@ -49,24 +49,24 @@ app:
   actions:
     requests:
       search:
-        ttl : "PT10S"
+        ttl: "PT10S"
       init:
-        ttl : "PT10S"
+        ttl: "PT10S"
       select:
-        ttl : "PT10S"
+        ttl: "PT10S"
       confirm:
-        ttl : "PT10S"
+        ttl: "PT10S"
       status:
-        ttl : "PT10S"
+        ttl: "PT10S"
       get_cancellation_reasons:
         ttl: "PT10S"
       get_rating_categories:
         ttl: "PT10S"
-    
-    responses: 
+
+    responses:
       on_search:
         ttl: "PT10S"
-      
+
       on_init:
         ttl: "PT10S"
       on_select:
@@ -79,20 +79,20 @@ app:
         ttl: "PT10S"
       rating_categories:
         ttl: "PT10S"
-  
+
   # Mandatory.
   privateKey: "private key"
   publicKey: "public key"
 
   # Mandatory.
   subscriberId: "dev.bap.faiz.protocol-server.com.dsep:jobs.BAP"
   subscriberUri: "https://410e-45-248-79-20.ngrok.io/"
-  
+
   # Mandatory.
   registryUrl: https://registry.becknprotocol.io/subscribers
   auth: true
   uniqueKey: "dev.bap.faiz.protocol-server.key"
-  
+
   # Mandatory.
   city: "std:080"
   country: "IND"
@@ -110,3 +110,6 @@ app:
     # In minutes
     syncInterval: 30
     redis_db: 3
+
+  useHMACForWebhook: false
+  sharedKeyForWebhookHMAC: ""
diff --git a/config/config-sample.yaml b/config/config-sample.yaml
@@ -21,13 +21,13 @@ responseCache:
 # 2. webhook
 # 3. pubSub
 client:
-  synchronous: 
+  synchronous:
     mongoURL: "mongodb://tvast:password@localhost:27017/protocol_server-v2?authSource=admin"
 
   webhook:
     url: "https://beckn.free.beeceptor.com/clientURL"
-  
-  messageQueue: 
+
+  messageQueue:
     amqpURL: "amqp://guest:guest@localhost:5672"
     incomingQueue: "protocol-server-incoming"
     outgoingQueue: "protocol-server-outgoing"
@@ -49,30 +49,30 @@ app:
   actions:
     requests:
       search:
-        ttl : "PT10S"
+        ttl: "PT10S"
       init:
-        ttl : "PT10S"
-    
-    responses: 
+        ttl: "PT10S"
+
+    responses:
       on_search:
         ttl: "PT10S"
-      
+
       on_init:
         ttl: "PT10S"
-  
+
   # Mandatory.
   privateKey: "your private key"
   publicKey: "your public key"
 
   # Mandatory.
   subscriberId: "dev.bap.protocol-server.com"
   subscriberUri: "https://ayush.free.beeceptor.com/"
-  
+
   # Mandatory.
   registryUrl: https://registry.becknprotocol.io/subscribers
   auth: true
   uniqueKey: "dev.bap.protocol-server.key"
-  
+
   # Mandatory.
   city: "std:080"
   country: "IND"
@@ -90,3 +90,6 @@ app:
     # In minutes
     syncInterval: 30
     redis_db: 3
+
+  useHMACForWebhook: false
+  sharedKeyForWebhookHMAC: ""
diff --git a/config/new-config-sample.yaml b/config/new-config-sample.yaml
@@ -21,13 +21,13 @@ responseCache:
 # 2. webhook
 # 3. pubSub
 client:
-  synchronous: 
+  synchronous:
     mongoURL: "mongodb://tvast:password@localhost:27017/protocol_server-v2?authSource=admin"
 
   webhook:
     url: "https://beckn.free.beeceptor.com/clientURL"
-  
-  messageQueue: 
+
+  messageQueue:
     amqpUrl: "amqp://guest:guest@localhost:5672"
     request-queue: "bap-protocol-server"
     response-queue: "bap-protocol-client"
@@ -50,30 +50,30 @@ app:
   actions:
     requests:
       search:
-        ttl : "PT10S"
+        ttl: "PT10S"
       init:
-        ttl : "PT10S"
-    
-    responses: 
+        ttl: "PT10S"
+
+    responses:
       on_search:
         ttl: "PT10S"
-      
+
       on_init:
         ttl: "PT10S"
-  
+
   # Mandatory.
   privateKey: "your private key"
   publicKey: "your public key"
 
   # Mandatory.
   subscriberId: "dev.bap.protocol-server.com"
   subscriberUri: "https://ayush.free.beeceptor.com/"
-  
+
   # Mandatory.
   registryUrl: https://registry.becknprotocol.io/subscribers
   auth: true
   uniqueKey: "dev.bap.protocol-server.key"
-  
+
   # Mandatory.
   city: "std:080"
   country: "IND"
@@ -91,3 +91,6 @@ app:
     # In minutes
     syncInterval: 30
     redis_db: 3
+
+  useHMACForWebhook: false
+  sharedKeyForWebhookHMAC: ""
diff --git a/config/samples/bap-client.yaml b/config/samples/bap-client.yaml
@@ -21,13 +21,13 @@ responseCache:
 # 2. webhook
 # 3. pubSub
 client:
-  synchronous: 
+  synchronous:
     mongoURL: "mongodb://MONGO_USERNAME:MONGO_PASSWORD@MONOG_URL:27017/MONGO_DB_NAME?authSource=admin"
 
   #webhook:
   #  url: "https://beckn.free.beeceptor.com/clientURL"
-  
-  #messageQueue: 
+
+  #messageQueue:
   #  amqpURL: "amqp://guest:guest@localhost:5672"
   #  incomingQueue: "protocol-server-incoming"
   #  outgoingQueue: "protocol-server-outgoing"
@@ -49,33 +49,33 @@ app:
   actions:
     requests:
       search:
-        ttl : "PT15S"
+        ttl: "PT15S"
       init:
-        ttl : "PT10S"
+        ttl: "PT10S"
       select:
-        ttl : "PT10S"
+        ttl: "PT10S"
       confirm:
-        ttl : "PT10S"
+        ttl: "PT10S"
       status:
-        ttl : "PT10S"
+        ttl: "PT10S"
       track:
-        ttl : "PT10S"
+        ttl: "PT10S"
       cancel:
-        ttl : "PT10S"
+        ttl: "PT10S"
       update:
-        ttl : "PT10S"
+        ttl: "PT10S"
       rating:
-        ttl : "PT10S"
+        ttl: "PT10S"
       support:
-        ttl : "PT10S"
+        ttl: "PT10S"
       get_cancellation_reasons:
-        ttl : "PT10S"
+        ttl: "PT10S"
       get_rating_categories:
-        ttl : "PT10S"
+        ttl: "PT10S"
       cancellation:
-        ttl : "PT10S"
+        ttl: "PT10S"
 
-    responses: 
+    responses:
       on_search:
         ttl: "PT15S"
       on_init:
@@ -99,8 +99,8 @@ app:
       cancellation_reasons:
         ttl: "PT10S"
       rating_categories:
-        ttl: "PT10S"          
-  
+        ttl: "PT10S"
+
   # Mandatory.
   privateKey: "PRIVATE_KEY"
   publicKey: "PUBLIC_KEY"
@@ -113,7 +113,7 @@ app:
   registryUrl: REGISTRY_URL
   auth: false
   uniqueKey: "BAP_SUBSCRIBER_ID_KEY"
-  
+
   # Mandatory.
   city: "std:080"
   country: "IND"
@@ -131,3 +131,6 @@ app:
     # In minutes
     syncInterval: 30
     redis_db: 3
+
+  useHMACForWebhook: false
+  sharedKeyForWebhookHMAC: ""