tlsnotary/website
1
0
Fork 0
mirror of https://github.com/tlsnotary/website.git synced 2026-01-09 22:18:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

Convert more content

Browse Source
This commit is contained in:
Hendrik Eeckhaut
2025-05-13 16:42:43 +02:00
parent 1a52dcdbb9
commit e4101bdd79
92 changed files with 1268 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
docs/quick_start/browser_extension.md Normal file
View File

@@ -0,0 +1,115 @@
---
sidebar_label: Browser Extension
---
# TLSNotary Browser Extension
In this quick start we will prove ownership of a Twitter account with TLSNotary's browser extension.
Optionaly you can [install](#install) and configure a local [websocket proxy](#proxy) and local [notary server](#notary-server).
## Install Browser Extension (Chrome/Brave) <a name="install"></a>
The easiest way to install the TLSN browser extension is to use **[Chrome Web Store](https://chromewebstore.google.com/detail/gcfkkledipjbgdbimfpijgbkhajiaaph)**.
![](images/chromewebstore.png)
Alternatively, you can install it manually:
1. Download the browser extension from https://github.com/tlsnotary/tlsn-extension/releases/download/0.1.0.1000/tlsn-extension-0.1.0.1000.zip
2. Unzip
⚠️ This is a flat zip file, so be careful if you unzip from the command line, this zip file contains many file at the top level
3. Open **Manage Extensions**: chrome://extensions/
4. Enable `Developer mode`
5. Click the **Load unpacked** button
6. Select the unzipped folder
![](images/extension_install.png)
(Optional:) Pin the extension, so that it is easier to find in the next steps:
![](images/extension_pin.png)
## Websocket Proxy <a name="proxy"></a>
Since a web browser doesn't have the ability to make TCP connection, we need to use a websocket proxy server. You can either run one yourself, or use a TLSNotary hosted proxy.
To use the TLSnotary hosted proxy:
1. Open the extension
2. Click **Options**
3. Enter `wss://notary.pse.dev/proxy` as **proxy API**
4. Click **Save**
> ⚠️ **Note:** The TLSNotary hosted 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-scaling-explorations/tlsn-infra/blob/main/docker/websockify/websockify_config).
To run your own websocket proxy **locally**, run:
1. Install [wstcp](https://github.com/sile/wstcp):
```shell
cargo install wstcp
```
2. Run a websocket proxy for `https://api.x.com`:
```shell
wstcp --bind-addr 127.0.0.1:55688 api.x.com:443
```
Note the `api.x.com:443` argument on the last line.
Next use `ws://localhost:55688` as **proxy API** in Step 3 above.
## Notary Server <a name="notary-server"></a>
To create a TLSNotary proof, the browser extension needs a TLSNotary notary server. In a real world scenario, this server should be run by a neutral party, or by the verifier of the proofs. In this quick start, you can either run the server yourself or use the test server from the TLSNotary team. Notarizing TLS with Multi Party Computation involves a lot of communication between the extension and notary server, so running a local server is the fastest option.
To use the TLSNotary team notary server:
1. Open the extension
2. Click **Options**
3. Update Notary API to: `https://notary.pse.dev/v0.1.0-alpha.10`
4. Click **Save**
5. Skip the next section and [continue with the notarization step](#notarize)
If you plan to run a local notary server:
1. Open the extension
2. Click **Options**
3. Update Notary API to: `http://localhost:7047`
4. Click **Save**
5. Run a local notary server (see [below](#local-notary))
<img width="478" src="images/extension_proxy.png" />
### Run a Local Notary Server <a name="local-notary"></a>
1. Clone the TLSNotary repository (defaults to the `main` branch, which points to the latest release):
```shell
git clone https://github.com/tlsnotary/tlsn.git
```
2. Run the notary server:
```sh
cd crates/notary/server
cargo run --release -- --tls-enabled false
```
The notary server will now be running in the background waiting for connections.
## Notarize Twitter Account Access <a name="notarize"></a>
1. Open the extension, you should see the Twitter plugin:
<img width="477" src="images/extension_plugins.png" />
2. Click the Twitter Plugin
3. The TLSNotary Extension sidebar should open and the browser will automatically navigate to Twitter
4. If you haven't already, log in
5. The sidebar should automatically proceeds through the steps
Tip: If you use the hosted notary server, notarization will take multiple seconds. You can track progress by opening the *offscreen console*:
* Open: chrome://extensions ▸ **TLSN Extension** ▸ **Details** ▸ **offscreen.html**
## Verify
When the notarization is ready, you can click the **View** button. If you closed the sidebar, you can find the proof by clicking the extension button and selecting the notarization request in the **History** tab.
<img width="477" src="./images/extension_history_new.png" />
![](./images/extension_history_new.png)
<!-- TODO -->
<!-- You also have the option to download the proof. You can view this proof later by using the **Verify** button or via <https://explorer.tlsnotary.org/>. You can get the Notary public key by visiting the Notary API specified [above](#notary-server). -->
## Write your own Extension Plugins
The TLSNotary Browser extension allows you to add custom plugins for more data sources. The repository at https://github.com/tlsnotary/tlsn-plugin-boilerplate shows how the Twitter plugin (see above) is built. The `examples` folder contains more examples.