Home / Golang / Networking

Automatically exposes the remote container's listening ports back to the local machine

Auto-portforward (apf) A handy tool to automatically set up proxies that expose the remote container's listening ports back to the local machine. Just
Information
Category: Golang / Networking
Watchers: 1
Star: 8
Fork: 0
Last update: Dec 31, 2021
Resource links
https://github.com/ruoshan/autoportforward

Auto-portforward (apf)

A handy tool to automatically set up proxies that expose the remote container's listening ports back to the local machine. Just like kubectl portforward or docker run -p LOCAL:REMOTE, but automatically discover and update the ports to be forwarded on the fly.

I often find myself forgot to add -p option when testing a image with docker, or missed to expose some other ports. Now I don't need to worry about that, I just run the following commands:

$ docker run -d --name ch clickhouse/clickhouse-server:latest

$ apf ch
LISTENING PORTS: [9005 ==> 9005, 9009 ==> 9009, 8123 ==> 8123, 9000 ==> 9000, 9004 ==> 9004]

apf will update the port list on the fly. So if you login to the container and start other server listening on different ports, it will dynamically update the local listeners.

For kubernetes:

$ kubectl run --image redis redis

$ apf -k default/redis
LISTENING PORTS: [6379 ==> 6379]

Installation

First of all, apf requires a working docker / kubectl client setup, the client can conect to either local docker daemon / k8s cluster or remote.

You can either download the binary from the release artifacts or build it yourself.

# MacOS (intel)
curl -L -O https://github.com/ruoshan/autoportforward/releases/download/v0.0.2/apf-mac
chmod +x apf-mac
mv apf-mac /usr/local/bin/apf

# Linux
curl -L -O https://github.com/ruoshan/autoportforward/releases/download/v0.0.2/apf-linux-x64
chmod +x apf-mac
mv apf-mac /usr/local/bin/apf

To manually build it, clone the repo and run the build.sh script.

Usage

# Docker
apf {container ID / name}

# Kubernetes
apf -k {namespace}/{pod name}

Status

  • Supporting for reverse proxy is in progress: Create listening ports in container and forward them back to local machine
0 Open More issues
Closed

apf exits after startup

if container use some common port which already used in the host node, such as ssh(22), http(80) the apf-agent may panic image

opened Jan 10, 2022 by warmingking 12
Closed

Not working with Docker per example

Running this per the documentation does not seem to work.

$ apf redis          

*  ==> : Forwarding local listening ports to (==>) remote ports
*  <== : Forwarding to local ports from (<==) remote listening ports (use -r option)

No ports are opened.

I have tried builds from commit 38558a1 and b8059ea. I've tried the -d option, but the log file is empty

Docker version 20.10.12, build e91ed5707e Linux archlinux 5.15.10-arch1-1 #1 SMP PREEMPT Fri, 17 Dec 2021 11:17:37 +0000 x86_64 GNU/Linux

Let me know if you need any other information

opened Jan 4, 2022 by codebling 11
Closed

proxy listener port changed to +5k instead of 10+ for ports under 1024

Chrome and Safari seem to have problems with ports over 10.000 and block them by default. This changes the proxy listener to add only 5000 instead of 10000 to all port numbers under 1024.

opened Feb 12, 2022 by MilanVives 3
Closed

Change default host port for webserver containers from 10080 to something under 10K

For some reason most browsers seem to block webservers on ports higher than 10K. Apf now by default maps all server containers (80) to host port 10080. I tried Nginx and httpd.

Maybe change the default port to something like 9080 or 8080 to avoid this problem.

Docker ➤ docker ps
CONTAINER ID   IMAGE     COMMAND                  CREATED          STATUS          PORTS     NAMES
c88969704c48   nginx     "/docker-entrypoint.…"   15 minutes ago   Up 15 minutes   80/tcp    nginx
Docker ➤ apf nginx

*  ==> : Forwarding local listening ports to (==>) remote ports
*  <== : Forwarding to local ports from (<==) remote listening ports (use -r option)

Forwarding: [10080 ==> 80]

Get request from Netcat. Website root (Nginx default page) is loaded.

Docker ➤ nc localhost 10080
GET / HTTP/1.2
Host: localhost

HTTP/1.1 200 OK
Server: nginx/1.21.4
Date: Thu, 10 Feb 2022 09:28:03 GMT
Content-Type: text/html
Content-Length: 615
Last-Modified: Tue, 02 Nov 2021 14:49:22 GMT
Connection: keep-alive
ETag: "61814ff2-267"
Accept-Ranges: bytes

<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
<style>
html { color-scheme: light dark; }
body { width: 35em; margin: 0 auto;
font-family: Tahoma, Verdana, Arial, sans-serif; }
</style>
</head>
<body>
<h1>Welcome to nginx!</h1>
<p>If you see this page, the nginx web server is successfully installed and
working. Further configuration is required.</p>

<p>For online documentation and support please refer to
<a href="http://nginx.org/">nginx.org</a>.<br/>
Commercial support is available at
<a href="http://nginx.com/">nginx.com</a>.</p>

<p><em>Thank you for using nginx.</em></p>
</body>
</html>
Docker ➤

Browser Screenshot 2022-02-10 at 10 30 59

opened Feb 10, 2022 by MilanVives 3
Closed

Invalid memory address or nil pointer dereference on M1 

~ ➤ docker run -d --name redis redis
ae44475c8835158e4c1d36406de38048b3b797e49f5f86a80e23f3e330b89c9f
~ ➤ apf redis

*  ==> : Forwarding local listening ports to (==>) remote ports
*  <== : Forwarding to local ports from (<==) remote listening ports (use -r option)

Forwarding: []panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x18 pc=0x102cdff34]

goroutine 8 [running]:
io.ReadAtLeast({0x0, 0x0}, {0x140000ae00a, 0x3, 0x3}, 0x3)
	/opt/hostedtoolcache/go/1.17.5/x64/src/io/io.go:328 +0x74
io.ReadFull(...)
	/opt/hostedtoolcache/go/1.17.5/x64/src/io/io.go:347
github.com/ruoshan/autoportforward/manager.(*Manager).receivingLoop(0x14000066000)
	/home/runner/work/autoportforward/autoportforward/manager/manager.go:86 +0xb8
created by github.com/ruoshan/autoportforward/manager.(*Manager).Run
	/home/runner/work/autoportforward/autoportforward/manager/manager.go:74 +0x54
~ ➤
opened Feb 8, 2022 by MilanVives 3
Closed

add support for podman/containerd

Please add command line argument to extend your tool for other container runtimes.

It is probably easy to add Podman support. It has compatible command line for cp/exec commands.

Containerd doesn't have cp command, but it looks for k8s you do same as described here https://github.com/containerd/containerd/issues/2044.

enhancement 
opened Jan 4, 2022 by k2s 1

Contents

    Shimmur Tool for tunneling a port forward into remote Docker containers over SSH 🚢
    p3nt4 Forward local or remote tcp ports through SMB pipes.
    ridha Kills all processes listening on the given TCP ports
    buildfoundation Tool for remote builds. Sync project to remote machine, execute command, sync back.
    bsideup Utility to auto forward a port from localhost into ports on Docker containers running in a boot2docker or Docker Machine VM
    brthor Push docker images from your local machine to remote servers without the hassle.
    flackbash Android audio player that tracks the listening progress of your audio books and podcasts
    nitr0us A RAT (Remote Administration Tool) using port-knocking techniques for *NIX systems I wrote in 2006 but still works in 2017. libpcap-based server and libnet-based client. No TCP/UDP port listening.
    Microsoft Visual Studio Code Remote Development: Open any folder in WSL, in a Docker container, or on a remote machine using SSH and take advantage of VS Code's full feature set.
    TheLittleMister In n-back task you need to remember n previous spatial or auditory stimuli. N-back is a memory test where n refers on how many previous stimuli must be remembered. Dual means that verbal auditory stimulus and spatial visual stimulus are presented at the same time and must be remembered separately.
    ideamark A simple and powerful remote ports mapping tool
    freaker2k7 Super lightweight & simple RESTFul distributed server for running docker containers on a remote machine(s).
    Rich-Harris Utilities for dealing with ports in Node apps
    cristianoliveira The management of multiple apps running over different ports made easy
    mcaubrey Neumorphic containers and text widget primitives to serve as the foundation of your own unique neumorphic designs.
    mcaubrey Neumorphic containers and text widget primitives to serve as the foundation of your own unique neumorphic designs.
    containers Podman: A tool for managing OCI containers and pods
    hyperia-sk Simple and efficient way to delete remote branches from git repository.
    GhostPack SharpWMI is a C# implementation of various WMI functionality.
    BlackHC Putting TensorFlow back in PyTorch, back in TensorFlow (differentiable TensorFlow PyTorch adapters).
    amosavian FileManager replacement for Local, iCloud and Remote (WebDAV/FTP/Dropbox/OneDrive) files -- Swift
    Share this repo

    Related Repos


    Networking
    19
    Create, manage and execute http requests from the terminal
    PierreKieffer _ _ _ _ _ | |_| |_| |_ _ __ ___| |_ __ _ _ _ | |_____ _ _ | ' \ _| _| '_ \___| _/ _` | ' \| / / -_) '_| |_||
     
    Networking
    341
    GoNN is an implementation of Neural Network in Go Language, which includes BPNN, RBF, PCN
    fxsjy GoNN Neural Network in GoLang Feature BackPropagation Network / RBF Network / Perceptron Network Parallel BackPropagation Network (each neural has its
     
    Networking
    6
    Simple HTTP client for Go
    hadihammurabi GoRe (Go Requester) Simple HTTP client for Go Example g := gore.New( gore.WithBaseURL("https://api.products.com"), ) resp, err := g.Get("/entities"
     
    Networking
    8
    A simple Go server that broadcasts any data/stream
    schollz broadcast A simple Go server that broadcasts any data/stream usage data You can POST data. curl -X POST --data-binary "@111.png" localhost:9222/test.p
     
    Networking
    7
    Lightweight HTTP server to handle webhooks from listmonk and forward it to different messe...
    joeirimpan listmonk-messenger Lightweight HTTP server to handle webhooks from listmonk and forward it to different messengers. Supported messengers Pinpoint Deve
     
    Networking
    4
    Cloud-Z gathers information and perform benchmarks on cloud instances in multiple cloud pr...
    CloudSnorkel Cloud-Z Cloud-Z gathers information and perform benchmarks on cloud instances in multiple cloud providers. Cloud type, instance id, and type CPU infor
     
    Networking
    3.1k
    Expose localhost servers to the Internet
    progrium localtunnel What happened to localtunnel? After pioneering instant public tunnels to localhost, many people copied the project and started businesses
     
    Networking
    259
    Distributed tracing using OpenTelemetry and ClickHouse
    uptrace Distributed tracing backend using OpenTelemetry and ClickHouse Uptrace is a distributed tracing system that uses OpenTelemetry to collect data and Cli
     
    Networking
    8
    Automatically exposes the remote container's listening ports back to the local machine
    ruoshan Auto-portforward (apf) A handy tool to automatically set up proxies that expose the remote container's listening ports back to the local machine. Just
     
    Networking
    0
    An encrypted photo album for home network use
    codazoda X2 An (eventually encrypted) private photo album for home network use. Getting Started The server should run on any Mac, Linux, or Windows machine but
     
    Networking
    18
    USENET-inspired decentralized internet discussion system
    mrusme =============================================================================== INTERACTIVE ASYNC / FULL DUPLEX ===============
     
    Networking
    3
    🪝 Make requests to HTTP servers with Hackney
    gleam-lang Hackney Bindings to Erlang's HTTP client, hackney. import gleam/hackney import gleam/http.{Get} import gleeunit/should pub fn main() { // Prepare a
     
    Networking
    0
    It is simple proxy to work with tcp connection
    gelleson It is simple proxy to work with tcp connection
     
    Networking
    8
    Help fuzz various protocols and waits for ping backs Integrates LDAP server and JNDI paylo...
    LeakIX l9fuzz Fuzzes various protocols with JNDI LDAP payloads and listen for ping backs Features Low CPU/Memory footprint Integrated LDAP server Trace orign
     
    Networking
    3
    A light-weight high-performance UDP sockets library
    org-arl DirectSockets A light-weight high-performance UDP sockets library. Background The Julia standard library Sockets provides a great UDPSocket implementa