|
1 | 1 | --- |
2 | 2 | sidebar_position: 4 |
3 | 3 | sidebar_label: Notary server |
| 4 | +unlisted: true |
4 | 5 | --- |
5 | 6 |
|
| 7 | +# Notary Server (Deprecated) |
6 | 8 |
|
7 | 9 | :::danger |
8 | 10 |
|
9 | | -In [alpha.13](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.13) the project’s scope was narrowed to focus on the core TLSNotary libraries and the upcoming SDK. While the Notary server was designed to be simple and easy to customize, maintaining it became increasingly challenging due to growing feature requests and support needs. By removing the Notary server more resources can be allocated to stabilizing and improving the core protocol. |
| 11 | +The Notary server was **removed** from the TLSNotary project in [alpha.13](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.13). The project's scope was narrowed to focus on the core TLSNotary libraries and the upcoming SDK. |
10 | 12 |
|
11 | | -Existing users who rely on the Notary server can continue to use it by forking and maintaining their own version. We encourage the community to adapt and extend the server as needed for their use cases. |
12 | | - |
13 | | -[More info](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.13) |
| 13 | +The `notary.pse.dev` hosted server and its WebSocket proxy have been **shut down**. |
14 | 14 |
|
15 | 15 | ::: |
16 | 16 |
|
| 17 | +## What Should I Use Instead? |
17 | 18 |
|
18 | | -# Run a Notary Server |
19 | | -This guide shows you how to run a [notary server](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server) in an Ubuntu server instance. |
20 | | - |
21 | | -## Configure Server Setting |
22 | | -Refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#configuration) for instructions on how to configure the following settings. |
23 | | - |
24 | | -1. The following files are needed before running a notary server. |
25 | | - |
26 | | - | File | Purpose | File Type | Compulsory | Sample Command | |
27 | | - | ------------------ | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | |
28 | | - | TLS private key | The private key used for the notary server's TLS certificate to establish TLS connections with provers | TLS private key in PEM format | Yes unless TLS is turned off | \<Generated when creating CSR for your Certificate Authority, e.g. using [Certbot](https://certbot.eff.org/)> | |
29 | | - | TLS certificate | The notary server's TLS certificate to establish TLS connections with provers | TLS certificate in PEM format | Yes unless TLS is turned off | \<Obtained from your Certificate Authority, e.g. [Let's Encrypt](https://letsencrypt.org/)> | |
30 | | - | Notary signing key | The private key used by the notary server to sign the attestation | A K256 or P256 elliptic curve private key in PKCS#8 PEM format | Yes | `openssl genpkey -algorithm EC -out eckey.pem -pkeyopt ec_paramgen_curve:secp256k1 -pkeyopt ec_param_enc:named_curve` | |
31 | | -2. Expose the notary server port (specified in the config) on your server networking setting. |
32 | | -3. Optionally one can turn on [authorization](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#authorization), or turn off [TLS](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#tls) if TLS is handled by an external setup, e.g. reverse proxy, cloud setup. |
33 | | - |
34 | | -## Using Cargo |
35 | | -1. Install required system dependencies. |
36 | | -```bash |
37 | | -sudo apt-get update && sudo apt-get upgrade |
38 | | -sudo apt-get install libclang-dev pkg-config build-essential libssl-dev |
39 | | -``` |
40 | | -2. Install rust. |
41 | | -```bash |
42 | | -curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh |
43 | | -source ~/.cargo/env |
44 | | -``` |
45 | | -3. Download the notary server source code. |
46 | | -```bash |
47 | | - mkdir ~/src; cd ~/src |
48 | | - git clone https://github.com/tlsnotary/tlsn.git |
49 | | -``` |
50 | | -4. Switch to your desired [released version](https://github.com/tlsnotary/tlsn/releases), or stay in the `main` branch to use the latest version (⚠️ only prover of the same version is supported for now). |
51 | | -```bash |
52 | | -git checkout tags/<version> |
53 | | -``` |
54 | | -5. To configure the server setting, please refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#configuration). |
55 | | -6. Run the server. |
56 | | -```bash |
57 | | -cargo run --release --bin notary-server |
58 | | -``` |
59 | | - |
60 | | -## Using Docker |
61 | | -1. Install docker following your preferred method [here](https://docs.docker.com/engine/install/ubuntu/). |
62 | | -2. To configure the server setting, please refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#configuration). |
63 | | -3. Run the notary server docker image of your desired version (⚠️ only prover of the same version is supported for now). |
64 | | -```bash |
65 | | -docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/tlsn/notary-server:<version> |
66 | | -``` |
67 | | - |
68 | | -## API Endpoints |
69 | | -Please refer to the list of all HTTP APIs [here](pathname:///swagger-ui/notary_server_api.html), and WebSocket APIs [here](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server#websocket-apis). |
70 | | - |
71 | | -## PSE Development Notary Server |
72 | | - |
73 | | -> **_⚠️ WARNING:_** `notary.pse.dev` is hosted for development purposes only. You are welcome to use it for exploration and development; however, please refrain from building your business on it. Use it at your own risk. |
74 | | -
|
75 | | -The TLSNotary team hosts a public notary server for development, experimentation, and demonstration purposes. The server is currently open to everyone, provided that it is used fairly. |
76 | | - |
77 | | -We host multiple versions of the notary server: Check https://notary.pse.dev to get a list of the currently hosted versions. The version with a `-sgx` suffix run the notary server software in a Trusted Execution Environment (TEE), Intel SGX on Azure. |
78 | | -You can verify the software attestation by visiting `https://notary.pse.dev/<version>/info`. |
79 | | - |
80 | | -To check the status of the notary server, visit the `healthcheck` endpoint at: |
81 | | -`https://notary.pse.dev/<version>/healthcheck` |
82 | | - |
83 | | -### WebSocket Proxy Server |
84 | | - |
85 | | -Because web browsers don't have the ability to make TCP connections directly, TLSNotary requires a WebSocket proxy to set up TCP connections when it is used in a browser. To facilitate the exploration of TLSNotary and to run the examples easily, the TLSNotary team hosts a public WebSocket proxy server. Note that this proxy only supports a predefined set of domains. You can view the full list of supported domains in the [websockify configuration file](https://github.com/privacy-ethereum/tlsn-infra/blob/main/docker/websockify/websockify_config). |
86 | | - |
87 | | -You can utilize this WebSocket proxy with the following syntax: |
88 | | - |
89 | | -``` |
90 | | -wss://notary.pse.dev/proxy?token=<domain> |
91 | | -``` |
92 | | - |
93 | | -Replace `<domain>` with the domain you wish to access (for example, `swapi.dev`). |
94 | | - |
95 | | -## Running Notary Server on Windows Subsystem for Linux (WSL) |
96 | | - |
97 | | -When running the Notary Server and WebSocket Proxy on Windows Subsystem for Linux (WSL), you may encounter networking issues. In older versions of Windows (prior to Windows 11 22H2), WSL uses a virtual Ethernet adapter with its own IP address, which requires additional firewall configuration. |
98 | | - |
99 | | -#### For Windows Versions Prior to 11 22H2: |
100 | | - |
101 | | -1. **Identify the WSL IP Address**: |
102 | | - Run the following command inside the WSL terminal: |
103 | | - ```bash |
104 | | - wsl hostname -I |
105 | | - ``` |
| 19 | +- **Browser extension users:** Use the [Verifier Server](/docs/extension/verifier), which includes a [built-in WebSocket proxy](/docs/extension/verifier#built-in-websocket-proxy). |
| 20 | +- **Rust users:** See the [Quick Start](/docs/quick_start/rust) examples for Prover-Verifier workflows that don't require a notary server. |
106 | 21 |
|
107 | | -2. **Configure Port Forwarding on the Windows Host**: |
108 | | - To forward traffic from the Windows host to the Notary Server inside WSL, set up port forwarding. Run the following PowerShell command on your Windows host, replacing `connectaddress` with the WSL IP address you retrieved in the previous step: |
109 | | - ```powershell |
110 | | - netsh interface portproxy add v4tov4 listenport=7047 listenaddress=0.0.0.0 connectport=7047 connectaddress=192.168.101.100 |
111 | | - ``` |
| 22 | +## Legacy Documentation |
112 | 23 |
|
113 | | -#### For Windows 11 22H2 and Later: |
| 24 | +For users who have forked and maintain their own notary server, the original source code and documentation are available at: |
114 | 25 |
|
115 | | -In newer versions of Windows (Windows 11 22H2 and above), networking has been simplified with the introduction of mirrored mode. This mode allows WSL instances to share the host’s network interface, eliminating the need for manual port forwarding configurations. You can enable mirrored mode as recommended by Microsoft [here](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking). |
| 26 | +- [Notary server source code (v0.1.0-alpha.12)](https://github.com/tlsnotary/tlsn/tree/v0.1.0-alpha.12/crates/notary/server) |
| 27 | +- [alpha.13 release notes](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.13) explaining the removal |
0 commit comments