Skip to content

README.md

Latest commit

 

History

History
284 lines (192 loc) · 6.02 KB

README.md

File metadata and controls

284 lines (192 loc) · 6.02 KB
Raw

✨ Kitty Protocol x Meowssenger ✨

Kitty Logo      Kitty Protocol

Cute • Secure • Decentralized Messaging 🐾

A lightweight, secure and modern messenger powered by a custom QUIC + E2EE protocol.

en pl

About the Project

What is Kitty Protocol?

Kitty Protocol is a custom, lightweight and secure communication protocol designed for fast, private exchange of text messages.

Meowssenger follows a Client–Server architecture where the central Hub acts purely as a router:

  • 🚫 stores no message history,
  • 🔐 has no access to user keys,
  • 🛡️ cannot read message contents.

The project was designed with a strong focus on:

  • privacy,
  • performance,
  • security,
  • modern networking technologies.

Execution instruction

Available in file: INSTRUCTION.md

Project Architecture

Component Description
🐈 Hub QUIC/TLS 1.3 Router
💻 CLI Client Terminal-based protocol client
🎨 GUI Client Desktop application built with Go + Fyne

Hub (Server)

The central component of the infrastructure:

  • QUIC + TLS 1.3 transport,
  • session management,
  • authentication and registration,
  • encrypted frame routing,
  • rate limiting,
  • replay protection,
  • zero access to message content.

CLI Client

Modern terminal-based client:

  • full protocol support,
  • colorful logs,
  • fast command system,
  • ideal for debugging,
  • lightweight and efficient.

Available Commands

/status <user>
/secret <user>
/chat <user> 
/accept <user>
/refuse <user>
/msg <text>
/end
/logout
/menu
/help

🎨 GUI Client (Fyne)

Desktop application built with Go + Fyne.

GUI Features

  • ✨ modern user interface,
  • 🔐 authentication screen,
  • 💬 chat view,
  • 🎨 custom Pink Theme,
  • 📦 embedded fonts and assets,
  • ⚡ native performance.

Key Features

Feature Description
🔐 E2EE End-to-End Encryption
⚡ QUIC Low-latency modern transport
🧩 JSON Frames Human-readable frame structure
🛡️ Replay Protection Protection against replay attacks
🔑 TOFU Trust On First Use
🚀 TLS 1.3 Secure transport encryption

Technologies

📂 Project Structure

gui_src/
 ├── main.go
 ├── resources/
 ├── state/
 ├── theme/
 └── views/

📚 Documentation

Full protocol documentation:

KittyProtocol-EN.pdf

Includes:

  • protocol architecture,
  • flow diagrams,
  • security model,
  • frame definitions,
  • communication scenarios,
  • QUIC transport design.

☁️ Azure Hub Deployment

Quick Start

1️⃣ Create a VM

Ubuntu 22.04 (B1s)

2️⃣ Open UDP Port

9999/UDP

3️⃣ Configure Environment Variables

export KITTY_DB_DSN="postgres://kitty:kittypass@localhost:5432/kittyhub?sslmode=disable"

export KITTY_INTERCEPT_ADDR="0.0.0.0:9999"

4️⃣ Run the Hub

go run ./cmd/hub

Full deployment guide available here

👥 Authors

Author GitHub
Gabriela Błaut @gabbla05
Michał Brzeziński @Michal-Brzezinski
Aleksandra Gołek @styliana

📄 License

This project is distributed under the MIT License.

Leave a star if you like the project! ⭐

Made with 💖 by Kitty Protocol Team