feat: enclave manager exposes api's to lock, unlock ports and view their current state

api/golang/core/lib/binding_constructors/binding_constructors.go

@@ -24,6 +24,7 @@ func NewPort(
 		TransportProtocol:        protocol,
 		MaybeApplicationProtocol: maybeApplicationProtocol,
 		MaybeWaitTimeout:         maybeWaitTimeout,
+		Locked:                   nil,
 	}
 }
 

api/protobuf/core/api_container_service.proto

@@ -78,6 +78,9 @@ message Port {
   string maybe_application_protocol = 3;
   // The wait timeout duration in string
   string maybe_wait_timeout = 4;
+
+  // this is useful in the cloud context; ignore in local
+  optional bool locked = 5;
 }
 
 message Container {

api/rust/src/api_container_api.rs

@@ -14,6 +14,9 @@ pub struct Port {
     /// The wait timeout duration in string
     #[prost(string, tag = "4")]
     pub maybe_wait_timeout: ::prost::alloc::string::String,
+    /// this is useful in the cloud context; ignore in local
+    #[prost(bool, optional, tag = "5")]
+    pub locked: ::core::option::Option<bool>,
 }
 /// Nested message and enum types in `Port`.
 pub mod port {

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_grpc_web_pb.d.ts

@@ -1,7 +1,7 @@
 import * as grpcWeb from 'grpc-web';
 
-import * as api_container_service_pb from './api_container_service_pb';
-import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb';
+import * as api_container_service_pb from './api_container_service_pb'; // proto import: "api_container_service.proto"
+import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb'; // proto import: "google/protobuf/empty.proto"
 
 
 export class ApiContainerServiceClient {

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_grpc_web_pb.js

@@ -6,7 +6,7 @@
 
 // Code generated by protoc-gen-grpc-web. DO NOT EDIT.
 // versions:
-// 	protoc-gen-grpc-web v1.4.2
+// 	protoc-gen-grpc-web v1.5.0
 // 	protoc              v3.19.1
 // source: api_container_service.proto
 

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.d.ts

@@ -1,6 +1,6 @@
 import * as jspb from 'google-protobuf'
 
-import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb';
+import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb'; // proto import: "google/protobuf/empty.proto"
 
 
 export class Port extends jspb.Message {
@@ -16,6 +16,11 @@ export class Port extends jspb.Message {
   getMaybeWaitTimeout(): string;
   setMaybeWaitTimeout(value: string): Port;
 
+  getLocked(): boolean;
+  setLocked(value: boolean): Port;
+  hasLocked(): boolean;
+  clearLocked(): Port;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): Port.AsObject;
   static toObject(includeInstance: boolean, msg: Port): Port.AsObject;
@@ -30,13 +35,19 @@ export namespace Port {
     transportProtocol: Port.TransportProtocol,
     maybeApplicationProtocol: string,
     maybeWaitTimeout: string,
+    locked?: boolean,
   }
 
   export enum TransportProtocol { 
     TCP = 0,
     SCTP = 1,
     UDP = 2,
   }
+
+  export enum LockedCase { 
+    _LOCKED_NOT_SET = 0,
+    LOCKED = 5,
+  }
 }
 
 export class Container extends jspb.Message {

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.js

@@ -1058,7 +1058,8 @@ proto.api_container_api.Port.toObject = function(includeInstance, msg) {
     number: jspb.Message.getFieldWithDefault(msg, 1, 0),
     transportProtocol: jspb.Message.getFieldWithDefault(msg, 2, 0),
     maybeApplicationProtocol: jspb.Message.getFieldWithDefault(msg, 3, ""),
-    maybeWaitTimeout: jspb.Message.getFieldWithDefault(msg, 4, "")
+    maybeWaitTimeout: jspb.Message.getFieldWithDefault(msg, 4, ""),
+    locked: jspb.Message.getBooleanFieldWithDefault(msg, 5, false)
   };
 
   if (includeInstance) {
@@ -1111,6 +1112,10 @@ proto.api_container_api.Port.deserializeBinaryFromReader = function(msg, reader)
       var value = /** @type {string} */ (reader.readString());
       msg.setMaybeWaitTimeout(value);
       break;
+    case 5:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setLocked(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -1168,6 +1173,13 @@ proto.api_container_api.Port.serializeBinaryToWriter = function(message, writer)
       f
     );
   }
+  f = /** @type {boolean} */ (jspb.Message.getField(message, 5));
+  if (f != null) {
+    writer.writeBool(
+      5,
+      f
+    );
+  }
 };
 
 
@@ -1252,6 +1264,42 @@ proto.api_container_api.Port.prototype.setMaybeWaitTimeout = function(value) {
 };
 
 
+/**
+ * optional bool locked = 5;
+ * @return {boolean}
+ */
+proto.api_container_api.Port.prototype.getLocked = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 5, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.api_container_api.Port} returns this
+ */
+proto.api_container_api.Port.prototype.setLocked = function(value) {
+  return jspb.Message.setField(this, 5, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.api_container_api.Port} returns this
+ */
+proto.api_container_api.Port.prototype.clearLocked = function() {
+  return jspb.Message.setField(this, 5, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.api_container_api.Port.prototype.hasLocked = function() {
+  return jspb.Message.getField(this, 5) != null;
+};
+
+
 
 /**
  * List of repeated fields within this message type.

api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_connect.d.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=js+dts"
+// @generated by protoc-gen-connect-es v0.13.2 with parameter "target=js+dts"
 // @generated from file api_container_service.proto (package api_container_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_connect.js

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=js+dts"
+// @generated by protoc-gen-connect-es v0.13.2 with parameter "target=js+dts"
 // @generated from file api_container_service.proto (package api_container_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.d.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.3.1 with parameter "target=js+dts"
+// @generated by protoc-gen-es v1.5.1 with parameter "target=js+dts"
 // @generated from file api_container_service.proto (package api_container_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -122,6 +122,13 @@ export declare class Port extends Message<Port> {
    */
   maybeWaitTimeout: string;
 
+  /**
+   * this is useful in the cloud context; ignore in local
+   *
+   * @generated from field: optional bool locked = 5;
+   */
+  locked?: boolean;
+
   constructor(data?: PartialMessage<Port>);
 
   static readonly runtime: typeof proto3;

api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.js

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.3.1 with parameter "target=js+dts"
+// @generated by protoc-gen-es v1.5.1 with parameter "target=js+dts"
 // @generated from file api_container_service.proto (package api_container_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck
@@ -76,6 +76,7 @@ export const Port = proto3.makeMessageType(
     { no: 2, name: "transport_protocol", kind: "enum", T: proto3.getEnumType(Port_TransportProtocol) },
     { no: 3, name: "maybe_application_protocol", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 4, name: "maybe_wait_timeout", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "locked", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
   ],
 );
 

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/connect/engine_service_connect.d.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=js+dts"
+// @generated by protoc-gen-connect-es v0.13.2 with parameter "target=js+dts"
 // @generated from file engine_service.proto (package engine_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/connect/engine_service_connect.js

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-connect-es v1.3.0 with parameter "target=js+dts"
+// @generated by protoc-gen-connect-es v0.13.2 with parameter "target=js+dts"
 // @generated from file engine_service.proto (package engine_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/connect/engine_service_pb.d.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.3.1 with parameter "target=js+dts"
+// @generated by protoc-gen-es v1.5.1 with parameter "target=js+dts"
 // @generated from file engine_service.proto (package engine_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/connect/engine_service_pb.js

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.3.1 with parameter "target=js+dts"
+// @generated by protoc-gen-es v1.5.1 with parameter "target=js+dts"
 // @generated from file engine_service.proto (package engine_api, syntax proto3)
 /* eslint-disable */
 // @ts-nocheck

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/engine_service_grpc_web_pb.d.ts

@@ -1,7 +1,7 @@
 import * as grpcWeb from 'grpc-web';
 
-import * as engine_service_pb from './engine_service_pb';
-import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb';
+import * as engine_service_pb from './engine_service_pb'; // proto import: "engine_service.proto"
+import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb'; // proto import: "google/protobuf/empty.proto"
 
 
 export class EngineServiceClient {

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/engine_service_grpc_web_pb.js

@@ -6,7 +6,7 @@
 
 // Code generated by protoc-gen-grpc-web. DO NOT EDIT.
 // versions:
-// 	protoc-gen-grpc-web v1.4.2
+// 	protoc-gen-grpc-web v1.5.0
 // 	protoc              v3.19.1
 // source: engine_service.proto
 

api/typescript/src/engine/kurtosis_engine_rpc_api_bindings/engine_service_pb.d.ts

@@ -1,7 +1,7 @@
 import * as jspb from 'google-protobuf'
 
-import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb';
-import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb';
+import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb'; // proto import: "google/protobuf/empty.proto"
+import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb'; // proto import: "google/protobuf/timestamp.proto"
 
 
 export class GetEngineInfoResponse extends jspb.Message {

cli/cli/commands/service/add/add.go

@@ -541,6 +541,7 @@ func parsePortSpecStr(specStr string) (*kurtosis_core_rpc_api_bindings.Port, err
 		TransportProtocol:        transportProtocolFromEnum,
 		MaybeApplicationProtocol: maybeApplicationProtocol,
 		MaybeWaitTimeout:         defaultPortWaitTimeoutStr, //TODO we should add this to the port's arguments instead of using only a default value
+		Locked:                   nil,
 	}, nil
 }
 

cli/cli/commands/service/add/add_test.go

@@ -23,28 +23,28 @@ func TestParsePortSpecstr_SuccessCases(t *testing.T) {
 			args: args{
 				specStr: "http:3333",
 			},
-			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_TCP, MaybeApplicationProtocol: "http", MaybeWaitTimeout: defaultPortWaitTimeoutStr},
+			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_TCP, MaybeApplicationProtocol: "http", MaybeWaitTimeout: defaultPortWaitTimeoutStr, Locked: nil},
 		},
 		{
 			name: "Successfully parse str with application protocol and with transport protocol",
 			args: args{
 				specStr: "http:3333/udp",
 			},
-			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_UDP, MaybeApplicationProtocol: "http", MaybeWaitTimeout: defaultPortWaitTimeoutStr},
+			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_UDP, MaybeApplicationProtocol: "http", MaybeWaitTimeout: defaultPortWaitTimeoutStr, Locked: nil},
 		},
 		{
 			name: "Successfully parse str without application protocol and with transport protocol",
 			args: args{
 				specStr: "3333/udp",
 			},
-			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_UDP, MaybeApplicationProtocol: "", MaybeWaitTimeout: defaultPortWaitTimeoutStr},
+			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_UDP, MaybeApplicationProtocol: "", MaybeWaitTimeout: defaultPortWaitTimeoutStr, Locked: nil},
 		},
 		{
 			name: "Successfully parse str without application protocol and without transport protocol",
 			args: args{
 				specStr: "3333",
 			},
-			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_TCP, MaybeApplicationProtocol: "", MaybeWaitTimeout: defaultPortWaitTimeoutStr},
+			want: &kurtosis_core_rpc_api_bindings.Port{Number: uint32(3333), TransportProtocol: kurtosis_core_rpc_api_bindings.Port_TCP, MaybeApplicationProtocol: "", MaybeWaitTimeout: defaultPortWaitTimeoutStr, Locked: nil},
 		},
 	}
 	for _, parsePortSpecTest := range parsePortSpecSuccessTests {

cli/cli/kurtosis_gateway/server/api_container_gateway/api_container_gateway_service_server.go

@@ -341,6 +341,7 @@ func (service *ApiContainerGatewayServiceServer) startRunningConnectionForKurtos
 			TransportProtocol:        privateApiPort.GetTransportProtocol(),
 			MaybeApplicationProtocol: privateApiPort.GetMaybeApplicationProtocol(),
 			MaybeWaitTimeout:         privateApiPort.GetMaybeWaitTimeout(),
+			Locked:                   nil,
 		}
 	}