hivemind-http-protocol 0.0.1__tar.gz

hivemind-http-protocol-0.0.1/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Casimiro Ferreira
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hivemind-http-protocol-0.0.1/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: hivemind-http-protocol
+Version: 0.0.1
+Summary: http network protocol for hivemind-core
+Home-page: https://github.com/JarbasHiveMind/hivemind-http-protocol
+Author: jarbasAi
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+License-File: LICENSE.md

hivemind-http-protocol-0.0.1/README.md

@@ -0,0 +1,158 @@
+# HiveMind HTTP Protocol
+
+The HiveMind HTTP Protocol provides an alternative REST-based implementation for message exchange in the HiveMind ecosystem. 
+
+
+---
+
+## Configuration
+
+This plugin integrates with the `hivemind-core` framework. It is not a standalone project, and its behavior is controlled by the `hivemind-core` configuration.
+
+To enable and configure the HiveMind HTTP Protocol, update the `network_protocol` entry in the `hivemind-core` configuration file. Below is an example configuration:
+
+```json
+"network_protocol": {
+    "hivemind-websocket-plugin": {
+        "host": "0.0.0.0",
+        "port": 5678
+    },
+    "hivemind-http-plugin": {
+        "host": "0.0.0.0",
+        "port": 5679
+    }
+}
+```
+
+---
+## Client Library
+
+
+```python
+from hivemind_bus_client.http_client import HiveMindHTTPClient, BinaryDataCallbacks
+from hivemind_bus_client.message import HiveMessage, HiveMessageType
+from ovos_bus_client.message import Message
+
+
+class BinaryDataHandler(BinaryDataCallbacks):
+    def handle_receive_tts(self, bin_data: bytes,
+                           utterance: str,
+                           lang: str,
+                           file_name: str):
+        # we can play it or save to file or whatever
+        print(f"got {len(bin_data)} bytes of TTS audio")
+        print(f"utterance: {utterance}", f"lang: {lang}", f"file_name: {file_name}")
+        # got 33836 bytes of TTS audio
+        # utterance: hello world lang: en-US file_name: 5eb63bbbe01eeed093cb22bb8f5acdc3.wav
+        
+# not passing key etc so it uses hivemind identity file for details
+client = HiveMindHTTPClient(host="http://localhost", port=5679,
+                            bin_callbacks=BinaryDataHandler())
+
+client.emit(HiveMessage(HiveMessageType.BUS,
+                        Message("speak:synth", {"utterance": "hello world"})))
+```
+
+---
+
+## REST API Documentation
+
+### Authentication
+
+Authentication is handled via an HTTP `authorization` parameter in the request. The value should be a Base64-encoded string in the format `useragent:access_key`.
+
+### Endpoints
+
+#### 1. Connect to the Server
+
+**Endpoint:** `/connect`  
+**Method:** `POST`
+
+**Request Parameters:**
+- `authorization` (string, mandatory): Base64-encoded `useragent:access_key`.
+
+**Response:**
+- `200 OK`: `{ "status": "Connected" }`
+- `400 Bad Request`: `{ "error": "Missing authorization" }`
+- `500 Internal Server Error`: `{ "error": "Connection failed" }`
+
+---
+
+#### 2. Disconnect from the Server
+
+**Endpoint:** `/disconnect`  
+**Method:** `POST`
+
+**Request Parameters:**
+- `authorization` (string, mandatory): Base64-encoded `useragent:access_key`.
+
+**Response:**
+- `200 OK`: `{ "status": "Disconnected" }`
+- `400 Bad Request`: `{ "error": "Missing authorization" }`
+- `500 Internal Server Error`: `{ "error": "Disconnection failed" }`
+
+---
+
+#### 3. Send a Message
+
+**Endpoint:** `/send_message`  
+**Method:** `POST`
+
+**Request Parameters:**
+- `authorization` (string, mandatory): Base64-encoded `useragent:access_key`.
+- `message` (string, mandatory): Encoded message payload.
+
+**Response:**
+- `200 OK`: `{ "status": "message sent" }`
+- `400 Bad Request`: `{ "error": "Missing message" }`
+- `500 Internal Server Error`: `{ "error": "Message sending failed" }`
+
+---
+
+#### 4. Retrieve Messages
+
+**Endpoint:** `/get_messages`  
+**Method:** `GET`
+
+**Request Parameters:**
+- `authorization` (string, mandatory): Base64-encoded `useragent:access_key`.
+
+**Response:**
+- `200 OK`: `{ "messages": ["message1", "message2"] }`
+- `400 Bad Request`: `{ "error": "Missing authorization" }`
+- `500 Internal Server Error`: `{ "error": "Failed to retrieve messages" }`
+
+---
+
+#### 5. Retrieve Binary Messages
+
+**Endpoint:** `/get_binary_messages`  
+**Method:** `GET`
+
+**Request Parameters:**
+- `authorization` (string, mandatory): Base64-encoded `useragent:access_key`.
+
+**Response:**
+- `200 OK`: `{ "messages": ["Base64Message1", "Base64Message2"] }`
+- `400 Bad Request`: `{ "error": "Missing authorization" }`
+- `500 Internal Server Error`: `{ "error": "Failed to retrieve messages" }`
+
+---
+
+## Notes
+
+- The `connect` and `disconnect` endpoints enable state management in scenarios where persistent connections are not feasible
+- Binary messages are Base64-encoded to ensure compatibility with REST APIs, which are text-based protocols.
+
+
+---
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request or open an issue for bug reports or feature requests.
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License. See the `LICENSE` file for more details.

hivemind-http-protocol-0.0.1/hivemind_http_protocol/__init__.py

@@ -0,0 +1,349 @@
+import asyncio
+import dataclasses
+import os
+import os.path
+import random
+from collections import defaultdict
+from queue import Queue
+from os import makedirs
+from os.path import exists, join
+from socket import gethostname
+from typing import Dict, Any, Optional, Tuple, Union
+
+import pybase64
+from OpenSSL import crypto
+from ovos_bus_client.session import Session
+from ovos_utils.log import LOG
+from ovos_utils.xdg_utils import xdg_data_home
+from tornado import ioloop
+from tornado import web
+from tornado.platform.asyncio import AnyThreadEventLoopPolicy
+
+from hivemind_bus_client.message import HiveMessageType
+from hivemind_core.protocol import (
+    HiveMindListenerProtocol,
+    HiveMindClientConnection,
+    HiveMindNodeType
+)
+from hivemind_plugin_manager.protocols import ClientCallbacks
+from hivemind_plugin_manager.protocols import NetworkProtocol
+from poorman_handshake import PasswordHandShake
+
+
+@dataclasses.dataclass
+class HiveMindHttpProtocol(NetworkProtocol):
+    """
+    HTTP handler for managing HiveMind client connections.
+
+    Attributes:
+        hm_protocol (Optional[HiveMindListenerProtocol]): The protocol instance for handling HiveMind messages.
+    """
+    config: Dict[str, Any] = dataclasses.field(default_factory=dict)
+    hm_protocol: Optional[HiveMindListenerProtocol] = None
+    callbacks: ClientCallbacks = dataclasses.field(default_factory=ClientCallbacks)
+
+    def run(self):
+        LOG.debug(f"HTTP server config: {self.config}")
+        asyncio.set_event_loop_policy(AnyThreadEventLoopPolicy())
+        HiveMindHttpHandler.hm_protocol = self.hm_protocol
+
+        ssl = self.config.get("ssl", False)
+        cert_dir: str = self.config.get("cert_dir") or f"{xdg_data_home()}/hivemind"
+        cert_name: str = self.config.get("cert_name") or "hivemind"
+        host = self.config.get("host", "0.0.0.0")
+        port = int(self.config.get("port", 5678))
+
+        routes = [
+            (r"/connect", ConnectHandler),
+            (r"/disconnect", DisconnectHandler),
+            (r"/send_message", SendMessageHandler),
+            (r"/get_messages", GetMessagesHandler),
+            (r"/get_binary_messages", GetBinMessagesHandler),
+        ]
+        application = web.Application(routes)
+        if ssl:
+            cert_file = f"{cert_dir}/{cert_name}.crt"
+            key_file = f"{cert_dir}/{cert_name}.key"
+            if not os.path.isfile(key_file):
+                LOG.info(f"Generating self-signed SSL certificate")
+                cert_file, key_file = self.create_self_signed_cert(cert_dir, cert_name)
+            LOG.debug("Using SSL key at " + key_file)
+            LOG.debug("Using SSL certificate at " + cert_file)
+            ssl_options = {"certfile": cert_file, "keyfile": key_file}
+            LOG.info(f"HTTPS listener started at port: {port}")
+            application.listen(port, host, ssl_options=ssl_options)
+        else:
+            LOG.info(f"HTTP listener started at port: {port}")
+            application.listen(port, host)
+
+        ioloop.IOLoop.current().start()
+
+    @staticmethod
+    def create_self_signed_cert(
+            cert_dir: str = f"{xdg_data_home()}/hivemind",
+            name: str = "hivemind"
+    ) -> Tuple[str, str]:
+        """
+        Create a self-signed certificate and key pair if they do not already exist.
+
+        Args:
+            cert_dir (str): The directory where the certificate and key will be stored.
+            name (str): The base name for the certificate and key files.
+
+        Returns:
+            Tuple[str, str]: The paths to the created certificate and key files.
+        """
+        cert_file = name + ".crt"
+        key_file = name + ".key"
+        cert_path = join(cert_dir, cert_file)
+        key_path = join(cert_dir, key_file)
+        makedirs(cert_dir, exist_ok=True)
+
+        if not exists(join(cert_dir, cert_file)) or not exists(join(cert_dir, key_file)):
+            # Create a key pair
+            k = crypto.PKey()
+            k.generate_key(crypto.TYPE_RSA, 2048)
+
+            # Create a self-signed certificate
+            cert = crypto.X509()
+            cert.get_subject().C = "PT"
+            cert.get_subject().ST = "Europe"
+            cert.get_subject().L = "Mountains"
+            cert.get_subject().O = "Jarbas AI"
+            cert.get_subject().OU = "Powered by HiveMind"
+            cert.get_subject().CN = gethostname()
+            cert.set_serial_number(random.randint(0, 2000))
+            cert.gmtime_adj_notBefore(0)
+            cert.gmtime_adj_notAfter(10 * 365 * 24 * 60 * 60)
+            cert.set_issuer(cert.get_subject())
+            cert.set_pubkey(k)
+            # TODO: Don't use SHA1
+            cert.sign(k, "sha1")
+
+            open(cert_path, "wb").write(crypto.dump_certificate(crypto.FILETYPE_PEM, cert))
+            open(key_path, "wb").write(crypto.dump_privatekey(crypto.FILETYPE_PEM, k))
+
+        return cert_path, key_path
+
+
+class HiveMindHttpHandler(web.RequestHandler):
+    """Base handler for HTTP requests."""
+    hm_protocol = None
+
+    # Class-level properties for managing client state and message queues
+    clients: Dict[str, HiveMindClientConnection] = {}
+    undelivered: Dict[str, Queue] = defaultdict(Queue)  # Non-binary messages
+    undelivered_bin: Dict[str, Queue] = defaultdict(Queue)  # Binary messages
+
+    def decode_auth(self):
+        auth = self.get_argument("authorization", "")
+        if not auth:
+            self.set_status(400)
+            return None, None
+        userpass_encoded = bytes(auth, encoding="utf-8")
+        userpass_decoded = pybase64.b64decode(userpass_encoded).decode("utf-8")
+        return userpass_decoded.split(":")
+
+    def get_client(self, useragent, key, cache=True) -> Optional[HiveMindClientConnection]:
+        if cache and key in self.clients:
+            return self.clients[key]
+
+        def do_send(payload: Union[bytes, str], is_bin: bool):
+            if is_bin:
+                payload = pybase64.b64encode(payload).decode("utf-8")
+                self.undelivered_bin[key].put(payload)
+            else:
+                self.undelivered[key].put(payload)
+
+        def do_disconnect():
+            if key in self.undelivered:
+                self.undelivered.pop(key)
+            if key in self.clients:
+                self.clients.pop(key)
+
+        client = HiveMindClientConnection(
+            key=key,
+            disconnect=do_disconnect,
+            send_msg=do_send,
+            sess=Session(session_id="default"),  # will be re-assigned once client sends handshake
+            name=useragent,
+            hm_protocol=self.hm_protocol
+        )
+        self.hm_protocol.db.sync()
+        user = self.hm_protocol.db.get_client_by_api_key(key)
+        if not user:
+            LOG.error("Client provided an invalid Access key")
+            self.hm_protocol.handle_invalid_key_connected(client)
+            return None
+
+        client.name = f"{useragent}::{user.client_id}::{user.name}"
+        client.crypto_key = user.crypto_key
+        client.msg_blacklist = user.message_blacklist or []
+        client.skill_blacklist = user.skill_blacklist or []
+        client.intent_blacklist = user.intent_blacklist or []
+        client.allowed_types = user.allowed_types
+        client.can_propagate = user.can_propagate
+        client.can_escalate = user.can_escalate
+        client.is_admin = user.is_admin
+        if user.password:
+            # pre-shared password to derive aes_key
+            client.pswd_handshake = PasswordHandShake(user.password)
+
+        client.node_type = HiveMindNodeType.NODE  # TODO . placeholder
+        if cache:
+            self.clients[key] = client
+        return client
+
+
+class ConnectHandler(HiveMindHttpHandler):
+    async def post(self):
+        try:
+            useragent, key = self.decode_auth()
+            if not key:
+                self.write({"error": "Missing authorization"})
+                return
+
+            client = self.get_client(useragent, key)
+
+            if (
+                    not client.crypto_key
+                    and not self.hm_protocol.handshake_enabled
+                    and self.hm_protocol.require_crypto
+            ):
+                LOG.error(
+                    "No pre-shared crypto key for client and handshake disabled, "
+                    "but configured to require crypto!"
+                )
+                # clients requiring handshake support might fail here
+                self.hm_protocol.handle_invalid_protocol_version(client)
+                return
+
+            self.hm_protocol.handle_new_client(client)
+            self.write({"status": "Connected"})
+        except Exception as e:
+            LOG.error(f"Connection failed: {e}")
+            self.set_status(500)
+            self.write({"error": "Connection failed"})
+
+
+class DisconnectHandler(HiveMindHttpHandler):
+    async def post(self):
+
+        try:
+            useragent, key = self.decode_auth()
+            if not key:
+                self.write({"error": "Missing authorization"})
+                return
+            if key in HiveMindHttpHandler.clients:
+                client = self.get_client(useragent, key)
+                LOG.info(f"disconnecting client: {client.peer}")
+                self.hm_protocol.handle_client_disconnected(client)
+                self.write({"status": "Disconnected"})
+            else:
+                self.write({"error": "Already Disconnected"})
+        except Exception as e:
+            LOG.error(f"Disconnection failed: {e}")
+            self.set_status(500)
+            self.write({"error": "Disconnection failed"})
+
+
+class SendMessageHandler(HiveMindHttpHandler):
+    async def post(self):
+        try:
+            useragent, key = self.decode_auth()
+            if not key:
+                self.write({"error": "Missing authorization"})
+                return
+            # refuse if connect wasnt called first
+            if key not in HiveMindHttpHandler.clients:
+                self.write({"error": "Client is not connected"})
+                return
+
+            client = self.get_client(useragent, key)
+
+            message = self.get_argument("message", "")
+            if not message:
+                self.set_status(400)
+                self.write({"error": "Missing message"})
+                return
+
+            message = client.decode(message)
+            if (
+                    message.msg_type == HiveMessageType.BUS
+                    and message.payload.msg_type == "recognizer_loop:b64_audio"
+            ):
+                LOG.info(f"Received {client.peer} sent base64 audio for STT")
+            else:
+                LOG.info(f"Received {client.peer} message: {message}")
+            self.hm_protocol.handle_message(message, client)
+
+            self.write({"status": "message sent"})
+        except Exception as e:
+            LOG.error(f"Message sending failed: {e}")
+            self.set_status(500)
+            self.write({"error": "Message sending failed"})
+
+
+class GetMessagesHandler(HiveMindHttpHandler):
+
+    async def get(self):
+        try:
+            useragent, key = self.decode_auth()
+            if not key:
+                self.write({"error": "Missing authorization"})
+                return
+
+            # refuse if connect wasnt called first
+            if key not in HiveMindHttpHandler.clients:
+                self.write({"error": "Client is not connected"})
+                return
+
+            messages = []
+            queue = HiveMindHttpHandler.undelivered[key]
+
+            # Retrieve all messages from the queue
+            while not queue.empty():
+                try:
+                    message = queue.get_nowait()
+                    messages.append(message)
+                except Exception as e:
+                    # Handle unexpected errors (unlikely with get_nowait)
+                    break
+            self.write({"status": "messages retrieved", "messages": messages})
+        except Exception as e:
+            LOG.error(f"Retrieving messages failed: {e}")
+            self.set_status(500)
+            self.write({"error": "Retrieving messages failed"})
+
+
+class GetBinMessagesHandler(HiveMindHttpHandler):
+
+    async def get(self):
+        try:
+            useragent, key = self.decode_auth()
+            if not key:
+                self.write({"error": "Missing authorization"})
+                return
+
+            # refuse if connect wasnt called first
+            if key not in HiveMindHttpHandler.clients:
+                self.write({"error": "Client is not connected"})
+                return
+
+            messages = []
+            queue = HiveMindHttpHandler.undelivered_bin[key]
+
+            # Retrieve all messages from the queue
+            while not queue.empty():
+                try:
+                    message = queue.get_nowait()
+                    messages.append(message)
+                except Exception as e:
+                    # Handle unexpected errors (unlikely with get_nowait)
+                    break
+
+            self.write({"status": "messages retrieved", "b64_messages": messages})
+        except Exception as e:
+            LOG.error(f"Retrieving messages failed: {e}")
+            self.set_status(500)
+            self.write({"error": "Retrieving messages failed"})

hivemind-http-protocol-0.0.1/hivemind_http_protocol/version.py

@@ -0,0 +1,6 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: hivemind-http-protocol
+Version: 0.0.1
+Summary: http network protocol for hivemind-core
+Home-page: https://github.com/JarbasHiveMind/hivemind-http-protocol
+Author: jarbasAi
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+License-File: LICENSE.md

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+setup.py
+hivemind_http_protocol/__init__.py
+hivemind_http_protocol/version.py
+hivemind_http_protocol.egg-info/PKG-INFO
+hivemind_http_protocol.egg-info/SOURCES.txt
+hivemind_http_protocol.egg-info/dependency_links.txt
+hivemind_http_protocol.egg-info/entry_points.txt
+hivemind_http_protocol.egg-info/requires.txt
+hivemind_http_protocol.egg-info/top_level.txt

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[hivemind.network.protocol]
+hivemind-http-plugin = hivemind_http_protocol:HiveMindHttpProtocol

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/requires.txt

@@ -0,0 +1,4 @@
+tornado
+hivemind-plugin-manager
+poorman_handshake>=0.1.0
+pyOpenSSL

hivemind-http-protocol-0.0.1/hivemind_http_protocol.egg-info/top_level.txt

@@ -0,0 +1 @@
+hivemind_http_protocol

hivemind-http-protocol-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hivemind-http-protocol-0.0.1/setup.py

@@ -0,0 +1,55 @@
+import os
+from setuptools import setup
+
+BASEDIR = os.path.abspath(os.path.dirname(__file__))
+
+
+def get_version():
+    """ Find the version of the package"""
+    version_file = os.path.join(BASEDIR, 'hivemind_http_protocol', 'version.py')
+    major, minor, build, alpha = (None, None, None, None)
+    with open(version_file) as f:
+        for line in f:
+            if 'VERSION_MAJOR' in line:
+                major = line.split('=')[1].strip()
+            elif 'VERSION_MINOR' in line:
+                minor = line.split('=')[1].strip()
+            elif 'VERSION_BUILD' in line:
+                build = line.split('=')[1].strip()
+            elif 'VERSION_ALPHA' in line:
+                alpha = line.split('=')[1].strip()
+
+            if ((major and minor and build and alpha) or
+                    '# END_VERSION_BLOCK' in line):
+                break
+    version = f"{major}.{minor}.{build}"
+    if int(alpha) > 0:
+        version += f"a{alpha}"
+    return version
+
+
+def required(requirements_file):
+    """ Read requirements file and remove comments and empty lines. """
+    with open(os.path.join(BASEDIR, requirements_file), 'r') as f:
+        requirements = f.read().splitlines()
+        if 'MYCROFT_LOOSE_REQUIREMENTS' in os.environ:
+            print('USING LOOSE REQUIREMENTS!')
+            requirements = [r.replace('==', '>=').replace('~=', '>=') for r in requirements]
+        return [pkg for pkg in requirements
+                if pkg.strip() and not pkg.startswith("#")]
+
+
+PLUGIN_ENTRY_POINT = 'hivemind-http-plugin=hivemind_http_protocol:HiveMindHttpProtocol'
+
+setup(
+    name='hivemind-http-protocol',
+    version=get_version(),
+    packages=['hivemind_http_protocol'],
+    url='https://github.com/JarbasHiveMind/hivemind-http-protocol',
+    license='Apache-2.0',
+    author='jarbasAi',
+    install_requires=required("requirements.txt"),
+    entry_points={'hivemind.network.protocol': PLUGIN_ENTRY_POINT},
+    author_email='jarbasai@mailfence.com',
+    description='http network protocol for hivemind-core'
+)