mirrors_public/schollz_croc
1
1
Fork 0
mirror of https://github.com/schollz/croc.git synced 2025-10-11 13:21:00 +02:00
Code Activity

dos2unix

Browse source
This commit is contained in:
Zack Scholl 2020-10-12 12:33:56 -07:00
parent b12fc47951
commit fa1359f1b8
1 changed files with 212 additions and 202 deletions
Download patch file Download diff file Expand all files Collapse all files

414
README.md
View file

@ -1,202 +1,212 @@
<p align="center"> <p align="center">
<img <img
src="https://user-images.githubusercontent.com/6550035/46709024-9b23ad00-cbf6-11e8-9fb2-ca8b20b7dbec.jpg" src="https://user-images.githubusercontent.com/6550035/46709024-9b23ad00-cbf6-11e8-9fb2-ca8b20b7dbec.jpg"
width="408px" border="0" alt="croc"> width="408px" border="0" alt="croc">
<br> <br>
<a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-v8.4.0-brightgreen.svg?style=flat-square" alt="Version"></a> <a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-v8.4.0-brightgreen.svg?style=flat-square" alt="Version"></a>
<a href="https://coveralls.io/github/schollz/croc"><img src="https://img.shields.io/badge/coverage-81%25-green.svg?style=flat-square" alt="Coverage"></a> <a href="https://coveralls.io/github/schollz/croc"><img src="https://img.shields.io/badge/coverage-81%25-green.svg?style=flat-square" alt="Coverage"></a>
<a href="https://travis-ci.org/schollz/croc"><img <a href="https://travis-ci.org/schollz/croc"><img
src="https://img.shields.io/travis/schollz/croc.svg?style=flat-square" alt="Build src="https://img.shields.io/travis/schollz/croc.svg?style=flat-square" alt="Build
Status"></a> Status"></a>
</p> </p>
`croc` is a tool that allows any two computers to simply and securely transfer files and folders. AFAIK, *croc* is the only CLI file-transfer tool that does **all** of the following: `croc` is a tool that allows any two computers to simply and securely transfer files and folders. AFAIK, *croc* is the only CLI file-transfer tool that does **all** of the following:
- allows **any two computers** to transfer data (using a relay) - allows **any two computers** to transfer data (using a relay)
- provides **end-to-end encryption** (using PAKE) - provides **end-to-end encryption** (using PAKE)
- enables easy **cross-platform** transfers (Windows, Linux, Mac) - enables easy **cross-platform** transfers (Windows, Linux, Mac)
- allows **multiple file** transfers - allows **multiple file** transfers
- allows **resuming transfers** that are interrupted - allows **resuming transfers** that are interrupted
- local server or port-forwarding **not needed** - local server or port-forwarding **not needed**
- **ipv6-first** with ipv4 fallback - **ipv6-first** with ipv4 fallback
- can **use proxy**, like tor
For more information about `croc`, see [my blog post](https://schollz.com/software/croc6).
For more information about `croc`, see [my blog post](https://schollz.com/software/croc6).
![Example](src/install/customization.gif)
![Example](src/install/customization.gif)
## Install
## Install
Download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line:
Download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line:
```
$ curl https://getcroc.schollz.com | bash ```
``` $ curl https://getcroc.schollz.com | bash
```
On macOS you can install the latest release with [Homebrew](https://brew.sh/):
On macOS you can install the latest release with [Homebrew](https://brew.sh/):
```
$ brew install croc ```
``` $ brew install croc
```
On macOS you can also install the latest release with [MacPorts](https://macports.org/):
On macOS you can also install the latest release with [MacPorts](https://macports.org/):
```
$ sudo port selfupdate ```
$ sudo port install croc $ sudo port selfupdate
``` $ sudo port install croc
```
On Windows you can install the latest release with [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org):
On Windows you can install the latest release with [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org):
```
$ scoop install croc ```
``` $ scoop install croc
```
```
$ choco install croc ```
``` $ choco install croc
```
On Unix you can install the latest release with [Nix](https://nixos.org/nix):
On Unix you can install the latest release with [Nix](https://nixos.org/nix):
```
$ nix-env -i croc ```
``` $ nix-env -i croc
```
On Arch Linux you can install the latest release with `pacman`:
On Arch Linux you can install the latest release with `pacman`:
```
$ pacman -S croc ```
``` $ pacman -S croc
```
On Ubuntu you can install with `snap`:
On Ubuntu you can install with `snap`:
```
$ snap install croc ```
``` $ snap install croc
```
On Gentoo you can install with `portage`:
``` On Gentoo you can install with `portage`:
$ emerge net-misc/croc ```
``` $ emerge net-misc/croc
```
On Termux you can install with `pkg`:
On Termux you can install with `pkg`:
```
$ pkg install croc ```
``` $ pkg install croc
```
On FreeBSD you can install with `pkg`:
On FreeBSD you can install with `pkg`:
```
$ pkg install croc ```
``` $ pkg install croc
```
Or, you can [install Go](https://golang.org/dl/) and build from source (requires Go 1.12+):
Or, you can [install Go](https://golang.org/dl/) and build from source (requires Go 1.12+):
```
$ GO111MODULE=on go get -v github.com/schollz/croc/v8 ```
``` $ GO111MODULE=on go get -v github.com/schollz/croc/v8
```
## Usage
## Usage
To send a file, simply do:
To send a file, simply do:
```
$ croc send [file(s)-or-folder] ```
Sending 'file-or-folder' (X MB) $ croc send [file(s)-or-folder]
Code is: code-phrase Sending 'file-or-folder' (X MB)
``` Code is: code-phrase
```
Then to receive the file (or folder) on another computer, you can just do
Then to receive the file (or folder) on another computer, you can just do
```
$ croc code-phrase ```
``` $ croc code-phrase
```
The code phrase is used to establish password-authenticated key agreement ([PAKE](https://en.wikipedia.org/wiki/Password-authenticated_key_agreement)) which generates a secret key for the sender and recipient to use for end-to-end encryption.
The code phrase is used to establish password-authenticated key agreement ([PAKE](https://en.wikipedia.org/wiki/Password-authenticated_key_agreement)) which generates a secret key for the sender and recipient to use for end-to-end encryption.
There are a number of configurable options (see `--help`). A set of options (like custom relay, ports, and code phrase) can be set using `--remember`.
There are a number of configurable options (see `--help`). A set of options (like custom relay, ports, and code phrase) can be set using `--remember`.
### Custom code phrase
### Custom code phrase
You can send with your own code phrase (must be more than 4 characters).
You can send with your own code phrase (must be more than 4 characters).
```
$ croc send --code [code-phrase] [file(s)-or-folder] ```
``` $ croc send --code [code-phrase] [file(s)-or-folder]
```
### Use pipes - stdin and stdout
### Use pipes - stdin and stdout
You can pipe to `croc`:
You can pipe to `croc`:
```
$ cat [filename] | croc send ```
``` $ cat [filename] | croc send
```
In this case `croc` will automatically use the stdin data and send and assign a filename like "croc-stdin-123456789". To receive to `stdout` at you can always just use the `--yes` will automatically approve the transfer and pipe it out to `stdout`.
In this case `croc` will automatically use the stdin data and send and assign a filename like "croc-stdin-123456789". To receive to `stdout` at you can always just use the `--yes` will automatically approve the transfer and pipe it out to `stdout`.
```
$ croc --yes [code-phrase] > out ```
``` $ croc --yes [code-phrase] > out
```
All of the other text printed to the console is going to `stderr` so it will not interfere with the message going to `stdout`.
All of the other text printed to the console is going to `stderr` so it will not interfere with the message going to `stdout`.
### Send text
### Send text
Sometimes you want to send URLs or short text. In addition to piping, you can easily send text with `croc`:
Sometimes you want to send URLs or short text. In addition to piping, you can easily send text with `croc`:
```
$ croc send --text "hello world" ```
``` $ croc send --text "hello world"
```
This will automatically tell the receiver to use `stdout` when they receive the text so it will be displayed.
This will automatically tell the receiver to use `stdout` when they receive the text so it will be displayed.
### Self-host relay
The relay is needed to staple the parallel incoming and outgoing connections. By default, `croc` uses a public relay but you can also run your own relay: ### Use a proxy
``` You can use a proxy as your connection to the relay by adding a proxy address with `--socks5`. For example, you can send via a tor relay:
$ croc relay
``` ```
$ croc --socks5 "127.0.0.1:9050" send SOMEFILE
By default it uses TCP ports 9009-9013. Make sure to open those up. You can customized the ports (e.g. `croc relay --ports 1111,1112`), but you must have a minimum of **2** ports for the relay. The first port is for communication and the subsequent ports are used for the multiplexed data transfer. ```
You can send files using your relay by entering `--relay` to change the relay that you are using if you want to custom host your own. ### Self-host relay
``` The relay is needed to staple the parallel incoming and outgoing connections. By default, `croc` uses a public relay but you can also run your own relay:
$ croc --relay "myrelay.example.com:9009" send [filename]
``` ```
$ croc relay
Note, when sending, you only need to include the first port (the communication port). The subsequent ports for data transfer will be transmitted back to the user from the relay. ```
#### Self-host relay (docker) By default it uses TCP ports 9009-9013. Make sure to open those up. You can customized the ports (e.g. `croc relay --ports 1111,1112`), but you must have a minimum of **2** ports for the relay. The first port is for communication and the subsequent ports are used for the multiplexed data transfer.
If it's easier you can also run a relay with Docker: You can send files using your relay by entering `--relay` to change the relay that you are using if you want to custom host your own.
```
``` $ croc --relay "myrelay.example.com:9009" send [filename]
$ docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' schollz/croc ```
```
Note, when sending, you only need to include the first port (the communication port). The subsequent ports for data transfer will be transmitted back to the user from the relay.
Be sure to include the password for the relay otherwise any requests will be rejected.
#### Self-host relay (docker)
```
$ croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [filename] If it's easier you can also run a relay with Docker:
```
Note: when including `--pass YOURPASSWORD` you can instead pass a file with the password, e.g. `--pass FILEWITHPASSWORD`. ```
$ docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' schollz/croc
## License ```
MIT Be sure to include the password for the relay otherwise any requests will be rejected.
## Acknowledgements ```
$ croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [filename]
`croc` has gone through many iterations, and I am awed by all the great contributions! If you feel like contributing, in any way, by all means you can send an Issue, a PR, ask a question, or tweet me ([@yakczar](http://ctt.ec/Rq054)). ```
Thanks [@warner](https://github.com/warner) for the [idea](https://github.com/warner/magic-wormhole), [@tscholl2](https://github.com/tscholl2) for the [encryption gists](https://gist.github.com/tscholl2/dc7dc15dc132ea70a98e8542fefffa28), [@skorokithakis](https://github.com/skorokithakis) for [code on proxying two connections](https://www.stavros.io/posts/proxying-two-connections-go/). Finally thanks for making pull requests [@maximbaz](https://github.com/maximbaz), [@meyermarcel](https://github.com/meyermarcel), [@Girbons](https://github.com/Girbons), [@techtide](https://github.com/techtide), [@heymatthew](https://github.com/heymatthew), [@Lunsford94](https://github.com/Lunsford94), [@lummie](https://github.com/lummie), [@jesuiscamille](https://github.com/jesuiscamille), [@threefjord](https://github.com/threefjord), [@marcossegovia](https://github.com/marcossegovia), [@csleong98](https://github.com/csleong98), [@afotescu](https://github.com/afotescu), [@callmefever](https://github.com/callmefever), [@El-JojA](https://github.com/El-JojA), [@anatolyyyyyy](https://github.com/anatolyyyyyy), [@goggle](https://github.com/goggle), [@smileboywtu](https://github.com/smileboywtu), [@nicolashardy](https://github.com/nicolashardy), [@fbartels](https://github.com/fbartels), [@rkuprov](https://github.com/rkuprov), [@xenrox](https://github.com/xenrox) and [Ipar](https://github.com/lpar)! Note: when including `--pass YOURPASSWORD` you can instead pass a file with the password, e.g. `--pass FILEWITHPASSWORD`.
## License
MIT
## Acknowledgements
`croc` has gone through many iterations, and I am awed by all the great contributions! If you feel like contributing, in any way, by all means you can send an Issue, a PR, ask a question, or tweet me ([@yakczar](http://ctt.ec/Rq054)).
Thanks [@warner](https://github.com/warner) for the [idea](https://github.com/warner/magic-wormhole), [@tscholl2](https://github.com/tscholl2) for the [encryption gists](https://gist.github.com/tscholl2/dc7dc15dc132ea70a98e8542fefffa28), [@skorokithakis](https://github.com/skorokithakis) for [code on proxying two connections](https://www.stavros.io/posts/proxying-two-connections-go/). Finally thanks for making pull requests [@maximbaz](https://github.com/maximbaz), [@meyermarcel](https://github.com/meyermarcel), [@Girbons](https://github.com/Girbons), [@techtide](https://github.com/techtide), [@heymatthew](https://github.com/heymatthew), [@Lunsford94](https://github.com/Lunsford94), [@lummie](https://github.com/lummie), [@jesuiscamille](https://github.com/jesuiscamille), [@threefjord](https://github.com/threefjord), [@marcossegovia](https://github.com/marcossegovia), [@csleong98](https://github.com/csleong98), [@afotescu](https://github.com/afotescu), [@callmefever](https://github.com/callmefever), [@El-JojA](https://github.com/El-JojA), [@anatolyyyyyy](https://github.com/anatolyyyyyy), [@goggle](https://github.com/goggle), [@smileboywtu](https://github.com/smileboywtu), [@nicolashardy](https://github.com/nicolashardy), [@fbartels](https://github.com/fbartels), [@rkuprov](https://github.com/rkuprov), [@xenrox](https://github.com/xenrox) and [Ipar](https://github.com/lpar)!