managed

Documentation

Index

• Constants
• func AddTransportOptions(transportOptsURL string, opts TransportOptions)
• func CheckKnownHost(host string, knownHosts []byte, fingerprint []byte) error
• func Enabled() bool
• func InitManagedTransport() error
• func KnownHostsCallback(host string, knownHosts []byte) git2go.CertificateCheckCallback
• func RemoteCallbacks() git2go.RemoteCallbacks
• func RemoveTransportOptions(transportOptsURL string)
• type TransportOptions

Constants

const (
	// URLMaxLength represents the max length for the entire URL
	// when cloning Git repositories via HTTP(S).
	URLMaxLength = 2048

	// PathMaxLength represents the max length for the path element
	// when cloning Git repositories via SSH.
	PathMaxLength = 4096
)

Functions

func AddTransportOptions

func AddTransportOptions(transportOptsURL string, opts TransportOptions)

AddTransportOptions registers a TransportOptions object mapped to the provided transportOptsURL, which must be a valid URL, i.e. prefixed with "http://" or "ssh://", as it is used as a dummy URL for all git operations and the managed transports will only be invoked for the protocols that they have been registered for.

func CheckKnownHost

func CheckKnownHost(host string, knownHosts []byte, fingerprint []byte) error

CheckKnownHost checks whether the host being connected to is part of the known_hosts, and if so, it ensures the host fingerprint matches the fingerprint of the known host with the same name.

func Enabled

func Enabled() bool

Enabled defines whether the use of Managed Transport is enabled which is only true if InitManagedTransport was called successfully at least once.

This is only affects git operations that uses libgit2 implementation.

func InitManagedTransport

func InitManagedTransport() error

InitManagedTransport initialises HTTP(S) and SSH managed transport for git2go, and therefore only impact git operations using the libgit2 implementation.

This must run after git2go.init takes place, hence this is not executed within a init(). Regardless of the state in libgit2/git2go, this will replace the built-in transports.

This function will only register managed transports once, subsequent calls leads to no-op.

func KnownHostsCallback

func KnownHostsCallback(host string, knownHosts []byte) git2go.CertificateCheckCallback

knownHostCallback returns a CertificateCheckCallback that verifies the key of Git server against the given host and known_hosts for git.SSH Transports.

func RemoteCallbacks

func RemoteCallbacks() git2go.RemoteCallbacks

RemoteCallbacks constructs git2go.RemoteCallbacks with dummy callbacks.

func RemoveTransportOptions

func RemoveTransportOptions(transportOptsURL string)

RemoveTransportOptions removes the registerd TransportOptions object mapped to the provided id.

Types

type TransportOptions

type TransportOptions struct {
	TargetURL    string
	AuthOpts     *git.AuthOptions
	ProxyOptions *git2go.ProxyOptions
	Context      context.Context
}

TransportOptions represents options to be applied at transport-level at request time.