1 files changed, 50 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..02695fb
--- /dev/null
+++ b/README
@@ -0,0 +1,50 @@
+GNUPG over web
+
+Copyright (C) 2023 Salahuddin <salahuddin@member.fsf.org>
+
+It allows user to use gnupg over plain web.
+===========================================
+
+   user    ---------- public key ---------------->
+                                                 |  webserver
+                                                 v
+   user    <-----HTTP data with GNUPG tag(s)------
+
+
+   browser -------- encrypted data -------------->
+                                                 | local websocket
+                                                 v (gpg_websocket.py)
+   browser <------- plain text data --------------
+
+
+Example:
+
+1. users browser receive the following data.
+
+"
+<!DOCTYPE html>
+function myFunction() {
+   const socket = new WebSocket("ws://localhost:8765");
+   // send data to local websocket to decrypt
+   // and place plain text locally
+}
+<body onload="myFunction();">
+...
+<div class="GNUPG_OVER_WEB">
+-----BEGIN PGP MESSAGE-----
+hQGMAyJ3PpkRYGT1AQv7BTx9T8PpK8kFB5UYfcuhkuvWN1AixXE+12UniO7aRAXz
+...
+-----END PGP MESSAGE-----
+</div>
+</body>
+</html>
+"
+
+2. web browser will send encrypted data to local websocket server "gpg_websocket.py".
+Local websocket server will decrypt send back plain text data.
+
+3. browser view.
+
+<div class="GPG_OVER_WEB">
+plain text content.
+</div>