mirror of
https://github.com/MercuryWorkshop/epoxy-tls.git
synced 2025-05-15 15:30:00 -04:00
47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# epoxy
|
|
Epoxy is an encrypted proxy for browser javascript. It allows you to make requests that bypass CORS without compromising security, by running SSL/TLS inside webassembly.
|
|
|
|
## Using the client
|
|
Epoxy must be run from within a web worker and must be served with the [security headers needed for `SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements). Here is a simple usage example:
|
|
```javascript
|
|
import epoxy from "./epoxy-module-bundled.js";
|
|
import ROOTS from "./pkg/certs-module.js";
|
|
// or
|
|
// importScripts("epoxy-bundled.js");
|
|
// importScripts("certs.js");
|
|
|
|
const { EpoxyClient, EpoxyClientOptions } = await epoxy();
|
|
|
|
let options = new EpoxyClientOptions();
|
|
options.user_agent = navigator.userAgent;
|
|
|
|
let client = await new EpoxyClient("wss://localhost:4000", ROOTS, options);
|
|
|
|
let response = await client.fetch("https://httpbin.org/get");
|
|
console.log(await response.text());
|
|
```
|
|
See `client/demo.js` for more examples.
|
|
|
|
## Using the server
|
|
See the [server readme](server/README.md).
|
|
|
|
## Building
|
|
|
|
### Server
|
|
See the [server readme](server/README.md).
|
|
|
|
### Client
|
|
> [!IMPORTANT]
|
|
> Building the client is only supported on Linux.
|
|
|
|
Make sure you have the `wasm32-unknown-unknown` rust target, the `rust-std` component, and the `wasm-bindgen`, `wasm-opt`, and `base64` binaries installed.
|
|
|
|
In the `client` directory:
|
|
```
|
|
bash build.sh
|
|
```
|
|
|
|
To host a local server with the required headers:
|
|
```
|
|
python3 serve.py
|
|
```
|