Skip to content

Commit c130bde

Browse files
authored
add: comparison matrix (#1)
Along with some preliminary texts. Signed-off-by: Gaukas Wang <[email protected]>
1 parent c3c4b52 commit c130bde

File tree

4 files changed

+63
-19
lines changed

4 files changed

+63
-19
lines changed

_config.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,31 @@ plugins:
3333
exclude:
3434
- LICENSE
3535
- README.md
36+
37+
aux_links:
38+
Refraction Networking: "https://refraction.network/"
39+
FOCI 2024 Paper: "https://www.petsymposium.org/foci/2024/foci-2024-0003.php"
40+
41+
# External navigation links
42+
nav_external_links:
43+
- title: refraction-networking/water
44+
url: https://github.com/refraction-networking/water
45+
- title: refraction-networking/water-rs
46+
url: https://github.com/refraction-networking/water-rs
47+
48+
callouts_level: quiet # or loud
49+
callouts:
50+
highlight:
51+
color: yellow
52+
important:
53+
title: Important
54+
color: blue
55+
new:
56+
title: New
57+
color: green
58+
note:
59+
title: Note
60+
color: purple
61+
warning:
62+
title: Warning
63+
color: red

about.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

comparison.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: page
3+
title: Comparisons
4+
permalink: /comparisons.html
5+
---
6+
7+
# Comparisons
8+
9+
## WATER vs. other pluggable transport designs
10+
11+
We evaluate WATER against other pluggable transport designs in terms of the following features:
12+
- **Hot-swappable**: Can the transport be loaded and unloaded without recompling the host application?
13+
- **Host Isolation**: Does the transport execute in an isolated environment (e.g., a sandbox) and with limited access to the host resources?
14+
- **Compatibility Guarantee**: Can the host application be transport-agnostic and still work with any transport that implements the interface?
15+
- **Cross-language Deployment**: Can the transport be implemented in a different programming language than the host application?
16+
17+
18+
| Feature | PTs | Marionette | Proteus | WATER |
19+
|----------------|------|------------|---------|-------|
20+
| Hot-swappable |||||
21+
| Host Isolation || ⚠️ |||
22+
| Compatibility Guarantee || ⚠️ |||
23+
| Cross-language Deployment |||||
24+
25+
### References
26+
- PTs ([pluggabletransports.info](https://www.pluggabletransports.info/))
27+
- Marionette: A Programmable Network Traffic Obfuscation System ([USENIX Security'15](https://www.usenix.org/conference/usenixsecurity15/technical-sessions/presentation/dyer))
28+
- Proteus: Programmable Protocols for Censorship Circumvention ([FOCI 2023](https://www.petsymposium.org/foci/2023/foci-2023-0013.php))

index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@ layout: home
77

88
# WATER: WebAssembly Transport Executables Runtime
99

10-
Documentation under construction. Please check back later.
10+
This site hosts the online documentation for Project WATER: [refraction-networking/water](https://github.com/refraction-networking/water) and [refraction-networking/water-rs](https://github.com/refraction-networking/water-rs).
11+
12+
## WATER
13+
14+
WATER stands for WebAssembly Transport Executables Runtime, a novel approach to building pluggable network transports using WebAssembly. Comparing to other designs, WATER in general provides better flexibility and security, more consistent development and deployment experience, and better performance.
15+
16+
A matrix comparing WATER with other pluggable transport designs is available [here](comparisons.html#water-vs-other-pluggable-transport-designs).

0 commit comments

Comments
 (0)