keytranspraency

package module
v0.0.0-...-e557385 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

README

Key Transparency

Build Status Go Report Card GoDoc

Key Transparency Logo

Key Transparency provides a lookup service for generic records and a public, tamper-proof audit log of all record changes. While being publicly auditable, individual records are only revealed in response to queries for specific IDs.

Key Transparency can be used as a public key discovery service to authenticate users and provides a mechanism to keep the service accountable. It can be used by account owners to reliably see what keys have been associated with their account, and it can be used by senders to see how long an account has been active and stable before trusting it.

Key Transparency is inspired by CONIKS and Certificate Transparency. It is a work-in-progress with the following milestones under development.

Key Transparency Client

Setup
  1. Install Go 1.9.
  2. go get -u github.com/google/keytransparency/cmd/keytransparency-client
  3. Get an OAuth client ID and download the generated JSON file to client_secret.json.
Client operations
Generate a private key
keytransparency-client authorized-keys create-keyset -p password
keytransparency-client authorized-keys list-keyset -p password
Publish the public key
keytransparency-client post user@domain.com app1 --client-secret=client_secret.json --insecure -d 'dGVzdA==' #Base64
Get and verify a public key
keytransparency-client get <email> <app> --insecure --verbose
✓ Commitment verified.
✓ VRF verified.
✓ Sparse tree proof verified.
✓ Signed Map Head signature verified.
CT ✓ STH signature verified.
CT ✓ Consistency proof verified.
CT   New trusted STH: 2016-09-12 15:31:19.547 -0700 PDT
CT ✓ SCT signature verified. Saving SCT for future inclusion proof verification.
✓ Signed Map Head CT inclusion proof verified.
keys:<key:"app1" value:"test" >
Verify key history
keytransparency-client history <email> --insecure
Epoch |Timestamp                    |Profile
4     |Mon Sep 12 22:23:54 UTC 2016 |keys:<key:"app1" value:"test" >

Running the server

Install
  1. OpenSSL
  2. Docker
    • Docker Engine 1.13.0+ docker version -f '{{.Server.APIVersion}}'
    • Docker Compose 1.11.0+ docker-compose --version
  3. go get -u github.com/google/keytransparency/...
  4. go get -u github.com/google/trillian/...
  5. ./scripts/prepare_server.sh -f
Run
  1. Run Key Transparency
$ docker-compose up -d
Creating keytransparency_db_1 ...         done
Creating keytransparency_map_server_1 ... done
Creating keytransparency_log_server_1 ... done
Creating keytransparency_log_server_1 ... done
Creating keytransparency_server_1 ...     done
Creating keytransparency_sequencer_1 ...  done
Creating keytransparency_monitor_1 ...    done
Creating keytransparency_init_1 ...       done
Creating keytransparency_prometheus_1 ... done
Creating keytransparency_monitor_1 ...    done
  1. Watch it Run

Development and Testing

Key Transparency and its Trillian backend use a MySQL database, which must be setup in order for the Key Transparency tests to work.

Support

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

View all Source files

Directories

Path Synopsis
cmd
gen-test-vectors command
keytransparency-client command
keytransparency-client/cmd
keytransparency-delegate command
Package main is a delegate server that can be used to (a) create user accounts.
 Package main is a delegate server that can be used to (a) create user accounts.
keytransparency-monitor command
keytransparency-sequencer command
keytransparency-server command
serverutil
core
adminserver
Package adminserver contains the KeyTransparencyAdmin implementation
 Package adminserver contains the KeyTransparencyAdmin implementation
api
api/monitor/v1/monitor_go_proto
Package monitor_go_proto is a generated protocol buffer package.
 Package monitor_go_proto is a generated protocol buffer package.
api/type/type_go_proto
Package type_go_proto is a generated protocol buffer package.
 Package type_go_proto is a generated protocol buffer package.
api/usermanager/v1/usermanager_go_proto
Package usermanager_go_proto is a generated protocol buffer package.
 Package usermanager_go_proto is a generated protocol buffer package.
api/v1/keytransparency_go_proto
Package keytransparency_go_proto is a reverse proxy.
 Package keytransparency_go_proto is a reverse proxy.
authentication
Package authentication implements authentication mechanisms.
 Package authentication implements authentication mechanisms.
authorization
Package authorization defines the authorization interface of Key Transparency.
 Package authorization defines the authorization interface of Key Transparency.
client
Package client is a client for communicating with the Key Server.
 Package client is a client for communicating with the Key Server.
client/gobindclient
Package gobindclient contains a gobind friendly implementation of a KeyTransparency Client able to make GetEntry requests to a KT server and verify the soundness of the responses.
 Package gobindclient contains a gobind friendly implementation of a KeyTransparency Client able to make GetEntry requests to a KT server and verify the soundness of the responses.
client/hammer
Package hammer sends multiple requests to Key Transparency at the same time.
 Package hammer sends multiple requests to Key Transparency at the same time.
client/multi
Package multi contains utilities for multiplexing io operations.
 Package multi contains utilities for multiplexing io operations.
crypto/commitments
Package commitments implements a cryptographic commitment.
 Package commitments implements a cryptographic commitment.
crypto/vrf
Package vrf defines the interface to a verifiable random function.
 Package vrf defines the interface to a verifiable random function.
crypto/vrf/p256
Package p256 implements a verifiable random function using curve p256.
 Package p256 implements a verifiable random function using curve p256.
domain
Package domain stores multi-tenancy configuration information.
 Package domain stores multi-tenancy configuration information.
fake
integration
Package integration exports a set of unit tests that can be run by impl/integration or any other specific instantiation of KeyTransparency.
 Package integration exports a set of unit tests that can be run by impl/integration or any other specific instantiation of KeyTransparency.
keyserver
Package keyserver implements a transparent key server for End to End.
 Package keyserver implements a transparent key server for End to End.
managementserver
Package managementserver implements the user manager APIs
 Package managementserver implements the user manager APIs
monitor
Package monitor implements the monitor service.
 Package monitor implements the monitor service.
monitorserver
Package monitorserver contains an implementation of a Monitor server which can be queried for monitoring results.
 Package monitorserver contains an implementation of a Monitor server which can be queried for monitoring results.
monitorstorage
Package monitorstorage holds data produced by the monitor
 Package monitorstorage holds data produced by the monitor
mutator
Package mutator defines the operations to transform mutations into changes in the map as well as operations to write and read mutations to and from the database.
 Package mutator defines the operations to transform mutations into changes in the map as well as operations to write and read mutations to and from the database.
mutator/entry
Package entry implements a simple replacement strategy as a mapper.
 Package entry implements a simple replacement strategy as a mapper.
sequencer
Package sequencer reads mutations and applies them to the Trillian Map.
 Package sequencer reads mutations and applies them to the Trillian Map.
storage
Package storage defines storage interfaces.
 Package storage defines storage interfaces.
testutil
Package testutil provides helper functions for tests.
 Package testutil provides helper functions for tests.
transaction
deploy
kubernetes
impl
authorization
Package authorization contains the authorization module implementation.
 Package authorization contains the authorization module implementation.
authorization/authz_proto
Package authz_proto is a generated protocol buffer package.
 Package authz_proto is a generated protocol buffer package.
google/authentication
integration
sql/domain
Package domain implements the domain.Storage interface.
 Package domain implements the domain.Storage interface.
sql/engine
sql/keysets
Package keysets implements the storage.KeySets interface.
 Package keysets implements the storage.KeySets interface.
sql/mutationstorage
Package mutationstorage defines operations to write and read mutations to and from the database.
 Package mutationstorage defines operations to write and read mutations to and from the database.
sql/testutil
Package testutil contains test supporting functionality for 'impl/sql/...'.
 Package testutil contains test supporting functionality for 'impl/sql/...'.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.