Initial

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>

Author: alexellis

.github/CODEOWNERS

@@ -0,0 +1 @@
+@alexellis

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+# reference: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: build
+
+on:
+  push:
+    branches:
+    - '*'
+  pull_request:
+    branches:
+    - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        go-version: [1.18.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 1
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Make all
+        run: make all

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish:
+    strategy:
+      matrix:
+        go-version: [1.18.x]
+        os: [ ubuntu-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 1
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Make all
+        run: make all
+      - name: Upload release binaries
+        uses: alexellis/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          asset_paths: '["./bin/mixctl*"]'

.gitignore

@@ -0,0 +1,2 @@
+/mixctl
+/bin/**

EULA.md

@@ -0,0 +1,56 @@
+End User License Agreement (EULA)
+
+1. Licensed software. inlets Pro is licensed as commercial software and must not be used without a valid license key from OpenFaaS Ltd.
+
+1.1 OpenFaaS Ltd. ("Supplier") is a registered company in England & Wales with number: 11076587, registered address: Peterborough UK.
+
+2. Your agreement. By accessing, executing, or otherwise using the Licensed Software, you ("Customer") acknowledge that you have read this Agreement, understand it, and agree to be bound by its terms and conditions. If you are not willing to be bound by the terms of this Agreement, do not access or use the Licensed Software.
+
+2.1 If you are using the Licensed Software in your capacity as employee or agent of a company or organization, then any references to “you” in this Agreement shall refer to such entity and not to you in your personal capacity. You warrant that you are authorized to legally bind the company or organization on whose behalf you are accessing the Licensed Software. If you are not so authorized, then neither you nor your company or organization may use the Licensed Software in any manner whatsoever.
+
+2.2 This Agreement, including any supplemental terms is between You ("Customer) and OpenFaaS Ltd. ("Supplier").
+
+2.3 Governing law. This Agreement is entered into the law of The Courts of England and Wales and shall be governed by, and construed in accordance with, the laws of England and Wales, exclusive of its choice of law rules.
+
+3. Free Trial
+
+If you either register on the inlets Pro web site for a free trial or otherwise order a free trial version, OpenFaaS Ltd will make certain Licensed Software available to you on a trial basis (the “Trial Version”) free of charge until the end of the free trial period for which you registered or ordered the applicable Licensed Software. The Trial Version may be used only to review, demonstrate and evaluate the Licensed Software and may have limited features. The Trial Version may cease operating after the applicable time period or number of uses based on an internal metering mechanism within the Trial Version itself. Regardless of any such metering, you must stop use at the end of such period or number of uses. Additional trial terms and conditions may appear on the trial registration web page or Order Form. Any such additional terms and conditions are incorporated into this Agreement by reference and are legally binding.
+
+4. Grant of License; Ownership.
+
+4.1 License Grant. Subject to the terms and conditions of this Agreement and Order Form, OpenFaaS Ltd hereby:
+
+(i) grants to the Licensee a limited, non-exclusive, non-transferable, revocable, license to use the Licensed Software and solely for its internal business purposes for use by End Users and for the term and in accordance with the conditions and limitations set forth herein and in the Order Form.
+
+(ii) To the extent that there is any Third Party Software embedded in, bundled with, or otherwise provided to Licensee in connection with the Licensed Program Materials under this License Agreement, such third party software shall be considered Licensed Software and such Third Party Software shall be used and operated solely with the operation of the Licensed Program Materials and not as a standalone application or any other purpose. Certain Third Party Software may be subject to an open source license(“OSS License”), which when required by such license is included with the documentation for the Licensed Software (“Documentation”). Licensee’s license rights with respect to Third Party Software subject to an OSS License are defined by the terms of the applicable OSS License; nothing in this Agreement shall restrict, limit, or otherwise affect any rights or obligations Licensee may have, or conditions to which Licensee may be subject, under such OSS License. The foregoing includes, without limitation, the Apache License, Version 2.0 found at: http://www.apache.org/licenses/LICENSE-2.0 (the “Apache License”) and the MIT License found at: https://opensource.org/licenses/MIT
+
+4.2 Ownership. As between the parties, OpenFaaS Ltd retains all right, title and interest in the Licensed Program Materials, including but not limited to any and all Intellectual Property Rights in the Licensed Program Materials now owned or that may be owned in the future by OpenFaaS Ltd.
+
+4.3 Intellectual Property Rights (IPR). Copyright for samples, code, logos, trademarks, diagrams and documentation rests with OpenFaaS Ltd. All pre-existing IPR remains the property of the originating party; and it is agreed that no IPR is transferred from the Client to the Supplier under this agreement.
+
+4.4 Restrictions. Licensee shall not distribute, display, sublicense, rent, lease, use in a service bureau, modify, translate, reverse engineer, decompile, disassemble, create derivative works based on, or copy the Licensed Program Materials, except to the extent expressly permitted by applicable law, and only to the extent OpenFaaS Ltd shall not be permitted by that applicable law to exclude or limit such rights.
+
+4.5 Feedback. Customer may provide feedback to OpenFaaS Ltd about the Products (e.g. technical support input, suggestions, or enhancement requests). OpenFaaS Ltd may develop, modify, and improve the Products based on Customer’s Feedback without obligation to Customer, and Customer irrevocably assigns to OpenFaaS Ltd all right, title, and interest in that Feedback.
+
+5. Termination and ongoing effectiveness
+
+This Agreement is effective from the first date you install the Software. You may terminate this Agreement at any time by permanently deleting, destroying and returning, at your own cost, the Software, all backup copies and all related materials provided by OpenFaaS Ltd. OpenFaaS Ltd or its licensors may terminate this Agreement at any time without notice if you fail to comply with any terms or conditions of this Agreement. Once it is terminated you MUST stop using this Software and delete all the Software and associated materials already copied and/or installed on your computer immediately.
+
+6. Customer Data
+
+6.1 Customer Data. In order to use the Products, Customer may need to complete a registration process and provide contact information such as an email address, credentials and other account billing information ("Account Data"). Customer must provide complete and accurate Account Data during the registration process and must keep Customer's Account Data up-to-date. Customer is prohibited from misrepresenting Customer's identity or affiliation with any company or other entity. By providing Account Data, Customer hereby consents that it may receive email or other communications from OpenFaaS Ltd. Such communications may include communications regarding Customer's use of the Products and/or commercial content relating to other OpenFaaS Ltd Products. If you do not wish to receive such communications, a Customer may opt-out by notifying OpenFaaS Ltd at [email protected]
+
+7. Co-Marketing
+At the request of Supplier, Customer agrees to participate in other reasonable marketing activities that promote the benefits of the Services to other potential customers and to use of Customer's name and logo on the Supplier's web site and in Supplier's promotional materials. Customer agrees that Supplier may disclose Customer as a customer of the Products.
+
+8. Limitation of Liability.
+
+8.1 Warranty disclaimer. You acknowledge that the Software is provided "as is" without warranty of any kind, express or implied. You use the Software at your own risk and the product is supplied on an "as is" and "as available" basis. You assume all responsibility for selecting the Software to achieve your intended results, and for the installation of, and results obtained from the Software.
+
+8.2 No Consequential Damages. IN NO EVENT SHALL OpenFaaS Ltd BE LIABLE HEREUNDER FOR SPECIAL, PUNITIVE, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES, INCLUDING, BUT NOT LIMITED TO, LOSS OF PROFITS, LOSS OF REVENUE, LOSS OF USE OR LOSS OF DATA, EVEN IF ADVISED OF THE POSSIBILITY THEREOF OR, IF REASONABLY FORESEEABLE, INCURRED BY LICENSEE OR END USERS, OR CLAIMED AGAINST LICENSEE BY ANY OTHER PARTY, INCLUDING END USERS (WHETHER ANY SUCH CLAIMS ARISE UNDER THEORY OF CONTRACT, TORT OR OTHERWISE).
+
+8.3 Limitation of Liability. To the extent permitted by applicable law, the liability of OpenFaaS Ltd and its licensors, personnel, subcontractors and suppliers arising out of, in connection with, or resulting from this Agreement and, without limitation, for any and all causes with respect to the Licensed Program Materials, breach of contract, tort, warranty or otherwise, shall in the aggregate not exceed the license fees paid by Licensee hereunder in the twelve (12) months immediately preceding the event giving rise to the claim.
+
+8.3 Sections 1, 2, 3, 4, 5, 6, 7 and 8 will remain effective after the termination of the Agreement.
+
+8.4 If you have any questions about these terms or our Services you may contact us by email at: [email protected]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Inlets Author(s)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,35 @@
+Version := $(shell git describe --tags --dirty)
+GitCommit := $(shell git rev-parse HEAD)
+LDFLAGS := "-s -w -X github.com/inlets/inlets-mixer/main.Version=$(Version) -X github.com/inlets/inlets-mixer/main.GitCommit=$(GitCommit)"
+PLATFORM := $(shell ./hack/platform-tag.sh)
+SOURCE_DIRS = main.go
+export GO111MODULE=on
+
+.PHONY: all
+all: gofmt test build dist hash
+
+.PHONY: build
+build:
+	go build
+
+.PHONY: gofmt
+gofmt:
+	@test -z $(shell gofmt -l -s $(SOURCE_DIRS) ./ | tee /dev/stderr) || (echo "[WARN] Fix formatting issues with 'make gofmt'" && exit 1)
+
+.PHONY: test
+test:
+	CGO_ENABLED=0 go test $(shell go list ./... | grep -v /vendor/|xargs echo) -cover
+
+.PHONY: dist
+dist:
+	mkdir -p bin
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags $(LDFLAGS) -a -installsuffix cgo -o bin/inlets-mixer
+	CGO_ENABLED=0 GOOS=darwin go build -ldflags $(LDFLAGS) -a -installsuffix cgo -o bin/inlets-mixer-darwin
+	CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -a -ldflags $(LDFLAGS) -installsuffix cgo -o bin/inlets-mixer-darwin-arm64
+	CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=6 go build -ldflags $(LDFLAGS) -a -installsuffix cgo -o bin/inlets-mixer-armhf
+	CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags $(LDFLAGS) -a -installsuffix cgo -o bin/inlets-mixer-arm64
+	CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags $(LDFLAGS) -a -installsuffix cgo -o bin/inlets-mixer.exe
+
+.PHONY: hash
+hash:
+	rm -rf bin/*.sha256 && ./hack/hashgen.sh

README.md

@@ -0,0 +1,42 @@
+## mixctl
+
+mixctl by inlets is a TCP proxy to forward multiple TCP connections over a single inlets Pro TCP tunnel.
+
+## Usage:
+
+1) Write a rules.yaml file such as: [./rules.example.yaml](./rules/example.yaml):
+
+```yaml
+version: 0.1
+
+rules:
+- name: rpi-k3s
+  from: 127.0.0.1:6443
+  to:
+    - 192.168.1.19:6443
+    - 192.168.1.21:6443
+    - 192.168.1.20:6443
+
+- name: rpi-ssh
+  from: 127.0.0.1:22222
+  to:
+    - 192.168.1.19:22
+    - 192.168.1.21:22
+    - 192.168.1.20:22
+```
+
+2) Run the tool: `mixctl -f ./rules.yaml`
+
+3) Run `inlets-pro tcp client --ports 6443 --ports 22222`
+
+4) Connect to ports 6443 or 22222 on your inlets Pro tunnel server to access any of the servers in the "to" array
+
+Connections are load balanced if there are multiple hosts in the `to` field.
+
+To make the upstream address listen on multiple ports, use `0.0.0.0` instead of `127.0.0.1` in the `from` field.
+
+The port for the from and to addresses do not need to match.
+
+## License
+
+This software is licensed MIT.

go.mod

@@ -0,0 +1,8 @@
+module github.com/inlets/mixctl
+
+go 1.18
+
+require (
+	golang.org/x/sync v0.0.0-20220907140024-f12130a52804
+	gopkg.in/yaml.v3 v3.0.1
+)

go.sum

@@ -0,0 +1,7 @@
+golang.org/x/sync v0.0.0-20220907140024-f12130a52804 h1:0SH2R3f1b1VmIMG7BXbEZCBUu2dKmHschSmjqGUrW8A=
+golang.org/x/sync v0.0.0-20220907140024-f12130a52804/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

hack/hashgen.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+for f in bin/uphill*; do shasum -a 256 $f > $f.sha256; done

hack/platform-tag.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+getPackage() {
+    suffix=""
+    arch=$(uname -m)
+    case $arch in
+    "aarch64")
+    suffix="-arm64"
+    ;;
+    esac
+    case $arch in
+    "armv6l" | "armv7l")
+    suffix="-armhf"
+    ;;
+    esac
+}
+
+getPackage
+echo ${suffix}

main.go

@@ -0,0 +1,116 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"io"
+	"log"
+	"math/rand"
+	"net"
+	"os"
+	"sync"
+	"time"
+
+	"golang.org/x/sync/errgroup"
+	yaml "gopkg.in/yaml.v3"
+)
+
+type ForwardingSet struct {
+	Rules []Rule `yaml:"rules"`
+}
+
+type Rule struct {
+	Name string   `yaml:"name"`
+	From string   `yaml:"from"`
+	To   []string `yaml:"to"`
+}
+
+func main() {
+	var (
+		file string
+	)
+
+	flag.StringVar(&file, "f", "", "Job to run or leave blank for job.yaml in current directory")
+
+	flag.Parse()
+
+	set := ForwardingSet{}
+	data, err := os.ReadFile(file)
+	if err != nil {
+		log.Fatalf("error reading file %s %s", file, err.Error())
+	}
+	if err = yaml.Unmarshal(data, &set); err != nil {
+		log.Fatalf("error parsing file %s %s", file, err.Error())
+	}
+
+	fmt.Printf("mixctl by inlets..\n")
+
+	wg := sync.WaitGroup{}
+	wg.Add(len(set.Rules))
+	for _, f := range set.Rules {
+
+		r := f
+		go func(rule *Rule) {
+			fmt.Printf("Forward (%s) from: %s to: %s\n", rule.Name, rule.From, rule.To)
+
+			if err := forward(rule.Name, rule.From, rule.To); err != nil {
+				log.Printf("error forwarding %s", err.Error())
+				os.Exit(1)
+			}
+
+			defer wg.Done()
+		}(&r)
+	}
+	wg.Wait()
+
+}
+
+func forward(name, from string, to []string) error {
+	seed := time.Now().UnixNano()
+	rand.Seed(seed)
+
+	l, err := net.Listen("tcp", from)
+	if err != nil {
+		return fmt.Errorf("error listening on %s %s", from, err.Error())
+	}
+	log.Printf("listening on %s", from)
+	for {
+		conn, err := l.Accept()
+		if err != nil {
+			return fmt.Errorf("error accepting connection %s", err.Error())
+		}
+
+		index := rand.Intn(len(to))
+
+		remote, err := net.Dial("tcp", to[index])
+		if err != nil {
+			return fmt.Errorf("error dialing %s %s", to[index], err.Error())
+		}
+
+		go func() {
+			log.Printf("[%s] %s => %s",
+				from,
+				conn.RemoteAddr().String(),
+				remote.RemoteAddr().String())
+			if err := forwardConnection(conn, remote); err != nil && err.Error() != "done" {
+				log.Printf("error forwarding connection %s", err.Error())
+			}
+		}()
+	}
+}
+
+func forwardConnection(from, to net.Conn) error {
+	errgrp, _ := errgroup.WithContext(context.Background())
+	errgrp.Go(func() error {
+		io.Copy(from, to)
+
+		return fmt.Errorf("done")
+	})
+	errgrp.Go(func() error {
+		io.Copy(to, from)
+		return fmt.Errorf("done")
+	})
+
+	return errgrp.Wait()
+}