Files
threshold/internal/proto/controller/servers/services/v1/session_service.proto
T
Hugo Vieira d206635d74 fix(connection): Make bytes up and down a signed 64-bit integer
This fixes a theoretical issue with database interaction. Because the
fields in the database are signed 64-bit integers, it's theoretically
possible to overflow them if we're using unsigned 64-bit integers in the
application code.
2022-10-26 17:44:28 +01:00

129 lines
5.0 KiB
Protocol Buffer

syntax = "proto3";
package controller.servers.services.v1;
import "controller/api/resources/targets/v1/target.proto";
import "controller/servers/services/v1/credential.proto";
import "controller/servers/services/v1/server_coordination_service.proto";
import "google/protobuf/timestamp.proto";
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/servers/services;services";
service SessionService {
// LookupSession allows a worker to retrieve session information from the
// controller.
rpc LookupSession(LookupSessionRequest) returns (LookupSessionResponse) {}
// ActivateSession allows a worker to activate a session on a controller.
rpc ActivateSession(ActivateSessionRequest) returns (ActivateSessionResponse) {}
// CancelSession allows a worker to request that the controller cancel a session.
rpc CancelSession(CancelSessionRequest) returns (CancelSessionResponse) {}
// AuthorizeConnection allows a worker to authorize a connection on a controller.
rpc AuthorizeConnection(AuthorizeConnectionRequest) returns (AuthorizeConnectionResponse) {}
// ConnectConnection updates a connection to set it to connected
rpc ConnectConnection(ConnectConnectionRequest) returns (ConnectConnectionResponse) {}
// CloseConnections updates a connection to set it to closed
rpc CloseConnection(CloseConnectionRequest) returns (CloseConnectionResponse) {}
}
message LookupSessionRequest {
// The session ID from the client
string session_id = 10; // @gotags: `class:"public"`
// The id of the requesting worker, used for filtering to ensure this worker
// can handle this session
string worker_id = 20; // @gotags: `class:"public"`
}
// LookupSessionResponse contains information necessary for a client to
// establish a session.
message LookupSessionResponse {
api.resources.targets.v1.SessionAuthorizationData authorization = 10;
string tofu_token = 20; // @gotags: `class:"secret"`
uint32 version = 30; // @gotags: `class:"public"`
string endpoint = 40; // @gotags: `class:"public"`
google.protobuf.Timestamp expiration = 50; // @gotags: `class:"public"`
controller.servers.services.v1.SESSIONSTATUS status = 60; // @gotags: `class:"public"`
int32 connection_limit = 70; // @gotags: `class:"public"`
int32 connections_left = 80; // @gotags: `class:"public"`
string host_id = 90; // @gotags: `class:"public"`
string host_set_id = 100; // @gotags: `class:"public"`
string target_id = 110; // @gotags: `class:"public"`
string user_id = 120; // @gotags: `class:"public"`
repeated Credential credentials = 130; // @gotags: `class:"secret"`
repeated bytes pkcs8_host_keys = 140; // @gotags: `class:"secret"`
}
message ActivateSessionRequest {
reserved 40;
reserved "worker_id";
string session_id = 10; // @gotags: `class:"public"`
string tofu_token = 20; // @gotags: `class:"secret"`
uint32 version = 30; // @gotags: `class:"public"`
controller.servers.services.v1.SESSIONSTATUS status = 50; // @gotags: `class:"public"`
}
message ActivateSessionResponse {
controller.servers.services.v1.SESSIONSTATUS status = 10; // @gotags: `class:"public"`
}
message CancelSessionRequest {
string session_id = 10; // @gotags: `class:"public"`
}
message CancelSessionResponse {
controller.servers.services.v1.SESSIONSTATUS status = 10; // @gotags: `class:"public"`
}
message AuthorizeConnectionRequest {
string session_id = 10; // @gotags: `class:"public"`
string worker_id = 20; // @gotags: `class:"public"`
}
message AuthorizeConnectionResponse {
string connection_id = 10; // @gotags: `class:"public"`
controller.servers.services.v1.CONNECTIONSTATUS status = 20; // @gotags: `class:"public"`
int32 connections_left = 30; // @gotags: `class:"public"`
}
message ConnectConnectionRequest {
string connection_id = 10; // @gotags: `class:"public"`
string client_tcp_address = 20; // @gotags: `class:"public"`
uint32 client_tcp_port = 30; // @gotags: `class:"public"`
string endpoint_tcp_address = 40; // @gotags: `class:"public"`
uint32 endpoint_tcp_port = 50; // @gotags: `class:"public"`
string type = 60; // @gotags: `class:"public"`
// user_client_ip is the user's client ip for the connection as determined by
// the inbound http request handler
string user_client_ip = 70; // @gotags: `class:"public"
}
message ConnectConnectionResponse {
controller.servers.services.v1.CONNECTIONSTATUS status = 10; // @gotags: `class:"public"`
}
message CloseConnectionRequestData {
string connection_id = 10; // @gotags: `class:"public"`
int64 bytes_up = 20; // @gotags: `class:"public"`
int64 bytes_down = 30; // @gotags: `class:"public"`
string reason = 40; // @gotags: `class:"public"`
}
message CloseConnectionRequest {
repeated CloseConnectionRequestData close_request_data = 10; // @gotags: `class:"public"`
}
message CloseConnectionResponseData {
string connection_id = 10;
controller.servers.services.v1.CONNECTIONSTATUS status = 20; // @gotags: `class:"public"`
}
message CloseConnectionResponse {
repeated CloseConnectionResponseData close_response_data = 10; // @gotags: `class:"public"`
}