forward

README

go-ssh-forward: A library for setting up a Forward via SSH in go

Table of Contents

• Motivation
• Usage
• Inspiration
• License

Motivation

I wanted it to be possible to establish a tunnel like the following in go

$ ssh -f -L 2376:localhost:2376 \ 
  -o ExitOnForwardFailure=yes \ 
	-o ProxyCommand="ssh -l jumpuser1 -i /Users/abc/.ssh/id_rsa_jump_host1 10.0.0.1 -W %h:%p" \ 
	-o UserKnownHostsFile=/dev/null \ 
	-o StrictHostKeyChecking=no \ 
	-i /Users/abc/.ssh/id_rsa_end_host \ 
	endhostuser@20.0.0.1 \
	sleep 10

In this scenario the end host is only accessible via the jump host

    localhost:2376 --(j)--> 10.0.0.1:22 --(e)--> 20.0.0.1:2376 -> 127.0.0.1:2376
       `host A`              `jump host`          `end host          `end host`          

Usage

package main

import (
	"log"
	"time"

  fw "github.com/mavogel/go-ssh-forward"
)
func main() {
  forwardConfig := &fw.Config{
		JumpHostConfigs: []*fw.SSHConfig{
			&fw.SSHConfig{
				Address:        "10.0.0.1:22",
				User:           "jumpuser1",
				PrivateKeyFile: "/Users/abc/.ssh/id_rsa_jump_host1",
			},
		},
		EndHostConfig: &fw.SSHConfig{
			Address:        "20.0.0.1:22",
			User:           "endhostuser",
			PrivateKeyFile: "/Users/abc/.ssh/id_rsa_end_host",
		},
		LocalAddress:  "localhost:2376",
		RemoteAddress: "localhost:2376",
  }
 
  forward, forwardErrors, bootstrapErr := fw.NewForward(forwardConfig)
  handleForwardErrors(forward)
  defer forward.Stop()
  if bootstrapErr != nil {
		log.Printf("bootstrapErr: %s", bootstrapErr)
		return
  }
  
  // run commands against 127.0.0.1:2376
  // ...

}

func handleForwardErrors(forwardErrors chan error) {
	go func() {
		for {
			select {
			case forwardError := <-forwardErrors:
				log.Printf("forward err: %s", forwardError)
			case <-time.After(3 * time.Second):
				log.Printf("NO forward err...")
			}
		}
	}()
}

Inspiration

• ssh via bastion
• Go Best Practices
• Shutdown go listeners
• sshego

License

Copyright (c) 2018 Manuel Vogel
Source code is open source and released under the MIT license.

Documentation

Index

• type Config
• type Forward
  • func NewForward(config *Config) (*Forward, chan error, error)
  • func (f *Forward) Stop()
• type SSHConfig

Types

type Config

type Config struct {
	JumpHostConfigs []*SSHConfig
	EndHostConfig   *SSHConfig
	LocalAddress    string
	RemoteAddress   string
}

Config the configuration for the forward

type Forward

type Forward struct {
	// contains filtered or unexported fields
}

Forward wraps the forward

func NewForward

func NewForward(config *Config) (*Forward, chan error, error)

NewForward creates new forward with optional jump hosts

func (*Forward) Stop

func (f *Forward) Stop()

Stop stops the forward

type SSHConfig

type SSHConfig struct {
	Address        string
	User           string
	PrivateKeyFile string
	Password       string
}

SSHConfig for a cleaner version