A transparent and secure way to look up public keys.
Go Shell Makefile
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmd Pass dial func as argument, not global variable (#965) Apr 18, 2018
core Pass dial func as argument, not global variable (#965) Apr 18, 2018
deploy Add loadtest hammer operation to the client (#946) Mar 8, 2018
docs Fix spelling mistake (#855) Nov 14, 2017
impl Move X_proto to X_go_proto (#952) Apr 11, 2018
scripts Tag docker images (#960) Apr 17, 2018
testdata Automate server and client configuration setup Oct 21, 2016
vendor Remove Trillian Fakes (#928) Feb 19, 2018
.dockerignore Add .dockerignore file, move gcloud auth command to travis (#622) Jun 20, 2017
.gitignore Add commit tags to docker images (#959) Apr 16, 2018
.keytransparency.yaml Simplify command line client flags (#738) Aug 12, 2017
.travis.yml Add commit tags to docker images (#959) Apr 16, 2018
AUTHORS Prevent protobuf nil pointer dereference (#600) Aug 8, 2017
CONTRIBUTING.md fix presubmit stanza in the guidelines Jan 19, 2017
CONTRIBUTORS Monitor verification logic (#768) Sep 1, 2017
LICENSE Add Licensing Jun 2, 2015
Makefile Generate client test vectors (#951) Mar 27, 2018
README.md authorized-keys create-keyset command (#958) Apr 17, 2018
coverage.sh remove vendoring specific logic now that 1.9 handles it for us (#828) Oct 3, 2017
docker-compose.yml Add commit tags to docker images (#959) Apr 16, 2018
gen.go Split proto/authorization_proto between api/type and impl/authorizat… Dec 12, 2017
gometalinter.json AccountManagerService API (#864) Dec 7, 2017
travis_secrets.tar.gz.enc Update/re-encrypt and add credentials-file (#647) (#648) Jun 22, 2017

README.md

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