https://github.com/msskowron/sshtunnelhttp
SSH tunneling written in Golang.
https://github.com/msskowron/sshtunnelhttp
go http ssh
Last synced: 9 days ago
JSON representation
SSH tunneling written in Golang.
- Host: GitHub
- URL: https://github.com/msskowron/sshtunnelhttp
- Owner: MSSkowron
- Created: 2023-06-02T13:34:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-08T11:39:29.000Z (about 3 years ago)
- Last Synced: 2025-01-09T11:56:00.062Z (over 1 year ago)
- Topics: go, http, ssh
- Language: Go
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ssh-tunnel-http
This code provides a basic implementation of SSH tunneling using the github.com/gliderlabs/ssh package in Go. It allows establishing an SSH server that can handle incoming SSH sessions and forward their data to HTTP clients via an HTTP server. It can be used as a starting point for building more complex SSH tunneling applications.
## Prerequisites
Before running this project, ensure that you have Go installed on your system.
## Install
Follow these steps to install the project:
1. Clone the repository:
```
git clone https://github.com/MSSkowron/ssh-tunnel-http.git
```
2. Change to the project directory:
```
cd ssh-tunnel-http
```
## Run
To run the project, execute the following command in the project directory:
```
go run main.go
```
The SSH server will be listening on port 2222, and the HTTP server will be listening on port 3000.
## Usage
- **SSH Tunneling**
Once the server is running, you can establish an SSH session to transfer data through a tunnel. Use your preferred SSH client to connect to the server:
Example (using OpenSSH client):
```
ssh user@localhost -p 2222 < file.txt
```
Data sent from the SSH client will be forwarded to the corresponding tunnel.
- **API Endpoint**
The API endpoint / allows HTTP clients to access the data being forwarded through the SSH tunnel. The endpoint expects a query parameter id that represents the tunnel ID. The ID is printed in the server logs when an SSH connection is established. The data from the corresponding tunnel will be returned as the response.
Example:
```
GET /?id=12345
```
This will retrieve the data from tunnel ID 12345 and return it as the response.
- **Flags**
The following flags can be used to configure the application:
- `http`: Specifies the port number for the HTTP server. By default, it is set to 3000. To change the port number, use the flag followed by the desired port number.
Example:
```
go run main.go -http 8080
```
This will run the HTTP server on port 8080 instead of the default port 3000.
- `ssh`: Specifies the port number for the SSH server. By default, it is set to 2222. To change the port number, use the flag followed by the desired port number.
Example:
```
go run main.go -ssh 22222
```
This will run the SSH server on port 22222 instead of the default port 2222.
Remember to include these flags when running the application to customize the port numbers as needed.