chore: delete deprecated proto top-level folder

.buf.yaml

@@ -1,4 +1,6 @@
 version: v2
+modules:
+  - path: hipcheck-common/proto
 lint:
   use:
     - STANDARD

hipcheck-common/build.rs

@@ -1,14 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use anyhow::Result;
-use pathbuf::pathbuf;
-use tonic_build::compile_protos;
+use tonic_build::configure;
 
 fn main() -> Result<()> {
 	// Compile the Hipcheck gRPC protocol spec to an .rs file
-	let root = env!("CARGO_MANIFEST_DIR");
-	let path = pathbuf![root, "proto", "hipcheck", "v1", "hipcheck.proto"];
-	compile_protos(path)?;
+	configure().compile_protos(&["proto/hipcheck/v1/plugin_service.proto"], &["proto"])?;
 
 	// Make the target available as a compile-time env var for plugin arch
 	// resolution

proto/hipcheck/v1/messages/default_policy_expr_request.proto → hipcheck-common/proto/hipcheck/v1/default_policy_expr_request.proto

@@ -1,12 +1,12 @@
 syntax = "proto3";
 package hipcheck.v1;
 
-import "empty.proto";
+import "hipcheck/v1/empty.proto";
 
 /**
  * Getting the default policy expression has no params, so we just wrap
  * the empty message for maximal forward compatibility.
  */
-message DefaultPolicyExprRequest {
-    Empty empty = 1;
+message GetDefaultPolicyExpressionRequest {
+  Empty empty = 1;
 }

hipcheck-common/proto/hipcheck/v1/default_policy_expr_response.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package hipcheck.v1;
+
+message GetDefaultPolicyExpressionResponse {
+  // A policy expression, if the plugin has a default policy.
+  // This MUST be filled in with any default values pulled from the plugin's
+  // configuration. Hipcheck will only request the default policy _after_
+  // configuring the plugin.
+  string policy_expression = 1;
+}

proto/hipcheck/v1/messages/explain_default_query_request.proto → hipcheck-common/proto/hipcheck/v1/explain_default_query_request.proto

@@ -1,8 +1,8 @@
 syntax = "proto3";
 package hipcheck.v1;
 
-import "empty.proto";
+import "hipcheck/v1/empty.proto";
 
 message ExplainDefaultQueryRequest {
-    Empty empty = 1;
+  Empty empty = 1;
 }

proto/hipcheck/v1/messages/explain_default_query_response.proto → hipcheck-common/proto/hipcheck/v1/explain_default_query_response.proto

@@ -5,8 +5,8 @@ package hipcheck.v1;
  * The response from the ExplainDefaultQuery RPC call.
  */
 message ExplainDefaultQueryResponse {
-    /**
-     * An unstructured description of the default query.
-     */
-    string explanation = 1;
+  /**
+   * An unstructured description of the default query.
+   */
+  string explanation = 1;
 }

hipcheck-common/proto/hipcheck/v1/plugin_service.proto

@@ -0,0 +1,69 @@
+syntax = "proto3";
+package hipcheck.v1;
+
+import "hipcheck/v1/default_policy_expr_request.proto";
+import "hipcheck/v1/default_policy_expr_response.proto";
+import "hipcheck/v1/explain_default_query_request.proto";
+import "hipcheck/v1/explain_default_query_response.proto";
+import "hipcheck/v1/query.proto";
+import "hipcheck/v1/query_response.proto";
+import "hipcheck/v1/query_schemas_request.proto";
+import "hipcheck/v1/set_configuration_request.proto";
+import "hipcheck/v1/set_configuration_response.proto";
+
+service PluginService {
+  /**
+   * Get schemas for all supported queries by the plugin.
+   *
+   * This is used by Hipcheck to validate that:
+   *
+   * - The plugin supports a default query taking a `target` type if used
+   *   as a top-level plugin in the user's policy file.
+   * - That requests sent to the plugin and data returned by the plugin
+   *   match the schema during execution.
+   */
+  rpc GetQuerySchemas(GetQuerySchemasRequest) returns (stream GetQuerySchemasResponse);
+
+  /**
+   * Hipcheck sends all child nodes for the plugin from the user's policy
+   * file to configure the plugin.
+   */
+  rpc SetConfiguration(SetConfigurationRequest) returns (SetConfigurationResponse);
+
+  /**
+   * Get the default policy for a plugin, which may additionally depend on
+   * the plugin's configuration.
+   */
+  rpc GetDefaultPolicyExpression(GetDefaultPolicyExpressionRequest) returns (GetDefaultPolicyExpressionResponse);
+
+  /**
+   * Get an explanation of what the default query returns, to use when
+   * reporting analysis results to users.
+   *
+   * Note that, because users can specify their own policy expression, this
+   * explanation *should not* assume the user has used the default policy
+   * expression, if one is provided by the plugin.
+   */
+  rpc ExplainDefaultQuery(ExplainDefaultQueryRequest) returns (ExplainDefaultQueryResponse);
+
+  /**
+   * Open a bidirectional streaming RPC to enable a request/response
+   * protocol between Hipcheck and a plugin, where Hipcheck can issue
+   * queries to the plugin, and the plugin may issue queries to _other_
+   * plugins through Hipcheck.
+   *
+   * Queries are cached by the publisher name, plugin name, query name,
+   * and key, and if a match is found for those four values, then
+   * Hipcheck will respond with the cached result of that prior matching
+   * query rather than running the query again.
+   */
+  rpc InitiateQueryProtocol(stream InitiateQueryProtocolRequest) returns (stream InitiateQueryProtocolResponse);
+}
+
+message InitiateQueryProtocolRequest {
+  Query query = 1;
+}
+
+message InitiateQueryProtocolResponse {
+  Query query = 1;
+}