Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shesek/onionfile

Simple file sharing over tor hidden services (v3)
https://github.com/shesek/onionfile

file-sharing hidden-service npx onion tor

Last synced: 2 months ago
JSON representation

Simple file sharing over tor hidden services (v3)

Awesome Lists containing this project

README

        

# onionfile

Simple file sharing over tor hidden services (v3).

No need to pre-install tor, everything is packaged in.

## Using

Use via [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) (built-in with npm 5.2.0+):

$ npx onionfile ~/shareme.txt

http://guy9ocyi3hac5j7kh3ua336qr4t5k6q35ncyxbsrajp3smc4yp7gxtyd.onion

That's it! Share the URL with the recipient to give her access to `~/shareme.txt`.

If a path to a directory is provided, the entire directory will be made accessible
with a directory index listing all the available files.

Note: it might take a few moments for the hidden service to become available.

## Installing

Instead of using `npx`, you may install the package locally to make it available simply as `onionfile`:

$ npm install -g onionfile

$ onionfile ~/shareme.txt

## Why?

- Share files easily and privately.

- Doesn't require accepting incoming connections, no port forwarding needed.

- Self-authenticating URLs, in both directions:
the URL is required in order to access the file (serving as an access key),
and it authenticates the identify of the server (protecting against MITM attacks).

## Thanks

To [Dead Canaries](http://deadcanaries.gitlab.io/)'s awesome
[granax](https://gitlab.com/deadcanaries/granax) and [hsv3](https://gitlab.com/deadcanaries/hsv3) libraries,
which made writing this utility a breeze (<30 LoC)!

## License

MIT