Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beordle/termtunnel
Cross-platform terminal tunnel tool
https://github.com/beordle/termtunnel
bastion-tools bypass jump-server lrzsz proxy ssh terminal tunnel
Last synced: about 1 month ago
JSON representation
Cross-platform terminal tunnel tool
- Host: GitHub
- URL: https://github.com/beordle/termtunnel
- Owner: beordle
- License: mit
- Created: 2022-04-09T13:11:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T13:49:59.000Z (7 months ago)
- Last Synced: 2024-08-02T20:45:20.011Z (4 months ago)
- Topics: bastion-tools, bypass, jump-server, lrzsz, proxy, ssh, terminal, tunnel
- Language: C
- Homepage:
- Size: 3.02 MB
- Stars: 353
- Watchers: 4
- Forks: 36
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - beordle/termtunnel - Cross-platform terminal tunnel tool (C)
README
# Termtunnel [](https://github.com/beordle/termtunnel/actions/workflows/build.yml)
Termtunnel is a tool that allows you to create a tunnel via multiple hops or fight against intranet isolation in a very simple way. As lrzsz can, termtunnel supports not only file transfer but also network proxy.
## Quickstart
**You must ensure that the termtunnel binary exists on both the local and remote first.**
Please use termtunnel to open any locally terminal application such as ssh, bash, etc.
```bash
sh-3.2$ >> termtunnel ssh [email protected]
```
After running, the terminal output is the same as without the `termtunnel` prefix, and you can keep your normal usage habits.
```bash
sh-3.2$ >> termtunnel ssh [email protected]
root@host:~# echo loulou
loulou
root@host:~# uname -a
Linux 5.10.0-11-amd64 #1 SMP Debian 5.10.92-2 (2022-02-28) x86_64 GNU/Linux
```
When a tunnel needs to be established, just run command `termtunnel -a` on that remote host.
For example, you can execute `termtunnel ssh [email protected]` locally, then start `/tmp/termtunnel -a` on the ssh host to enter the termtunnel shell
In the termtunnel shell, you are allowed to download and upload files or create socks5 proxy.
**So how to use the console?** *See [Use case](#use-case) please.*
**And, If you want to speed up the process, you can use [ONESHOT mode](#oneshot-mode) to started immediately without entering a session.**
```bash
sh-3.2$ >> termtunnel ssh [email protected]
root@host:~# /tmp/termsocks -a
termtunnel>> help
```
## Install
* MacOS
* `brew install beordle/tap/termtunnel`
* Linux
* Provide prebuilt static binaries to run. See [lastest releases](https://github.com/beordle/termtunnel/releases/latest)
* Windows
* Provide prebuilt binaries to run. [Download](https://github.com/beordle/termtunnel/releases/download/windows/termtunnel.zip)
* Android or iOS
* use Termux on Android, iSH on iOS to run Linux binary.
## Use case
> This documentation may be out of date, please refer to the output of the **help** command if necessary.
#### Download a file to local
> type `download path/to/file` and Enter, choose a folder to save.
#### Upload a file to remote
> type `upload` and Enter, choose a file to upload.
#### Share local internet with remote
> type `remote_listen 127.0.0.1 8000 127.0.0.1 0` and enter
> now, the port 8000 is a socks5/http mixed proxy server. well, open new a window to use it.
> eg. You can use it by curl: `curl --socks5 127.0.0.1:8000 https://google.com`
> and `curl -x 127.0.0.1:8000 https://google.com`
> or, [let yum use it.](https://unix.stackexchange.com/questions/43654/how-to-use-socks-proxy-with-yum)
#### Share Intranet host 10.11.123.123's VNC port 5100 with local
> type `local_listen 127.0.0.1 3333 10.11.123.123 5100` and enter
> now, the port 3333 on your local compute is 10.11.123.123's VNC port.
> use a local GUI VNC client to connect it!
#### ONESHOT mode
> you can directly run `termtunnel -- local_listen 127.0.0.1 80 127.0.0.1 0`, `termtunnel -- rz` or `termtunnel -- sz path\to\file`. in terminal, the corresponding action will be started immediately without entering a session.
## Build from Source
#### Linux/MacOS
```bash
cmake .
make
```
#### Windows
> Please use MSYS2 to compile under windows.
```
pacman -Syu libuv libuv-devel cmake make
pacman -Syu openssh # optional
cmake .
make
```
## FAQ
1. **Can I make the whole process unattended？** To reduce user intervention, you can try to use UNIX expect tool.
2. **How to use it with tmux？** Out of the box. Designed with tmux in mind. But because of the implementation of tmux, the speed is very limited. If you want to improve the speed, you need to modify the source code and recompile tmux
## License
This application is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE file for details.