An implementation of the notary server in Rust.
This project is currently under active development and should not be used in production. Expect bugs and regular major breaking changes.
- Configure the server setting in this config file — refer here for more information on the definition of the setting parameters.
- Start the server by running the following in a terminal at the root of this repository.
cargo run --release- To use a config file from a different location, run the following command to override the default config file location.
cargo run --release -- --config-file <path-of-new-config-file>There are two ways to obtain the notary server's Docker image:
- Obtain the latest image with:
docker pull ghcr.io/tlsnotary/notary-server:latest- Run the docker container with:
docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/notary-server:latest- If you want to change the default configuration, create a
configfolder locally, that contains aconfig.yaml, whose content follows the format of the default config file here. - Instead of step 2, run the docker container with the following (remember to change the port mapping if you have changed that in the config):
docker run --init -p 127.0.0.1:7047:7047 -v <your config folder path>:/root/.notary-server/config ghcr.io/tlsnotary/notary-server:latest- Configure the server setting in this config file.
- Build the docker image by running the following in a terminal at the root of this repository.
docker build . -t notary-server:local- Run the docker container and specify the port specified in the config file, e.g. for the default port 7047
docker run --init -p 127.0.0.1:7047:7047 notary-server:local- Instead of changing the key/cert file path(s) in the config file, create a folder containing your key/cert by following the folder structure here.
- When launching the docker container, mount your folder onto the docker container at the relevant path prefixed by
/root/.notary-server.
- Example 1: Using different key/cert for both TLS and notarization:
docker run --init -p 127.0.0.1:7047:7047 -v <your folder path>:/root/.notary-server/fixture notary-server:local- Example 2: Using different key for notarization (your folder should only contain
notary.key):
docker run --init -p 127.0.0.1:7047:7047 -v <your folder path>:/root/.notary-server/fixture/notary notary-server:localAll APIs are TLS-protected, hence please use https:// or wss://.
Defined in the OpenAPI specification.
To perform notarization using the session id (unique id returned upon calling the /session endpoint successfully) submitted as a custom header.
X-Session-Id
String
The main objective of a notary server is to perform notarization together with a prover. In this case, the prover can either be
- TCP client — which has access and control over the transport layer, i.e. TCP
- WebSocket client — which has no access over TCP and instead uses WebSocket for notarization
Axum is chosen as the framework to serve HTTP and WebSocket requests from the prover clients due to its rich and well supported features, e.g. native integration with Tokio/Hyper/Tower, customizable middleware, ability to support lower level integration of TLS (example). To simplify the notary server setup, a single Axum router is used to support both HTTP and WebSocket connections, i.e. all requests can be made to the same port of the notary server.
Axum's internal implementation of WebSocket uses tokio_tungstenite, which provides a WebSocket struct that doesn't implement AsyncRead and AsyncWrite. Both these traits are required by TLSN core libraries for prover and notary. To overcome this, a slight modification of Axum's implementation of WebSocket is used, where async_tungstenite is used instead so that ws_stream_tungstenite can be used to wrap on top of the WebSocket struct to get AsyncRead and AsyncWrite implemented.
To perform notarization, some parameters need to be configured by the prover and notary server (more details in the OpenAPI specification), i.e.
- maximum transcript size
- unique session id
To streamline this process, a single HTTP endpoint (/session) is used by both TCP and WebSocket clients.
After calling the configuration endpoint above, prover can proceed to start notarization. For TCP client, that means calling the /notarize endpoint using HTTP (https), while WebSocket client should call the same endpoint but using WebSocket (wss). Example implementations of these clients can be found in the integration test.
Currently, both the private key (and cert) used to establish TLS connection with prover, and the private key used by notary server to sign the notarized transcript, are hardcoded PEM keys stored in this repository. Though the paths of these keys can be changed in the config to use different keys instead.