exec

README

Exec

Executes arbitrary command remotely and returns the response.

Usage

sanssh exec run

For SoT of command line reference run sanssh exec help run.

sanssh <sanssh-args> exec run [--stream] [--user user] <command> [<args>...]

Run a command remotely and return the response.

Note: This is not optimized for large output or long running commands. If the output doesn't fit in memory in a single proto message or if it doesn't complete within the timeout, you'll have a bad time.

Where:

• <sanssh-args> common sanssh arguments
• <stream> flag can be used to stream back command output as the command runs. It doesn't affect the timeout.
• <user> lag allows to specify a user for running command, equivalent of sudo -u <user> <command> ...

Documentation

Overview

Package exec defines the RPC interface for the sansshell Exec actions.

Index

• Constants
• Variables
• func RegisterExecServer(s grpc.ServiceRegistrar, srv ExecServer)
• type ExecClient
  • func NewExecClient(cc grpc.ClientConnInterface) ExecClient
• type ExecClientProxy
  • func NewExecClientProxy(cc *proxy.Conn) ExecClientProxy
• type ExecRequest
  • func (*ExecRequest) Descriptor() ([]byte, []int)
  • func (x *ExecRequest) GetArgs() []string
  • func (x *ExecRequest) GetCommand() string
  • func (x *ExecRequest) GetUser() string
  • func (*ExecRequest) ProtoMessage()
  • func (x *ExecRequest) ProtoReflect() protoreflect.Message
  • func (x *ExecRequest) Reset()
  • func (x *ExecRequest) String() string
• type ExecResponse
  • func (*ExecResponse) Descriptor() ([]byte, []int)
  • func (x *ExecResponse) GetRetCode() int32
  • func (x *ExecResponse) GetStderr() []byte
  • func (x *ExecResponse) GetStdout() []byte
  • func (*ExecResponse) ProtoMessage()
  • func (x *ExecResponse) ProtoReflect() protoreflect.Message
  • func (x *ExecResponse) Reset()
  • func (x *ExecResponse) String() string
• type ExecServer
• type Exec_StreamingRunClient
• type Exec_StreamingRunClientProxy
• type Exec_StreamingRunServer
• type RunManyResponse
• type StreamingRunManyResponse
• type UnimplementedExecServer
  • func (UnimplementedExecServer) Run(context.Context, *ExecRequest) (*ExecResponse, error)
  • func (UnimplementedExecServer) StreamingRun(*ExecRequest, grpc.ServerStreamingServer[ExecResponse]) error
• type UnsafeExecServer

Constants

const (
	Exec_Run_FullMethodName          = "/Exec.Exec/Run"
	Exec_StreamingRun_FullMethodName = "/Exec.Exec/StreamingRun"
)

Variables

var Exec_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Exec.Exec",
	HandlerType: (*ExecServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Run",
			Handler:    _Exec_Run_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamingRun",
			Handler:       _Exec_StreamingRun_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "exec.proto",
}

Exec_ServiceDesc is the grpc.ServiceDesc for Exec service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var File_exec_proto protoreflect.FileDescriptor

Functions

func RegisterExecServer

func RegisterExecServer(s grpc.ServiceRegistrar, srv ExecServer)

Types

type ExecClient

type ExecClient interface {
	// Run takes input, executes it and returns result of input execution
	Run(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (*ExecResponse, error)
	// StreamingRun takes input, executes it and streams back execution information
	//
	// A nonzero return code, if any, will be in the final response. Intermediate
	// responses may contain stdout and/or stderr.
	StreamingRun(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ExecResponse], error)
}

ExecClient is the client API for Exec service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

The Exec service definition.

func NewExecClient

func NewExecClient(cc grpc.ClientConnInterface) ExecClient

type ExecClientProxy

type ExecClientProxy interface {
	ExecClient
	RunOneMany(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (<-chan *RunManyResponse, error)
	StreamingRunOneMany(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (Exec_StreamingRunClientProxy, error)
}

ExecClientProxy is the superset of ExecClient which additionally includes the OneMany proxy methods

func NewExecClientProxy

func NewExecClientProxy(cc *proxy.Conn) ExecClientProxy

NewExecClientProxy creates a ExecClientProxy for use in proxied connections. NOTE: This takes a proxy.Conn instead of a generic ClientConnInterface as the methods here are only valid in proxy.Conn contexts.

type ExecRequest

type ExecRequest struct {
	Command string   `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
	Args    []string `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// User to execute command as, equivalent of `sudo -u <user> <command>`.
	User string `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

ExecRequest describes what to execute

func (*ExecRequest) Descriptor

func (*ExecRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExecRequest.ProtoReflect.Descriptor instead.

func (*ExecRequest) GetArgs

func (x *ExecRequest) GetArgs() []string

func (*ExecRequest) GetCommand

func (x *ExecRequest) GetCommand() string

func (*ExecRequest) GetUser

func (x *ExecRequest) GetUser() string

func (*ExecRequest) ProtoMessage

func (*ExecRequest) ProtoMessage()

func (*ExecRequest) ProtoReflect

func (x *ExecRequest) ProtoReflect() protoreflect.Message

func (*ExecRequest) Reset

func (x *ExecRequest) Reset()

func (*ExecRequest) String

func (x *ExecRequest) String() string

type ExecResponse

type ExecResponse struct {
	Stdout  []byte `protobuf:"bytes,1,opt,name=stdout,proto3" json:"stdout,omitempty"`
	Stderr  []byte `protobuf:"bytes,2,opt,name=stderr,proto3" json:"stderr,omitempty"`
	RetCode int32  `protobuf:"varint,3,opt,name=retCode,proto3" json:"retCode,omitempty"`
	// contains filtered or unexported fields
}

ExecResponse describes output of execution

func (*ExecResponse) Descriptor

func (*ExecResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExecResponse.ProtoReflect.Descriptor instead.

func (*ExecResponse) GetRetCode

func (x *ExecResponse) GetRetCode() int32

func (*ExecResponse) GetStderr

func (x *ExecResponse) GetStderr() []byte

func (*ExecResponse) GetStdout

func (x *ExecResponse) GetStdout() []byte

func (*ExecResponse) ProtoMessage

func (*ExecResponse) ProtoMessage()

func (*ExecResponse) ProtoReflect

func (x *ExecResponse) ProtoReflect() protoreflect.Message

func (*ExecResponse) Reset

func (x *ExecResponse) Reset()

func (*ExecResponse) String

func (x *ExecResponse) String() string

type ExecServer

type ExecServer interface {
	// Run takes input, executes it and returns result of input execution
	Run(context.Context, *ExecRequest) (*ExecResponse, error)
	// StreamingRun takes input, executes it and streams back execution information
	//
	// A nonzero return code, if any, will be in the final response. Intermediate
	// responses may contain stdout and/or stderr.
	StreamingRun(*ExecRequest, grpc.ServerStreamingServer[ExecResponse]) error
}

ExecServer is the server API for Exec service. All implementations should embed UnimplementedExecServer for forward compatibility.

The Exec service definition.

type Exec_StreamingRunClient

type Exec_StreamingRunClient = grpc.ServerStreamingClient[ExecResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Exec_StreamingRunClientProxy

type Exec_StreamingRunClientProxy interface {
	Recv() ([]*StreamingRunManyResponse, error)
	grpc.ClientStream
}

type Exec_StreamingRunServer

type Exec_StreamingRunServer = grpc.ServerStreamingServer[ExecResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type RunManyResponse

type RunManyResponse struct {
	Target string
	// As targets can be duplicated this is the index into the slice passed to proxy.Conn.
	Index int
	Resp  *ExecResponse
	Error error
}

RunManyResponse encapsulates a proxy data packet. It includes the target, index, response and possible error returned.

type StreamingRunManyResponse

type StreamingRunManyResponse struct {
	Target string
	// As targets can be duplicated this is the index into the slice passed to proxy.Conn.
	Index int
	Resp  *ExecResponse
	Error error
}

StreamingRunManyResponse encapsulates a proxy data packet. It includes the target, index, response and possible error returned.

type UnimplementedExecServer

type UnimplementedExecServer struct{}

UnimplementedExecServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedExecServer) Run

func (UnimplementedExecServer) Run(context.Context, *ExecRequest) (*ExecResponse, error)

func (UnimplementedExecServer) StreamingRun

func (UnimplementedExecServer) StreamingRun(*ExecRequest, grpc.ServerStreamingServer[ExecResponse]) error

type UnsafeExecServer

type UnsafeExecServer interface {
	// contains filtered or unexported methods
}

UnsafeExecServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExecServer will result in compilation errors.