opaque-ea

README

opaque-ea

This project is a proof-of-concept implementation of OPAQUE with Exported Authenticators, written in Go.

You can play with the demo at https://opaque.research.cloudflare.com/.

DISCLAIMER: This is a reference implementation only. DO NOT use in production systems.

Getting started

Get the source code:

go get github.com/cloudflare/opaque-ea

Running tests

From the opaque-ea folder, run all tests:

make test

Run a test client and server

Spin up a local server:

  # Set PUBLIC_PATH to path of public folder
  export PUBLIC_PATH="public/"
  # Build the server
  cd https-server && go build main.go && cd ../..
  # Build the client
  cd public/go && GOOS=js GOARCH=wasm go build -o ../main.wasm && cd ../..
  # Start local server
  ./https-server/main

View the result locally at http://localhost:8080/.

Making changes to client

If you make any changes to the client code, you need to re-compile Go to Wasm to see them in your browser.

From the opaque-ea folder:

# Compile go to wasm
cd public/go && GOOS=js GOARCH=wasm go build -o ../main.wasm && cd ../..

Packages

Library packages

expauth	TLS Exported Authenticators	Partially implements https://datatracker.ietf.org/doc/html/draft-ietf-tls-exported-authenticator-13
opaque	OPAQUE core (no key exchange)	Partially implements https://tools.ietf.org/html/draft-krawczyk-cfrg-opaque-06
opaqueea	OPAQUE with Exported Authenticators	Partially implements https://tools.ietf.org/html/draft-sullivan-tls-opaque-00
ohttp	OPAQUE-EA over HTTPS, client and server

Executable packages

public/go	Wrapper for HTTPS client, compiles to Wasm
https-server	Wrapper for HTTPS server, compiles to Go executable

How to Cite

To cite OPAQUE-EA, use one of the following formats and update with the date you accessed this project.

APA Style

Bradley, T. and Celi, S. (2020). Introducing OPAQUE-EA:
A Proof of Concept implementation of OPAQUE with Exported Authenticators. Cloudflare.
Available at https://github.com/cloudflare/opaque-ea. Accessed Feb 2021.

Bibtex Source

@manual{circl,
  title        = {Introducing OPAQUE-EA: A Proof of Concept implementation of OPAQUE with Exported Authenticators},
  author       = {Tatiana Bradley and Sof\'{i}a Celi},
  organization = {Cloudflare},
  note         = {Available at \url{https://github.com/cloudflare/opaque-ea}. Accessed Feb 2021},
  month        = dec,
  year         = {2020}
}

License

The project is licensed under the BSD-3-Clause License.