models

Documentation

Index

• type DataVaultConfiguration
• type EncryptedDocument
• type IDTypePair
• type IndexedAttribute
• type IndexedAttributeCollection
• type Query
• type StructuredDocument

Types

type DataVaultConfiguration

type DataVaultConfiguration struct {
	Sequence    int        `json:"sequence"`
	Controller  string     `json:"controller"`
	Invoker     string     `json:"invoker"`
	Delegator   string     `json:"delegator"`
	ReferenceID string     `json:"referenceId"`
	KEK         IDTypePair `json:"kek"`
	HMAC        IDTypePair `json:"hmac"`
}

DataVaultConfiguration represents a Data Vault Configuration.

type EncryptedDocument

type EncryptedDocument struct {
	ID                          string                       `json:"id"`
	Sequence                    int                          `json:"sequence"`
	IndexedAttributeCollections []IndexedAttributeCollection `json:"indexed"`
	JWE                         json.RawMessage              `json:"jwe"`
}

EncryptedDocument represents an Encrypted Document.

type IDTypePair

type IDTypePair struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

IDTypePair represents an ID+type pair.

type IndexedAttribute

type IndexedAttribute struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Unique bool   `json:"unique"`
}

IndexedAttribute represents a single indexed attribute.

type IndexedAttributeCollection

type IndexedAttributeCollection struct {
	Sequence          int                `json:"sequence"`
	HMAC              IDTypePair         `json:"hmac"`
	IndexedAttributes []IndexedAttribute `json:"attributes"`
}

IndexedAttributeCollection represents a collection of indexed attributes, all of which share a common MAC algorithm and key.

type Query

type Query struct {
	Name  string `json:"index"`
	Value string `json:"equals"`
}

Query represents a name+value pair that can be used to query the encrypted indices for specific data.

type StructuredDocument

type StructuredDocument struct {
	ID      string                 `json:"id"`
	Meta    map[string]interface{} `json:"meta"`
	Content map[string]interface{} `json:"content"`
}

StructuredDocument represents a Structured Document.