Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ntsd/zero-share

A secure P2P file sharing using WebRTC without server-side need.
https://github.com/ntsd/zero-share

astro data-sharing data-transfer file-sharing file-transfer hacktoberfest p2p svelte webrtc

Last synced: 6 days ago
JSON representation

A secure P2P file sharing using WebRTC without server-side need.

Host: GitHub
URL: https://github.com/ntsd/zero-share
Owner: ntsd
License: mit
Created: 2023-03-20T14:08:29.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-23T16:58:43.000Z (2 months ago)
Last Synced: 2024-11-23T13:27:03.588Z (30 days ago)
Topics: astro, data-sharing, data-transfer, file-sharing, file-transfer, hacktoberfest, p2p, svelte, webrtc
Language: Svelte
Homepage: https://zero-share.github.io
Size: 3.69 MB
Stars: 94
Watchers: 2
Forks: 10
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-webrtc - zero-share - A client-side secure P2P file sharing using WebRTC. (Projects / File Transfer)

README

# Zero share

[![website](https://img.shields.io/website?url=https%3A%2F%2Fzero-share.github.io)](https://zero-share.github.io/)
[![workflow](https://img.shields.io/github/actions/workflow/status/zero-share/zero-share.github.io/static.yml)](https://github.com/zero-share/zero-share.github.io/actions/workflows/static.yml)

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](https://github.com/ntsd/sdp-compact).

## Usage

1. The offer goes to .
2. The offer generates an offer link and then sends it to the answer.
3. The answer opens the offer link and then sends it to the offer.
4. The offer paste the answer code then click `Accept Answer`.
5. The offer/answer can now select and send files.

[example.webm](https://user-images.githubusercontent.com/8283616/234210465-7b20ad8d-9b1b-413b-ac4e-3919f9261b8e.webm)

## 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).

```mermaid
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.

```mermaid
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

```sh
npm install
```

Run development (hot reload)

```sh
npm run dev
```

Test (playwright)

```sh
npm run test
```

## Deployment

The deployment will using this [Github Workflow](https://github.com/zero-share/zero-share.github.io/blob/main/.github/workflows/static.yml) 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

1. 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](https://github.com/pradt2/always-online-stun/blob/master/valid_hosts.txt).
2. 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:

1. Fork the repository on GitHub.
2. Create a new branch and make changes.
3. Test your changes by running `npm run test`.
4. Ensure your code is properly formatted and linted by running `npm run lint` and `npm run format`.
5. Commit and the commit message should following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
6. 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.

## License