summaryrefslogtreecommitdiffstats
path: root/office/unaesgcm/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/unaesgcm/README')
-rw-r--r--office/unaesgcm/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/office/unaesgcm/README b/office/unaesgcm/README
new file mode 100644
index 0000000000..b5c7649c9b
--- /dev/null
+++ b/office/unaesgcm/README
@@ -0,0 +1,18 @@
+unaesgcm is An AES-256-GCM de-/encryption utility specializing on
+`aesgcm`-scheme URLs as described in the [OMEMO media sharing XMPP
+extension (XEP-0454)](https://xmpp.org/extensions/xep-0454.html) and as
+implemented in modern XMPP clients. The latter meaning, in particular,
+that the initialization vector size is not restricted to 96 bits.
+
+The utility consists of:
+
+* `unaesgcm` command for decrypting local files;
+* `aesgcm-open` command for fetching URLs, decrypting and opening files
+ with associated applications;
+* a desktop entry handling `aesgcm` URLs using a GUI-friendly flavor of
+ the above command;
+* `aesgcm` command for encrypting local files that exists mostly for
+ symmetry.
+
+The utility is intended mainly for development/debugging, as the URLs
+with this scheme are supposed to be invisible to XMPP users, in ideal.