cmd

Documentation

Index

• Constants
• Variables
• func ExamplePbkdf2JsonStr() string
• func GeneratePaths(args []string) (string, string, error)
• func HeadersWithYamux(headers []piping_util.KeyValue) []piping_util.KeyValue
• func MakeDuplexWithEncryptionAndProgressIfNeed(duplex io.ReadWriteCloser, encrypts bool, passphrase string, cipherType string, ...) (io.ReadWriteCloser, error)
• func MakeProgressMessage(progress *io_progress.IOProgress) string
• func MakeUserInputPassphraseIfEmpty(passphrase *string) (err error)
• func ValidateClientCipher(str string) error
• type ClientPmuxConfigJson
• type OpensslAesCtrParams
  • func ParseOpensslAesCtrParams(cipherType string, pbkdf2ConfigJsonStr string) (*OpensslAesCtrParams, error)
• type Pbkdf2Config
  • func ParsePbkdf2(str string) (*Pbkdf2Config, error)
• type ServerPmuxConfigJson

Constants

const (
	YamuxFlagLongName                          = "yamux"
	PmuxFlagLongName                           = "pmux"
	PmuxConfigFlagLongName                     = "pmux-config"
	SymmetricallyEncryptsFlagLongName          = "symmetric"
	SymmetricallyEncryptsFlagShortName         = "c"
	SymmetricallyEncryptPassphraseFlagLongName = "pass"
	CipherTypeFlagLongName                     = "cipher-type"
	Pbkdf2FlagLongName                         = "pbkdf2"
)

const DefaultCipherType = piping_util.CipherTypeAesCtr

const (
	ServerUrlEnvName = "PIPING_SERVER"
)

const YamuxMimeType = "application/yamux"

Variables

var DnsServer string

var HeaderKeyValueStrs []string

var HttpReadBufSize int

var HttpWriteBufSize int

var Insecure bool

var RootCmd = &cobra.Command{
	Use:          os.Args[0],
	Short:        "piping-tunnel",
	Long:         "Tunneling from anywhere with Piping Server",
	SilenceUsage: true,
	Example: fmt.Sprintf(`
Normal:
  piping-tunnel server -p 22 aaa bbb
  piping-tunnel client -p 1022 aaa bbb

Short:
  piping-tunnel server -p 22 mypath
  piping-tunnel client -p 1022 mypath

Multiplexing:
  piping-tunnel server -p 22 --yamux aaa bbb
  piping-tunnel client -p 1022 --yamux aaa bbb

SOCKS proxy like VPN:
  piping-tunnel socks --yamux aaa bbb
  piping-tunnel client -p 1080 --yamux aaa bbb

Environment variable:
  $%s for default Piping Server
`, ServerUrlEnvName),
	RunE: func(cmd *cobra.Command, args []string) error {
		if showsVersion {
			fmt.Println(version.Version)
			return nil
		}
		return cmd.Help()
	},
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		Vlog.Level = verboseLoggerLevel
	},
}

var ServerUrl string

var ShowProgress bool

var Vlog *verbose_logger.Logger

Functions

func ExamplePbkdf2JsonStr

func ExamplePbkdf2JsonStr() string

func GeneratePaths

func GeneratePaths(args []string) (string, string, error)

func HeadersWithYamux

func HeadersWithYamux(headers []piping_util.KeyValue) []piping_util.KeyValue

func MakeDuplexWithEncryptionAndProgressIfNeed

func MakeDuplexWithEncryptionAndProgressIfNeed(duplex io.ReadWriteCloser, encrypts bool, passphrase string, cipherType string, pbkdf2JsonStr string) (io.ReadWriteCloser, error)

func MakeProgressMessage

func MakeProgressMessage(progress *io_progress.IOProgress) string

func MakeUserInputPassphraseIfEmpty

func MakeUserInputPassphraseIfEmpty(passphrase *string) (err error)

func ValidateClientCipher

func ValidateClientCipher(str string) error

Types

type ClientPmuxConfigJson

type ClientPmuxConfigJson struct {
	Hb bool `json:"hb"`
}

type OpensslAesCtrParams

type OpensslAesCtrParams struct {
	KeyBits uint16
	Pbkdf2  *Pbkdf2Config
}

func ParseOpensslAesCtrParams

func ParseOpensslAesCtrParams(cipherType string, pbkdf2ConfigJsonStr string) (*OpensslAesCtrParams, error)

type Pbkdf2Config

type Pbkdf2Config struct {
	Iter                   int
	Hash                   func() hash.Hash
	HashNameForCommandHint string // for command hint
}

func ParsePbkdf2

func ParsePbkdf2(str string) (*Pbkdf2Config, error)

type ServerPmuxConfigJson

type ServerPmuxConfigJson struct {
	Hb bool `json:"hb"`
}