update on ondc-crypto-utility node js

.gitmodules

@@ -0,0 +1,15 @@
+[submodule "protocol-layer/python-based-protocol-layer"]
+	path = protocol-layer/python-based-buyer-app-side-protocol-layer
+	url = https://github.com/Open-network-for-digital-commerce/py-protocol-layer.git
+[submodule "protocol-layer/kotlin-based-buyer-app-side-protocol-layer"]
+	path = protocol-layer/kotlin-based-buyer-app-side-protocol-layer
+	url = https://github.com/beckn/biab-bap-protocol.git
+[submodule "server-side-clients/node-js-based-buyer-app-client"]
+	path = server-side-clients/node-js-based-buyer-app-client
+	url = https://github.com/Open-network-for-digital-commerce/biap-client-node-js.git
+[submodule "server-side-clients/kotlin-based-buyer-app-client"]
+	path = server-side-clients/kotlin-based-buyer-app-client
+	url = https://github.com/beckn/biab-bap-client.git
+[submodule "frontend-ui/frontend-react-js-based-buyer-app"]
+	path = frontend-ui/frontend-react-js-based-buyer-app
+	url = https://github.com/Open-network-for-digital-commerce/biap-app-ui-front.git

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ONDC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -67,5 +67,3 @@ c. Reference buyer app
 ## SwaggerHub links
 
 `https://app.swaggerhub.com/organizations/ONDC`
-
-

utilities/deep-links/android/AndroidManifest.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.Beckn_application"
+        tools:targetApi="31">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.Beckn_application">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+
+            <!-- Separate intent filter for the deep link -->
+            <intent-filter android:autoVerify="true">
+                <action android:name="android.intent.action.VIEW" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <category android:name="android.intent.category.BROWSABLE" />
+                <data android:scheme="beckn"
+                    android:host="ondc" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

utilities/deep-links/qr_code_generator/__init__.py

@@ -0,0 +1 @@
+from .core import generate_deep_link, generate_qr_code, bulk_read

utilities/deep-links/qr_code_generator/constants/mapping.py

@@ -0,0 +1,10 @@
+KEY_MAPPING = {
+    "bpp_id": "context.bpp_id",
+    "domain": "context.domain",
+    "provider_id": "message.intent.provider.id"
+}
+BASE_URL = "beckn://ondc"
+
+DEFAULT_PARAMS = {
+    "context.action": "search"
+}

utilities/deep-links/qr_code_generator/core.py

@@ -0,0 +1,86 @@
+import qrcode
+from PIL import Image
+import os
+import csv
+from qr_code_generator.constants import mapping
+
+
+
+
+def bulk_read(data_file, qr_data={}, qr_list = []):
+    with open(data_file, mode ='r', encoding='utf-8-sig') as file: 
+        csvFile = csv.DictReader(file)
+        for row in csvFile:
+            data = dict(row)
+            for key, value in data.items():
+                k = mapping.KEY_MAPPING[key]
+                qr_data[k] = value
+            qr_list.append(qr_data)
+    return qr_list
+
+#  Generate deep link
+def generate_deep_link(deep_link):
+    params = mapping.DEFAULT_PARAMS.copy()
+    params.update(deep_link)
+    query_string = '&'.join([f"{k}={v}" for k, v in params.items()])
+    # fallback_url = "https://google.com"
+    print(f"{mapping.BASE_URL}?{query_string}")
+    return f"{mapping.BASE_URL}?{query_string}"
+
+#  Generate QR code with deep link embedded
+
+def generate_qr_code(deep_link, output):
+    """
+    Generate a QR code from a given deep link.
+
+    Parameters:
+    - deep_link (str): The deep link to encode in the QR code.
+    - file_name (str): The name of the file to save the QR code image. Default is "qr_code.png".
+
+    Returns:
+    - None
+    """
+    try:
+        # load ONDC logo
+        logo_path = os.path.join(os.path.dirname(__file__), "assets/ondc-network-vertical.png")
+
+        # Create QR code with deep link embedded
+        qr = qrcode.QRCode(
+            # version=1,
+            error_correction=qrcode.constants.ERROR_CORRECT_H,
+            box_size=8,
+            border=4,
+        )
+        qr.add_data(deep_link)
+        qr.make(fit=True)
+
+        img = qr.make_image(fill_color="black", back_color="white")
+        qr_img = img.convert("RGBA")
+
+        # # Load the logo image
+        logo = Image.open(logo_path)
+        logo = logo.convert("RGBA")
+
+        # taking base width
+        basewidth = 150
+
+        # adjust image size
+        wpercent = (basewidth/float(logo.size[0]))
+        hsize = int((float(logo.size[1])*float(wpercent)))
+        logo = logo.resize((basewidth, hsize), Image.LANCZOS)
+
+        # # Calculate the position to center the logo on the QR code
+        logo_position = ((qr_img.size[0] - logo.size[0]) // 2, (qr_img.size[1] - logo.size[1]) // 2)
+
+        # # Paste the logo onto the QR code
+        qr_img.paste(logo, logo_position, logo)
+
+
+        qr_img.save(output)
+
+    except FileNotFoundError:
+        print(f"Logo file not found at: {logo_path}")
+        raise
+    except Exception as e:
+        print(f"Exception at: {e}")
+        raise

utilities/deep-links/qr_generate.py

@@ -0,0 +1,37 @@
+import argparse
+import json
+import os
+from qr_code_generator import generate_deep_link, generate_qr_code, bulk_read
+
+def generate_qr(query_string):
+    deep_link = generate_deep_link(query_string)
+    output_path = f"./qr_code_generator/output/{(query_string['context.bpp_id']).split('/')[0]}"
+    if not os.path.isdir(output_path):
+        os.makedirs(output_path, exist_ok=True)
+    output_path = f"{output_path}/{query_string['message.intent.provider.id']}.png"
+
+    generate_qr_code(deep_link, output_path)
+    return True
+
+try:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--data', type=str, help='JSON data')
+    parser.add_argument('--file', type=str, help='CSV file')
+
+    args = parser.parse_args()
+
+    if args.data:
+        query_string = json.loads(args.data)
+        generate_qr(query_string)
+    elif args.file:
+        for query_string in bulk_read(args.file):
+            generate_qr(query_string)
+    else:
+        parser.print_help()
+
+except json.JSONDecodeError:
+    print("Error: Invalid JSON input.")
+    raise
+except Exception as e:
+    print(f"An unexpected error occurred: {e}")
+    raise

utilities/deep-links/readme.md

@@ -0,0 +1,65 @@
+# Beckn Enabled Deep Links
+
+To facilitate seamless and standardized user interactions across digital ecosystems on ONDC, it is crucial to create a universally recognized and standardized "beckn" URI scheme, similar to what Unified Payments Interface (UPI), and WhatsApp, has achieved for major platforms like Web, Android and iOS, thus enhancing deep linking capabilities for entities using the Beckn protocol. Furthermore, the scheme should have easy integration and accessibility through software languages like Java, Python, among others.
+
+As the first use case, ONDC proposes to enable QR code (with deep link embedded) features for merchants facilitated by their respective BPPs (Seller Apps in this context).
+
+Please refer to the detailed [concept note](https://docs.google.com/document/d/17H8gpY1U2dRiZE6DccWYRh__BuVQ2kiMxEw5ZFJ7ULo/edit) on beckn enabled deep links, which details on the deep link schema and example use cases that could be enabled.
+
+## Steps for generating QR code:
+
+### Install dependencies:
+
+```bash
+pip3 install -r requirements.txt
+
+```
+
+**Usage - The utility can be used to generate singlw QR code or bulk QR codes.**
+
+### Generate Single QR code:
+
+Create query string for generating single QR code based on use case
+
+##### Catalog Access through Seller-Generated QR Codes
+
+```python
+query_string = {
+        "context.bpp_id": "webapi.magicpin.in",
+        "message.intent.provider.id": "P1",
+        "context.domain": "nic2004:52110"
+    }
+```
+
+##### Category-Specific Browsing via Seller-Generated QR Codes
+
+```python
+query_string = {
+        "context.bpp_id": "sellerapp.com",
+        "message.intent.provider.id": "P1",
+        "context.domain": "RET10",
+        "message.intent.category.id": "Foodgrains"
+    }
+```
+
+##### And so on for the rest of the use cases...
+
+**Run this utility**
+
+**Pass the query_string data as a data argument**
+
+```bash
+python3 qr_generate.py --data '{"context.bpp_id": "sellerapp.com", "message.intent.provider.id": "P1", "context.domain": "RET10", "message.intent.category.id": "Foodgrains"}'
+```
+
+### Generate Bulk QR codes:
+
+**Pass the csv file as a file argument**
+
+```bash
+python3 qr_generate.py --file data.csv
+```
+
+## Buyer App Platform Integration
+
+Different platforms have different handling mechanisms, for example, Android uses Intent Filters and iOS uses URL schemes or Universal links to identify which apps can handle which URI schemes or use fallback URLs to redirect the consumer to a fallback web URL, usually prompting them to download the relevant app. If multiple apps have registered the same URI scheme, it will either redirect to the default app or prompt the user to select the app they would like to use. Please refer [detailed guide](https://docs.google.com/document/d/1pmwQvF9G37_KwcFViub7m_qYDUjbGLrwvgkv1XZEc08/edit?usp=sharing) on implementation.

utilities/deep-links/requirements.txt

@@ -0,0 +1,2 @@
+qrcode==7.4.2
+Pillow==9.4.0

utilities/docs/allclasses-index.html

@@ -0,0 +1,76 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) on Thu Oct 20 15:50:28 IST 2022 -->
+<title>All Classes and Interfaces</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2022-10-20">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-classes-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="org/ondc/crypto/util/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="org/ondc/crypto/util/package-tree.html">Tree</a></li>
+<li><a href="index-files/index-1.html">Index</a></li>
+<li><a href="help-doc.html#all-classes">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
+</div>
+<div id="all-classes-table">
+<div class="caption"><span>Classes</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Class</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/ondc/crypto/util/CryptoFunctions.html" title="class in org.ondc.crypto.util">CryptoFunctions</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">The Class CryptoFunctions provides generation of key pairs for signing and encryption along with signing, verification, encryption and decryption.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/ondc/crypto/util/CryptoKeyPair.html" title="class in org.ondc.crypto.util">CryptoKeyPair</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">The Class CryptoKeyPair is used to store keypair</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/ondc/crypto/util/CryptoTest.html" title="class in org.ondc.crypto.util">CryptoTest</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">The Class CryptoTest is used to test ondc.crypto.util.CryptoFunctions</div>
+</div>
+</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>