kvstore

README

KV Store

The key-values (KV) store is Veraison storage layer. It is used for both endorsements and trust anchors.

It is intentionally "dumb": we assume that the filtering smarts are provided by the plugins.

The key is a string synthesised deterministically from a structured endorsement / trustanchor "identifier". It is formatted according to a custom URI format -- see below).

The value is an array of JSON strings each containing an endorsement or trust anchor data associated with that key. The data is opaque to the KV store and varies depending on the attestation format. The only invariant enforced by the KV store is that it is valid JSON.

The IKVStore interface defines the required methods for storing, fetching and deleting KV objects. Note that (for the moment) there is no method for patching data in place. Interface methods for initialising and orderly terminating the underlying DB are also exposed.

This package contains two implementations of the IKVStore:

1. SQL, supporting different SQL engines (e.g., SQLite, PostgreSQL, etc. -- see below),
2. Memory, a thread-safe in-memory associative array intended for testing.

A New method can be used to create either of these from a Config object.

SQL drivers

To use a SQL backend the calling code needs to (anonymously) import the supporting driver.

For example, to use PostgreSQL:

import _ "github.com/lib/pq"

Instead, to use SQLite:

import _ "github.com/mattn/go-sqlite3"

SQL schemas

CREATE TABLE endorsement (
  key text NOT NULL,
  vals text NOT NULL
);

CREATE TABLE trustanchor (
  key text NOT NULL,
  vals text NOT NULL
);

URI format

scheme ":" authority path-absolute

where:

• scheme encodes the attestation format (e.g., "psa", "tcg-dice", "tpm-enacttrust", "open-dice", "tcg-tpm", etc.)
• authority encodes the tenant
• path-absolute encodes the parts of the key, identified positionally. Missing optional parts are encoded as empty path segments.

Attestation technology specific code (i.e., plugins) must provide their own synthesis functions.

Examples

PSA

• Trust Anchor ID
  • psa-iot://TenantID.Fmt()/ImplID.Fmt()/InstID.Fmt()`
• Software ID (Model is optional)
  • psa-iot://TenantID.Fmt()/ImplID.Fmt()/Model.Fmt()
  • psa-iot://TenantID.Fmt()/ImplID.Fmt()/

EnactTrust TPM

• Trust Anchor ID
  • tpm-enacttrust://TenantID.Fmt()/NodeID.Fmt()
• Software ID
  • tpm-enacttrust://TenantID.Fmt()/NodeID.Fmt()

Documentation

Overview

Copyright 2021 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2021-2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2021-2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2021-2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2021-2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Copyright 2021-2022 Contributors to the Veraison project. SPDX-License-Identifier: Apache-2.0

Index

• Constants
• Variables
• type Config
  • func (cfg Config) ReadVarString(directive string) (string, error)
• type IKVStore
  • func New(cfg Config) (IKVStore, error)
• type Memory
  • func (o *Memory) Add(key string, val string) error
  • func (o *Memory) Close() error
  • func (o *Memory) Del(key string) error
  • func (o Memory) Dump()
  • func (o Memory) Get(key string) ([]string, error)
  • func (o *Memory) Init(unused Config) error
  • func (o *Memory) Set(key string, val string) error
• type SQL
  • func (o SQL) Add(key string, val string) error
  • func (o *SQL) Close() error
  • func (o SQL) Del(key string) error
  • func (o SQL) Get(key string) ([]string, error)
  • func (o *SQL) Init(cfg Config) error
  • func (o SQL) Set(key string, val string) error

Constants

const (
	DirectiveSQLTableName      string = "sql_tablename"
	DirectiveSQLDriverName     string = "sql_driver"
	DirectiveSQLDataSourceName string = "sql_datasource"
)

SQL-specific directives use the "kvstore.sql_" namespace

const (
	DefaultTableName = "kvstore"
)

const (
	DirectiveBackend = "backend"
)

Common directives -- MUST NOT be reused by specialisations

Variables

var (
	ErrMissingDirective = errors.New("missing directive")
	ErrInvalidDirective = errors.New("invalidly specified directive")
)

Types

type Config

type Config map[string]interface{}

func (Config) ReadVarString

func (cfg Config) ReadVarString(directive string) (string, error)

type IKVStore

type IKVStore interface {
	Init(cfg Config) error
	Close() error
	Get(key string) ([]string, error)
	Set(key, val string) error
	Del(key string) error
	Add(key, val string) error
}

func New

func New(cfg Config) (IKVStore, error)

type Memory

type Memory struct {
	Data map[string][]string
}

func (*Memory) Add

func (o *Memory) Add(key string, val string) error

func (*Memory) Close

func (o *Memory) Close() error

func (*Memory) Del

func (o *Memory) Del(key string) error

func (Memory) Dump

func (o Memory) Dump()

func (Memory) Get

func (o Memory) Get(key string) ([]string, error)

func (*Memory) Init

func (o *Memory) Init(unused Config) error

func (*Memory) Set

func (o *Memory) Set(key string, val string) error

type SQL

type SQL struct {
	TableName string
	DB        *sql.DB
}

func (SQL) Add

func (o SQL) Add(key string, val string) error

func (*SQL) Close

func (o *SQL) Close() error

func (SQL) Del

func (o SQL) Del(key string) error

func (SQL) Get

func (o SQL) Get(key string) ([]string, error)

func (*SQL) Init

func (o *SQL) Init(cfg Config) error

func (SQL) Set

func (o SQL) Set(key string, val string) error