From 06e61bff2e1e245b3e23c57e0a65e1a2c4b016e0 Mon Sep 17 00:00:00 2001
From: Alexandre Dulaunoy <a@foo.be>
Date: Wed, 10 Jul 2019 08:44:15 +0200
Subject: [PATCH] chg: [doc] back-end data format added

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 7369104..772d420 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ This is a work-in-progress to solve specific problems in security and informatio
 - Standard HKP interface with `add` method disabled
 - Simple interface to filter out known malicious or rogue PGP keys
 - Fast and reliable
+- Simple namespace to group keys in a set of known members (e.g. CSIRT, MISP sharing group, organisation)
 
 # Requirements
 
@@ -21,4 +22,20 @@ This is a work-in-progress to solve specific problems in security and informatio
 - Python 3.6
 - [Pgpy](https://github.com/SecurityInnovation/PGPy)
 - redis python library
+- Flask
+
+## Back-end format (ardb)
+
+| key type   | key name         | values              |
+|------------|------------------|---------------------|
+|   k/v      |  k:<fingerprint> | armored PGP key     |
+|   set      |  n:<namespace>   | set of fingerprints |
+|   set      |  un:<uid-name>   | set of fingerprints |
+|   set      |  uc:<uid-name>   | set of fingerprints |
+|   set      |  ue:<uid-name>   | set of fingerprints |
+
+
+- un -> name in the UID
+- uc -> comment in the UID
+- ue -> email in the UID