firewallo-sdk 1.0.1

package/README.md

@@ -0,0 +1,104 @@
+# Firewall SDK
+
+The `firewallb-sdk` is a JavaScript library designed to integrate with your web application to block malicious IPs and protect sensitive content. It validates user IP addresses against a firewall API and prevents unauthorized access.
+
+## Features
+
+- **IP Validation**: Validates whether a user's IP is blocked by the firewall API.
+- **ProtectedPage Component**: Wraps content and ensures that only authorized users can access it.
+- **Easy Setup**: Simple configuration through environment variables.
+
+## Installation
+
+To install the `firewallb-sdk`, use npm:
+
+### Using npm
+
+`npm install firewallb-sdk`
+
+---
+
+## Configuration & Usage
+
+### Step 1: Set Environment Variables
+
+Before using the `firewallb-sdk`, you need to configure your environment variables. These variables contain your API key and app ID, which are essential for connecting your app to the firewall service.
+
+In your project's root directory, create or update the `.env` file with the following configuration:
+
+```
+REACT_APP_FIREWALL_API_KEY="your-api-key"
+REACT_APP_FIREWALL_APP_ID="your-app-id"
+```
+
+- `REACT_APP_FIREWALL_API_KEY`: Your unique API key provided by the firewall service.
+- `REACT_APP_FIREWALL_APP_ID`: The app ID associated with your firewall service account.
+
+Ensure these variables are correctly set in your `.env` file. They will be used by the SDK to authenticate and make requests to the firewall service.
+
+### Important Notes:
+
+- The `REACT_APP_` prefix is required for environment variables to be accessible in React applications created with Create React App or Vite.
+- Do not commit your `.env` file to version control (e.g., Git) for security reasons. Add it to your `.gitignore` file.
+
+---
+
+### Step 2: Set Configuration in Your App
+
+Once the environment variables are set, configure the SDK using the `setConfig` function. This function will allow the SDK to access the firewall service with the provided API key and app ID.
+
+In your main app file (e.g., `App.js` or `App.jsx`), use the following code to configure the firewall SDK:
+
+```
+import React from "react";
+import { setConfig, ProtectedPage } from "firewallb-sdk";
+
+// Set the configuration for the firewall
+setConfig({
+  API_KEY: process.env.REACT_APP_FIREWALL_API_KEY,
+  APP_ID: process.env.REACT_APP_FIREWALL_APP_ID,
+});
+
+function App() {
+  return (
+    <div className="App">
+      <ProtectedPage>
+        <h1>Protected Content</h1>
+        <p>This content is protected by the firewall SDK.</p>
+      </ProtectedPage>
+    </div>
+  );
+}
+
+export default App;
+```
+
+This code will initialize the SDK with the API key and app ID from your environment variables.
+
+---
+
+### Step 3: Use `ProtectedPage` to Protect Content
+
+Once the SDK is configured, you can use the `ProtectedPage` component to protect content within your application. Here's how:
+
+```
+<ProtectedPage>
+  <h1>Protected Content</h1>
+  <p>This content is protected by the firewall SDK.</p>
+</ProtectedPage>
+```
+
+The `ProtectedPage` component ensures that only authorized users can access the content inside it, while unauthorized users will be blocked.
+
+---
+
+## Final Notes
+
+- Make sure to test your app after integration to ensure the firewall SDK is working as expected.
+- If you encounter any issues with the firewall or SDK setup, please check the API key and app ID in the environment variables.
+
+---
+
+This guide covers the basic steps to configure and use the `firewallb-sdk` in your React application. Let us know if you need further assistance!
+
+---

package/lib/api/firewallApi.js

@@ -0,0 +1,103 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateIP = exports.listenForTrafficUpdates = exports.disconnectWebSocket = exports.connectWebSocket = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _config = require("../config/config");
+var _socket = _interopRequireDefault(require("socket.io-client"));
+var _axios = _interopRequireDefault(require("axios"));
+// Import socket.io-client
+// Import axios for API requests
+
+// WebSocket setup for real-time monitoring
+var socket;
+var trafficUpdateCallback = null;
+var connectWebSocket = exports.connectWebSocket = function connectWebSocket() {
+  var _getConfig = (0, _config.getConfig)(),
+    FIREWALL_API_URL = _getConfig.FIREWALL_API_URL,
+    APP_ID = _getConfig.APP_ID,
+    API_KEY = _getConfig.API_KEY;
+  if (!socket) {
+    // Initialize WebSocket connection
+    socket = (0, _socket["default"])(FIREWALL_API_URL, {
+      query: {
+        apiKey: API_KEY,
+        // Include API Key
+        appId: APP_ID // Include App ID
+      }
+    });
+    socket.on("connect", function () {
+      console.log("Connected to WebSocket for real-time updates");
+    });
+    socket.on("traffic-update-".concat(APP_ID), function (data) {
+      console.log("Received real-time traffic update:", data);
+      if (trafficUpdateCallback) {
+        trafficUpdateCallback(data);
+      }
+    });
+    socket.on("ip-blocked", function (data) {
+      console.log("IP Blocked:", data);
+    });
+    socket.on("ip-unblocked", function (data) {
+      console.log("IP Unblocked:", data);
+    });
+    socket.on("disconnect", function () {
+      console.log("Disconnected from WebSocket");
+    });
+  }
+};
+
+// Function to disconnect WebSocket when it's no longer needed
+var disconnectWebSocket = exports.disconnectWebSocket = function disconnectWebSocket() {
+  if (socket) {
+    socket.disconnect();
+    socket = null;
+    console.log("WebSocket disconnected");
+  }
+};
+
+// Function to subscribe to traffic updates
+var listenForTrafficUpdates = exports.listenForTrafficUpdates = function listenForTrafficUpdates(callback) {
+  trafficUpdateCallback = callback;
+};
+
+// Function to validate IP using the firewall backend API
+var validateIP = exports.validateIP = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee(ip) {
+    var _getConfig2, FIREWALL_API_URL, APP_ID, API_KEY, response;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _getConfig2 = (0, _config.getConfig)(), FIREWALL_API_URL = _getConfig2.FIREWALL_API_URL, APP_ID = _getConfig2.APP_ID, API_KEY = _getConfig2.API_KEY;
+          _context.prev = 1;
+          _context.next = 4;
+          return _axios["default"].post("".concat(FIREWALL_API_URL, "/api/apps/").concat(APP_ID, "/validate-ip"), {
+            ip: ip
+          }, {
+            headers: {
+              "Content-Type": "application/json",
+              "x-api-key": API_KEY
+            }
+          });
+        case 4:
+          response = _context.sent;
+          return _context.abrupt("return", response.data);
+        case 8:
+          _context.prev = 8;
+          _context.t0 = _context["catch"](1);
+          console.error("Error in validateIP (firewallApi.js):", _context.t0);
+          throw _context.t0;
+        case 12:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[1, 8]]);
+  }));
+  return function validateIP(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();

package/lib/components/ProtectedPage.js

@@ -0,0 +1,83 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+var _firewallService = require("../services/firewallService");
+var _firewallApi = require("../api/firewallApi");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
+// Add WebSocket import
+
+var ProtectedPage = function ProtectedPage(_ref) {
+  var children = _ref.children;
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+    isBlocked = _useState2[0],
+    setIsBlocked = _useState2[1];
+  var _useState3 = (0, _react.useState)(true),
+    _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+    loading = _useState4[0],
+    setLoading = _useState4[1];
+  (0, _react.useEffect)(function () {
+    var validateIP = /*#__PURE__*/function () {
+      var _ref2 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
+        var blocked;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return (0, _firewallService.checkIP)();
+            case 3:
+              blocked = _context.sent;
+              setIsBlocked(blocked);
+              _context.next = 11;
+              break;
+            case 7:
+              _context.prev = 7;
+              _context.t0 = _context["catch"](0);
+              console.error("Error validating IP:", _context.t0);
+              setIsBlocked(false);
+            case 11:
+              _context.prev = 11;
+              setLoading(false);
+              return _context.finish(11);
+            case 14:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, null, [[0, 7, 11, 14]]);
+      }));
+      return function validateIP() {
+        return _ref2.apply(this, arguments);
+      };
+    }();
+
+    // Establish WebSocket connection for real-time updates
+    (0, _firewallApi.connectWebSocket)();
+
+    // Validate IP on load
+    validateIP();
+
+    // Cleanup WebSocket connection on component unmount
+    return function () {
+      (0, _firewallApi.disconnectWebSocket)();
+    };
+  }, []);
+  if (loading) {
+    return /*#__PURE__*/_react["default"].createElement("div", null, "Loading...");
+  }
+  if (isBlocked) {
+    return /*#__PURE__*/_react["default"].createElement("div", null, /*#__PURE__*/_react["default"].createElement("h1", null, "Access Denied"), /*#__PURE__*/_react["default"].createElement("p", null, "Your IP address has been blocked. Please contact support if you believe this is an error."));
+  }
+  return /*#__PURE__*/_react["default"].createElement("div", null, children);
+};
+var _default = exports["default"] = ProtectedPage;

package/lib/config/config.js

@@ -0,0 +1,22 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setConfig = exports.getConfig = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var config = {
+  FIREWALL_API_URL: "http://localhost:4000",
+  // Default API URL
+  API_KEY: "",
+  APP_ID: ""
+};
+var setConfig = exports.setConfig = function setConfig(newConfig) {
+  config = _objectSpread(_objectSpread({}, config), newConfig);
+};
+var getConfig = exports.getConfig = function getConfig() {
+  return config;
+};

package/lib/index.js

@@ -0,0 +1,45 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ProtectedPage", {
+  enumerable: true,
+  get: function get() {
+    return _ProtectedPage["default"];
+  }
+});
+Object.defineProperty(exports, "connectWebSocket", {
+  enumerable: true,
+  get: function get() {
+    return _firewallApi.connectWebSocket;
+  }
+});
+Object.defineProperty(exports, "disconnectWebSocket", {
+  enumerable: true,
+  get: function get() {
+    return _firewallApi.disconnectWebSocket;
+  }
+});
+Object.defineProperty(exports, "listenForTrafficUpdates", {
+  enumerable: true,
+  get: function get() {
+    return _firewallApi.listenForTrafficUpdates;
+  }
+});
+Object.defineProperty(exports, "setConfig", {
+  enumerable: true,
+  get: function get() {
+    return _config.setConfig;
+  }
+});
+var _ProtectedPage = _interopRequireDefault(require("./components/ProtectedPage"));
+var _config = require("./config/config");
+var _firewallApi = require("./api/firewallApi");
+// Import WebSocket functions
+
+// Optionally, connect WebSocket on initialization
+(0, _firewallApi.connectWebSocket)();
+
+// Export components and functions

package/lib/services/firewallService.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.checkIP = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _ipUtils = require("../utils/ipUtils");
+var _firewallApi = require("../api/firewallApi");
+// Import validateIP
+
+var checkIP = exports.checkIP = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var ip, result;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          _context.next = 3;
+          return (0, _ipUtils.getUserIP)();
+        case 3:
+          ip = _context.sent;
+          if (ip) {
+            _context.next = 6;
+            break;
+          }
+          throw new Error("Unable to fetch IP address.");
+        case 6:
+          _context.next = 8;
+          return (0, _firewallApi.validateIP)(ip);
+        case 8:
+          result = _context.sent;
+          return _context.abrupt("return", result.blocked);
+        case 12:
+          _context.prev = 12;
+          _context.t0 = _context["catch"](0);
+          console.error("Error checking IP:", _context.t0);
+          return _context.abrupt("return", false);
+        case 16:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 12]]);
+  }));
+  return function checkIP() {
+    return _ref.apply(this, arguments);
+  };
+}();

package/lib/utils/ipUtils.js

@@ -0,0 +1,40 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getUserIP = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var getUserIP = exports.getUserIP = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var response, data;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          _context.next = 3;
+          return fetch("https://api.ipify.org?format=json");
+        case 3:
+          response = _context.sent;
+          _context.next = 6;
+          return response.json();
+        case 6:
+          data = _context.sent;
+          return _context.abrupt("return", data.ip);
+        case 10:
+          _context.prev = 10;
+          _context.t0 = _context["catch"](0);
+          console.error("Error fetching user IP:", _context.t0);
+          return _context.abrupt("return", null);
+        case 14:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 10]]);
+  }));
+  return function getUserIP() {
+    return _ref.apply(this, arguments);
+  };
+}();

package/lib/validateIP.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateIP = validateIP;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _config = require("./config/config");
+var _axios = _interopRequireDefault(require("axios"));
+// Function to validate IP using axios
+function validateIP(_x) {
+  return _validateIP.apply(this, arguments);
+}
+function _validateIP() {
+  _validateIP = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee(ip) {
+    var _getConfig, FIREWALL_API_URL, APP_ID, API_KEY, response;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _getConfig = (0, _config.getConfig)(), FIREWALL_API_URL = _getConfig.FIREWALL_API_URL, APP_ID = _getConfig.APP_ID, API_KEY = _getConfig.API_KEY;
+          _context.prev = 1;
+          _context.next = 4;
+          return _axios["default"].post("".concat(FIREWALL_API_URL, "/api/apps/").concat(APP_ID, "/validate-ip"), {
+            ip: ip
+          }, {
+            headers: {
+              "Content-Type": "application/json",
+              "x-api-key": API_KEY
+            }
+          });
+        case 4:
+          response = _context.sent;
+          return _context.abrupt("return", response.data);
+        case 8:
+          _context.prev = 8;
+          _context.t0 = _context["catch"](1);
+          console.error("Error in validateIP (validateIP.js):", _context.t0);
+          throw _context.t0;
+        case 12:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[1, 8]]);
+  }));
+  return _validateIP.apply(this, arguments);
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "firewallo-sdk",
+    "version": "1.0.1",
+    "description": "Firewall SDK to protect web apps by validating IP addresses.",
+    "main": "lib/index.js",
+    "files": [
+        "lib"
+    ],
+    "module": "src/index.js",
+    "author": "SridharSolaris",
+    "license": "MIT",
+    "peerDependencies": {
+        "react": "^18.0.0",
+        "react-dom": "^18.0.0"
+    },
+    "scripts": {
+        "build": "babel src --out-dir lib",
+        "start": "babel src --out-dir lib --watch"
+    },
+    "devDependencies": {
+        "@babel/cli": "^7.26.4",
+        "@babel/plugin-transform-runtime": "^7.25.9",
+        "@babel/preset-env": "^7.26.7",
+        "@babel/preset-react": "^7.26.3"
+    },
+    "dependencies": {
+        "axios": "^1.7.9",
+        "socket.io-client": "^4.8.1"
+    }
+}