package bridge

Import Path
	github.com/limanmys/render-engine/internal/bridge (on go.dev)

Dependency Relation
	imports 26 packages, and imported by 4 packages

Involved Source Files

	    clean.go
	    connection.go
	    file.go
	    initialize.go
	    session.go
	    sftp.go
	    smb.go
	    ssh.go
	    ssh_tunnel.go
	    winrm.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Pool (struct)

		Fields (total 2)
			Connections map[string]*Session
			Mutex sync.Mutex
		Methods (total 8)
			(*Pool) Delete(key string)
				Delete connection object from pool

			(*Pool) Get(userID, serverID string) (*Session, error)
				Get connection from pool

			(*Pool) GetRaw(userID, remoteHost, username string) (*Session, error)
				GetRaw connection object from pool

			(*Pool) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*Pool) Set(userID, serverID string, session *Session)
				Set connection on pool

			(*Pool) SetRaw(userID, remoteHost, username string, session *Session)
				SetRaw connection object on pool

			(*Pool) TryLock() bool
				TryLock tries to lock m and reports whether it succeeded.
				
				Note that while correct uses of TryLock do exist, they are rare,
				and use of TryLock is often a sign of a deeper problem
				in a particular use of mutexes.

			(*Pool) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.
				
				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

		Implements (at least one exported)
			*Pool : sync.Locker
		As Types Of (only one)
			  var Sessions

	 type Session (struct)

		Fields (total 12)
			IpAddr string
			LastConnection time.Time
			Mutex sync.Mutex
			Port string
			SFTP *sftp.Client
			SMB *smb2.Session
			SSH *ssh.Client
			SSHSession *ssh.Client
			Username string
			WinRM *winrm.Client
			WindowsLetter string
			WindowsPath string
		Methods (total 14)
			(*Session) CloseAllConnections()
				CloseAllConnections closes all connections on session

			(*Session) CreateFileConnection(userID, serverID, host string) bool
				CreateFileSesssion creates a new file session with credential type and sets it on session

			(*Session) CreateRaw(connectionType, username, password, host, port string) bool
				CreateRaw creates a new raw shell with credential type and sets it on session

			(*Session) CreateShell(userID, serverID, host string) bool
				CreateShell creates a new shell with credential type and sets it on session

			(*Session) Get(localPath, remotePath string) error
				Get downloads file to local path

			(*Session) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*Session) Put(localPath, remotePath string) error
				Put sends file to a remote path

			(*Session) Run(command string) (string, error)
				Run runs command on sessions SSH and returns output

			(*Session) SftpGetFile(localPath, remotePath string) error
				SftpGetFile downloads file from remote path

			(*Session) SftpPutFile(localPath, remotePath string) error
				SftpPutFile uploads file on remote path

			(*Session) SmbGetFile(localPath, remotePath, remoteDisk string) error
				SmbGetFile downloads file from remote path to local path

			(*Session) SmbPutFile(localPath, remotePath, remoteDisk string) error
				SmbPutFile uploads file from local path to remote path

			(*Session) TryLock() bool
				TryLock tries to lock m and reports whether it succeeded.
				
				Note that while correct uses of TryLock do exist, they are rare,
				and use of TryLock is often a sign of a deeper problem
				in a particular use of mutexes.

			(*Session) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.
				
				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

		Implements (at least one exported)
			*Session : sync.Locker
		As Outputs Of (at least 3)
			func GetSession(userID, serverID, host string) (*Session, error)
			func (*Pool).Get(userID, serverID string) (*Session, error)
			func (*Pool).GetRaw(userID, remoteHost, username string) (*Session, error)
		As Inputs Of (at least 2)
			func (*Pool).Set(userID, serverID string, session *Session)
			func (*Pool).SetRaw(userID, remoteHost, username string, session *Session)

	 type Tunnel (struct)

		Fields (total 5)
			LastConnection time.Time
			Mutex sync.Mutex
			Port int
			SshClient *ssh.Client
			Started bool
		Methods (total 6)
			(*Tunnel) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*Tunnel) Start()
				Start starts binding to remote end and return error if exists any

			(*Tunnel) Stop()
				Stop collapses tunnel

			(*Tunnel) String() string
				String returns readable format of tunnel struct

			(*Tunnel) TryLock() bool
				TryLock tries to lock m and reports whether it succeeded.
				
				Note that while correct uses of TryLock do exist, they are rare,
				and use of TryLock is often a sign of a deeper problem
				in a particular use of mutexes.

			(*Tunnel) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.
				
				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

		Implements (at least 3)
			*Tunnel : github.com/ChrisTrenkamp/goxpath/tree.Result
			*Tunnel : fmt.Stringer
			*Tunnel : sync.Locker
		As Outputs Of (at least one exported)
			func (*TunnelPool).Get(remoteHost, remotePort, username string) (*Tunnel, error)
		As Inputs Of (at least one exported)
			func (*TunnelPool).Set(remoteHost, remotePort, username string, tunnel *Tunnel)

	 type TunnelPool (struct)

		Fields (total 2)
			Connections map[string]*Tunnel
			Mutex sync.Mutex
		Methods (total 6)
			(*TunnelPool) Delete(key string)
				Delete Tunnel connection from pool

			(*TunnelPool) Get(remoteHost, remotePort, username string) (*Tunnel, error)
				Get Tunnel connection from pool

			(*TunnelPool) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*TunnelPool) Set(remoteHost, remotePort, username string, tunnel *Tunnel)
				Set Tunnel connection to pool

			(*TunnelPool) TryLock() bool
				TryLock tries to lock m and reports whether it succeeded.
				
				Note that while correct uses of TryLock do exist, they are rare,
				and use of TryLock is often a sign of a deeper problem
				in a particular use of mutexes.

			(*TunnelPool) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.
				
				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

		Implements (at least one exported)
			*TunnelPool : sync.Locker
		As Types Of (only one)
			  var Tunnels


Package-Level Functions (total 12)

	 func Clean()
		Clean clears long standing sessions from memory

	 func CreateTunnel(remoteHost, remotePort, username, password, sshPort string) int
		CreateTunnel starts a new tunnel instance and sets it into TunnelPool

	 func GetSession(userID, serverID, host string) (*Session, error)
		GetSession gets session from memory and if does not exists creates a new one

	 func InitShellWithCert(username, certificate, host, port string) (*ssh.Client, error)
		InitShellWithCert creates a SSH shell with certificate

	 func InitShellWithPassword(username, password, host, port string) (*ssh.Client, error)
		InitShellWithPassword creates a SSH shell with password

	 func InitWinRm(username, password, host, port string, secure bool) (*winrm.Client, error)
		InitWinRm creates a new WinRM client and returns it

	 func OpenSFTPConnection(conn *ssh.Client) *sftp.Client
		OpenSFTPConnection creates a new SFTP connection

	 func OpenSmbConnection(host, username, password string) (*smb2.Session, error)
		OpenSmbConnection creates a new smb connection session

	 func VerifyAuth(username, password, ipAddress, port, keyType string) bool
		VerifyAuth verifies key when connecting

	 func VerifySSH(username, password, host, port string) bool
		VerifySSH checks if remote end is active or not

	 func VerifySSHCertificate(username, certificate, host, port string) bool
		VerifySSHCertificate checks if remote end is active or not

	 func VerifyWinRm(username, password, host, port string, secure bool) bool
		VerifyWinRm checks if WinRM authentication is valid to remote end


Package-Level Variables (total 2)

	  var Sessions Pool
	  var Tunnels TunnelPool

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.