Zero Share

A client-side secure P2P file sharing using WebRTC.

Features

Send multiple files in parallel.
Generate SDP connection for WebRTC data channel.
No server side (only use public STUN servers for ICE candidates).
PGP Encryption.
Responsive UI.
Open-source license.
QR Scan for SDP trade.
Paste from the clipboard.
short SDP by sdp-compact.

Usage

The offer goes to https://zero-share.github.io/.
The offer generates an offer link and then sends it to the answer.
The answer opens the offer link and then sends it to the offer.
The offer paste the answer code then click Accept Answer.
The offer/answer can now select and send files.

How does it work?

Zero share client will get ICE Candidate from STUN/TURN server and make a connections between peers.

Thanks to the Interactive Connectivity Establishment (ICE) protocol, Two peers will have the shortest path to travel between them without caring the Network address translation (NAT).

WebRTC protocol will secure by DTLS (Datagram Transport Layer Security) But DTLS can be vulnerable to man-in-the-middle (MITM), So we provide a second layer encryption using PGP (RSA-OAEP-1024, AES-128).

>C4Context
    Component(stun, "STUN Server")

    Boundary(b, "", "") {
        Person(bob, "Bob", "Bob Zero Share")
        Person(alice, "Alice", "Alice Zero Share")
    }

    Rel(alice, stun, "get ice candidates")
    UpdateRelStyle(alice, stun, $offsetX="-90", $offsetY="-40")

    Rel(bob, stun, "get ice candidates")
    UpdateRelStyle(bob, stun, $offsetX="-90", $offsetY="-40")

    BiRel(alice, bob, "file transfer")
    UpdateRelStyle(alice, bob, $offsetX="-30")

Example sequence, Alice want to send a file to Bob.

>sequenceDiagram
    actor Alice
    actor Bob
    Alice-->>Alice: generate offer sdp
    Alice->>Bob: send offer link
    Bob-->>Bob: generate RSA keypair
    Bob-->>Bob: generate answer sdp
    Bob->>Alice: send answer sdp + RSA pub key
    Alice-->>Alice: encrypt file with AES key
    Alice-->>Alice: encrypt AES key with RSA pub key
    Alice->>Bob: send encrypted file + encrypted AES key
    Bob-->>Bob: decrypt file with decrypted AES key

Development

Requirements

Node (^16.14 || >=18)
NPM

Installation

npm install

Run development (hot reload)

npm run dev

Test (playwright)

npm run test

Deployment

The deployment will using this Github Workflow to trigger the Github Action to build the Github Pages.

For self-host, you can run npm run build to build the static files. This no need the server side of svelte.

Known Issues

Sometimes your internet will block the Google public STUN server and it may slow. I recommend to try to use a different STUN server, can check the list here.
Sometimes gets blocked by the firewall during sending files.

Contributing

We welcome contributions from the community! If you’d like to contribute to the project, follow these steps:

Fork the repository on GitHub.
Create a new branch and make changes.
Test your changes by running npm run test.
Ensure your code is properly formatted and linted by running npm run lint and npm run format.
Commit and the commit message should following Conventional Commits.
Create a Pull Request on the original repository, describing the changes you’ve made and the problem they solve.

For feature requests, please open an issue on the GitHub repository to discuss your ideas with the maintainers.

Zero share