https://github.com/mihaigalos/caster

🚀 Publish local commands and services via http.
https://github.com/mihaigalos/caster

Last synced: 3 days ago
JSON representation

🚀 Publish local commands and services via http.

• Host: GitHub
• URL: https://github.com/mihaigalos/caster
• Owner: mihaigalos
• License: mit
• Created: 2022-02-11T06:22:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T01:44:42.000Z (3 months ago)
• Last Synced: 2024-10-16T04:12:30.008Z (29 days ago)
• Language: Rust
• Homepage:
• Size: 78.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# caster

[![CI](https://github.com/mihaigalos/caster/actions/workflows/ci.yaml/badge.svg)](https://github.com/mihaigalos/caster/actions/workflows/ci.yaml)

[![crates.io](https://img.shields.io/crates/d/caster.svg)](https://crates.io/crates/caster)

[![docker pulls](https://img.shields.io/docker/pulls/mihaigalos/caster)](https://hub.docker.com/r/mihaigalos/caster)

Publish local commands and services via http.

![caster](screenshots/caster.png)

# Why?

`caster` can be used for running commands on remote machines, where `ssh` is either not possible (no permissions) or not preferred (principle of least privilege).

# Usage

## Building from source

```bash

cargo install caster

```

## Using precompiled binaries

Will be implemented as an upcoming feature.

## Docker

The server [`docker image`](https://contains.dev/mihaigalos/caster) is `<10MB`.

### Server

```bash

$ docker run --rm -it -p 8080:8080 mihaigalos/caster

```

To avoid i.e. leaking sensitive information such as passwords, you can pass the `--secure` flag. This will only permit access to named endpoints such as `/ping` or `/curl`.

### Client

Test if the remote endpoint can reach the internet:

```bash

$ curl localhost:8080 -XPOST -d 'ping -c 3 google.com'

PING google.com (142.251.36.206): 56 data bytes

64 bytes from 142.251.36.206: seq=0 ttl=117 time=30.143 ms

64 bytes from 142.251.36.206: seq=1 ttl=117 time=19.261 ms

64 bytes from 142.251.36.206: seq=2 ttl=117 time=15.664 ms

--- google.com ping statistics ---

3 packets transmitted, 3 packets received, 0% packet loss

round-trip min/avg/max = 15.664/21.689/30.143 ms

```

Test access, ignore TLS/SSL:

```bash

$ curl localhost:8080 -XPOST -d 'curl -sSLk news.ycombinator.com'

```

Use remote `jq` service for formatting json:

```bash

$ curl localhost:8080 -XPOST -d 'jq -n {key:"value"}'

```

The following are aliases for the above:

```bash

$ curl localhost:8080/ping -XPOST -d '-c 3 google.com'

$ curl localhost:8080/curl -XPOST -d '-sSLk news.ycombinator.com'

$ curl localhost:8080/jq -XPOST -d '-n {key:"value"}'

```

#### Nested curl

curl-ing with another nested `curl` command and passing arguments to it:

```bash

$ curl -s localhost:8080 -XPOST -d 'curl -s localhost:8080 -XPOST -d "jq -n {\"key\":0}"'

{

  "key": 0

}

```