You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/extension/README.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,15 @@ sidebar_label: Browser Extension
3
3
---
4
4
# Chrome Extension (MV3) for TLSNotary
5
5
6
-
> **Important**
7
-
>
8
-
> ⚠️ When running the extension against a notary server, ensure that the notary server's version matches the version of this extension.
6
+
:::warning
7
+
When running the extension against a notary server, ensure that the notary server's version matches the version of this extension.
8
+
:::
9
+
10
+
:::warning
11
+
12
+
The current browser extension will stay locked to version alpha.12 of the TLSNotary protocol while we are rewriting it on top of the upcoming TLSNotary SDK.
13
+
14
+
:::
9
15
10
16
The TLSNotary browser extension includes a plugin system that allows you to safely extend its functionality with custom plugins tailored to your specific data sources. This section also explains how to interact with the TLSN Extension within web applications.
Copy file name to clipboardExpand all lines: docs/faq.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -135,9 +135,7 @@ RUST_LOG=trace,yamux=info,uid_mux=info cargo run --release
135
135
```
136
136
137
137
In the browser extension, you can change the logging level via **Options > Advanced > Logging Level**.
138
-
139
-
For the notary server, please refer to [this](https://github.com/tlsnotary/tlsn/blob/main/crates/notary/server/README.md#logging) on how to change the logging level.
140
-
138
+
w
141
139
### How do I troubleshoot connection issues?
142
140
143
141
If a TLSNotary request fails, first ensure that the request works independently of TLSNotary by testing it with tools like `curl`, Postman, or another HTTP client. This helps rule out any server or network issues unrelated to TLSNotary.
Copy file name to clipboardExpand all lines: docs/notary_server.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,25 @@
1
1
---
2
2
sidebar_position: 4
3
+
sidebar_label: Notary server
3
4
---
5
+
6
+
7
+
:::danger
8
+
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.
10
+
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.
This guide shows you how to run a [notary server](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server) in an Ubuntu server instance.
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.
6
20
7
21
## Configure Server Setting
8
-
Refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server#configuration) for instructions on how to configure the following settings.
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.
9
23
10
24
1. The following files are needed before running a notary server.
11
25
@@ -15,7 +29,7 @@ Refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/main/cr
15
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/)> |
16
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`|
17
31
2. Expose the notary server port (specified in the config) on your server networking setting.
18
-
3. Optionally one can turn on [authorization](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server#authorization), or turn off [TLS](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server#tls) if TLS is handled by an external setup, e.g. reverse proxy, cloud setup.
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.
19
33
20
34
## Using Cargo
21
35
1. Install required system dependencies.
@@ -37,22 +51,22 @@ source ~/.cargo/env
37
51
```bash
38
52
git checkout tags/<version>
39
53
```
40
-
5. To configure the server setting, please refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server#configuration).
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).
41
55
6. Run the server.
42
56
```bash
43
57
cargo run --release --bin notary-server
44
58
```
45
59
46
60
## Using Docker
47
61
1. Install docker following your preferred method [here](https://docs.docker.com/engine/install/ubuntu/).
48
-
2. To configure the server setting, please refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/main/crates/notary/server#configuration).
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).
49
63
3. Run the notary server docker image of your desired version (⚠️ only prover of the same version is supported for now).
50
64
```bash
51
65
docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/tlsn/notary-server:<version>
52
66
```
53
67
54
68
## API Endpoints
55
-
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/main/crates/notary/server#websocket-apis).
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).
TLSNotary can also be used in a setup where MPC-TLS verification is delegated to a notary server. In this example, the notary attests to the data served to the prover. Next, the prover can share this attestation with a Verifier who can verify the data.
34
+
TLSNotary also supports a workflow where a Verifier (acting as Attestor) attests to the proven data. The Prover can then generate a presentation of this attested data, which can be verified by anyone who trusts the Attestor.
This makes this webpage use the [PSE](https://pse.dev) notary server to notarize the API request. Feel free to use different or [local notary](#local); a local server will be faster because it removes the bandwidth constraints between the user and the notary.
@@ -44,7 +44,7 @@ In this demo, we will request JSON data from the Star Wars API at https://swapi.
44
44
Because a web browser doesn't have the ability to make TCP connection, we need to use a websocket proxy server. This uses a proxy hosted by [PSE](https://pse.dev). Feel free to use different or [local notary](#local) proxy.
0 commit comments