wip: plugin endpoint authentication

ludomikula · ludomikula · commit c5f6d5dc87f5 · 2023-11-24T20:03:52.000+01:00
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/configuration/CustomWebFluxConfigurationSupport.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/configuration/CustomWebFluxConfigurationSupport.java
@@ -13,5 +13,4 @@ protected RouterFunctionMapping createRouterFunctionMapping()
 	{
 		return new ReloadableRouterFunctionMapping();
 	}
-
 }
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/endpoint/PluginEndpointHandlerImpl.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/plugin/endpoint/PluginEndpointHandlerImpl.java
@@ -21,6 +21,7 @@
 import org.lowcoder.plugin.api.data.EndpointRequest;
 import org.lowcoder.plugin.api.data.EndpointResponse;
 import org.lowcoder.sdk.exception.BaseException;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.support.GenericApplicationContext;
 import org.springframework.core.ResolvableType;
@@ -30,7 +31,6 @@
 import org.springframework.web.reactive.function.server.RouterFunction;
 import org.springframework.web.reactive.function.server.ServerResponse;
 import org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder;
-import org.springframework.web.reactive.function.server.support.RouterFunctionMapping;
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -45,7 +45,7 @@ public class PluginEndpointHandlerImpl implements PluginEndpointHandler
 	private List<RouterFunction<ServerResponse>> routes = new ArrayList<>();
 	
 	private final ApplicationContext applicationContext;
-	private final RouterFunctionMapping routerFunctionMapping;
+	private final DefaultListableBeanFactory beanFactory;
 	
 	@Override
 	public void registerEndpoints(String pluginUrlPrefix, List<PluginEndpoint> endpoints) 
@@ -54,20 +54,24 @@ public void registerEndpoints(String pluginUrlPrefix, List<PluginEndpoint> endpo
 		
 		if (CollectionUtils.isNotEmpty(endpoints))
 		{
-			
+			List<EndpointExtension> toAuthorize = new ArrayList<>();
 			for (PluginEndpoint endpoint : endpoints)
 			{
 				Method[] handlers = endpoint.getClass().getDeclaredMethods();
 				if (handlers != null && handlers.length > 0)
 				{
 					for (Method handler : handlers)
 					{
-						registerEndpointHandler(urlPrefix, endpoint, handler);
+						toAuthorize.addAll(registerEndpointHandler(urlPrefix, endpoint, handler));
 					}
 				}
 			}
 			
-			((ReloadableRouterFunctionMapping)routerFunctionMapping).reloadFunctionMappings();			
+			((ReloadableRouterFunctionMapping)beanFactory.getBean("routerFunctionMapping")).reloadFunctionMappings();
+			if (!toAuthorize.isEmpty())
+			{
+				// TODO: ludomikula: finish endpoint authorization
+			}
 		}
 	}
 	
@@ -77,8 +81,10 @@ public List<RouterFunction<ServerResponse>> registeredEndpoints()
 		return routes;
 	}
 
-	private void registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint, Method handler)
+	private List<EndpointExtension> registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint, Method handler)
 	{
+		List<EndpointExtension> toAuthorize = new ArrayList<>();
+		
 		if (handler.isAnnotationPresent(EndpointExtension.class))
 		{
 			if (checkHandlerMethod(handler))
@@ -103,13 +109,20 @@ private void registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint,
 				routes.add(routerFunction);				
 				registerRouterFunctionMapping(endpointName, routerFunction);
 				
+				if (endpointMeta.authenticated())
+				{
+					toAuthorize.add(endpointMeta);
+				}
+				
 				log.info("Registered endpoint: {} -> {}: {}", endpoint.getClass().getSimpleName(), endpointMeta.method(), urlPrefix + endpointMeta.uri());
 			}
 			else
 			{
 				log.error("Cannot register plugin endpoint: {} -> {}! Handler method must be defined as: public Mono<ServerResponse> {}(ServerRequest request)", endpoint.getClass().getSimpleName(), handler.getName(), handler.getName());
 			}
 		}
+		
+		return toAuthorize;
 	}
 	
 	private void registerRouterFunctionMapping(String endpointName, RouterFunction<ServerResponse> routerFunction)
diff --git a/server/api-service/lowcoder-server/src/main/resources/selfhost/ce/application.yml b/server/api-service/lowcoder-server/src/main/resources/selfhost/ce/application.yml
@@ -16,7 +16,7 @@ spring:
   codec:
     max-in-memory-size: 20MB
   webflux:
-    context-path: /
+    base-path: /
 
 server:
   compression:

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,4 @@ protected RouterFunctionMapping createRouterFunctionMapping()`
`13`	`13`	`{`
`14`	`14`	`return new ReloadableRouterFunctionMapping();`
`15`	`15`	`}`
`16`		`-`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`import org.lowcoder.plugin.api.data.EndpointRequest;`
`22`	`22`	`import org.lowcoder.plugin.api.data.EndpointResponse;`
`23`	`23`	`import org.lowcoder.sdk.exception.BaseException;`
	`24`	`+import org.springframework.beans.factory.support.DefaultListableBeanFactory;`
`24`	`25`	`import org.springframework.context.ApplicationContext;`
`25`	`26`	`import org.springframework.context.support.GenericApplicationContext;`
`26`	`27`	`import org.springframework.core.ResolvableType;`
`@@ -30,7 +31,6 @@`
`30`	`31`	`import org.springframework.web.reactive.function.server.RouterFunction;`
`31`	`32`	`import org.springframework.web.reactive.function.server.ServerResponse;`
`32`	`33`	`import org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder;`
`33`		`-import org.springframework.web.reactive.function.server.support.RouterFunctionMapping;`
`34`	`34`
`35`	`35`	`import lombok.RequiredArgsConstructor;`
`36`	`36`	`import lombok.extern.slf4j.Slf4j;`
`@@ -45,7 +45,7 @@ public class PluginEndpointHandlerImpl implements PluginEndpointHandler`
`45`	`45`	`private List<RouterFunction<ServerResponse>> routes = new ArrayList<>();`
`46`	`46`
`47`	`47`	`private final ApplicationContext applicationContext;`
`48`		`- private final RouterFunctionMapping routerFunctionMapping;`
	`48`	`+ private final DefaultListableBeanFactory beanFactory;`
`49`	`49`
`50`	`50`	`@Override`
`51`	`51`	`public void registerEndpoints(String pluginUrlPrefix, List<PluginEndpoint> endpoints)`
`@@ -54,20 +54,24 @@ public void registerEndpoints(String pluginUrlPrefix, List<PluginEndpoint> endpo`
`54`	`54`
`55`	`55`	`if (CollectionUtils.isNotEmpty(endpoints))`
`56`	`56`	`{`
`57`		`-`
	`57`	`+ List<EndpointExtension> toAuthorize = new ArrayList<>();`
`58`	`58`	`for (PluginEndpoint endpoint : endpoints)`
`59`	`59`	`{`
`60`	`60`	`Method[] handlers = endpoint.getClass().getDeclaredMethods();`
`61`	`61`	`if (handlers != null && handlers.length > 0)`
`62`	`62`	`{`
`63`	`63`	`for (Method handler : handlers)`
`64`	`64`	`{`
`65`		`- registerEndpointHandler(urlPrefix, endpoint, handler);`
	`65`	`+ toAuthorize.addAll(registerEndpointHandler(urlPrefix, endpoint, handler));`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`		`- ((ReloadableRouterFunctionMapping)routerFunctionMapping).reloadFunctionMappings();`
	`70`	`+ ((ReloadableRouterFunctionMapping)beanFactory.getBean("routerFunctionMapping")).reloadFunctionMappings();`
	`71`	`+ if (!toAuthorize.isEmpty())`
	`72`	`+ {`
	`73`	`+ // TODO: ludomikula: finish endpoint authorization`
	`74`	`+ }`
`71`	`75`	`}`
`72`	`76`	`}`
`73`	`77`
`@@ -77,8 +81,10 @@ public List<RouterFunction<ServerResponse>> registeredEndpoints()`
`77`	`81`	`return routes;`
`78`	`82`	`}`
`79`	`83`
`80`		`- private void registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint, Method handler)`
	`84`	`+ private List<EndpointExtension> registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint, Method handler)`
`81`	`85`	`{`
	`86`	`+ List<EndpointExtension> toAuthorize = new ArrayList<>();`
	`87`	`+`
`82`	`88`	`if (handler.isAnnotationPresent(EndpointExtension.class))`
`83`	`89`	`{`
`84`	`90`	`if (checkHandlerMethod(handler))`
`@@ -103,13 +109,20 @@ private void registerEndpointHandler(String urlPrefix, PluginEndpoint endpoint,`
`103`	`109`	`routes.add(routerFunction);`
`104`	`110`	`registerRouterFunctionMapping(endpointName, routerFunction);`
`105`	`111`
	`112`	`+ if (endpointMeta.authenticated())`
	`113`	`+ {`
	`114`	`+ toAuthorize.add(endpointMeta);`
	`115`	`+ }`
	`116`	`+`
`106`	`117`	`log.info("Registered endpoint: {} -> {}: {}", endpoint.getClass().getSimpleName(), endpointMeta.method(), urlPrefix + endpointMeta.uri());`
`107`	`118`	`}`
`108`	`119`	`else`
`109`	`120`	`{`
`110`	`121`	`log.error("Cannot register plugin endpoint: {} -> {}! Handler method must be defined as: public Mono<ServerResponse> {}(ServerRequest request)", endpoint.getClass().getSimpleName(), handler.getName(), handler.getName());`
`111`	`122`	`}`
`112`	`123`	`}`
	`124`	`+`
	`125`	`+ return toAuthorize;`
`113`	`126`	`}`
`114`	`127`
`115`	`128`	`private void registerRouterFunctionMapping(String endpointName, RouterFunction<ServerResponse> routerFunction)`