Help us shape the future of Go! Take the 2026 Go Developer Survey

api

package
v0.40.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 26, 2026 License: Apache-2.0 Imports: 9 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SetJoinTimeoutResponse_Outcome_name = map[int32]string{
		0: "OUTCOME_UNSPECIFIED",
		1: "COUNTING",
		2: "PENDING",
		3: "DISABLED",
		4: "CLAIMED",
		5: "ENDING",
	}
	SetJoinTimeoutResponse_Outcome_value = map[string]int32{
		"OUTCOME_UNSPECIFIED": 0,
		"COUNTING":            1,
		"PENDING":             2,
		"DISABLED":            3,
		"CLAIMED":             4,
		"ENDING":              5,
	}
)

Enum value maps for SetJoinTimeoutResponse_Outcome.

View Source
var (
	Client_Kind_name = map[int32]string{
		0: "GUEST",
		1: "HOST",
		2: "FORWARD",
	}
	Client_Kind_value = map[string]int32{
		"GUEST":   0,
		"HOST":    1,
		"FORWARD": 2,
	}
)

Enum value maps for Client_Kind.

View Source
var (
	Identifier_Type_name = map[int32]string{
		0: "HOST",
		1: "CLIENT",
	}
	Identifier_Type_value = map[string]int32{
		"HOST":   0,
		"CLIENT": 1,
	}
)

Enum value maps for Identifier_Type.

View Source
var (
	Accept_Decision_name = map[int32]string{
		0: "ACCEPTED",
		1: "DECLINED",
		2: "INTERRUPTED",
	}
	Accept_Decision_value = map[string]int32{
		"ACCEPTED":    0,
		"DECLINED":    1,
		"INTERRUPTED": 2,
	}
)

Enum value maps for Accept_Decision.

View Source
var AdminService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.AdminService",
	HandlerType: (*AdminServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSession",
			Handler:    _AdminService_GetSession_Handler,
		},
		{
			MethodName: "StopSession",
			Handler:    _AdminService_StopSession_Handler,
		},
		{
			MethodName: "SetJoinTimeout",
			Handler:    _AdminService_SetJoinTimeout_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api.proto",
}

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

View Source
var File_startup_proto protoreflect.FileDescriptor

Functions

func RegisterAdminServiceServer

func RegisterAdminServiceServer(s grpc.ServiceRegistrar, srv AdminServiceServer)

Types

type Accept added in v0.30.0

type Accept struct {
	Decision Accept_Decision `protobuf:"varint,1,opt,name=decision,proto3,enum=api.Accept_Decision" json:"decision,omitempty"`
	// contains filtered or unexported fields
}

Accept answers session_created.

func (*Accept) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Accept.ProtoReflect.Descriptor instead.

func (*Accept) GetDecision added in v0.30.0

func (x *Accept) GetDecision() Accept_Decision

func (*Accept) ProtoMessage added in v0.30.0

func (*Accept) ProtoMessage()

func (*Accept) ProtoReflect added in v0.30.0

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

func (*Accept) Reset added in v0.30.0

func (x *Accept) Reset()

func (*Accept) String added in v0.30.0

func (x *Accept) String() string

type Accept_Decision added in v0.30.0

type Accept_Decision int32
const (
	Accept_ACCEPTED    Accept_Decision = 0
	Accept_DECLINED    Accept_Decision = 1
	Accept_INTERRUPTED Accept_Decision = 2
)

func (Accept_Decision) Descriptor added in v0.30.0

func (Accept_Decision) Enum added in v0.30.0

func (x Accept_Decision) Enum() *Accept_Decision

func (Accept_Decision) EnumDescriptor deprecated added in v0.30.0

func (Accept_Decision) EnumDescriptor() ([]byte, []int)

Deprecated: Use Accept_Decision.Descriptor instead.

func (Accept_Decision) Number added in v0.30.0

func (Accept_Decision) String added in v0.30.0

func (x Accept_Decision) String() string

func (Accept_Decision) Type added in v0.30.0

type AdminServiceClient

type AdminServiceClient interface {
	GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*GetSessionResponse, error)
	StopSession(ctx context.Context, in *StopSessionRequest, opts ...grpc.CallOption) (*StopSessionResponse, error)
	SetJoinTimeout(ctx context.Context, in *SetJoinTimeoutRequest, opts ...grpc.CallOption) (*SetJoinTimeoutResponse, error)
}

AdminServiceClient is the client API for AdminService 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.

type AdminServiceServer

AdminServiceServer is the server API for AdminService service. All implementations should embed UnimplementedAdminServiceServer for forward compatibility

type AuthorizedKey added in v0.13.0

type AuthorizedKey struct {
	PublicKeyFingerprints []string `` /* 126-byte string literal not displayed */
	Comment               string   `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

func (*AuthorizedKey) Descriptor deprecated added in v0.13.0

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

Deprecated: Use AuthorizedKey.ProtoReflect.Descriptor instead.

func (*AuthorizedKey) GetComment added in v0.13.0

func (x *AuthorizedKey) GetComment() string

func (*AuthorizedKey) GetPublicKeyFingerprints added in v0.13.0

func (x *AuthorizedKey) GetPublicKeyFingerprints() []string

func (*AuthorizedKey) ProtoMessage added in v0.13.0

func (*AuthorizedKey) ProtoMessage()

func (*AuthorizedKey) ProtoReflect added in v0.13.0

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

func (*AuthorizedKey) Reset added in v0.13.0

func (x *AuthorizedKey) Reset()

func (*AuthorizedKey) String added in v0.13.0

func (x *AuthorizedKey) String() string

type Claimed added in v0.30.0

type Claimed struct {
	Name         string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	LaunchId     string `protobuf:"bytes,2,opt,name=launch_id,json=launchId,proto3" json:"launch_id,omitempty"`
	AdminSocket  string `protobuf:"bytes,3,opt,name=admin_socket,json=adminSocket,proto3" json:"admin_socket,omitempty"`
	AttachSocket string `protobuf:"bytes,4,opt,name=attach_socket,json=attachSocket,proto3" json:"attach_socket,omitempty"`
	LogPath      string `protobuf:"bytes,5,opt,name=log_path,json=logPath,proto3" json:"log_path,omitempty"`
	Pid          int32  `protobuf:"varint,6,opt,name=pid,proto3" json:"pid,omitempty"`
	// contains filtered or unexported fields
}

Claimed is the daemon's first report: the name it holds and the paths that belong to it. Sent before the tunnel is dialled.

func (*Claimed) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Claimed.ProtoReflect.Descriptor instead.

func (*Claimed) GetAdminSocket added in v0.30.0

func (x *Claimed) GetAdminSocket() string

func (*Claimed) GetAttachSocket added in v0.30.0

func (x *Claimed) GetAttachSocket() string

func (*Claimed) GetLaunchId added in v0.30.0

func (x *Claimed) GetLaunchId() string

func (*Claimed) GetLogPath added in v0.30.0

func (x *Claimed) GetLogPath() string

func (*Claimed) GetName added in v0.30.0

func (x *Claimed) GetName() string

func (*Claimed) GetPid added in v0.30.0

func (x *Claimed) GetPid() int32

func (*Claimed) ProtoMessage added in v0.30.0

func (*Claimed) ProtoMessage()

func (*Claimed) ProtoReflect added in v0.30.0

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

func (*Claimed) Reset added in v0.30.0

func (x *Claimed) Reset()

func (*Claimed) String added in v0.30.0

func (x *Claimed) String() string

type Client

type Client struct {
	Id                   string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Version              string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Addr                 string `protobuf:"bytes,3,opt,name=addr,proto3" json:"addr,omitempty"`
	PublicKeyFingerprint string `protobuf:"bytes,4,opt,name=public_key_fingerprint,json=publicKeyFingerprint,proto3" json:"public_key_fingerprint,omitempty"`
	// Which door the client came in by. GUEST is zero so a reader built before
	// this field existed sees every client as a guest, which is what they were.
	Kind Client_Kind `protobuf:"varint,5,opt,name=kind,proto3,enum=api.Client_Kind" json:"kind,omitempty"`
	// Where a FORWARD client's forwards go: the distinct host:port destinations
	// it has opened, as it asked for them, in the order first opened, at most
	// 16 of them. unlisted_forwards counts the forwards it opened to anywhere
	// past those.
	ForwardDestinations []string `protobuf:"bytes,6,rep,name=forward_destinations,json=forwardDestinations,proto3" json:"forward_destinations,omitempty"`
	UnlistedForwards    uint32   `protobuf:"varint,7,opt,name=unlisted_forwards,json=unlistedForwards,proto3" json:"unlisted_forwards,omitempty"`
	// contains filtered or unexported fields
}

func (*Client) Descriptor deprecated

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

Deprecated: Use Client.ProtoReflect.Descriptor instead.

func (*Client) GetAddr

func (x *Client) GetAddr() string

func (*Client) GetForwardDestinations added in v0.37.0

func (x *Client) GetForwardDestinations() []string

func (*Client) GetId

func (x *Client) GetId() string

func (*Client) GetKind added in v0.30.0

func (x *Client) GetKind() Client_Kind

func (*Client) GetPublicKeyFingerprint

func (x *Client) GetPublicKeyFingerprint() string

func (*Client) GetUnlistedForwards added in v0.37.0

func (x *Client) GetUnlistedForwards() uint32

func (*Client) GetVersion

func (x *Client) GetVersion() string

func (*Client) ProtoMessage

func (*Client) ProtoMessage()

func (*Client) ProtoReflect added in v0.5.0

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

func (*Client) Reset

func (x *Client) Reset()

func (*Client) String

func (x *Client) String() string

type Client_Kind added in v0.30.0

type Client_Kind int32
const (
	Client_GUEST Client_Kind = 0
	Client_HOST  Client_Kind = 1
	// A guest connection's forwards, listed apart from any terminal or SFTP
	// session on the same connection: a jump through the session (`ssh -J`)
	// or an `ssh -L`, to somewhere the host can reach. A reader built before
	// this value existed sees it as a guest, which it also is.
	Client_FORWARD Client_Kind = 2
)

func (Client_Kind) Descriptor added in v0.30.0

func (Client_Kind) Enum added in v0.30.0

func (x Client_Kind) Enum() *Client_Kind

func (Client_Kind) EnumDescriptor deprecated added in v0.30.0

func (Client_Kind) EnumDescriptor() ([]byte, []int)

Deprecated: Use Client_Kind.Descriptor instead.

func (Client_Kind) Number added in v0.30.0

func (x Client_Kind) Number() protoreflect.EnumNumber

func (Client_Kind) String added in v0.30.0

func (x Client_Kind) String() string

func (Client_Kind) Type added in v0.30.0

type Failed added in v0.30.0

type Failed struct {
	Error     string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	NameInUse bool   `protobuf:"varint,2,opt,name=name_in_use,json=nameInUse,proto3" json:"name_in_use,omitempty"`
	Abandoned bool   `protobuf:"varint,3,opt,name=abandoned,proto3" json:"abandoned,omitempty"`
	// contains filtered or unexported fields
}

Failed: the session did not start. name_in_use asks the parent to draw another name; abandoned means the parent's own answer ended it.

func (*Failed) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Failed.ProtoReflect.Descriptor instead.

func (*Failed) GetAbandoned added in v0.30.0

func (x *Failed) GetAbandoned() bool

func (*Failed) GetError added in v0.30.0

func (x *Failed) GetError() string

func (*Failed) GetNameInUse added in v0.30.0

func (x *Failed) GetNameInUse() bool

func (*Failed) ProtoMessage added in v0.30.0

func (*Failed) ProtoMessage()

func (*Failed) ProtoReflect added in v0.30.0

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

func (*Failed) Reset added in v0.30.0

func (x *Failed) Reset()

func (*Failed) String added in v0.30.0

func (x *Failed) String() string

type GetSessionRequest

type GetSessionRequest struct {
	// contains filtered or unexported fields
}

func (*GetSessionRequest) Descriptor deprecated

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

Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.

func (*GetSessionRequest) ProtoMessage

func (*GetSessionRequest) ProtoMessage()

func (*GetSessionRequest) ProtoReflect added in v0.5.0

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

func (*GetSessionRequest) Reset

func (x *GetSessionRequest) Reset()

func (*GetSessionRequest) String

func (x *GetSessionRequest) String() string

type GetSessionResponse

type GetSessionResponse struct {
	SessionId        string           `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	Command          []string         `protobuf:"bytes,2,rep,name=command,proto3" json:"command,omitempty"`
	ForceCommand     []string         `protobuf:"bytes,3,rep,name=force_command,json=forceCommand,proto3" json:"force_command,omitempty"`
	Host             string           `protobuf:"bytes,4,opt,name=host,proto3" json:"host,omitempty"`
	NodeAddr         string           `protobuf:"bytes,5,opt,name=node_addr,json=nodeAddr,proto3" json:"node_addr,omitempty"`
	ConnectedClients []*Client        `protobuf:"bytes,6,rep,name=connected_clients,json=connectedClients,proto3" json:"connected_clients,omitempty"`
	AuthorizedKeys   []*AuthorizedKey `protobuf:"bytes,7,rep,name=authorized_keys,json=authorizedKeys,proto3" json:"authorized_keys,omitempty"`
	SshUser          string           `protobuf:"bytes,8,opt,name=ssh_user,json=sshUser,proto3" json:"ssh_user,omitempty"`                 // SSH username for client connections
	SftpDisabled     bool             `protobuf:"varint,9,opt,name=sftp_disabled,json=sftpDisabled,proto3" json:"sftp_disabled,omitempty"` // true if SFTP is disabled (--no-sftp)
	JoinState        *JoinState       `protobuf:"bytes,10,opt,name=join_state,json=joinState,proto3" json:"join_state,omitempty"`          // the join timeout as the daemon holds it
	// launch_id is the launch this daemon speaks for, so a reader can tell the
	// run it read a record for from one that has since claimed the name. Empty
	// from a daemon that claimed no name, and from daemons before this field.
	LaunchId string `protobuf:"bytes,11,opt,name=launch_id,json=launchId,proto3" json:"launch_id,omitempty"`
	// open is true when anyone with the session ID can join and nobody was
	// asked: there is no allowlist, and the session was started with --accept,
	// so nobody confirmed it either. It describes the session and changes
	// nothing about who may join. False from daemons before this field.
	Open bool `protobuf:"varint,12,opt,name=open,proto3" json:"open,omitempty"`
	// The fields below are each optional: a daemon from before one leaves it
	// unset, and a reader must treat unset as unknown, never as false or empty.
	Name                 *string `protobuf:"bytes,13,opt,name=name,proto3,oneof" json:"name,omitempty"`                                     // the session's name
	Status               *string `protobuf:"bytes,14,opt,name=status,proto3,oneof" json:"status,omitempty"`                                 // starting, ready, reconnecting, disconnected, ending
	Reconnect            *string `protobuf:"bytes,15,opt,name=reconnect,proto3,oneof" json:"reconnect,omitempty"`                           // supported, unsupported
	TunnelReason         *string `protobuf:"bytes,16,opt,name=tunnel_reason,json=tunnelReason,proto3,oneof" json:"tunnel_reason,omitempty"` // why the tunnel is down, one of sessiondir's TunnelReason values; empty when it is up
	TunnelLostAtUnixNano *int64  ``                                                                                                         // UTC; unset when the tunnel is up
	/* 135-byte string literal not displayed */
	NextAttemptAtUnixNano *int64 `` // UTC; unset when no attempt is scheduled
	/* 138-byte string literal not displayed */
	StartConfirmed               *bool   `protobuf:"varint,19,opt,name=start_confirmed,json=startConfirmed,proto3,oneof" json:"start_confirmed,omitempty"` // the host answered the start prompt, rather than passing --accept
	ReadOnly                     *bool   `protobuf:"varint,20,opt,name=read_only,json=readOnly,proto3,oneof" json:"read_only,omitempty"`
	FileTransfer                 *string `protobuf:"bytes,21,opt,name=file_transfer,json=fileTransfer,proto3,oneof" json:"file_transfer,omitempty"` // off, downloads, all
	FileTransferApprovalRequired *bool   ``                                                                                                         // each guest file transfer waits for the host's dialog
	/* 157-byte string literal not displayed */
	LocalForwarding *bool `protobuf:"varint,23,opt,name=local_forwarding,json=localForwarding,proto3,oneof" json:"local_forwarding,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSessionResponse) Descriptor deprecated

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

Deprecated: Use GetSessionResponse.ProtoReflect.Descriptor instead.

func (*GetSessionResponse) GetAuthorizedKeys added in v0.13.0

func (x *GetSessionResponse) GetAuthorizedKeys() []*AuthorizedKey

func (*GetSessionResponse) GetCommand

func (x *GetSessionResponse) GetCommand() []string

func (*GetSessionResponse) GetConnectedClients

func (x *GetSessionResponse) GetConnectedClients() []*Client

func (*GetSessionResponse) GetFileTransfer added in v0.39.0

func (x *GetSessionResponse) GetFileTransfer() string

func (*GetSessionResponse) GetFileTransferApprovalRequired added in v0.39.0

func (x *GetSessionResponse) GetFileTransferApprovalRequired() bool

func (*GetSessionResponse) GetForceCommand

func (x *GetSessionResponse) GetForceCommand() []string

func (*GetSessionResponse) GetHost

func (x *GetSessionResponse) GetHost() string

func (*GetSessionResponse) GetJoinState added in v0.32.0

func (x *GetSessionResponse) GetJoinState() *JoinState

func (*GetSessionResponse) GetLaunchId added in v0.32.0

func (x *GetSessionResponse) GetLaunchId() string

func (*GetSessionResponse) GetLocalForwarding added in v0.39.0

func (x *GetSessionResponse) GetLocalForwarding() bool

func (*GetSessionResponse) GetName added in v0.39.0

func (x *GetSessionResponse) GetName() string

func (*GetSessionResponse) GetNextAttemptAtUnixNano added in v0.39.0

func (x *GetSessionResponse) GetNextAttemptAtUnixNano() int64

func (*GetSessionResponse) GetNodeAddr

func (x *GetSessionResponse) GetNodeAddr() string

func (*GetSessionResponse) GetOpen added in v0.37.0

func (x *GetSessionResponse) GetOpen() bool

func (*GetSessionResponse) GetReadOnly added in v0.39.0

func (x *GetSessionResponse) GetReadOnly() bool

func (*GetSessionResponse) GetReconnect added in v0.39.0

func (x *GetSessionResponse) GetReconnect() string

func (*GetSessionResponse) GetSessionId

func (x *GetSessionResponse) GetSessionId() string

func (*GetSessionResponse) GetSftpDisabled added in v0.22.0

func (x *GetSessionResponse) GetSftpDisabled() bool

func (*GetSessionResponse) GetSshUser added in v0.15.0

func (x *GetSessionResponse) GetSshUser() string

func (*GetSessionResponse) GetStartConfirmed added in v0.39.0

func (x *GetSessionResponse) GetStartConfirmed() bool

func (*GetSessionResponse) GetStatus added in v0.39.0

func (x *GetSessionResponse) GetStatus() string

func (*GetSessionResponse) GetTunnelLostAtUnixNano added in v0.39.0

func (x *GetSessionResponse) GetTunnelLostAtUnixNano() int64

func (*GetSessionResponse) GetTunnelReason added in v0.39.0

func (x *GetSessionResponse) GetTunnelReason() string

func (*GetSessionResponse) ProtoMessage

func (*GetSessionResponse) ProtoMessage()

func (*GetSessionResponse) ProtoReflect added in v0.5.0

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

func (*GetSessionResponse) Reset

func (x *GetSessionResponse) Reset()

func (*GetSessionResponse) String

func (x *GetSessionResponse) String() string

type Hello added in v0.30.0

type Hello struct {
	Nonce string `protobuf:"bytes,1,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// contains filtered or unexported fields
}

Hello carries the nonce a transport that cannot inherit a descriptor uses to prove the connection came from the child it spawned.

func (*Hello) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Hello.ProtoReflect.Descriptor instead.

func (*Hello) GetNonce added in v0.30.0

func (x *Hello) GetNonce() string

func (*Hello) ProtoMessage added in v0.30.0

func (*Hello) ProtoMessage()

func (*Hello) ProtoReflect added in v0.30.0

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

func (*Hello) Reset added in v0.30.0

func (x *Hello) Reset()

func (*Hello) String added in v0.30.0

func (x *Hello) String() string

type Identifier

type Identifier struct {
	Id       string          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Type     Identifier_Type `protobuf:"varint,2,opt,name=type,proto3,enum=api.Identifier_Type" json:"type,omitempty"`
	NodeAddr string          `protobuf:"bytes,3,opt,name=node_addr,json=nodeAddr,proto3" json:"node_addr,omitempty"`
	// contains filtered or unexported fields
}

func (*Identifier) Descriptor deprecated

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

Deprecated: Use Identifier.ProtoReflect.Descriptor instead.

func (*Identifier) GetId

func (x *Identifier) GetId() string

func (*Identifier) GetNodeAddr

func (x *Identifier) GetNodeAddr() string

func (*Identifier) GetType

func (x *Identifier) GetType() Identifier_Type

func (*Identifier) ProtoMessage

func (*Identifier) ProtoMessage()

func (*Identifier) ProtoReflect added in v0.5.0

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

func (*Identifier) Reset

func (x *Identifier) Reset()

func (*Identifier) String

func (x *Identifier) String() string

type Identifier_Type

type Identifier_Type int32
const (
	Identifier_HOST   Identifier_Type = 0
	Identifier_CLIENT Identifier_Type = 1
)

func (Identifier_Type) Descriptor added in v0.5.0

func (Identifier_Type) Enum added in v0.5.0

func (x Identifier_Type) Enum() *Identifier_Type

func (Identifier_Type) EnumDescriptor deprecated

func (Identifier_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Identifier_Type.Descriptor instead.

func (Identifier_Type) Number added in v0.5.0

func (Identifier_Type) String

func (x Identifier_Type) String() string

func (Identifier_Type) Type added in v0.5.0

type JoinState added in v0.32.0

type JoinState struct {
	TimeoutNanos             int64 `protobuf:"varint,1,opt,name=timeout_nanos,json=timeoutNanos,proto3" json:"timeout_nanos,omitempty"`               // set and not claimed
	DeadlineUnixNano         int64 `protobuf:"varint,2,opt,name=deadline_unix_nano,json=deadlineUnixNano,proto3" json:"deadline_unix_nano,omitempty"` // counting, or the deadline that fired
	FirstGuestJoinedUnixNano int64 ``                                                                                                                 // the first guest's join
	/* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

JoinState is a session's join timeout. A zero field is absent.

func (*JoinState) Descriptor deprecated added in v0.32.0

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

Deprecated: Use JoinState.ProtoReflect.Descriptor instead.

func (*JoinState) GetDeadlineUnixNano added in v0.32.0

func (x *JoinState) GetDeadlineUnixNano() int64

func (*JoinState) GetFirstGuestJoinedUnixNano added in v0.32.0

func (x *JoinState) GetFirstGuestJoinedUnixNano() int64

func (*JoinState) GetTimeoutNanos added in v0.32.0

func (x *JoinState) GetTimeoutNanos() int64

func (*JoinState) ProtoMessage added in v0.32.0

func (*JoinState) ProtoMessage()

func (*JoinState) ProtoReflect added in v0.32.0

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

func (*JoinState) Reset added in v0.32.0

func (x *JoinState) Reset()

func (*JoinState) String added in v0.32.0

func (x *JoinState) String() string

type Line added in v0.30.0

type Line struct {
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Line answers a read.

func (*Line) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Line.ProtoReflect.Descriptor instead.

func (*Line) GetText added in v0.30.0

func (x *Line) GetText() string

func (*Line) ProtoMessage added in v0.30.0

func (*Line) ProtoMessage()

func (*Line) ProtoReflect added in v0.30.0

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

func (*Line) Reset added in v0.30.0

func (x *Line) Reset()

func (*Line) String added in v0.30.0

func (x *Line) String() string

type Listening added in v0.30.0

type Listening struct {
	AttachSocket string   `protobuf:"bytes,1,opt,name=attach_socket,json=attachSocket,proto3" json:"attach_socket,omitempty"`
	HostKeys     []string `protobuf:"bytes,2,rep,name=host_keys,json=hostKeys,proto3" json:"host_keys,omitempty"`
	// contains filtered or unexported fields
}

Listening: the attach door is bound and these are its host keys, in authorized_keys form. A foreground parent attaches now.

func (*Listening) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Listening.ProtoReflect.Descriptor instead.

func (*Listening) GetAttachSocket added in v0.30.0

func (x *Listening) GetAttachSocket() string

func (*Listening) GetHostKeys added in v0.30.0

func (x *Listening) GetHostKeys() []string

func (*Listening) ProtoMessage added in v0.30.0

func (*Listening) ProtoMessage()

func (*Listening) ProtoReflect added in v0.30.0

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

func (*Listening) Reset added in v0.30.0

func (x *Listening) Reset()

func (*Listening) String added in v0.30.0

func (x *Listening) String() string

type Print added in v0.30.0

type Print struct {
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Print is text for the parent's stderr: a prompt's preamble, a warning.

func (*Print) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Print.ProtoReflect.Descriptor instead.

func (*Print) GetText added in v0.30.0

func (x *Print) GetText() string

func (*Print) ProtoMessage added in v0.30.0

func (*Print) ProtoMessage()

func (*Print) ProtoReflect added in v0.30.0

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

func (*Print) Reset added in v0.30.0

func (x *Print) Reset()

func (*Print) String added in v0.30.0

func (x *Print) String() string

type Read added in v0.30.0

type Read struct {
	Prompt string `protobuf:"bytes,1,opt,name=prompt,proto3" json:"prompt,omitempty"`
	Secret bool   `protobuf:"varint,2,opt,name=secret,proto3" json:"secret,omitempty"`
	// contains filtered or unexported fields
}

Read asks the parent for one line from its terminal. secret means the line must not echo and needs a terminal; the parent answers line or read_failed.

func (*Read) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Read.ProtoReflect.Descriptor instead.

func (*Read) GetPrompt added in v0.30.0

func (x *Read) GetPrompt() string

func (*Read) GetSecret added in v0.30.0

func (x *Read) GetSecret() bool

func (*Read) ProtoMessage added in v0.30.0

func (*Read) ProtoMessage()

func (*Read) ProtoReflect added in v0.30.0

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

func (*Read) Reset added in v0.30.0

func (x *Read) Reset()

func (*Read) String added in v0.30.0

func (x *Read) String() string

type ReadFailed added in v0.30.0

type ReadFailed struct {
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

ReadFailed answers a read the parent could not satisfy.

func (*ReadFailed) Descriptor deprecated added in v0.30.0

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

Deprecated: Use ReadFailed.ProtoReflect.Descriptor instead.

func (*ReadFailed) GetReason added in v0.30.0

func (x *ReadFailed) GetReason() string

func (*ReadFailed) ProtoMessage added in v0.30.0

func (*ReadFailed) ProtoMessage()

func (*ReadFailed) ProtoReflect added in v0.30.0

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

func (*ReadFailed) Reset added in v0.30.0

func (x *ReadFailed) Reset()

func (*ReadFailed) String added in v0.30.0

func (x *ReadFailed) String() string

type SessionCreated added in v0.30.0

type SessionCreated struct {
	Session *GetSessionResponse `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

SessionCreated: the tunnel is up and the session is registered. The parent shows it and answers accept.

func (*SessionCreated) Descriptor deprecated added in v0.30.0

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

Deprecated: Use SessionCreated.ProtoReflect.Descriptor instead.

func (*SessionCreated) GetSession added in v0.30.0

func (x *SessionCreated) GetSession() *GetSessionResponse

func (*SessionCreated) ProtoMessage added in v0.30.0

func (*SessionCreated) ProtoMessage()

func (*SessionCreated) ProtoReflect added in v0.30.0

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

func (*SessionCreated) Reset added in v0.30.0

func (x *SessionCreated) Reset()

func (*SessionCreated) String added in v0.30.0

func (x *SessionCreated) String() string

type SetJoinTimeoutRequest added in v0.32.0

type SetJoinTimeoutRequest struct {

	// launch_id binds the request to the launch the caller read, for the reason
	// StopSessionRequest's does.
	LaunchId     string `protobuf:"bytes,1,opt,name=launch_id,json=launchId,proto3" json:"launch_id,omitempty"`
	TimeoutNanos int64  `protobuf:"varint,2,opt,name=timeout_nanos,json=timeoutNanos,proto3" json:"timeout_nanos,omitempty"`
	// contains filtered or unexported fields
}

SetJoinTimeoutRequest sets how long the session waits for its first guest, counted from now, or from readiness if it is not ready yet. It replaces any timeout already set; zero disables it.

func (*SetJoinTimeoutRequest) Descriptor deprecated added in v0.32.0

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

Deprecated: Use SetJoinTimeoutRequest.ProtoReflect.Descriptor instead.

func (*SetJoinTimeoutRequest) GetLaunchId added in v0.32.0

func (x *SetJoinTimeoutRequest) GetLaunchId() string

func (*SetJoinTimeoutRequest) GetTimeoutNanos added in v0.32.0

func (x *SetJoinTimeoutRequest) GetTimeoutNanos() int64

func (*SetJoinTimeoutRequest) ProtoMessage added in v0.32.0

func (*SetJoinTimeoutRequest) ProtoMessage()

func (*SetJoinTimeoutRequest) ProtoReflect added in v0.32.0

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

func (*SetJoinTimeoutRequest) Reset added in v0.32.0

func (x *SetJoinTimeoutRequest) Reset()

func (*SetJoinTimeoutRequest) String added in v0.32.0

func (x *SetJoinTimeoutRequest) String() string

type SetJoinTimeoutResponse added in v0.32.0

type SetJoinTimeoutResponse struct {
	Outcome SetJoinTimeoutResponse_Outcome `protobuf:"varint,1,opt,name=outcome,proto3,enum=api.SetJoinTimeoutResponse_Outcome" json:"outcome,omitempty"`
	State   *JoinState                     `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*SetJoinTimeoutResponse) Descriptor deprecated added in v0.32.0

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

Deprecated: Use SetJoinTimeoutResponse.ProtoReflect.Descriptor instead.

func (*SetJoinTimeoutResponse) GetOutcome added in v0.32.0

func (*SetJoinTimeoutResponse) GetState added in v0.32.0

func (x *SetJoinTimeoutResponse) GetState() *JoinState

func (*SetJoinTimeoutResponse) ProtoMessage added in v0.32.0

func (*SetJoinTimeoutResponse) ProtoMessage()

func (*SetJoinTimeoutResponse) ProtoReflect added in v0.32.0

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

func (*SetJoinTimeoutResponse) Reset added in v0.32.0

func (x *SetJoinTimeoutResponse) Reset()

func (*SetJoinTimeoutResponse) String added in v0.32.0

func (x *SetJoinTimeoutResponse) String() string

type SetJoinTimeoutResponse_Outcome added in v0.32.0

type SetJoinTimeoutResponse_Outcome int32
const (
	SetJoinTimeoutResponse_OUTCOME_UNSPECIFIED SetJoinTimeoutResponse_Outcome = 0
	SetJoinTimeoutResponse_COUNTING            SetJoinTimeoutResponse_Outcome = 1 // state.deadline_unix_nano says when it fires
	SetJoinTimeoutResponse_PENDING             SetJoinTimeoutResponse_Outcome = 2 // not ready yet; state.timeout_nanos counts from readiness
	SetJoinTimeoutResponse_DISABLED            SetJoinTimeoutResponse_Outcome = 3
	SetJoinTimeoutResponse_CLAIMED             SetJoinTimeoutResponse_Outcome = 4 // a guest had joined, at state.first_guest_joined_unix_nano; nothing was set
	SetJoinTimeoutResponse_ENDING              SetJoinTimeoutResponse_Outcome = 5 // the timeout already fired, or the session is tearing down
)

func (SetJoinTimeoutResponse_Outcome) Descriptor added in v0.32.0

func (SetJoinTimeoutResponse_Outcome) Enum added in v0.32.0

func (SetJoinTimeoutResponse_Outcome) EnumDescriptor deprecated added in v0.32.0

func (SetJoinTimeoutResponse_Outcome) EnumDescriptor() ([]byte, []int)

Deprecated: Use SetJoinTimeoutResponse_Outcome.Descriptor instead.

func (SetJoinTimeoutResponse_Outcome) Number added in v0.32.0

func (SetJoinTimeoutResponse_Outcome) String added in v0.32.0

func (SetJoinTimeoutResponse_Outcome) Type added in v0.32.0

type Started added in v0.30.0

type Started struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// status is what the record said at the moment readiness was published --
	// ready, or reconnecting if the tunnel was lost between the command
	// starting and that write (disconnected, on a relay that can't reconnect),
	// which leaves the earlier status standing. The parent reports this rather
	// than assuming ready, so that what it prints and what `upterm session
	// info` answers cannot disagree.
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// join_state is the join timeout as the daemon holds it at the moment
	// readiness is reported, so that `--detach -o json` shows what `upterm
	// session info` would.
	JoinState *JoinState `protobuf:"bytes,3,opt,name=join_state,json=joinState,proto3" json:"join_state,omitempty"`
	// contains filtered or unexported fields
}

Started: the command is running and the session's record has been published. The parent may exit.

func (*Started) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Started.ProtoReflect.Descriptor instead.

func (*Started) GetJoinState added in v0.32.0

func (x *Started) GetJoinState() *JoinState

func (*Started) GetSessionId added in v0.30.0

func (x *Started) GetSessionId() string

func (*Started) GetStatus added in v0.30.0

func (x *Started) GetStatus() string

func (*Started) ProtoMessage added in v0.30.0

func (*Started) ProtoMessage()

func (*Started) ProtoReflect added in v0.30.0

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

func (*Started) Reset added in v0.30.0

func (x *Started) Reset()

func (*Started) String added in v0.30.0

func (x *Started) String() string

type Startup added in v0.30.0

type Startup struct {

	// Types that are valid to be assigned to Msg:
	//
	//	*Startup_Print
	//	*Startup_Read
	//	*Startup_Claimed
	//	*Startup_SessionCreated
	//	*Startup_Listening
	//	*Startup_Started
	//	*Startup_Failed
	//	*Startup_Hello
	//	*Startup_Line
	//	*Startup_ReadFailed
	//	*Startup_Accept
	Msg isStartup_Msg `protobuf_oneof:"msg"`
	// contains filtered or unexported fields
}

Startup is one message of the exchange between `upterm host` and the daemon it spawned, carried over the socket the daemon inherits. The child sends print, read, claimed, session_created, listening, started, failed and hello; the parent sends line, read_failed and accept. Only read and session_created expect a reply.

func (*Startup) Descriptor deprecated added in v0.30.0

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

Deprecated: Use Startup.ProtoReflect.Descriptor instead.

func (*Startup) GetAccept added in v0.30.0

func (x *Startup) GetAccept() *Accept

func (*Startup) GetClaimed added in v0.30.0

func (x *Startup) GetClaimed() *Claimed

func (*Startup) GetFailed added in v0.30.0

func (x *Startup) GetFailed() *Failed

func (*Startup) GetHello added in v0.30.0

func (x *Startup) GetHello() *Hello

func (*Startup) GetLine added in v0.30.0

func (x *Startup) GetLine() *Line

func (*Startup) GetListening added in v0.30.0

func (x *Startup) GetListening() *Listening

func (*Startup) GetMsg added in v0.30.0

func (x *Startup) GetMsg() isStartup_Msg

func (*Startup) GetPrint added in v0.30.0

func (x *Startup) GetPrint() *Print

func (*Startup) GetRead added in v0.30.0

func (x *Startup) GetRead() *Read

func (*Startup) GetReadFailed added in v0.30.0

func (x *Startup) GetReadFailed() *ReadFailed

func (*Startup) GetSessionCreated added in v0.30.0

func (x *Startup) GetSessionCreated() *SessionCreated

func (*Startup) GetStarted added in v0.30.0

func (x *Startup) GetStarted() *Started

func (*Startup) ProtoMessage added in v0.30.0

func (*Startup) ProtoMessage()

func (*Startup) ProtoReflect added in v0.30.0

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

func (*Startup) Reset added in v0.30.0

func (x *Startup) Reset()

func (*Startup) String added in v0.30.0

func (x *Startup) String() string

type Startup_Accept added in v0.30.0

type Startup_Accept struct {
	Accept *Accept `protobuf:"bytes,11,opt,name=accept,proto3,oneof"`
}

type Startup_Claimed added in v0.30.0

type Startup_Claimed struct {
	Claimed *Claimed `protobuf:"bytes,3,opt,name=claimed,proto3,oneof"`
}

type Startup_Failed added in v0.30.0

type Startup_Failed struct {
	Failed *Failed `protobuf:"bytes,7,opt,name=failed,proto3,oneof"`
}

type Startup_Hello added in v0.30.0

type Startup_Hello struct {
	Hello *Hello `protobuf:"bytes,8,opt,name=hello,proto3,oneof"`
}

type Startup_Line added in v0.30.0

type Startup_Line struct {
	Line *Line `protobuf:"bytes,9,opt,name=line,proto3,oneof"`
}

type Startup_Listening added in v0.30.0

type Startup_Listening struct {
	Listening *Listening `protobuf:"bytes,5,opt,name=listening,proto3,oneof"`
}

type Startup_Print added in v0.30.0

type Startup_Print struct {
	Print *Print `protobuf:"bytes,1,opt,name=print,proto3,oneof"`
}

type Startup_Read added in v0.30.0

type Startup_Read struct {
	Read *Read `protobuf:"bytes,2,opt,name=read,proto3,oneof"`
}

type Startup_ReadFailed added in v0.30.0

type Startup_ReadFailed struct {
	ReadFailed *ReadFailed `protobuf:"bytes,10,opt,name=read_failed,json=readFailed,proto3,oneof"`
}

type Startup_SessionCreated added in v0.30.0

type Startup_SessionCreated struct {
	SessionCreated *SessionCreated `protobuf:"bytes,4,opt,name=session_created,json=sessionCreated,proto3,oneof"`
}

type Startup_Started added in v0.30.0

type Startup_Started struct {
	Started *Started `protobuf:"bytes,6,opt,name=started,proto3,oneof"`
}

type StopSessionRequest added in v0.30.0

type StopSessionRequest struct {

	// launch_id must be the launch_id of the record the caller read. A name
	// and a socket path are reused by whoever claims the name next, so they
	// do not say which run is being stopped; the launch does. The daemon
	// refuses any other value, an empty one included, so that a session that
	// ended and was replaced between the read and this call is not stopped in
	// place of the one that was inspected.
	LaunchId string `protobuf:"bytes,1,opt,name=launch_id,json=launchId,proto3" json:"launch_id,omitempty"`
	// contains filtered or unexported fields
}

StopSessionRequest asks the session to end: the command is hung up, then terminated, then killed, and the record reads stopped.

func (*StopSessionRequest) Descriptor deprecated added in v0.30.0

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

Deprecated: Use StopSessionRequest.ProtoReflect.Descriptor instead.

func (*StopSessionRequest) GetLaunchId added in v0.30.0

func (x *StopSessionRequest) GetLaunchId() string

func (*StopSessionRequest) ProtoMessage added in v0.30.0

func (*StopSessionRequest) ProtoMessage()

func (*StopSessionRequest) ProtoReflect added in v0.30.0

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

func (*StopSessionRequest) Reset added in v0.30.0

func (x *StopSessionRequest) Reset()

func (*StopSessionRequest) String added in v0.30.0

func (x *StopSessionRequest) String() string

type StopSessionResponse added in v0.30.0

type StopSessionResponse struct {
	// contains filtered or unexported fields
}

func (*StopSessionResponse) Descriptor deprecated added in v0.30.0

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

Deprecated: Use StopSessionResponse.ProtoReflect.Descriptor instead.

func (*StopSessionResponse) ProtoMessage added in v0.30.0

func (*StopSessionResponse) ProtoMessage()

func (*StopSessionResponse) ProtoReflect added in v0.30.0

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

func (*StopSessionResponse) Reset added in v0.30.0

func (x *StopSessionResponse) Reset()

func (*StopSessionResponse) String added in v0.30.0

func (x *StopSessionResponse) String() string

type UnimplementedAdminServiceServer

type UnimplementedAdminServiceServer struct {
}

UnimplementedAdminServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAdminServiceServer) GetSession

func (UnimplementedAdminServiceServer) SetJoinTimeout added in v0.32.0

func (UnimplementedAdminServiceServer) StopSession added in v0.30.0

type UnsafeAdminServiceServer added in v0.10.0

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL