Overview

Users create KVDBs to organize collections where they can securely exchange encrypted data with designated participants. All the active users are notified right away when a new entry arrives, is modified, or anything within the KVDB changes.

All the data is stored in PrivMX Bridge and can be freely shared between its users.

Prerequisites

Before working with KVDBs, you need to have a PrivMX Bridge instance.

To install it, follow PrivMX quick start guide.

Architecture

Think of a KVDB as a simple key-value database that allows you to publish entries, which can include any binary as well as metadata. Each KVDB has its own set of permissions, managed by assigning the users’ public keys to the KVDB. Only the users with assigned public keys can read the entries posted in that KVDB. Decryption of these entries is possible only with the corresponding private keys.

Each entry is protected by a synchronous key, which is further secured using an asynchronous pair of public and private user keys. This dual-layer encryption ensures that the system remains both safe and efficient.

Learn more about our advanced encryption methods and how they safeguard your entries.

Entries in KVDBs

The main data units in KVDBs are entries, which contain binary data, as well as metadata.

• privateMeta - encrypted data about the entry
• publicMeta - decrypted additional data about the entry, with can be used ro advanced queries

Each entry also has information assigned by the Bridge.

To learn more about entries, go to Managing Entries.

Examples

• Simple, minimal examples A set of short code snippets showing you how to start interacting with PrivMX Endpoint Library.

  Github