package winrm

Import Path
	github.com/masterzen/winrm (on go.dev)

Dependency Relation
	imports 27 packages, and imported by one package

Involved Source Files

	    auth.go
	    client.go
	    command.go
	    endpoint.go
	    error.go
	    http.go
	    kerberos.go
	    ntlm.go
	    parameters.go
	    powershell.go
	    request.go
	    response.go
	    shell.go
Package-Level Type Names (total 11)

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

		Fields (total 6)
			Parameters Parameters
			Parameters.Dial func(network, addr string) (net.Conn, error)
			Parameters.EnvelopeSize int
			Parameters.Locale string
			Parameters.Timeout string
			Parameters.TransportDecorator func() Transporter
		Methods (total 10)
			(*Client) CreateShell() (*Shell, error)
				CreateShell will create a WinRM Shell,
				which is the prealable for running commands.

			(*Client) NewShell(id string) *Shell
				NewShell will create a new WinRM Shell for the given shellID

			(*Client) Run(command string, stdout io.Writer, stderr io.Writer) (int, error)
				Run will run command on the the remote host, writing the process stdout and stderr to
				the given writers. Note with this method it isn't possible to inject stdin.
				
				Deprecated: use RunWithContext()

			(*Client) RunPSWithContextWithString(ctx context.Context, command string, stdin string) (string, string, int, error)
				RunPSWithContextWithString will basically wrap your code to execute commands in powershell.exe. Default RunWithString
				runs commands in cmd.exe

			(*Client) RunPSWithString(command string, stdin string) (string, string, int, error)
				RunPSWithString will basically wrap your code to execute commands in powershell.exe. Default RunWithString
				runs commands in cmd.exe
				
				Deprecated: use RunPSWithContextWithString()

			(*Client) RunWithContext(ctx context.Context, command string, stdout io.Writer, stderr io.Writer) (int, error)
				RunWithContext will run command on the the remote host, writing the process stdout and stderr to
				the given writers. Note with this method it isn't possible to inject stdin.
				If the context is canceled, the remote command is canceled.

			(*Client) RunWithContextWithInput(ctx context.Context, command string, stdout, stderr io.Writer, stdin io.Reader) (int, error)
				RunWithContextWithInput will run command on the the remote host, writing the process stdout and stderr to
				the given writers, and injecting the process stdin with the stdin reader.
				If the context is canceled, the command on the remote machine is canceled.
				Warning stdin (not stdout/stderr) are bufferized, which means reading only one byte in stdin will
				send a winrm http packet to the remote host. If stdin is a pipe, it might be better for
				performance reasons to buffer it.
				If stdin is nil, this is equivalent to c.RunWithContext()

			(*Client) RunWithContextWithString(ctx context.Context, command string, stdin string) (string, string, int, error)
				RunWithContextWithString will run command on the the remote host, returning the process stdout and stderr
				as strings, and using the input stdin string as the process input
				If the context is canceled, the remote command is canceled.

			(*Client) RunWithInput(command string, stdout, stderr io.Writer, stdin io.Reader) (int, error)
				RunWithInput will run command on the the remote host, writing the process stdout and stderr to
				the given writers, and injecting the process stdin with the stdin reader.
				Warning stdin (not stdout/stderr) are bufferized, which means reading only one byte in stdin will
				send a winrm http packet to the remote host. If stdin is a pipe, it might be better for
				performance reasons to buffer it.
				If stdin is nil, this is equivalent to c.Run()
				
				Deprecated: use RunWithContextWithInput()

			(*Client) RunWithString(command string, stdin string) (string, string, int, error)
				RunWithString will run command on the the remote host, returning the process stdout and stderr
				as strings, and using the input stdin string as the process input
				
				Deprecated: use RunWithContextWithString()

		As Outputs Of (at least 3)
			func NewClient(endpoint *Endpoint, user, password string) (*Client, error)
			func NewClientWithParameters(endpoint *Endpoint, user, password string, params *Parameters) (*Client, error)
			func github.com/limanmys/render-engine/internal/bridge.InitWinRm(username, password, host, port string, secure bool) (*Client, error)
		As Inputs Of (at least 4)
			func ClientAuthRequest.Post(client *Client, request *soap.SoapMessage) (string, error)
			func (*ClientKerberos).Post(clt *Client, request *soap.SoapMessage) (string, error)
			func ClientNTLM.Post(client *Client, request *soap.SoapMessage) (string, error)
			func Transporter.Post(*Client, *soap.SoapMessage) (string, error)

	 type ClientAuthRequest (struct)
		ClientAuthRequest ClientAuthRequest

		Methods (total 2)
			( ClientAuthRequest) Post(client *Client, request *soap.SoapMessage) (string, error)
				Post Post

			(*ClientAuthRequest) Transport(endpoint *Endpoint) error
				Transport Transport

		Implements (at least one exported)
			*ClientAuthRequest : Transporter
		As Outputs Of (at least one exported)
			func NewClientAuthRequestWithDial(dial func(network, addr string) (net.Conn, error)) *ClientAuthRequest

	 type ClientKerberos (struct)

		Fields (total 9)
			Hostname string
			KrbCCache string
			KrbConf string
			Password string
			Port int
			Proto string
			Realm string
			SPN string
			Username string
		Methods (total 2)
			(*ClientKerberos) Post(clt *Client, request *soap.SoapMessage) (string, error)
			(*ClientKerberos) Transport(endpoint *Endpoint) error
		Implements (at least one exported)
			*ClientKerberos : Transporter
		As Outputs Of (at least one exported)
			func NewClientKerberos(settings *Settings) *ClientKerberos

	 type ClientNTLM (struct)
		ClientNTLM provides a transport via NTLMv2

		Methods (total 2)
			( ClientNTLM) Post(client *Client, request *soap.SoapMessage) (string, error)
				Post make post to the winrm soap service (forwarded to clientRequest implementation)

			(*ClientNTLM) Transport(endpoint *Endpoint) error
				Transport creates the wrapped NTLM transport

		Implements (at least one exported)
			*ClientNTLM : Transporter
		As Outputs Of (at least 2)
			func NewClientNTLMWithDial(dial func(network, addr string) (net.Conn, error)) *ClientNTLM
			func NewClientNTLMWithProxyFunc(proxyfunc func(req *http.Request) (*url.URL, error)) *ClientNTLM

	 type Command (struct)
		Command represents a given command running on a Shell. This structure allows to get access
		to the various stdout, stderr and stdin pipes.

		Fields (total 3)
			Stderr *commandReader
			Stdin *commandWriter
			Stdout *commandReader
		Methods (total 3)
			(*Command) Close() error
				Close will terminate the running command

			(*Command) ExitCode() int
				ExitCode returns command exit code when it is finished. Before that the result is always 0.

			(*Command) Wait()
				Wait function will block the current goroutine until the remote command terminates.

		Implements (at least one exported)
			*Command : io.Closer
		As Outputs Of (at least 2)
			func (*Shell).Execute(command string, arguments ...string) (*Command, error)
			func (*Shell).ExecuteWithContext(ctx context.Context, command string, arguments ...string) (*Command, error)

	 type Endpoint (struct)
		Endpoint struct holds configurations
		for the server endpoint

		Fields (total 9)
			CACert []byte
				pointer pem certs, and key
				// cert auth to intdetify the server cert

			Cert []byte
				// cert for client auth connections

			HTTPS bool
				set the flag true for https connections

			Host string
				host name or ip address

			Insecure bool
				set the flag true for skipping ssl verifications

			Key []byte
				// public key for client auth connections

			Port int
				port to determine if it's http or https default
				winrm ports (http:5985, https:5986).Versions
				of winrm can be customized to listen on other ports

			TLSServerName string
				if set, used to verify the hostname on the returned certificate

			Timeout time.Duration
				duration timeout for the underling tcp conn(http/https base protocol)
				if the time exceeds the connection is cloded/timeouts

		As Outputs Of (at least one exported)
			func NewEndpoint(host string, port int, https bool, insecure bool, Cacert, cert, key []byte, timeout time.Duration) *Endpoint
		As Inputs Of (at least 6)
			func NewClient(endpoint *Endpoint, user, password string) (*Client, error)
			func NewClientWithParameters(endpoint *Endpoint, user, password string, params *Parameters) (*Client, error)
			func (*ClientAuthRequest).Transport(endpoint *Endpoint) error
			func (*ClientKerberos).Transport(endpoint *Endpoint) error
			func (*ClientNTLM).Transport(endpoint *Endpoint) error
			func Transporter.Transport(*Endpoint) error

	 type ExecuteCommandError (struct)

		Fields (total 2)
			Body string
			Inner error
		Methods (total 3)
			(*ExecuteCommandError) Error() string
			(*ExecuteCommandError) Is(err error) bool
			(*ExecuteCommandError) Unwrap() error
		Implements (at least one exported)
			*ExecuteCommandError : error

	 type Parameters (struct)
		Parameters struct defines
		metadata information and http transport config

		Fields (total 5)
			Dial func(network, addr string) (net.Conn, error)
			EnvelopeSize int
			Locale string
			Timeout string
			TransportDecorator func() Transporter
		As Outputs Of (at least one exported)
			func NewParameters(timeout, locale string, envelopeSize int) *Parameters
		As Inputs Of (at least 7)
			func NewClientWithParameters(endpoint *Endpoint, user, password string, params *Parameters) (*Client, error)
			func NewDeleteShellRequest(uri, shellID string, params *Parameters) *soap.SoapMessage
			func NewExecuteCommandRequest(uri, shellID, command string, arguments []string, params *Parameters) *soap.SoapMessage
			func NewGetOutputRequest(uri, shellID, commandID, streams string, params *Parameters) *soap.SoapMessage
			func NewOpenShellRequest(uri string, params *Parameters) *soap.SoapMessage
			func NewSendInputRequest(uri, shellID, commandID string, input []byte, eof bool, params *Parameters) *soap.SoapMessage
			func NewSignalRequest(uri string, shellID string, commandID string, params *Parameters) *soap.SoapMessage
		As Types Of (only one)
			  var DefaultParameters *Parameters

	 type Settings (struct)
		Settings holds all the information necessary to configure the provider

		Fields (total 12)
			KrbCCache string
			KrbConfig string
			KrbRealm string
			KrbSpn string
			WinRMHost string
			WinRMInsecure bool
			WinRMPassCredentials bool
			WinRMPassword string
			WinRMPort int
			WinRMProto string
			WinRMUseNTLM bool
			WinRMUsername string
		As Inputs Of (at least one exported)
			func NewClientKerberos(settings *Settings) *ClientKerberos

	 type Shell (struct)
		Shell is the local view of a WinRM Shell of a given Client

		Methods (total 3)
			(*Shell) Close() error
				Close will terminate this shell. No commands can be issued once the shell is closed.

			(*Shell) Execute(command string, arguments ...string) (*Command, error)
				Execute command on the given Shell, returning either an error or a Command
				
				Deprecated: user ExecuteWithContext

			(*Shell) ExecuteWithContext(ctx context.Context, command string, arguments ...string) (*Command, error)
				ExecuteWithContext command on the given Shell, returning either an error or a Command

		Implements (at least one exported)
			*Shell : io.Closer
		As Outputs Of (at least 2)
			func (*Client).CreateShell() (*Shell, error)
			func (*Client).NewShell(id string) *Shell

	 type Transporter (interface)
		Transporter does different transporters
		and init a Post request based on them

		Methods (total 2)
			( Transporter) Post(*Client, *soap.SoapMessage) (string, error)
				init request baset on the transport configurations

			( Transporter) Transport(*Endpoint) error
		Implemented By (at least 3)
			*ClientAuthRequest
			*ClientKerberos
			*ClientNTLM


Package-Level Functions (total 21)

	 func NewClient(endpoint *Endpoint, user, password string) (*Client, error)
		NewClient will create a new remote client on url, connecting with user and password
		This function doesn't connect (connection happens only when CreateShell is called)

	 func NewClientAuthRequestWithDial(dial func(network, addr string) (net.Conn, error)) *ClientAuthRequest
		NewClientAuthRequestWithDial NewClientAuthRequestWithDial

	 func NewClientKerberos(settings *Settings) *ClientKerberos
	 func NewClientNTLMWithDial(dial func(network, addr string) (net.Conn, error)) *ClientNTLM
		NewClientNTLMWithDial NewClientNTLMWithDial

	 func NewClientNTLMWithProxyFunc(proxyfunc func(req *http.Request) (*url.URL, error)) *ClientNTLM
		NewClientNTLMWithProxyFunc NewClientNTLMWithProxyFunc

	 func NewClientWithDial(dial func(network, addr string) (net.Conn, error)) *clientRequest
		NewClientWithDial NewClientWithDial

	 func NewClientWithParameters(endpoint *Endpoint, user, password string, params *Parameters) (*Client, error)
		NewClientWithParameters will create a new remote client on url, connecting with user and password
		This function doesn't connect (connection happens only when CreateShell is called)

	 func NewClientWithProxyFunc(proxyfunc func(req *http.Request) (*url.URL, error)) *clientRequest
		NewClientWithProxyFunc NewClientWithProxyFunc

	 func NewDeleteShellRequest(uri, shellID string, params *Parameters) *soap.SoapMessage
		NewDeleteShellRequest ...

	 func NewEndpoint(host string, port int, https bool, insecure bool, Cacert, cert, key []byte, timeout time.Duration) *Endpoint
		NewEndpoint returns new pointer to struct Endpoint, with a default 60s response header timeout

	 func NewExecuteCommandRequest(uri, shellID, command string, arguments []string, params *Parameters) *soap.SoapMessage
		NewExecuteCommandRequest exec command on specific shellID

	 func NewGetOutputRequest(uri, shellID, commandID, streams string, params *Parameters) *soap.SoapMessage
		NewGetOutputRequest NewGetOutputRequest

	 func NewOpenShellRequest(uri string, params *Parameters) *soap.SoapMessage
		NewOpenShellRequest makes a new soap request

	 func NewParameters(timeout, locale string, envelopeSize int) *Parameters
		NewParameters return new struct of type Parameters
		this struct makes the configuration for the request, size message, etc.

	 func NewSendInputRequest(uri, shellID, commandID string, input []byte, eof bool, params *Parameters) *soap.SoapMessage
		NewSendInputRequest NewSendInputRequest

	 func NewSignalRequest(uri string, shellID string, commandID string, params *Parameters) *soap.SoapMessage
		NewSignalRequest NewSignalRequest

	 func ParseExecuteCommandResponse(response string) (commandId string, err error)
		ParseExecuteCommandResponse ParseExecuteCommandResponse

	 func ParseOpenShellResponse(response string) (string, error)
		ParseOpenShellResponse ParseOpenShellResponse

	 func ParseSlurpOutputErrResponse(response string, stdout, stderr io.Writer) (bool, int, error)
		ParseSlurpOutputErrResponse ParseSlurpOutputErrResponse

	 func ParseSlurpOutputResponse(response string, stream io.Writer, streamType string) (bool, int, error)
		ParseSlurpOutputResponse ParseSlurpOutputResponse

	 func Powershell(psCmd string) string
		Powershell wraps a PowerShell script
		and prepares it for execution by the winrm client


Package-Level Variables (only one)

	  var DefaultParameters *Parameters
		DefaultParameters return constant config
		of type Parameters

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.