https://github.com/eindiran/interject
Prevent `curl | sh` shennanigans by piping curl's output into an editor.
https://github.com/eindiran/interject
bash curl installation-scripts pipe-viewer
Last synced: 3 months ago
JSON representation
Prevent `curl | sh` shennanigans by piping curl's output into an editor.
- Host: GitHub
- URL: https://github.com/eindiran/interject
- Owner: eindiran
- License: mit
- Created: 2019-04-16T18:44:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-24T02:17:39.000Z (almost 6 years ago)
- Last Synced: 2025-01-23T06:08:57.317Z (5 months ago)
- Topics: bash, curl, installation-scripts, pipe-viewer
- Language: Shell
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# interject
Inspect and edit the contents of a pipe. Useful for preventing `curl | sh` shennanigans.
```shell
command1 | interject [-e EDITOR] [-t TEMPDIR] | command2
```
## Installation
To install `interject`, run the install script `install.sh` from the top-level directory:
```bash
sudo ./install.sh
```
This script likely requires root privileges to successfully complete the installation as it places files into `/usr/local/`.
### Requirements
To install `interject`, your machine will need `core-utils` and `gzip`. To run the script, you'll need `core-utils` and either a copy of `vim` or to set the environment variable `EDITOR` to point to an editor available on the system.
### OS Support
`interject` is intended to run on `*nix` systems; it has been tested on a few different Linux distributions and macOS. Both `interject` and the install script have been designed to support OpenBSD and FreeBSD, but BSD support hasn't been tested.
If the install script fails or the installation is happening on an OS other than macOS, Linux or *BSD: set the environment variables `BIN_PATH` (where the binary should be installed) and `MAN_PATH` (where the manpage should be installed). Then run the following commands:
```bash
install -g 0 -o 0 -m 0755 interject "${BIN_PATH}"/interject
install -g 0 -o 0 -m 0644 interject.roff "${MAN_PATH}"/interject.1
gzip "${MAN_PATH}"/interject.1
```
Depending on where `BIN_PATH` and `MAN_PATH` are pointing, you may need to run the commands as `root`.
## Options and Environment Variables
### Options
* `-n`: Don't wait for the input command to finish before opening the editor. Useful for examining the output of commands that take a long time to run before completion. Usage: `long-command | interject -n | command2`.
* `-e `: sets the editor used to view and edit the contents of a pipe to ``. E.g. `command1 | interject -e emacs | command2` will open the results of `command1` in `emacs`.
* `-t `: sets the temporary directory used by `interject` to ``. E.g. `command1 | interject -t /home/example/ | command2` will store the temporary file containing the output `command1` in the directory `/home/example`.
### Environment Variables
`interject` uses the `EDITOR` and `TEMPDIR` environment variables to control the editor and temporary directory used if the `-e` and `-t` options aren't used.
If `EDITOR` isn't set, the system's default version of `vim` is used by default. Likewise, if `TEMPDIR` isn't set, `/tmp` is used as the default.
## Use
`interject` blocks while waiting for the input pipe to complete, a la `sponge`. Once the data from the pipe has been copied into a temporary file, `interject` opens the temporary file with an editor. Make edits to the file, then if you want to run the file, save and exit.
If you don't want to run the script now that you've examined it, instead exit with an error code.
If your editor doesn't support exiting with an error code, simply delete all lines in the file before saving and exiting. Once the editor has exited, `interject` will forward the output to STDOUT or the outgoing pipe, then delete the temporary file.
In `vim`, to run the file, make edits then exit with `:wq`. To exit without running the script, instead use `:cq`. If using the `-n` flag, you can reload the file in `vim` using either `:e`, `:e!`, or `:checktime`. Note that `:e!` will automatically overwrite your changes to the file so far.
### Examples
* `curl www.example.com/potentially-malicious-script.sh | interject -e emacs | sh`
* Download the script at `www.example.com` using `curl`, opening the result with `emacs`. After editing it, run the script using `sh`.
* `interject < foo.txt | bar`
* Edit a temporary copy of `foo.txt` then send the edited copy to the command `bar`.
* `long-command | interject -n -t /home/test-user > output`
* Immediately open the results of `long-command` with the default editor, saving the temporary file in `/home/test-user`. Once complete, save the edited version to `output`.