Feat update gateway plugin to dev branch (#729)

* update-gateway-plugin-to-dev-branch

* update

---------

Co-authored-by: ZzIsGod1019 <1498852723@qq.com>

Author: RWDai

Cargo.toml

@@ -79,7 +79,7 @@ tardis = { version = "0.1.0-rc.15" }
 spacegate-shell = { git = "https://github.com/ideal-world/spacegate.git", branch = "dev", features = [
   "cache",
   "k8s",
-  # "ext-redis",
+  "ext-axum",
 ] }
 
 spacegate-plugin = { git = "https://github.com/ideal-world/spacegate.git", branch = "dev" }

backend/gateways/spacegate-plugins/Cargo.toml

@@ -16,7 +16,12 @@ schema = ["spacegate-plugin/schema"]
 [dependencies]
 serde.workspace = true
 lazy_static.workspace = true
-spacegate-shell = { workspace = true, features = ["cache", "k8s", "ext-redis"] }
+spacegate-shell = { workspace = true, features = [
+  "cache",
+  "k8s",
+  "ext-redis",
+  "ext-axum",
+] }
 spacegate-plugin = { workspace = true, features = ["schema"], optional = true }
 
 bios-sdk-invoke = { path = "../../../frontend/sdks/invoke", features = [

backend/gateways/spacegate-plugins/src/plugin/anti_replay.rs

@@ -2,11 +2,11 @@ use std::sync::Arc;
 use std::time::Duration;
 
 use serde::{Deserialize, Serialize};
+use spacegate_shell::ext_redis::{redis::AsyncCommands, RedisClient};
 use spacegate_shell::hyper::{Request, Response, StatusCode};
 use spacegate_shell::kernel::extension::PeerAddr;
 use spacegate_shell::kernel::helper_layers::function::Inner;
 use spacegate_shell::plugin::{Plugin, PluginError};
-use spacegate_shell::ext_redis::{redis::AsyncCommands, RedisClient};
 use spacegate_shell::{BoxError, SgBody, SgRequestExt, SgResponseExt};
 
 use tardis::serde_json;
@@ -15,7 +15,7 @@ use tardis::{basic::result::TardisResult, tokio};
 #[cfg(feature = "schema")]
 use spacegate_plugin::schemars;
 #[cfg(feature = "schema")]
-spacegate_plugin::schema!(AntiReplayPlugin, SgFilterAntiReplay);
+spacegate_plugin::schema!(AntiReplayPlugin, AntiReplayPlugin);
 #[derive(Serialize, Deserialize, Clone)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[serde(default)]
@@ -81,6 +81,13 @@ async fn get_status(md5: &str, cache_key: &str, cache_client: &RedisClient) -> T
 
 impl Plugin for AntiReplayPlugin {
     const CODE: &'static str = "anti-replay";
+
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Anti-replay plugin for Spacegate. It can prevent replay attacks by checking the MD5 hash of the request."
+        )
+    }
+
     fn create(plugin_config: spacegate_shell::plugin::PluginConfig) -> Result<Self, BoxError> {
         let config: AntiReplayPlugin = serde_json::from_value(plugin_config.spec)?;
         Ok(config)

backend/gateways/spacegate-plugins/src/plugin/anti_xss.rs

@@ -20,7 +20,8 @@ macro_rules! append_value {
 use spacegate_plugin::schemars;
 use tardis::serde_json;
 #[cfg(feature = "schema")]
-spacegate_plugin::schema!(AntiXssPlugin, SgFilterAntiXSS);
+spacegate_plugin::schema!(AntiXssPlugin, CSPConfig);
+
 #[derive(Default, Serialize, Deserialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[serde(default)]
@@ -157,6 +158,13 @@ pub struct AntiXssPlugin {
 
 impl Plugin for AntiXssPlugin {
     const CODE: &'static str = "anti-xss";
+
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Anti XSS plugin"
+        )
+    }
+
     fn create(plugin_config: spacegate_shell::plugin::PluginConfig) -> Result<Self, BoxError> {
         let config: AntiXssConfig = serde_json::from_value(plugin_config.spec)?;
         let header = header::HeaderValue::from_str(&config.csp_config.to_string_header_value())?;

backend/gateways/spacegate-plugins/src/plugin/audit_log.rs

@@ -39,7 +39,7 @@ pub const CODE: &str = "audit_log";
 #[cfg(feature = "schema")]
 use spacegate_plugin::schemars;
 #[cfg(feature = "schema")]
-spacegate_plugin::schema!(AuditLogPlugin, SgFilterAuditLog);
+spacegate_plugin::schema!(AuditLogPlugin, AuditLogPlugin);
 
 #[derive(Serialize, Deserialize, Clone)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
@@ -260,9 +260,14 @@ impl Default for AuditLogPlugin {
 }
 
 impl Plugin for AuditLogPlugin {
-    // type MakeLayer = SgFilterAuditLog;
     const CODE: &'static str = CODE;
 
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Audit log for spacegate, it's base on spi-log"
+        )
+    }
+
     fn create(config: spacegate_shell::plugin::PluginConfig) -> Result<Self, BoxError> {
         let mut plugin: AuditLogPlugin = serde_json::from_value(config.spec.clone()).map_err(|e| -> BoxError { format!("[Plugin.AuditLog] deserialize error:{e}").into() })?;
         plugin.init()?;

backend/gateways/spacegate-plugins/src/plugin/auth.rs

@@ -536,7 +536,13 @@ fn headermap_to_hashmap(old_headers: &HeaderMap<HeaderValue>) -> TardisResult<Ha
 
 impl Plugin for AuthPlugin {
     const CODE: &'static str = CODE;
-    // type MakeLayer = SgPluginAuth;
+
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Auth plugin for spacegate, it is used to authenticate the request"
+        )
+    }
+
     fn create(plugin_config: PluginConfig) -> Result<Self, BoxError> {
         let config: SgPluginAuthConfig = serde_json::from_value(plugin_config.spec.clone())?;
         let plugin: AuthPlugin = config.clone().into();

backend/gateways/spacegate-plugins/src/plugin/ip_time.rs

@@ -99,6 +99,13 @@ impl IpTimePlugin {
 }
 impl Plugin for IpTimePlugin {
     const CODE: &'static str = CODE;
+
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Block/Allow IP by time rule"
+        )
+    }
+
     fn create(config: spacegate_shell::plugin::PluginConfig) -> Result<Self, BoxError> {
         let ip_time_config: SgFilterIpTimeConfig = serde_json::from_value(config.spec.clone())?;
         let plugin: IpTimePlugin = ip_time_config.into();
@@ -116,9 +123,4 @@ impl Plugin for IpTimePlugin {
         }
         Ok(inner.call(req).await)
     }
-    // fn create(_: Option<String>, value: JsonValue) -> Result<Self::MakeLayer, BoxError> {
-    //     let config: SgFilterIpTimeConfig = serde_json::from_value(value)?;
-    //     let filter: SgFilterIpTime = config.into();
-    //     Ok(filter)
-    // }
 }

backend/gateways/spacegate-plugins/src/plugin/op_redis_publisher.rs

@@ -42,6 +42,12 @@ pub struct RedisPublisherPlugin {
 impl Plugin for RedisPublisherPlugin {
     const CODE: &'static str = "op_redis_publisher";
 
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Build for open platform, and it depend on plugin audit-log"
+        )
+    }
+
     fn create(config: PluginConfig) -> Result<Self, BoxError> {
         let layer_config = serde_json::from_value::<RedisPublisherConfig>(config.spec.clone())?;
 

backend/gateways/spacegate-plugins/src/plugin/rewrite_ns_b_ip.rs

@@ -12,6 +12,8 @@ use std::net::IpAddr;
 use std::str::FromStr;
 use std::sync::Arc;
 
+#[cfg(feature = "schema")]
+use spacegate_plugin::schemars;
 use tardis::{log, serde_json};
 
 /// Kube available only!
@@ -66,6 +68,13 @@ impl Default for RewriteNsConfig {
 
 impl Plugin for RewriteNsPlugin {
     const CODE: &'static str = "rewrite-ns";
+
+    fn meta() -> spacegate_plugin::PluginMetaData {
+        spacegate_plugin::plugin_meta!(
+            description: "Rewrite namespace for request.Kubernetes available only!"
+        )
+    }
+
     fn create(plugin_config: PluginConfig) -> Result<Self, spacegate_shell::BoxError> {
         let config: RewriteNsConfig = serde_json::from_value(plugin_config.spec)?;
         let ip_list: Vec<IpNet> = config
@@ -119,6 +128,7 @@ impl RewriteNsPlugin {
 mod test {
 
     use http::{Method, Request, Uri, Version};
+    use spacegate_plugin::{PluginInstanceId, PluginInstanceName};
     use spacegate_shell::{
         config::K8sServiceData,
         extension::k8s_service::K8sService,
@@ -133,9 +143,11 @@ mod test {
     #[tokio::test]
     async fn test() {
         let plugin = RewriteNsPlugin::create(PluginConfig {
-            code: "rewrite-ns".into(),
+            id: PluginInstanceId {
+                code: "rewrite-ns".into(),
+                name: PluginInstanceName::mono(),
+            },
             spec: json!({"ip_list":["198.168.1.0/24"],"target_ns":"target"}),
-            name: None,
         })
         .unwrap();