diff --git a/docker/.gitignore b/docker/.gitignore new file mode 100644 index 0000000..5e82536 --- /dev/null +++ b/docker/.gitignore @@ -0,0 +1,2 @@ +example/ +src/ \ No newline at end of file diff --git a/example/plugins/api-call-example/go.mod b/example/plugins/api-call-example/go.mod new file mode 100644 index 0000000..6b83139 --- /dev/null +++ b/example/plugins/api-call-example/go.mod @@ -0,0 +1,3 @@ +module aroz.org/zoraxy/api-call-example + +go 1.24.5 \ No newline at end of file diff --git a/example/plugins/api-call-example/main.go b/example/plugins/api-call-example/main.go new file mode 100644 index 0000000..fa2e751 --- /dev/null +++ b/example/plugins/api-call-example/main.go @@ -0,0 +1,54 @@ +package main + +import ( + "fmt" + "net/http" + + plugin "aroz.org/zoraxy/api-call-example/mod/zoraxy_plugin" +) + +const ( + PLUGIN_ID = "org.aroz.zoraxy.api_call_example" + UI_PATH = "/ui" +) + +func main() { + // Serve the plugin intro spect + // This will print the plugin intro spect and exit if the -introspect flag is provided + runtimeCfg, err := plugin.ServeAndRecvSpec(&plugin.IntroSpect{ + ID: PLUGIN_ID, + Name: "API Call Example Plugin", + Author: "Anthony Rubick", + AuthorContact: "", + Description: "An example plugin for making API calls", + Type: plugin.PluginType_Utilities, + VersionMajor: 1, + VersionMinor: 0, + VersionPatch: 0, + + UIPath: UI_PATH, + + /* API Access Control */ + PermittedAPIEndpoints: []plugin.PermittedAPIEndpoint{ + { + Method: http.MethodGet, + Endpoint: "/plugin/api/access/list", + Reason: "Used to display all configured Access Rules", + }, + }, + }) + + if err != nil { + fmt.Printf("Error serving introspect: %v\n", err) + return + } + + // Start the HTTP server + http.HandleFunc(UI_PATH+"/", func(w http.ResponseWriter, r *http.Request) { + RenderUI(runtimeCfg, w, r) + }) + + serverAddr := fmt.Sprintf("127.0.0.1:%d", runtimeCfg.Port) + fmt.Printf("Starting API Call Example Plugin on %s\n", serverAddr) + http.ListenAndServe(serverAddr, nil) +} diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/README.txt b/example/plugins/api-call-example/mod/zoraxy_plugin/README.txt new file mode 100644 index 0000000..ed8a405 --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/README.txt @@ -0,0 +1,19 @@ +# Zoraxy Plugin + +## Overview +This module serves as a template for building your own plugins for the Zoraxy Reverse Proxy. By copying this module to your plugin mod folder, you can create a new plugin with the necessary structure and components. + +## Instructions + +1. **Copy the Module:** + - Copy the entire `zoraxy_plugin` module to your plugin mod folder. + +2. **Include the Structure:** + - Ensure that you maintain the directory structure and file organization as provided in this module. + +3. **Modify as Needed:** + - Customize the copied module to implement the desired functionality for your plugin. + +## Directory Structure + zoraxy_plugin: Handle -introspect and -configuration process required for plugin loading and startup + embed_webserver: Handle embeded web server routing and injecting csrf token to your plugin served UI pages \ No newline at end of file diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/dev_webserver.go b/example/plugins/api-call-example/mod/zoraxy_plugin/dev_webserver.go new file mode 100644 index 0000000..9bed106 --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/dev_webserver.go @@ -0,0 +1,145 @@ +package zoraxy_plugin + +import ( + "fmt" + "net/http" + "os" + "strings" + "time" +) + +type PluginUiDebugRouter struct { + PluginID string //The ID of the plugin + TargetDir string //The directory where the UI files are stored + HandlerPrefix string //The prefix of the handler used to route this router, e.g. /ui + EnableDebug bool //Enable debug mode + terminateHandler func() //The handler to be called when the plugin is terminated +} + +// NewPluginFileSystemUIRouter creates a new PluginUiRouter with file system +// The targetDir is the directory where the UI files are stored (e.g. ./www) +// The handlerPrefix is the prefix of the handler used to route this router +// The handlerPrefix should start with a slash (e.g. /ui) that matches the http.Handle path +// All prefix should not end with a slash +func NewPluginFileSystemUIRouter(pluginID string, targetDir string, handlerPrefix string) *PluginUiDebugRouter { + //Make sure all prefix are in /prefix format + if !strings.HasPrefix(handlerPrefix, "/") { + handlerPrefix = "/" + handlerPrefix + } + handlerPrefix = strings.TrimSuffix(handlerPrefix, "/") + + //Return the PluginUiRouter + return &PluginUiDebugRouter{ + PluginID: pluginID, + TargetDir: targetDir, + HandlerPrefix: handlerPrefix, + } +} + +func (p *PluginUiDebugRouter) populateCSRFToken(r *http.Request, fsHandler http.Handler) http.Handler { + //Get the CSRF token from header + csrfToken := r.Header.Get("X-Zoraxy-Csrf") + if csrfToken == "" { + csrfToken = "missing-csrf-token" + } + + //Return the middleware + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Check if the request is for an HTML file + if strings.HasSuffix(r.URL.Path, ".html") { + //Read the target file from file system + targetFilePath := strings.TrimPrefix(r.URL.Path, "/") + targetFilePath = p.TargetDir + "/" + targetFilePath + targetFilePath = strings.TrimPrefix(targetFilePath, "/") + targetFileContent, err := os.ReadFile(targetFilePath) + if err != nil { + http.Error(w, "File not found", http.StatusNotFound) + return + } + body := string(targetFileContent) + body = strings.ReplaceAll(body, "{{.csrfToken}}", csrfToken) + w.Header().Set("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + w.Write([]byte(body)) + return + } else if strings.HasSuffix(r.URL.Path, "/") { + //Check if the request is for a directory + //Check if the directory has an index.html file + targetFilePath := strings.TrimPrefix(r.URL.Path, "/") + targetFilePath = p.TargetDir + "/" + targetFilePath + "index.html" + targetFilePath = strings.TrimPrefix(targetFilePath, "/") + if _, err := os.Stat(targetFilePath); err == nil { + //Serve the index.html file + targetFileContent, err := os.ReadFile(targetFilePath) + if err != nil { + http.Error(w, "File not found", http.StatusNotFound) + return + } + body := string(targetFileContent) + body = strings.ReplaceAll(body, "{{.csrfToken}}", csrfToken) + w.Header().Set("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + w.Write([]byte(body)) + return + } + } + + //Call the next handler + fsHandler.ServeHTTP(w, r) + }) + +} + +// GetHttpHandler returns the http.Handler for the PluginUiRouter +func (p *PluginUiDebugRouter) Handler() http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + //Remove the plugin UI handler path prefix + if p.EnableDebug { + fmt.Print("Request URL:", r.URL.Path, " rewriting to ") + } + + rewrittenURL := r.RequestURI + rewrittenURL = strings.TrimPrefix(rewrittenURL, p.HandlerPrefix) + rewrittenURL = strings.ReplaceAll(rewrittenURL, "//", "/") + r.URL.Path = rewrittenURL + r.RequestURI = rewrittenURL + if p.EnableDebug { + fmt.Println(r.URL.Path) + } + + //Serve the file from the file system + fsHandler := http.FileServer(http.Dir(p.TargetDir)) + + // Replace {{csrf_token}} with the actual CSRF token and serve the file + p.populateCSRFToken(r, fsHandler).ServeHTTP(w, r) + }) +} + +// RegisterTerminateHandler registers the terminate handler for the PluginUiRouter +// The terminate handler will be called when the plugin is terminated from Zoraxy plugin manager +// if mux is nil, the handler will be registered to http.DefaultServeMux +func (p *PluginUiDebugRouter) RegisterTerminateHandler(termFunc func(), mux *http.ServeMux) { + p.terminateHandler = termFunc + if mux == nil { + mux = http.DefaultServeMux + } + mux.HandleFunc(p.HandlerPrefix+"/term", func(w http.ResponseWriter, r *http.Request) { + p.terminateHandler() + w.WriteHeader(http.StatusOK) + go func() { + //Make sure the response is sent before the plugin is terminated + time.Sleep(100 * time.Millisecond) + os.Exit(0) + }() + }) +} + +// Attach the file system UI handler to the target http.ServeMux +func (p *PluginUiDebugRouter) AttachHandlerToMux(mux *http.ServeMux) { + if mux == nil { + mux = http.DefaultServeMux + } + + p.HandlerPrefix = strings.TrimSuffix(p.HandlerPrefix, "/") + mux.Handle(p.HandlerPrefix+"/", p.Handler()) +} diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/dynamic_router.go b/example/plugins/api-call-example/mod/zoraxy_plugin/dynamic_router.go new file mode 100644 index 0000000..22e56be --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/dynamic_router.go @@ -0,0 +1,162 @@ +package zoraxy_plugin + +import ( + "encoding/json" + "fmt" + "io" + "net/http" + "strings" +) + +/* + + Dynamic Path Handler + +*/ + +type SniffResult int + +const ( + SniffResultAccept SniffResult = iota // Forward the request to this plugin dynamic capture ingress + SniffResultSkip // Skip this plugin and let the next plugin handle the request +) + +type SniffHandler func(*DynamicSniffForwardRequest) SniffResult + +/* +RegisterDynamicSniffHandler registers a dynamic sniff handler for a path +You can decide to accept or skip the request based on the request header and paths +*/ +func (p *PathRouter) RegisterDynamicSniffHandler(sniff_ingress string, mux *http.ServeMux, handler SniffHandler) { + if !strings.HasSuffix(sniff_ingress, "/") { + sniff_ingress = sniff_ingress + "/" + } + mux.Handle(sniff_ingress, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if p.enableDebugPrint { + fmt.Println("Request captured by dynamic sniff path: " + r.RequestURI) + } + + // Decode the request payload + jsonBytes, err := io.ReadAll(r.Body) + if err != nil { + if p.enableDebugPrint { + fmt.Println("Error reading request body:", err) + } + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + return + } + payload, err := DecodeForwardRequestPayload(jsonBytes) + if err != nil { + if p.enableDebugPrint { + fmt.Println("Error decoding request payload:", err) + fmt.Print("Payload: ") + fmt.Println(string(jsonBytes)) + } + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + return + } + + // Get the forwarded request UUID + forwardUUID := r.Header.Get("X-Zoraxy-RequestID") + payload.requestUUID = forwardUUID + payload.rawRequest = r + + sniffResult := handler(&payload) + if sniffResult == SniffResultAccept { + w.WriteHeader(http.StatusOK) + w.Write([]byte("OK")) + } else { + w.WriteHeader(http.StatusNotImplemented) + w.Write([]byte("SKIP")) + } + })) +} + +// RegisterDynamicCaptureHandle register the dynamic capture ingress path with a handler +func (p *PathRouter) RegisterDynamicCaptureHandle(capture_ingress string, mux *http.ServeMux, handlefunc func(http.ResponseWriter, *http.Request)) { + if !strings.HasSuffix(capture_ingress, "/") { + capture_ingress = capture_ingress + "/" + } + mux.Handle(capture_ingress, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if p.enableDebugPrint { + fmt.Println("Request captured by dynamic capture path: " + r.RequestURI) + } + + rewrittenURL := r.RequestURI + rewrittenURL = strings.TrimPrefix(rewrittenURL, capture_ingress) + rewrittenURL = strings.ReplaceAll(rewrittenURL, "//", "/") + if rewrittenURL == "" { + rewrittenURL = "/" + } + if !strings.HasPrefix(rewrittenURL, "/") { + rewrittenURL = "/" + rewrittenURL + } + r.RequestURI = rewrittenURL + + handlefunc(w, r) + })) +} + +/* + Sniffing and forwarding + + The following functions are here to help with + sniffing and forwarding requests to the dynamic + router. +*/ +// A custom request object to be used in the dynamic sniffing +type DynamicSniffForwardRequest struct { + Method string `json:"method"` + Hostname string `json:"hostname"` + URL string `json:"url"` + Header map[string][]string `json:"header"` + RemoteAddr string `json:"remote_addr"` + Host string `json:"host"` + RequestURI string `json:"request_uri"` + Proto string `json:"proto"` + ProtoMajor int `json:"proto_major"` + ProtoMinor int `json:"proto_minor"` + + /* Internal use */ + rawRequest *http.Request `json:"-"` + requestUUID string `json:"-"` +} + +// GetForwardRequestPayload returns a DynamicSniffForwardRequest object from an http.Request object +func EncodeForwardRequestPayload(r *http.Request) DynamicSniffForwardRequest { + return DynamicSniffForwardRequest{ + Method: r.Method, + Hostname: r.Host, + URL: r.URL.String(), + Header: r.Header, + RemoteAddr: r.RemoteAddr, + Host: r.Host, + RequestURI: r.RequestURI, + Proto: r.Proto, + ProtoMajor: r.ProtoMajor, + ProtoMinor: r.ProtoMinor, + rawRequest: r, + } +} + +// DecodeForwardRequestPayload decodes JSON bytes into a DynamicSniffForwardRequest object +func DecodeForwardRequestPayload(jsonBytes []byte) (DynamicSniffForwardRequest, error) { + var payload DynamicSniffForwardRequest + err := json.Unmarshal(jsonBytes, &payload) + if err != nil { + return DynamicSniffForwardRequest{}, err + } + return payload, nil +} + +// GetRequest returns the original http.Request object, for debugging purposes +func (dsfr *DynamicSniffForwardRequest) GetRequest() *http.Request { + return dsfr.rawRequest +} + +// GetRequestUUID returns the request UUID +// if this UUID is empty string, that might indicate the request +// is not coming from the dynamic router +func (dsfr *DynamicSniffForwardRequest) GetRequestUUID() string { + return dsfr.requestUUID +} diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/embed_webserver.go b/example/plugins/api-call-example/mod/zoraxy_plugin/embed_webserver.go new file mode 100644 index 0000000..b64318f --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/embed_webserver.go @@ -0,0 +1,156 @@ +package zoraxy_plugin + +import ( + "embed" + "fmt" + "io/fs" + "net/http" + "net/url" + "os" + "strings" + "time" +) + +type PluginUiRouter struct { + PluginID string //The ID of the plugin + TargetFs *embed.FS //The embed.FS where the UI files are stored + TargetFsPrefix string //The prefix of the embed.FS where the UI files are stored, e.g. /web + HandlerPrefix string //The prefix of the handler used to route this router, e.g. /ui + EnableDebug bool //Enable debug mode + terminateHandler func() //The handler to be called when the plugin is terminated +} + +// NewPluginEmbedUIRouter creates a new PluginUiRouter with embed.FS +// The targetFsPrefix is the prefix of the embed.FS where the UI files are stored +// The targetFsPrefix should be relative to the root of the embed.FS +// The targetFsPrefix should start with a slash (e.g. /web) that corresponds to the root folder of the embed.FS +// The handlerPrefix is the prefix of the handler used to route this router +// The handlerPrefix should start with a slash (e.g. /ui) that matches the http.Handle path +// All prefix should not end with a slash +func NewPluginEmbedUIRouter(pluginID string, targetFs *embed.FS, targetFsPrefix string, handlerPrefix string) *PluginUiRouter { + //Make sure all prefix are in /prefix format + if !strings.HasPrefix(targetFsPrefix, "/") { + targetFsPrefix = "/" + targetFsPrefix + } + targetFsPrefix = strings.TrimSuffix(targetFsPrefix, "/") + + if !strings.HasPrefix(handlerPrefix, "/") { + handlerPrefix = "/" + handlerPrefix + } + handlerPrefix = strings.TrimSuffix(handlerPrefix, "/") + + //Return the PluginUiRouter + return &PluginUiRouter{ + PluginID: pluginID, + TargetFs: targetFs, + TargetFsPrefix: targetFsPrefix, + HandlerPrefix: handlerPrefix, + } +} + +func (p *PluginUiRouter) populateCSRFToken(r *http.Request, fsHandler http.Handler) http.Handler { + //Get the CSRF token from header + csrfToken := r.Header.Get("X-Zoraxy-Csrf") + if csrfToken == "" { + csrfToken = "missing-csrf-token" + } + + //Return the middleware + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Check if the request is for an HTML file + if strings.HasSuffix(r.URL.Path, ".html") { + //Read the target file from embed.FS + targetFilePath := strings.TrimPrefix(r.URL.Path, "/") + targetFilePath = p.TargetFsPrefix + "/" + targetFilePath + targetFilePath = strings.TrimPrefix(targetFilePath, "/") + targetFileContent, err := fs.ReadFile(*p.TargetFs, targetFilePath) + if err != nil { + http.Error(w, "File not found", http.StatusNotFound) + return + } + body := string(targetFileContent) + body = strings.ReplaceAll(body, "{{.csrfToken}}", csrfToken) + w.Header().Set("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + w.Write([]byte(body)) + return + } else if strings.HasSuffix(r.URL.Path, "/") { + // Check if the directory has an index.html file + indexFilePath := strings.TrimPrefix(r.URL.Path, "/") + "index.html" + indexFilePath = p.TargetFsPrefix + "/" + indexFilePath + indexFilePath = strings.TrimPrefix(indexFilePath, "/") + indexFileContent, err := fs.ReadFile(*p.TargetFs, indexFilePath) + if err == nil { + body := string(indexFileContent) + body = strings.ReplaceAll(body, "{{.csrfToken}}", csrfToken) + w.Header().Set("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + w.Write([]byte(body)) + return + } + } + + //Call the next handler + fsHandler.ServeHTTP(w, r) + }) + +} + +// GetHttpHandler returns the http.Handler for the PluginUiRouter +func (p *PluginUiRouter) Handler() http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + //Remove the plugin UI handler path prefix + if p.EnableDebug { + fmt.Print("Request URL:", r.URL.Path, " rewriting to ") + } + + rewrittenURL := r.RequestURI + rewrittenURL = strings.TrimPrefix(rewrittenURL, p.HandlerPrefix) + rewrittenURL = strings.ReplaceAll(rewrittenURL, "//", "/") + r.URL, _ = url.Parse(rewrittenURL) + r.RequestURI = rewrittenURL + if p.EnableDebug { + fmt.Println(r.URL.Path) + } + + //Serve the file from the embed.FS + subFS, err := fs.Sub(*p.TargetFs, strings.TrimPrefix(p.TargetFsPrefix, "/")) + if err != nil { + fmt.Println(err.Error()) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + return + } + + // Replace {{csrf_token}} with the actual CSRF token and serve the file + p.populateCSRFToken(r, http.FileServer(http.FS(subFS))).ServeHTTP(w, r) + }) +} + +// RegisterTerminateHandler registers the terminate handler for the PluginUiRouter +// The terminate handler will be called when the plugin is terminated from Zoraxy plugin manager +// if mux is nil, the handler will be registered to http.DefaultServeMux +func (p *PluginUiRouter) RegisterTerminateHandler(termFunc func(), mux *http.ServeMux) { + p.terminateHandler = termFunc + if mux == nil { + mux = http.DefaultServeMux + } + mux.HandleFunc(p.HandlerPrefix+"/term", func(w http.ResponseWriter, r *http.Request) { + p.terminateHandler() + w.WriteHeader(http.StatusOK) + go func() { + //Make sure the response is sent before the plugin is terminated + time.Sleep(100 * time.Millisecond) + os.Exit(0) + }() + }) +} + +// Attach the embed UI handler to the target http.ServeMux +func (p *PluginUiRouter) AttachHandlerToMux(mux *http.ServeMux) { + if mux == nil { + mux = http.DefaultServeMux + } + + p.HandlerPrefix = strings.TrimSuffix(p.HandlerPrefix, "/") + mux.Handle(p.HandlerPrefix+"/", p.Handler()) +} diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/static_router.go b/example/plugins/api-call-example/mod/zoraxy_plugin/static_router.go new file mode 100644 index 0000000..f4abcb7 --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/static_router.go @@ -0,0 +1,105 @@ +package zoraxy_plugin + +import ( + "fmt" + "net/http" + "sort" + "strings" +) + +type PathRouter struct { + enableDebugPrint bool + pathHandlers map[string]http.Handler + defaultHandler http.Handler +} + +// NewPathRouter creates a new PathRouter +func NewPathRouter() *PathRouter { + return &PathRouter{ + enableDebugPrint: false, + pathHandlers: make(map[string]http.Handler), + } +} + +// RegisterPathHandler registers a handler for a path +func (p *PathRouter) RegisterPathHandler(path string, handler http.Handler) { + path = strings.TrimSuffix(path, "/") + p.pathHandlers[path] = handler +} + +// RemovePathHandler removes a handler for a path +func (p *PathRouter) RemovePathHandler(path string) { + delete(p.pathHandlers, path) +} + +// SetDefaultHandler sets the default handler for the router +// This handler will be called if no path handler is found +func (p *PathRouter) SetDefaultHandler(handler http.Handler) { + p.defaultHandler = handler +} + +// SetDebugPrintMode sets the debug print mode +func (p *PathRouter) SetDebugPrintMode(enable bool) { + p.enableDebugPrint = enable +} + +// StartStaticCapture starts the static capture ingress +func (p *PathRouter) RegisterStaticCaptureHandle(capture_ingress string, mux *http.ServeMux) { + if !strings.HasSuffix(capture_ingress, "/") { + capture_ingress = capture_ingress + "/" + } + mux.Handle(capture_ingress, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + p.staticCaptureServeHTTP(w, r) + })) +} + +// staticCaptureServeHTTP serves the static capture path using user defined handler +func (p *PathRouter) staticCaptureServeHTTP(w http.ResponseWriter, r *http.Request) { + capturePath := r.Header.Get("X-Zoraxy-Capture") + if capturePath != "" { + if p.enableDebugPrint { + fmt.Printf("Using capture path: %s\n", capturePath) + } + originalURI := r.Header.Get("X-Zoraxy-Uri") + r.URL.Path = originalURI + if handler, ok := p.pathHandlers[capturePath]; ok { + handler.ServeHTTP(w, r) + return + } + } + p.defaultHandler.ServeHTTP(w, r) +} + +func (p *PathRouter) PrintRequestDebugMessage(r *http.Request) { + if p.enableDebugPrint { + fmt.Printf("Capture Request with path: %s \n\n**Request Headers** \n\n", r.URL.Path) + keys := make([]string, 0, len(r.Header)) + for key := range r.Header { + keys = append(keys, key) + } + sort.Strings(keys) + for _, key := range keys { + for _, value := range r.Header[key] { + fmt.Printf("%s: %s\n", key, value) + } + } + + fmt.Printf("\n\n**Request Details**\n\n") + fmt.Printf("Method: %s\n", r.Method) + fmt.Printf("URL: %s\n", r.URL.String()) + fmt.Printf("Proto: %s\n", r.Proto) + fmt.Printf("Host: %s\n", r.Host) + fmt.Printf("RemoteAddr: %s\n", r.RemoteAddr) + fmt.Printf("RequestURI: %s\n", r.RequestURI) + fmt.Printf("ContentLength: %d\n", r.ContentLength) + fmt.Printf("TransferEncoding: %v\n", r.TransferEncoding) + fmt.Printf("Close: %v\n", r.Close) + fmt.Printf("Form: %v\n", r.Form) + fmt.Printf("PostForm: %v\n", r.PostForm) + fmt.Printf("MultipartForm: %v\n", r.MultipartForm) + fmt.Printf("Trailer: %v\n", r.Trailer) + fmt.Printf("RemoteAddr: %s\n", r.RemoteAddr) + fmt.Printf("RequestURI: %s\n", r.RequestURI) + + } +} diff --git a/example/plugins/api-call-example/mod/zoraxy_plugin/zoraxy_plugin.go b/example/plugins/api-call-example/mod/zoraxy_plugin/zoraxy_plugin.go new file mode 100644 index 0000000..5398087 --- /dev/null +++ b/example/plugins/api-call-example/mod/zoraxy_plugin/zoraxy_plugin.go @@ -0,0 +1,187 @@ +package zoraxy_plugin + +import ( + "encoding/json" + "fmt" + "os" + "strings" +) + +/* + Plugins Includes.go + + This file is copied from Zoraxy source code + You can always find the latest version under mod/plugins/includes.go + Usually this file are backward compatible +*/ + +type PluginType int + +const ( + PluginType_Router PluginType = 0 //Router Plugin, used for handling / routing / forwarding traffic + PluginType_Utilities PluginType = 1 //Utilities Plugin, used for utilities like Zerotier or Static Web Server that do not require interception with the dpcore +) + +type StaticCaptureRule struct { + CapturePath string `json:"capture_path"` + //To be expanded +} + +type ControlStatusCode int + +const ( + ControlStatusCode_CAPTURED ControlStatusCode = 280 //Traffic captured by plugin, ask Zoraxy not to process the traffic + ControlStatusCode_UNHANDLED ControlStatusCode = 284 //Traffic not handled by plugin, ask Zoraxy to process the traffic + ControlStatusCode_ERROR ControlStatusCode = 580 //Error occurred while processing the traffic, ask Zoraxy to process the traffic and log the error +) + +type SubscriptionEvent struct { + EventName string `json:"event_name"` + EventSource string `json:"event_source"` + Payload string `json:"payload"` //Payload of the event, can be empty +} + +type RuntimeConstantValue struct { + ZoraxyVersion string `json:"zoraxy_version"` + ZoraxyUUID string `json:"zoraxy_uuid"` + DevelopmentBuild bool `json:"development_build"` //Whether the Zoraxy is a development build or not +} + +type PermittedAPIEndpoint struct { + Method string `json:"method"` //HTTP method for the API endpoint (e.g., GET, POST) + Endpoint string `json:"endpoint"` //The API endpoint that the plugin can access + Reason string `json:"reason"` //The reason why the plugin needs to access this endpoint +} + +/* +IntroSpect Payload + +When the plugin is initialized with -introspect flag, +the plugin shell return this payload as JSON and exit +*/ +type IntroSpect struct { + /* Plugin metadata */ + ID string `json:"id"` //Unique ID of your plugin, recommended using your own domain in reverse like com.yourdomain.pluginname + Name string `json:"name"` //Name of your plugin + Author string `json:"author"` //Author name of your plugin + AuthorContact string `json:"author_contact"` //Author contact of your plugin, like email + Description string `json:"description"` //Description of your plugin + URL string `json:"url"` //URL of your plugin + Type PluginType `json:"type"` //Type of your plugin, Router(0) or Utilities(1) + VersionMajor int `json:"version_major"` //Major version of your plugin + VersionMinor int `json:"version_minor"` //Minor version of your plugin + VersionPatch int `json:"version_patch"` //Patch version of your plugin + + /* + + Endpoint Settings + + */ + + /* + Static Capture Settings + + Once plugin is enabled these rules always applies to the enabled HTTP Proxy rule + This is faster than dynamic capture, but less flexible + */ + StaticCapturePaths []StaticCaptureRule `json:"static_capture_paths"` //Static capture paths of your plugin, see Zoraxy documentation for more details + StaticCaptureIngress string `json:"static_capture_ingress"` //Static capture ingress path of your plugin (e.g. /s_handler) + + /* + Dynamic Capture Settings + + Once plugin is enabled, these rules will be captured and forward to plugin sniff + if the plugin sniff returns 280, the traffic will be captured + otherwise, the traffic will be forwarded to the next plugin + This is slower than static capture, but more flexible + */ + DynamicCaptureSniff string `json:"dynamic_capture_sniff"` //Dynamic capture sniff path of your plugin (e.g. /d_sniff) + DynamicCaptureIngress string `json:"dynamic_capture_ingress"` //Dynamic capture ingress path of your plugin (e.g. /d_handler) + + /* UI Path for your plugin */ + UIPath string `json:"ui_path"` //UI path of your plugin (e.g. /ui), will proxy the whole subpath tree to Zoraxy Web UI as plugin UI + + /* Subscriptions Settings */ + SubscriptionPath string `json:"subscription_path"` //Subscription event path of your plugin (e.g. /notifyme), a POST request with SubscriptionEvent as body will be sent to this path when the event is triggered + SubscriptionsEvents map[string]string `json:"subscriptions_events"` //Subscriptions events of your plugin, paired with comments describing how the event is used, see Zoraxy documentation for more details + + /* API Access Control */ + PermittedAPIEndpoints []PermittedAPIEndpoint `json:"permitted_api_endpoints"` //List of API endpoints this plugin can access, and a description of why the plugin needs to access this endpoint +} + +/* +ServeIntroSpect Function + +This function will check if the plugin is initialized with -introspect flag, +if so, it will print the intro spect and exit + +Place this function at the beginning of your plugin main function +*/ +func ServeIntroSpect(pluginSpect *IntroSpect) { + if len(os.Args) > 1 && os.Args[1] == "-introspect" { + //Print the intro spect and exit + jsonData, _ := json.MarshalIndent(pluginSpect, "", " ") + fmt.Println(string(jsonData)) + os.Exit(0) + } +} + +/* +ConfigureSpec Payload + +Zoraxy will start your plugin with -configure flag, +the plugin shell read this payload as JSON and configure itself +by the supplied values like starting a web server at given port +that listens to 127.0.0.1:port +*/ +type ConfigureSpec struct { + Port int `json:"port"` //Port to listen + RuntimeConst RuntimeConstantValue `json:"runtime_const"` //Runtime constant values + APIKey string `json:"api_key,omitempty"` //API key for accessing Zoraxy APIs, if the plugin has permitted endpoints + ZoraxyPort int `json:"zoraxy_port,omitempty"` //The port that Zoraxy is running on, used for making API calls to Zoraxy + //To be expanded +} + +/* +RecvExecuteConfigureSpec Function + +This function will read the configure spec from Zoraxy +and return the ConfigureSpec object + +Place this function after ServeIntroSpect function in your plugin main function +*/ +func RecvConfigureSpec() (*ConfigureSpec, error) { + for i, arg := range os.Args { + if strings.HasPrefix(arg, "-configure=") { + var configSpec ConfigureSpec + if err := json.Unmarshal([]byte(arg[11:]), &configSpec); err != nil { + return nil, err + } + return &configSpec, nil + } else if arg == "-configure" { + var configSpec ConfigureSpec + var nextArg string + if len(os.Args) > i+1 { + nextArg = os.Args[i+1] + if err := json.Unmarshal([]byte(nextArg), &configSpec); err != nil { + return nil, err + } + } else { + return nil, fmt.Errorf("No port specified after -configure flag") + } + return &configSpec, nil + } + } + return nil, fmt.Errorf("No -configure flag found") +} + +/* +ServeAndRecvSpec Function + +This function will serve the intro spect and return the configure spec +See the ServeIntroSpect and RecvConfigureSpec for more details +*/ +func ServeAndRecvSpec(pluginSpect *IntroSpect) (*ConfigureSpec, error) { + ServeIntroSpect(pluginSpect) + return RecvConfigureSpec() +} diff --git a/example/plugins/api-call-example/ui.go b/example/plugins/api-call-example/ui.go new file mode 100644 index 0000000..68d49a3 --- /dev/null +++ b/example/plugins/api-call-example/ui.go @@ -0,0 +1,272 @@ +package main + +import ( + "fmt" + "html" + "net/http" + "net/http/httputil" + "strconv" + + plugin "aroz.org/zoraxy/api-call-example/mod/zoraxy_plugin" +) + +func allowedEndpoint(cfg *plugin.ConfigureSpec) (string, error) { + // Make an API call to the permitted endpoint + client := &http.Client{} + apiURL := fmt.Sprintf("http://localhost:%d/plugin/api/access/list", cfg.ZoraxyPort) + req, err := http.NewRequest(http.MethodGet, apiURL, nil) + if err != nil { + return "", fmt.Errorf("error creating request: %v", err) + } + // Make sure to set the Authorization header + req.Header.Set("Authorization", "Bearer "+cfg.APIKey) // Use the API key from the runtime config + req.Header.Set("Content-Type", "application/json") + + resp, err := client.Do(req) + if err != nil { + return "", fmt.Errorf("error making API call: %v", err) + } + defer resp.Body.Close() + + respDump, err := httputil.DumpResponse(resp, true) + if err != nil { + + return "", fmt.Errorf("error dumping response: %v", err) + } + + // Check if the response status is OK + if resp.StatusCode != http.StatusOK { + return string(respDump), fmt.Errorf("received non-OK response status %d", resp.StatusCode) + } + + return string(respDump), nil +} + +func allowedEndpointInvalidKey(cfg *plugin.ConfigureSpec) (string, error) { + // Make an API call to the permitted endpoint with an invalid key + client := &http.Client{} + apiURL := fmt.Sprintf("http://localhost:%d/plugin/api/access/list", cfg.ZoraxyPort) + req, err := http.NewRequest(http.MethodGet, apiURL, nil) + if err != nil { + return "", fmt.Errorf("error creating request: %v", err) + } + // Use an invalid API key + req.Header.Set("Authorization", "Bearer invalid-key") + req.Header.Set("Content-Type", "application/json") + + resp, err := client.Do(req) + if err != nil { + return "", fmt.Errorf("error making API call: %v", err) + } + defer resp.Body.Close() + + respDump, err := httputil.DumpResponse(resp, true) + if err != nil { + + return "", fmt.Errorf("error dumping response: %v", err) + } + + return string(respDump), nil +} + +func unaccessibleEndpoint(cfg *plugin.ConfigureSpec) (string, error) { + // Make an API call to an endpoint that is not permitted + client := &http.Client{} + apiURL := fmt.Sprintf("http://localhost:%d/api/acme/listExpiredDomains", cfg.ZoraxyPort) + req, err := http.NewRequest(http.MethodGet, apiURL, nil) + if err != nil { + return "", fmt.Errorf("error creating request: %v", err) + } + // Use the API key from the runtime config + req.Header.Set("Authorization", "Bearer "+cfg.APIKey) + req.Header.Set("Content-Type", "application/json") + + resp, err := client.Do(req) + if err != nil { + return "", fmt.Errorf("error making API call: %v", err) + } + defer resp.Body.Close() + + respDump, err := httputil.DumpResponse(resp, true) + if err != nil { + return "", fmt.Errorf("error dumping response: %v", err) + } + + return string(respDump), nil +} + +func unpermittedEndpoint(cfg *plugin.ConfigureSpec) (string, error) { + // Make an API call to an endpoint that is plugin-accessible but is not permitted + client := &http.Client{} + apiURL := fmt.Sprintf("http://localhost:%d/plugin/api/proxy/list", cfg.ZoraxyPort) + req, err := http.NewRequest(http.MethodGet, apiURL, nil) + if err != nil { + return "", fmt.Errorf("error creating request: %v", err) + } + // Use the API key from the runtime config + req.Header.Set("Authorization", "Bearer "+cfg.APIKey) + req.Header.Set("Content-Type", "application/json") + + resp, err := client.Do(req) + if err != nil { + return "", fmt.Errorf("error making API call: %v", err) + } + defer resp.Body.Close() + + respDump, err := httputil.DumpResponse(resp, true) + if err != nil { + return "", fmt.Errorf("error dumping response: %v", err) + } + + return string(respDump), nil +} + +func RenderUI(config *plugin.ConfigureSpec, w http.ResponseWriter, r *http.Request) { + // make several types of API calls to demonstrate the plugin functionality + accessList, err := allowedEndpoint(config) + var RenderedAccessListHTML string + if err != nil { + if accessList != "" { + RenderedAccessListHTML = fmt.Sprintf("

Error fetching access list: %v

%s
", err, html.EscapeString(accessList)) + } else { + RenderedAccessListHTML = fmt.Sprintf("

Error fetching access list: %v

", err) + } + } else { + // Render the access list as HTML + RenderedAccessListHTML = fmt.Sprintf("
%s
", html.EscapeString(accessList)) + } + + // Make an API call with an invalid key + invalidKeyResponse, err := allowedEndpointInvalidKey(config) + var RenderedInvalidKeyResponseHTML string + if err != nil { + RenderedInvalidKeyResponseHTML = fmt.Sprintf("

Error with invalid key: %v

", err) + } else { + // Render the invalid key response as HTML + RenderedInvalidKeyResponseHTML = fmt.Sprintf("
%s
", html.EscapeString(invalidKeyResponse)) + } + + // Make an API call to an endpoint that is not plugin-accessible + unaccessibleResponse, err := unaccessibleEndpoint(config) + var RenderedUnaccessibleResponseHTML string + if err != nil { + RenderedUnaccessibleResponseHTML = fmt.Sprintf("

Error with unaccessible endpoint: %v

", err) + } else { + // Render the unaccessible response as HTML + RenderedUnaccessibleResponseHTML = fmt.Sprintf("
%s
", html.EscapeString(unaccessibleResponse)) + } + + // Make an API call to an endpoint that is plugin-accessible but is not permitted + unpermittedResponse, err := unpermittedEndpoint(config) + var RenderedUnpermittedResponseHTML string + if err != nil { + RenderedUnpermittedResponseHTML = fmt.Sprintf("

Error with unpermitted endpoint: %v

", err) + } else { + // Render the unpermitted response as HTML + RenderedUnpermittedResponseHTML = fmt.Sprintf("
%s
", html.EscapeString(unpermittedResponse)) + } + + // Render the UI for the plugin + w.Header().Set("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + html := ` + + + + API Call Example Plugin UI + + + + + + + + + + +

Welcome to the API Call Example Plugin UI

+

Plugin is running on port: ` + strconv.Itoa(config.Port) + `

+ +

API Call Examples

+ +
+

✅ Allowed Endpoint (Valid API Key)

+

Making a GET request to /plugin/api/access/list with a valid API key:

+
+ ` + RenderedAccessListHTML + ` +
+
+ +
+

⚠️ Invalid API Key

+

Making a GET request to /plugin/api/access/list with an invalid API key:

+
+ ` + RenderedInvalidKeyResponseHTML + ` +
+
+ +
+

⚠️ Unpermitted Endpoint

+

Making a GET request to /plugin/api/proxy/list (not a permitted endpoint):

+
+ ` + RenderedUnpermittedResponseHTML + ` +
+
+ +
+

❌ Disallowed Endpoint

+

Making a GET request to /api/acme/listExpiredDomains (not a plugin-accessible endpoint):

+
+ ` + RenderedUnaccessibleResponseHTML + ` +
+
+ + + ` + w.Write([]byte(html)) +} diff --git a/src/def.go b/src/def.go index e36f08b..1fac66a 100644 --- a/src/def.go +++ b/src/def.go @@ -149,6 +149,9 @@ var ( loadBalancer *loadbalance.RouteManager //Global scope loadbalancer, store the state of the lb routing pluginManager *plugins.Manager //Plugin manager for managing plugins + //Plugin auth related + pluginApiKeyManager *auth.APIKeyManager //API key manager for plugin authentication + //Authentication Provider forwardAuthRouter *forward.AuthRouter // Forward Auth router for Authelia/Authentik/etc authentication oauth2Router *oauth2.OAuth2Router //OAuth2Router router for OAuth2Router authentication diff --git a/src/main.go b/src/main.go index c848f59..7a02d06 100644 --- a/src/main.go +++ b/src/main.go @@ -115,6 +115,7 @@ func main() { //Initiate management interface APIs requireAuth = !(*noauth) initAPIs(webminPanelMux) + initRestAPI(webminPanelMux) //Start the reverse proxy server in go routine go func() { diff --git a/src/mod/auth/plugin_apikey_manager.go b/src/mod/auth/plugin_apikey_manager.go new file mode 100644 index 0000000..2803239 --- /dev/null +++ b/src/mod/auth/plugin_apikey_manager.go @@ -0,0 +1,112 @@ +package auth + +import ( + "crypto/rand" + "crypto/sha256" + "encoding/hex" + "fmt" + "sync" + "time" + + "imuslab.com/zoraxy/mod/plugins/zoraxy_plugin" +) + +// PluginAPIKey represents an API key for a plugin +type PluginAPIKey struct { + PluginID string + APIKey string + PermittedEndpoints []zoraxy_plugin.PermittedAPIEndpoint // List of permitted API endpoints + CreatedAt time.Time +} + +// APIKeyManager manages API keys for plugins +type APIKeyManager struct { + keys map[string]*PluginAPIKey // key: API key, value: plugin info + mutex sync.RWMutex +} + +// NewAPIKeyManager creates a new API key manager +func NewAPIKeyManager() *APIKeyManager { + return &APIKeyManager{ + keys: make(map[string]*PluginAPIKey), + mutex: sync.RWMutex{}, + } +} + +// GenerateAPIKey generates a new API key for a plugin +func (m *APIKeyManager) GenerateAPIKey(pluginID string, permittedEndpoints []zoraxy_plugin.PermittedAPIEndpoint) (*PluginAPIKey, error) { + m.mutex.Lock() + defer m.mutex.Unlock() + + // Generate a cryptographically secure random key + bytes := make([]byte, 32) + if _, err := rand.Read(bytes); err != nil { + return nil, fmt.Errorf("failed to generate random bytes: %w", err) + } + + // Hash the random bytes to create the API key + hash := sha256.Sum256(bytes) + apiKey := hex.EncodeToString(hash[:]) + + // Create the plugin API key + pluginAPIKey := &PluginAPIKey{ + PluginID: pluginID, + APIKey: apiKey, + PermittedEndpoints: permittedEndpoints, + CreatedAt: time.Now(), + } + + // Store the API key + m.keys[apiKey] = pluginAPIKey + + return pluginAPIKey, nil +} + +// ValidateAPIKey validates an API key and returns the associated plugin information +func (m *APIKeyManager) ValidateAPIKey(apiKey string) (*PluginAPIKey, error) { + m.mutex.RLock() + defer m.mutex.RUnlock() + + pluginAPIKey, exists := m.keys[apiKey] + if !exists { + return nil, fmt.Errorf("invalid API key") + } + + return pluginAPIKey, nil +} + +// ValidateAPIKeyForEndpoint validates an API key for a specific endpoint +func (m *APIKeyManager) ValidateAPIKeyForEndpoint(endpoint string, method string, apiKey string) (*PluginAPIKey, error) { + pluginAPIKey, err := m.ValidateAPIKey(apiKey) + if err != nil { + return nil, err + } + + // Check if the endpoint is permitted + for _, permittedEndpoint := range pluginAPIKey.PermittedEndpoints { + if permittedEndpoint.Endpoint == endpoint && permittedEndpoint.Method == method { + return pluginAPIKey, nil + } + } + + return nil, fmt.Errorf("endpoint not permitted for this API key") +} + +// RevokeAPIKeysForPlugin revokes all API keys for a specific plugin +func (m *APIKeyManager) RevokeAPIKeysForPlugin(pluginID string) error { + m.mutex.Lock() + defer m.mutex.Unlock() + + keysToRemove := []string{} + for apiKey, pluginAPIKey := range m.keys { + if pluginAPIKey.PluginID == pluginID { + keysToRemove = append(keysToRemove, apiKey) + } + } + + for _, apiKey := range keysToRemove { + delete(m.keys, apiKey) + } + + return nil +} diff --git a/src/mod/auth/plugin_middleware.go b/src/mod/auth/plugin_middleware.go new file mode 100644 index 0000000..568c801 --- /dev/null +++ b/src/mod/auth/plugin_middleware.go @@ -0,0 +1,94 @@ +// Handles the API-Key based authentication for plugins + +package auth + +import ( + "errors" + "fmt" + "net/http" + "strings" +) + +const ( + PLUGIN_API_PREFIX = "/plugin" +) + +type PluginMiddlewareOptions struct { + DeniedHandler http.HandlerFunc //Thing(s) to do when request is rejected + ApiKeyManager *APIKeyManager + TargetMux *http.ServeMux +} + +// PluginAuthMiddleware provides authentication middleware for plugin API requests +type PluginAuthMiddleware struct { + option PluginMiddlewareOptions + endpoints map[string]http.HandlerFunc +} + +// NewPluginAuthMiddleware creates a new plugin authentication middleware +func NewPluginAuthMiddleware(option PluginMiddlewareOptions) *PluginAuthMiddleware { + return &PluginAuthMiddleware{ + option: option, + endpoints: make(map[string]http.HandlerFunc), + } +} + +func (m *PluginAuthMiddleware) HandleAuthCheck(w http.ResponseWriter, r *http.Request, handler http.HandlerFunc) { + // Check for API key in the Authorization header + authHeader := r.Header.Get("Authorization") + if authHeader == "" { + // No authorization header + m.option.DeniedHandler(w, r) + return + } + + // Check if it's a plugin API key (Bearer token) + if !strings.HasPrefix(authHeader, "Bearer ") { + // Not a Bearer token + m.option.DeniedHandler(w, r) + return + } + + // Extract the API key + apiKey := strings.TrimPrefix(authHeader, "Bearer ") + + // Validate the API key for this endpoint + _, err := m.option.ApiKeyManager.ValidateAPIKeyForEndpoint(r.URL.Path, r.Method, apiKey) + if err != nil { + // Invalid API key or endpoint not permitted + m.option.DeniedHandler(w, r) + return + } + + // Call the original handler + handler(w, r) +} + +// wraps an HTTP handler with plugin authentication middleware +func (m *PluginAuthMiddleware) HandleFunc(endpoint string, handler http.HandlerFunc) error { + // ensure the endpoint is prefixed with PLUGIN_API_PREFIX + if !strings.HasPrefix(endpoint, PLUGIN_API_PREFIX) { + endpoint = PLUGIN_API_PREFIX + endpoint + } + + // Check if the endpoint already registered + if _, exist := m.endpoints[endpoint]; exist { + fmt.Println("WARNING! Duplicated registering of plugin api endpoint: " + endpoint) + return errors.New("endpoint register duplicated") + } + + m.endpoints[endpoint] = handler + + wrappedHandler := func(w http.ResponseWriter, r *http.Request) { + m.HandleAuthCheck(w, r, handler) + } + + // Ok. Register handler + if m.option.TargetMux == nil { + http.HandleFunc(endpoint, wrappedHandler) + } else { + m.option.TargetMux.HandleFunc(endpoint, wrappedHandler) + } + + return nil +} diff --git a/src/mod/plugins/lifecycle.go b/src/mod/plugins/lifecycle.go index 914acf7..cceff11 100644 --- a/src/mod/plugins/lifecycle.go +++ b/src/mod/plugins/lifecycle.go @@ -41,6 +41,18 @@ func (m *Manager) StartPlugin(pluginID string) error { Port: getRandomPortNumber(), RuntimeConst: *m.Options.SystemConst, } + + // Generate API key if the plugin has permitted endpoints + if len(thisPlugin.Spec.PermittedAPIEndpoints) > 0 { + apiKey, err := m.Options.APIKeyManager.GenerateAPIKey(thisPlugin.Spec.ID, thisPlugin.Spec.PermittedAPIEndpoints) + if err != nil { + return err + } + pluginConfiguration.APIKey = apiKey.APIKey + pluginConfiguration.ZoraxyPort = m.Options.ZoraxyPort + m.Log("Generated API key for plugin "+thisPlugin.Spec.Name, nil) + } + js, _ := json.Marshal(pluginConfiguration) //Start the plugin with given configuration @@ -270,6 +282,13 @@ func (m *Manager) StopPlugin(pluginID string) error { thisPlugin.Enabled = false thisPlugin.StopAllStaticPathRouters() thisPlugin.StopDynamicForwardRouter() + + //Clean up API key + err = m.Options.APIKeyManager.RevokeAPIKeysForPlugin(thisPlugin.Spec.ID) + if err != nil { + m.Log("Failed to revoke API keys for plugin "+thisPlugin.Spec.Name, err) + } + return nil } diff --git a/src/mod/plugins/typdef.go b/src/mod/plugins/typdef.go index 6b64068..befdf97 100644 --- a/src/mod/plugins/typdef.go +++ b/src/mod/plugins/typdef.go @@ -7,6 +7,7 @@ import ( "sync" "time" + "imuslab.com/zoraxy/mod/auth" "imuslab.com/zoraxy/mod/database" "imuslab.com/zoraxy/mod/dynamicproxy/dpcore" "imuslab.com/zoraxy/mod/info/logger" @@ -42,10 +43,14 @@ type ManagerOptions struct { /* Runtime */ SystemConst *zoraxyPlugin.RuntimeConstantValue //The system constant value + ZoraxyPort int //The port of the Zoraxy instance, used for API calls CSRFTokenGen func(*http.Request) string `json:"-"` //The CSRF token generator function Database *database.Database `json:"-"` Logger *logger.Logger `json:"-"` + /* API Key Management */ + APIKeyManager *auth.APIKeyManager `json:"-"` //The API key manager for the plugins + /* Development */ EnableHotReload bool //Check if the plugin file is changed and reload the plugin automatically HotReloadInterval int //The interval for checking the plugin file change, in seconds diff --git a/src/mod/plugins/zoraxy_plugin/zoraxy_plugin.go b/src/mod/plugins/zoraxy_plugin/zoraxy_plugin.go index 737e928..5398087 100644 --- a/src/mod/plugins/zoraxy_plugin/zoraxy_plugin.go +++ b/src/mod/plugins/zoraxy_plugin/zoraxy_plugin.go @@ -47,6 +47,12 @@ type RuntimeConstantValue struct { DevelopmentBuild bool `json:"development_build"` //Whether the Zoraxy is a development build or not } +type PermittedAPIEndpoint struct { + Method string `json:"method"` //HTTP method for the API endpoint (e.g., GET, POST) + Endpoint string `json:"endpoint"` //The API endpoint that the plugin can access + Reason string `json:"reason"` //The reason why the plugin needs to access this endpoint +} + /* IntroSpect Payload @@ -97,7 +103,10 @@ type IntroSpect struct { /* Subscriptions Settings */ SubscriptionPath string `json:"subscription_path"` //Subscription event path of your plugin (e.g. /notifyme), a POST request with SubscriptionEvent as body will be sent to this path when the event is triggered - SubscriptionsEvents map[string]string `json:"subscriptions_events"` //Subscriptions events of your plugin, see Zoraxy documentation for more details + SubscriptionsEvents map[string]string `json:"subscriptions_events"` //Subscriptions events of your plugin, paired with comments describing how the event is used, see Zoraxy documentation for more details + + /* API Access Control */ + PermittedAPIEndpoints []PermittedAPIEndpoint `json:"permitted_api_endpoints"` //List of API endpoints this plugin can access, and a description of why the plugin needs to access this endpoint } /* @@ -126,8 +135,10 @@ by the supplied values like starting a web server at given port that listens to 127.0.0.1:port */ type ConfigureSpec struct { - Port int `json:"port"` //Port to listen - RuntimeConst RuntimeConstantValue `json:"runtime_const"` //Runtime constant values + Port int `json:"port"` //Port to listen + RuntimeConst RuntimeConstantValue `json:"runtime_const"` //Runtime constant values + APIKey string `json:"api_key,omitempty"` //API key for accessing Zoraxy APIs, if the plugin has permitted endpoints + ZoraxyPort int `json:"zoraxy_port,omitempty"` //The port that Zoraxy is running on, used for making API calls to Zoraxy //To be expanded } diff --git a/src/plugin_api.go b/src/plugin_api.go new file mode 100644 index 0000000..21550b5 --- /dev/null +++ b/src/plugin_api.go @@ -0,0 +1,135 @@ +package main + +import ( + "net/http" + + "imuslab.com/zoraxy/mod/auth" + "imuslab.com/zoraxy/mod/netstat" +) + +// Register the APIs for HTTP proxy management functions +func RegisterHTTPProxyRestAPI(authMiddleware *auth.PluginAuthMiddleware) { + /* Reverse Proxy Settings & Status */ + authMiddleware.HandleFunc("/api/proxy/status", ReverseProxyStatus) + authMiddleware.HandleFunc("/api/proxy/list", ReverseProxyList) + authMiddleware.HandleFunc("/api/proxy/listTags", ReverseProxyListTags) + authMiddleware.HandleFunc("/api/proxy/detail", ReverseProxyListDetail) + /* Reverse proxy upstream (load balance) */ + authMiddleware.HandleFunc("/api/proxy/upstream/list", ReverseProxyUpstreamList) + /* Reverse proxy virtual directory */ + authMiddleware.HandleFunc("/api/proxy/vdir/list", ReverseProxyListVdir) + /* Reverse proxy user-defined header */ + authMiddleware.HandleFunc("/api/proxy/header/list", HandleCustomHeaderList) + /* Reverse proxy auth related */ + authMiddleware.HandleFunc("/api/proxy/auth/exceptions/list", ListProxyBasicAuthExceptionPaths) +} + +// Register the APIs for redirection rules management functions +func RegisterRedirectionRestAPI(authRouter *auth.PluginAuthMiddleware) { + authRouter.HandleFunc("/api/redirect/list", handleListRedirectionRules) +} + +// Register the APIs for access rules management functions +func RegisterAccessRuleRestAPI(authRouter *auth.PluginAuthMiddleware) { + /* Access Rules Settings & Status */ + authRouter.HandleFunc("/api/access/list", handleListAccessRules) + // authRouter.HandleFunc("/api/access/attach", handleAttachRuleToHost) + // authRouter.HandleFunc("/api/access/create", handleCreateAccessRule) + // authRouter.HandleFunc("/api/access/remove", handleRemoveAccessRule) + // authRouter.HandleFunc("/api/access/update", handleUpadateAccessRule) + /* Blacklist */ + authRouter.HandleFunc("/api/blacklist/list", handleListBlacklisted) + authRouter.HandleFunc("/api/blacklist/country/add", handleCountryBlacklistAdd) + authRouter.HandleFunc("/api/blacklist/country/remove", handleCountryBlacklistRemove) + authRouter.HandleFunc("/api/blacklist/ip/add", handleIpBlacklistAdd) + authRouter.HandleFunc("/api/blacklist/ip/remove", handleIpBlacklistRemove) + authRouter.HandleFunc("/api/blacklist/enable", handleBlacklistEnable) + /* Whitelist */ + authRouter.HandleFunc("/api/whitelist/list", handleListWhitelisted) + authRouter.HandleFunc("/api/whitelist/country/add", handleCountryWhitelistAdd) + authRouter.HandleFunc("/api/whitelist/country/remove", handleCountryWhitelistRemove) + authRouter.HandleFunc("/api/whitelist/ip/add", handleIpWhitelistAdd) + authRouter.HandleFunc("/api/whitelist/ip/remove", handleIpWhitelistRemove) + authRouter.HandleFunc("/api/whitelist/enable", handleWhitelistEnable) + authRouter.HandleFunc("/api/whitelist/allowLocal", handleWhitelistAllowLoopback) + /* Quick Ban List */ + authRouter.HandleFunc("/api/quickban/list", handleListQuickBan) +} + +// Register the APIs for path blocking rules management functions, WIP +func RegisterPathRuleRestAPI(authRouter *auth.PluginAuthMiddleware) { + authRouter.HandleFunc("/api/pathrule/list", pathRuleHandler.HandleListBlockingPath) +} + +// Register the APIs statistic anlysis and uptime monitoring functions +func RegisterStatisticalRestAPI(authRouter *auth.PluginAuthMiddleware) { + /* Traffic Summary */ + authRouter.HandleFunc("/api/stats/summary", statisticCollector.HandleTodayStatLoad) + authRouter.HandleFunc("/api/stats/countries", HandleCountryDistrSummary) + authRouter.HandleFunc("/api/stats/netstat", netstatBuffers.HandleGetNetworkInterfaceStats) + authRouter.HandleFunc("/api/stats/netstatgraph", netstatBuffers.HandleGetBufferedNetworkInterfaceStats) + authRouter.HandleFunc("/api/stats/listnic", netstat.HandleListNetworkInterfaces) + /* Zoraxy Analytic */ + authRouter.HandleFunc("/api/analytic/list", AnalyticLoader.HandleSummaryList) + authRouter.HandleFunc("/api/analytic/load", AnalyticLoader.HandleLoadTargetDaySummary) + authRouter.HandleFunc("/api/analytic/loadRange", AnalyticLoader.HandleLoadTargetRangeSummary) + authRouter.HandleFunc("/api/analytic/exportRange", AnalyticLoader.HandleRangeExport) + authRouter.HandleFunc("/api/analytic/resetRange", AnalyticLoader.HandleRangeReset) + /* UpTime Monitor */ + authRouter.HandleFunc("/api/utm/list", HandleUptimeMonitorListing) +} + +// Register the APIs for Stream (TCP / UDP) Proxy management functions +func RegisterStreamProxyRestAPI(authRouter *auth.PluginAuthMiddleware) { + authRouter.HandleFunc("/api/streamprox/config/list", streamProxyManager.HandleListConfigs) + authRouter.HandleFunc("/api/streamprox/config/status", streamProxyManager.HandleGetProxyStatus) +} + +// Register the APIs for mDNS service management functions +func RegisterMDNSRestAPI(authRouter *auth.PluginAuthMiddleware) { + authRouter.HandleFunc("/api/mdns/list", HandleMdnsListing) +} + +// Register the APIs for Static Web Server management functions +func RegisterStaticWebServerRestAPI(authRouter *auth.PluginAuthMiddleware) { + /* Static Web Server Controls */ + authRouter.HandleFunc("/api/webserv/status", staticWebServer.HandleGetStatus) + + /* File Manager */ + if *allowWebFileManager { + authRouter.HandleFunc("/api/fs/list", staticWebServer.FileManager.HandleList) + } +} + +func RegisterPluginRestAPI(authRouter *auth.PluginAuthMiddleware) { + authRouter.HandleFunc("/api/plugins/list", pluginManager.HandleListPlugins) + authRouter.HandleFunc("/api/plugins/info", pluginManager.HandlePluginInfo) + + authRouter.HandleFunc("/api/plugins/groups/list", pluginManager.HandleListPluginGroups) + + authRouter.HandleFunc("/api/plugins/store/list", pluginManager.HandleListDownloadablePlugins) +} + +/* Register all the APIs */ +func initRestAPI(targetMux *http.ServeMux) { + authMiddleware := auth.NewPluginAuthMiddleware( + auth.PluginMiddlewareOptions{ + TargetMux: targetMux, + ApiKeyManager: pluginApiKeyManager, + DeniedHandler: func(w http.ResponseWriter, r *http.Request) { + http.Error(w, "401 - Unauthorized", http.StatusUnauthorized) + }, + }, + ) + + //Register the APIs + RegisterHTTPProxyRestAPI(authMiddleware) + RegisterRedirectionRestAPI(authMiddleware) + RegisterAccessRuleRestAPI(authMiddleware) + RegisterPathRuleRestAPI(authMiddleware) + RegisterStatisticalRestAPI(authMiddleware) + RegisterStreamProxyRestAPI(authMiddleware) + RegisterMDNSRestAPI(authMiddleware) + RegisterStaticWebServerRestAPI(authMiddleware) + RegisterPluginRestAPI(authMiddleware) +} diff --git a/src/start.go b/src/start.go index 359da3a..b280871 100644 --- a/src/start.go +++ b/src/start.go @@ -3,6 +3,7 @@ package main import ( "log" "net/http" + "net/netip" "os" "runtime" "strconv" @@ -99,6 +100,9 @@ func startupSequence() { http.Redirect(w, r, "/login.html", http.StatusTemporaryRedirect) }) + // Create an API key manager for plugin authentication + pluginApiKeyManager = auth.NewAPIKeyManager() + //Create a TLS certificate manager tlsCertManager, err = tlscert.NewManager(CONF_CERT_STORE, SystemWideLogger) if err != nil { @@ -313,11 +317,18 @@ func startupSequence() { */ pluginFolder := *path_plugin pluginFolder = strings.TrimSuffix(pluginFolder, "/") + ZoraxyAddrPort, err := netip.ParseAddrPort(*webUIPort) + ZoraxyPort := 8000 + if err == nil && ZoraxyAddrPort.IsValid() && ZoraxyAddrPort.Port() > 0 { + ZoraxyPort = int(ZoraxyAddrPort.Port()) + } pluginManager = plugins.NewPluginManager(&plugins.ManagerOptions{ PluginDir: pluginFolder, Database: sysdb, Logger: SystemWideLogger, PluginGroupsConfig: CONF_PLUGIN_GROUPS, + APIKeyManager: pluginApiKeyManager, + ZoraxyPort: ZoraxyPort, CSRFTokenGen: func(r *http.Request) string { return csrf.Token(r) }, diff --git a/src/web/snippet/pluginInfo.html b/src/web/snippet/pluginInfo.html index 692a06b..71e514d 100644 --- a/src/web/snippet/pluginInfo.html +++ b/src/web/snippet/pluginInfo.html @@ -139,6 +139,26 @@
+

Plugin IntroSpect Permitted API Endpoints

+

The following API endpoints are registered by this plugin and will be accessible by the plugin's API key:

+ + + + + + + + + + + +
EndpointMethodReason
+

+ Note that the API endpoints are only accessible by the plugin's API key. + If the plugin does not have an API key, it will not be able to access these endpoints. + API keys are generated automatically by Zoraxy when a plugin with permitted API endpoints is enabled. +

+
@@ -219,6 +239,22 @@ $("#dynamic_capture_sniffing_path").text(dynamicCaptureSniffingPath); $("#dynamic_capture_ingress").text(dynamicCaptureIngress); $("#registered_ui_proxy_path").text(registeredUIProxyPath); + + //Update permitted API endpoints + let apiEndpoints = data.Spec.permitted_api_endpoints; + if (apiEndpoints == null || apiEndpoints.length == 0) { + $("#plugin_permitted_api_endpoints").html('No API endpoints registered'); + } else { + let endpointRows = ''; + apiEndpoints.forEach(function(endpoint) { + endpointRows += ` + ${endpoint.endpoint} + ${endpoint.method} + ${endpoint.reason} + `; + }); + $("#plugin_permitted_api_endpoints").html(endpointRows); + } }); }