Go language client library for e3db
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmd/e3db
example
registration_example
.gitignore
.travis.yml
Dockerfile
LICENSE.md
README.md
build.sh
client.go
client_integration_test.go
config.go
crypto.go
glide.lock
glide.yaml
query.go
travis-install-configfile.sh

README.md

Build Status Coverage Status

Overview

The Tozny End-to-End Encrypted Database (E3DB) is a storage platform with powerful sharing and consent management features. Read more on our blog.

E3DB provides a familiar JSON-based NoSQL-style API for reading, writing, and querying data stored securely in the cloud.

This repository contains a client library and command-line tool E3DB.

Build Prerequisites

e3db uses Glide for dependency management. For more information and installation instructions, see the Glide Web Site. Binaries for many platforms can be downloaded from the GitHub Releases Page.

Command-Line Interface

The E3DB command-line interface (CLI) is a powerful tool for administrating and interacting with the E3DB service. Binary releases for many platforms are available from this project's Releases page.

Building the CLI

To build a local version of the command-line interface, check out the sources into the appropriate location within $GOPATH, install dependencies using Glide, and build the github.com/tozny/e3db/cmd/e3db package:

git clone https://github.com/tozny/e3db-go $GOPATH/src/github.com/tozny/e3db-go
cd $GOPATH/src/github.com/tozny/e3db-go
glide install
go install ./cmd/e3db

Client Library

Installation

If your project uses Glide for managing dependencies and reproducible builds, add the E3DB client library to your glide.yaml by running:

$ glide get github.com/tozny/e3db-go

If you aren't using Glide and want to depend on the latest version of E3DB, check out the repository to the correct location within $GOPATH and install dependencies using Glide.

git clone https://github.com/tozny/e3db-go $GOPATH/src/github.com/tozny/e3db-go
cd $GOPATH/src/github.com/tozny/e3db-go
glide install

Registering a client

Register an account with InnoVault to get started. From the Admin Console you can create clients directly (and grab their credentials from the console) or create registration tokens to dynamically create clients with e3db.RegisterClient(). Clients registered from within the console will automatically back their credentials up to your account. Clients created dynamically via the SDK can optionally back their credentials up to your account.

For a more complete walkthrough, see /registration_example/registration.go.

Without Credential Backup

token := ""
client_name := ""

public_key, private_key, _ := e3db.GenerateKeyPair()
client_info, _ := e3db.RegisterClient(token, client_name, public_key, "", false, "https://api.e3db.com")

The object returned from the server contains the client's UUID, API key, and API secret (as well as echos back the public key passed during registration). It's your responsibility to store this information locally as it will not be recoverable without credential backup.

With Credential Backup

token := ""
client_name := ""

public_key, private_key, _ := e3db.GenerateKeyPair()
client_info, _ := e3db.RegisterClient(token, client_name, public_key, private_key, true, "https://api.e3db.com")

The private key must be passed to the registration handler when backing up credentials as it is used to cryptographically sign the encrypted backup file stored on the server. The private key never leaves the system, and the stored credentials will only be accessible to the newly-registered client itself or the account with which it is registered.

Usage

Here is some simple example code to connect and list records:

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/tozny/e3db-go"
)

func main() {
	client, err := e3db.GetDefaultClient()
	if err != nil {
		fmt.Fprint(os.Stderr, err)
		return
	}

	cursor := client.Query(context.Background(), e3db.Q{})
	for {
		record, err := cursor.Next()
		if err == e3db.Done {
			break
		} else if err != nil {
			log.Fatal(err)
		}
		fmt.Println(record.Meta.RecordID)
	}
}

Reading and Writing Records

To write new records to the database, first create a blank record of the correct type with NewRecord. Then fill in the fields of the record's Data field. Finally, write the record to the database with Write, which returns the unique ID of the newly created record.

record := client.NewRecord("contact")
record.Data["first_name"] = "Jon"
record.Data["last_name"]  = "Snow"
record.Data["phone"]      = "555-555-1212"
recordID, err := client.Write(context.Background(), record)
fmt.Println("Wrote record: " + recordID)
// Read it back out:
newRecord, err := client.Read(context.Background(), recordID)
fmt.Println (newRecord.Data["first_name"])

Documentaton

Comprehensive documentation for the SDK can be found online via GoDoc.