Home

This document provides a technical specification about how microkv is designed and implemented.

Before reading, consider a look at the Threat Model document to understand the types of attacks that microkv aim to mitigate against, and the security invariants that are upheld.

Technical Description

What microkv Is

microkv is a minimal security-focused key-value store, which enables users and developers to store key-value pairs in a persistent and secured state. microkv is implemented such that key-value pairs can index not only primitive types, but also well-formed, serializable structured types, making them an appealing alternative for database implementations that are strict with how data is persisted (ie with tables).

microkv is comprised of a base library, which enables developers to implement alongside their application. microkv also supports a proof-of-concept CLI application that enables a user to interact with it via their command line.

What microkv Isn't

microkv is not a replacement for relational databases, or even many of the industry-grade key-value store implementations out there. Relational / SQL-based database implementations often are much more feature-rich, and rely on an ACID-based transactional model that a key-value store may not adhere to.