Extra FAQ entries (#99)

This commit is contained in:
Hendrik Eeckhaut
2024-10-11 13:33:50 +02:00
committed by GitHub
parent 1b8ecf1ce9
commit 61e232b58b

View File

@@ -8,6 +8,9 @@
- [Which TLS versions are supported?](#faq6)
- [What is the overhead of using the TLSNotary protocol?](#faq7)
- [Does TLSNotary use a proxy?](#faq8)
- [Why does my session time out?](#faq9)
- [How to run TLSNotary with extra logging?](#faq10)
- [How do I troubleshoot connection issues?](#faq11)
### Doesn't TLS allow a third party to verify data authenticity? { #faq1 }
@@ -60,3 +63,25 @@ In a concrete scenario of sending a 1KB HTTP request followed by a 100KB respons
A proxy is required only for the browser extension because browsers do not allow extensions to open TCP connections. Instead, our extension opens a websocket connection to a proxy (local or remote) which opens a TCP connection with the server. Our custom TLS client is then attached to this connection and the proxy only sees encrypted data.
### Why does my session time out? { #faq9 }
If you are experiencing slow performance or server timeouts, make sure you are building with the `--release` profile. Debug builds are significantly slower due to extra checks. Use:
```
cargo run --release
```
### How to run TLSNotary with extra logging? { #faq10 }
To get deeper insights into what TLSNotary is doing, you can enable extra logging with `RUST_LOG=debug` or `RUST_LOG=trace`. This will generate a lot of output, as it logs extensive network activity. Its recommended to filter logs for better readability. The recommended configuration is:
```
RUST_LOG=trace,yamux=info,uid_mux=info cargo run --release
```
### How do I troubleshoot connection issues? { #faq11 }
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.
Next, confirm that your request includes the necessary headers:
- `Accept-Encoding: identity` to avoid compressed responses.
- `Connection: close` to ensure the server closes the connection after the response.
If the issue persists, [enable extra logging](#faq10) with `RUST_LOG=debug` or `RUST_LOG=trace` for deeper insights into what TLSNotary is doing.