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

update readme

Browse source
This commit is contained in:
Zack 2024-07-09 06:22:25 -07:00
parent d7c7440ae4
commit bc8b4b8ef9
1 changed files with 3 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -129,23 +129,19 @@ Then to receive the file (or folder) on another computer, you can just do
croc code-phrase croc code-phrase
``` ```
On Linux this behavior is disabled by default to avoid leaking the [secret via the process name](https://nvd.nist.gov/vuln/detail/CVE-2023-43621) ([see below](README.md#receiving-on-linux)).
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`.
### Receiving on Linux ### Receiving on Linux or Mac OS
On Linux receiving is slightly different to avoid [leaking the secret via the process name](https://nvd.nist.gov/vuln/detail/CVE-2023-43621). On Linux and Mac OS, the sending & receiving is slightly different to avoid [leaking the secret via the process name](https://nvd.nist.gov/vuln/detail/CVE-2023-43621). On these systems you will need to run `croc` with the secret as an environment variable. For example, to receive with the secret `***`:
Run
``` ```
CROC_SECRET=*** croc CROC_SECRET=*** croc
``` ```
to receive with secret `***`. This will show only `croc` in the process list of a multi-user system and not leak the secret.
It will show only `croc` in the process list of a multi-user system.
For a single-user system the default behavior can be permanently enabled by running For a single-user system the default behavior can be permanently enabled by running