---
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) {#install}

The easiest way to install the TLSN browser extension is to use **[Chrome Web Store](https://chromewebstore.google.com/detail/gcfkkledipjbgdbimfpijgbkhajiaaph)**.

![Chrome Web Store](./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.1100/tlsn-extension-0.1.0.1100.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

![Extension installation](./images/extension_install.png)

(Optional:) Pin the extension, so that it is easier to find in the next steps:

![Pin the extension](./images/extension_pin.png)

## Websocket Proxy {#proxy}

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 {#notary-server}

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.11`
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))

![Extension Notary and Proxy settings](./images/extension_proxy.png)

### Run a Local Notary Server {#local-notary}

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
   cargo run --release --bin notary-server
   ```

The notary server will now be running in the background waiting for connections.

## Notarize Twitter Account Access {#notarize}
   Note: 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**

   Using the TLSNotary Plugin Demo:
   1. Goto [TLSNotary Plugin Demo](https://demo.tlsnotary.org)
   2. Run the Twitter Plugin
   3. When finished you can view the attestation and transcript of the notarization at the bottom of the page or in the extension.


   Using the Browser console:
   1. Open Chrome/Brave
   2. Open the developer console (Right Click -> Inspect or F12)
   3. Copy/Paste the code below:
   ```javascript
   const client = await tlsn.connect();

   await client.runPlugin(
        'https://github.com/tlsnotary/tlsn-extension/raw/main/src/assets/plugins/twitter_profile.wasm'
      );
   ```
   4. Run the plugin from the pop up window
   5. This will navigate to [x.com](https://x.com), open the sidepanel, and begin notarization

## 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 clicking the "Notarize Request" that was just completed.

![Extension History](./images/extension_history_new.png)

## Write your own Extension Plugins

The TLSNotary Browser extension allows you to add custom plugins for more data sources. The repository at [tlsn-plugin-boilerplate](https://github.com/tlsnotary/tlsn-plugin-boilerplate) shows how the Twitter plugin (see above) is built. The `examples` folder contains more examples.
