Skip to content

Commit 2e0e956

Browse files
committed
WIP alpha.13
1 parent 5ea1291 commit 2e0e956

File tree

5 files changed

+34
-16
lines changed

5 files changed

+34
-16
lines changed

docs/extension/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@ sidebar_label: Browser Extension
33
---
44
# Chrome Extension (MV3) for TLSNotary
55

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+
:::
915

1016
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.
1117

docs/faq.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,7 @@ RUST_LOG=trace,yamux=info,uid_mux=info cargo run --release
135135
```
136136

137137
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
141139
### How do I troubleshoot connection issues?
142140

143141
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.

docs/notary_server.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
---
22
sidebar_position: 4
3+
sidebar_label: Notary server
34
---
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.
12+
13+
[More info](https://github.com/tlsnotary/tlsn/releases/tag/v0.1.0-alpha.13)
14+
15+
:::
16+
17+
418
# Run a Notary Server
5-
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.
620

721
## 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.
923

1024
1. The following files are needed before running a notary server.
1125

@@ -15,7 +29,7 @@ Refer to the server's [README.md](https://github.com/tlsnotary/tlsn/tree/main/cr
1529
| 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/)> |
1630
| 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` |
1731
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.
1933

2034
## Using Cargo
2135
1. Install required system dependencies.
@@ -37,22 +51,22 @@ source ~/.cargo/env
3751
```bash
3852
git checkout tags/<version>
3953
```
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).
4155
6. Run the server.
4256
```bash
4357
cargo run --release --bin notary-server
4458
```
4559

4660
## Using Docker
4761
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).
4963
3. Run the notary server docker image of your desired version (⚠️ only prover of the same version is supported for now).
5064
```bash
5165
docker run --init -p 127.0.0.1:7047:7047 ghcr.io/tlsnotary/tlsn/notary-server:<version>
5266
```
5367

5468
## 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).
5670

5771
## PSE Development Notary Server
5872

docs/quick_start/rust.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ This example demonstrates how to use TLSNotary in a simple interactive session b
2626
Follow the instructions from:
2727
https://github.com/tlsnotary/tlsn/tree/main/crates/examples/interactive#readme
2828
29-
## Simple Attestation Example: Verifying Data from an API in Rust with a Notary {#attestation}
29+
## Simple Attestation Example: Attesting and Verifying Data from an API in Rust {#attestation}
3030
3131
![](../../diagrams/light/overview_notary.svg#gh-light-mode-only)
3232
![](../../diagrams/dark/overview_notary.svg#gh-dark-mode-only)
3333
34-
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.
3535
3636
Follow the instructions from:
3737
https://github.com/tlsnotary/tlsn/tree/main/crates/examples/attestation#readme

docs/quick_start/tlsn-js.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In this demo, we will request JSON data from the Star Wars API at https://swapi.
3434
1. Open `app.tsx` in your favorite editor.
3535
2. Replace `notaryUrl: 'http://localhost:7047',` with:
3636
```ts
37-
notaryUrl: 'https://notary.pse.dev/v0.1.0-alpha.11',
37+
notaryUrl: 'https://notary.pse.dev/v0.1.0-alpha.12',
3838
```
3939
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.
4040
3. Replace `websocketProxyUrl: 'ws://localhost:55688',` with:
@@ -44,7 +44,7 @@ In this demo, we will request JSON data from the Star Wars API at https://swapi.
4444
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.
4545
4. In `package.json`: check the version number:
4646
```json
47-
"tlsn-js": "v0.1.0-alpha.11"
47+
"tlsn-js": "v0.1.0-alpha.12"
4848
```
4949
5. Install dependencies
5050
```sh

0 commit comments

Comments
 (0)