proxy

Documentation

Overview

Copyright 2017 Gravitational, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func DialWithDeadline(network string, addr string, config *ssh.ClientConfig) (*ssh.Client, error)
• func NewClientConnWithDeadline(conn net.Conn, addr string, config *ssh.ClientConfig) (*ssh.Client, error)
• type Dialer
  • func DialerFromEnvironment(addr string) Dialer

Functions

func DialWithDeadline

func DialWithDeadline(network string, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

DialWithDeadline works around the case when net.DialWithTimeout succeeds, but key exchange hangs. Setting deadline on connection prevents this case from happening

func NewClientConnWithDeadline

func NewClientConnWithDeadline(conn net.Conn, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

NewClientConnWithDeadline establishes new client connection with specified deadline

Types

type Dialer

type Dialer interface {
	// Dial establishes a client connection to a SSH server.
	Dial(network string, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

	// DialTimeout acts like Dial but takes a timeout.
	DialTimeout(network, address string, timeout time.Duration) (net.Conn, error)
}

A Dialer is a means for a client to establish a SSH connection.

func DialerFromEnvironment

func DialerFromEnvironment(addr string) Dialer

DialerFromEnvironment returns a Dial function. If the https_proxy or http_proxy environment variable are set, it returns a function that will dial through said proxy server. If neither variable is set, it will connect to the SSH server directly.