diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5d7f8ca --- /dev/null +++ b/.gitignore @@ -0,0 +1,56 @@ +# Go related +/bin/ +/pkg/ +*.exe +*.exe~ +*.dll +*.so +*.dylib +*.test +*.out + +# Go vendor directory +vendor/ + +# Mac related +.DS_Store + +# Windows related +Thumbs.db +Desktop.ini + +# GoLand IDE related files +.idea/ +*.iml +*.log +*.hprof +/out/ + +# IDE directories +.vscode/ +*.sublime-workspace + +# Ignore editor swap files +*~ +# Support for IntelliJ caching +/.idea/ +# Support for .env files +.env +/.env.local +/.env.development.local +/.env.test.local +/.env.qa.local + +# GoLand version-specific +/workspace.xml +/tasks.xml +/taskDescriptions.xml +/usage.statistics.xml +/gradle.xml +/jarRepositories.xml +# Rope project settings +.settings/ +/project/ +/.Rproj.user/ +/.vscode/* +.Rproj.user/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..895cf94 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2024 Yidi Sprei + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d310b74 --- /dev/null +++ b/README.md @@ -0,0 +1,176 @@ +# Host Route Library + +A high-performance Gin middleware library for routing based on the host. + +## Installation + +Add the module to your project by running: + +```sh +go get github.com/YidiDev/gin-host-route +``` + +## Usage + +Below is an example of how to utilize the library to define different routes based on the host. + +### Example + +```go +package main + +import ( + "github.com/gin-gonic/gin" + "github.com/YidiDev/gin-host-route" + "log" + "net/http" + "os" +) + +func defineHost1Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host1") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host1") + }) +} + +func defineHost2Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host2") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host2") + }) +} + +func init() { + log.SetOutput(os.Stdout) +} + +func main() { + r := gin.Default() + + // Define host-specific configurations + hostConfigs := []hostroute.HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + + // Generic hosts are hosts that will use the primary router without special sub-routes + genericHosts := []string{"host3.com", "host4.com"} + + // Setup host-based routes + hostroute.SetupHostBasedRoutes(r, hostConfigs, genericHosts, true) + + // Define handler for unmatched routes + r.NoRoute(func(c *gin.Context) { + c.String(http.StatusNotFound, "No known route") + }) + + // Start the server + r.Run(":8080") +} +``` + +## Configuration Options + +### `HostConfig` +The `HostConfig` struct is used to define the configuration for a specific host: +- `Host`: The hostname for which the configuration is defined. +- `Prefix`: A prefix to use for routes specific to this host when accessed on a generic host. +- `RouterFactory` A function that defined the routes for this host. + +### Generic Hosts +Generic hosts are hosts that will have access to all routes defined in all the host configs and any others defined on the default router. This is useful for: +- **Local Testing**: to be able to access all routes without changing the host. +- **Consolidated Access**: Handle routes from multiple applications on a single host. For example: + - You have two applications hosted on one Go server: one at `application1.example.com` and the other at `application2.example.com`. However, you also want people to be able to access both applications by going to `example.com/application1` or `example.com/application2`. + +### Secure Against Unknown Hosts +The `secureAgainstUnknownHosts` boolean flag controls how the middleware handles requests from unknown hosts: +- `true`: Requests from unknown hosts will receive a 404 Not Found Response. This is useful for securing your application against unexpected or unauthorized hosts. +- `false`: Requests from unknown hosts will be passed through the primary router. This is useful if you want to catch and handle such requests manually. + +### Route Configuration Example + +```go +package main + +import ( + "github.com/gin-gonic/gin" + "github.com/YidiDev/gin-host-route" + "log" + "net/http" + "os" +) + +func defineHost1Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host1") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host1") + }) +} + +func defineHost2Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host2") + }) + rg.GET("/hi", func(c *gin.Context) { + log.Println("Important stuff") + c.String(http.StatusOK, "Hi from host2") + }) +} + +func init() { + log.SetOutput(os.Stdout) +} + +func main() { + r := gin.Default() + + hostConfigs := []hostroute.HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + + genericHosts := []string{"host3.com", "host4.com"} + + hostroute.SetupHostBasedRoutes(r, hostConfigs, genericHosts, true) + + r.NoRoute(func(c *gin.Context) { + c.String(http.StatusNotFound, "No known route") + }) + + r.Run(":8080") +} +``` + +### Handling Different Hosts + +1. **Host-specific Routes**: + Routes are defined uniquely for each host using a specific `RouterFactory`. The `HostConfig` struct includes the hostname, path prefix, and a function to define routes for that host. + + ```go + hostConfigs := []hostroute.HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + ``` + +2. **Generic Hosts**: + Generic hosts allow for fallback to common routes defined in the primary router. + + ```go + genericHosts := []string{"host3.com", "host4.com"} + ``` + +3. **Secure Against Unknown Hosts**: + Secure your application by handling unknown hosts, preventing them from accessing unintended routes. + + ```go + hostroute.SetupHostBasedRoutes(r, hostConfigs, genericHosts, true) + ``` diff --git a/example/main.go b/example/main.go new file mode 100644 index 0000000..dd36852 --- /dev/null +++ b/example/main.go @@ -0,0 +1,51 @@ +package main + +import ( + "github.com/YidiDev/gin-host-route" + "github.com/gin-gonic/gin" + "log" + "net/http" + "os" +) + +func defineHost1Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host1") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host1") + }) +} + +func defineHost2Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host2") + }) + rg.GET("/hi", func(c *gin.Context) { + log.Println("Important stuff") + c.String(http.StatusOK, "Hi from host2") + }) +} + +func init() { + log.SetOutput(os.Stdout) +} + +func main() { + r := gin.Default() + + hostConfigs := []hostroute.HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + + genericHosts := []string{"host3.com", "host4.com"} + + hostroute.SetupHostBasedRoutes(r, hostConfigs, genericHosts, true) + + r.NoRoute(func(c *gin.Context) { + c.String(http.StatusNotFound, "No known route") + }) + + r.Run(":8080") +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..fa002ff --- /dev/null +++ b/go.mod @@ -0,0 +1,39 @@ +module github.com/YidiDev/gin-host-route + +go 1.23.0 + +require ( + github.com/gin-gonic/gin v1.10.0 + github.com/stretchr/testify v1.9.0 +) + +require ( + github.com/bytedance/sonic v1.11.6 // indirect + github.com/bytedance/sonic/loader v0.1.1 // indirect + github.com/cloudwego/base64x v0.1.4 // indirect + github.com/cloudwego/iasm v0.2.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.3 // indirect + github.com/gin-contrib/sse v0.1.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.20.0 // indirect + github.com/goccy/go-json v0.10.2 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/klauspost/cpuid/v2 v2.2.7 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.2 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.2.12 // indirect + golang.org/x/arch v0.8.0 // indirect + golang.org/x/crypto v0.23.0 // indirect + golang.org/x/net v0.25.0 // indirect + golang.org/x/sys v0.20.0 // indirect + golang.org/x/text v0.15.0 // indirect + google.golang.org/protobuf v1.34.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..7f08abb --- /dev/null +++ b/go.sum @@ -0,0 +1,89 @@ +github.com/bytedance/sonic v1.11.6 h1:oUp34TzMlL+OY1OUWxHqsdkgC/Zfc85zGqw9siXjrc0= +github.com/bytedance/sonic v1.11.6/go.mod h1:LysEHSvpvDySVdC2f87zGWf6CIKJcAvqab1ZaiQtds4= +github.com/bytedance/sonic/loader v0.1.1 h1:c+e5Pt1k/cy5wMveRDyk2X4B9hF4g7an8N3zCYjJFNM= +github.com/bytedance/sonic/loader v0.1.1/go.mod h1:ncP89zfokxS5LZrJxl5z0UJcsk4M4yY2JpfqGeCtNLU= +github.com/cloudwego/base64x v0.1.4 h1:jwCgWpFanWmN8xoIUHa2rtzmkd5J2plF/dnLS6Xd/0Y= +github.com/cloudwego/base64x v0.1.4/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w= +github.com/cloudwego/iasm v0.2.0 h1:1KNIy1I1H9hNNFEEH3DVnI4UujN+1zjpuk6gwHLTssg= +github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0= +github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.10.0 h1:nTuyha1TYqgedzytsKYqna+DfLos46nTv2ygFy86HFU= +github.com/gin-gonic/gin v1.10.0/go.mod h1:4PMNQiOhvDRa013RKVbsiNwoyezlm2rm0uX/T7kzp5Y= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.20.0 h1:K9ISHbSaI0lyB2eWMPJo+kOS/FBExVwjEviJTixqxL8= +github.com/go-playground/validator/v10 v10.20.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM= +github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= +github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= +github.com/klauspost/cpuid/v2 v2.2.7 h1:ZWSB3igEs+d0qvnxR/ZBzXVmxkgt8DdzP6m9pfuVLDM= +github.com/klauspost/cpuid/v2 v2.2.7/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws= +github.com/knz/go-libedit v1.10.1/go.mod h1:MZTVkCWyz0oBc7JOWP3wNAzd002ZbM/5hgShxwh4x8M= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM= +github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65EE= +github.com/ugorji/go/codec v1.2.12/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= +golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/arch v0.8.0 h1:3wRIsP3pM4yUptoR96otTUOXI367OS0+c9eeRi9doIc= +golang.org/x/arch v0.8.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys= +golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg= +google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= diff --git a/hostroute.go b/hostroute.go new file mode 100644 index 0000000..2eda894 --- /dev/null +++ b/hostroute.go @@ -0,0 +1,66 @@ +package hostroute + +import ( + "fmt" + "github.com/gin-gonic/gin" + "net/http" +) + +type HostConfig struct { + Host string + Prefix string + RouterFactory func(*gin.RouterGroup) + engine *gin.Engine +} + +func createHostBasedRoutingMiddleware(hostConfigMap map[string]*HostConfig, genericHosts map[string]bool, secureAgainstUnknownHosts bool) func(c *gin.Context) { + return func(c *gin.Context) { + host := c.Request.Host + + if config, exists := hostConfigMap[host]; exists { + config.engine.ServeHTTP(c.Writer, c.Request) + c.Abort() + return + } + + if _, exists := genericHosts[host]; exists { + c.Next() + return + } + + if secureAgainstUnknownHosts { + c.String(http.StatusNotFound, "Unknown host") + c.Abort() + return + } + + c.Next() + } +} + +func SetupHostBasedRoutes(r *gin.Engine, hostConfigs []HostConfig, genericHosts []string, secureAgainstUnknownHost bool) { + hostConfigMap := make(map[string]*HostConfig) + genericHostsMap := stringSliceToMap(genericHosts) + + for i := range hostConfigs { + engine := gin.New() + engine.Use(gin.Recovery()) + hostConfigs[i].engine = engine + hostConfigs[i].RouterFactory(&engine.RouterGroup) + + group := r.Group(fmt.Sprintf("/%s", hostConfigs[i].Prefix)) + hostConfigs[i].RouterFactory(group) + + hostConfigMap[hostConfigs[i].Host] = &hostConfigs[i] + } + + r.Use(createHostBasedRoutingMiddleware(hostConfigMap, genericHostsMap, secureAgainstUnknownHost)) +} + +func stringSliceToMap(slice []string) map[string]bool { + result := make(map[string]bool) + for _, s := range slice { + result[s] = true + } + return result +} diff --git a/hostroute_test.go b/hostroute_test.go new file mode 100644 index 0000000..c940a10 --- /dev/null +++ b/hostroute_test.go @@ -0,0 +1,174 @@ +package hostroute + +import ( + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" + "net/http" + "net/http/httptest" + "testing" +) + +func defineHost1Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host1") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host1") + }) +} + +func defineHost2Routes(rg *gin.RouterGroup) { + rg.GET("/", func(c *gin.Context) { + c.String(http.StatusOK, "Hello from host2") + }) + rg.GET("/hi", func(c *gin.Context) { + c.String(http.StatusOK, "Hi from host2") + }) +} + +func noRouteHandler(c *gin.Context) { + c.String(http.StatusNotFound, "No known route") +} + +func TestHostBasedRouting(t *testing.T) { + gin.SetMode(gin.TestMode) + + r := gin.Default() + r.NoRoute(noRouteHandler) + + hostConfigs := []HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + + genericHosts := []string{"host3.com", "host4.com"} + + SetupHostBasedRoutes(r, hostConfigs, genericHosts, true) + + server := httptest.NewServer(r) + defer server.Close() + + tests := []struct { + host, path string + expected string + statusCode int + }{ + {"host1.com", "/", "Hello from host1", http.StatusOK}, + {"host1.com", "/hi", "Hi from host1", http.StatusOK}, + {"host1.com", "/unknown", "No known route", http.StatusNotFound}, + + {"host2.com", "/", "Hello from host2", http.StatusOK}, + {"host2.com", "/hi", "Hi from host2", http.StatusOK}, + {"host2.com", "/unknown", "No known route", http.StatusNotFound}, + + {"host3.com", "/1", "Hello from host1", http.StatusOK}, + {"host3.com", "/1/hi", "Hi from host1", http.StatusOK}, + {"host3.com", "/2", "Hello from host2", http.StatusOK}, + {"host3.com", "/2/hi", "Hi from host2", http.StatusOK}, + {"host3.com", "/unknown", "No known route", http.StatusNotFound}, + + {"host4.com", "/1", "Hello from host1", http.StatusOK}, + {"host4.com", "/1/hi", "Hi from host1", http.StatusOK}, + {"host4.com", "/2", "Hello from host2", http.StatusOK}, + {"host4.com", "/2/hi", "Hi from host2", http.StatusOK}, + {"host4.com", "/unknown", "No known route", http.StatusNotFound}, + + {"unknown.com", "/", "Unknown host", http.StatusNotFound}, + } + + client := &http.Client{} + + for _, tt := range tests { + req, _ := http.NewRequest("GET", server.URL+tt.path, nil) + req.Host = tt.host + resp, err := client.Do(req) + + assert.NoError(t, err) + + body := make([]byte, resp.ContentLength) + _, err = resp.Body.Read(body) + if err != nil { + return + } + + assert.Equal(t, tt.statusCode, resp.StatusCode) + assert.Equal(t, tt.expected, string(body)) + err = resp.Body.Close() + if err != nil { + return + } + } +} + +func TestHostBasedRoutingWithoutSecureAgainstUnknownHosts(t *testing.T) { + gin.SetMode(gin.TestMode) + + r := gin.Default() + r.NoRoute(noRouteHandler) + + hostConfigs := []HostConfig{ + {Host: "host1.com", Prefix: "1", RouterFactory: defineHost1Routes}, + {Host: "host2.com", Prefix: "2", RouterFactory: defineHost2Routes}, + } + + genericHosts := []string{"host3.com", "host4.com"} + + SetupHostBasedRoutes(r, hostConfigs, genericHosts, false) + + server := httptest.NewServer(r) + defer server.Close() + + tests := []struct { + host, path string + expected string + statusCode int + }{ + {"host1.com", "/", "Hello from host1", http.StatusOK}, + {"host1.com", "/hi", "Hi from host1", http.StatusOK}, + {"host1.com", "/unknown", "No known route", http.StatusNotFound}, + + // Host 2 specific routes + {"host2.com", "/", "Hello from host2", http.StatusOK}, + {"host2.com", "/hi", "Hi from host2", http.StatusOK}, + {"host2.com", "/unknown", "No known route", http.StatusNotFound}, + + // Generic Host Routes + {"host3.com", "/1", "Hello from host1", http.StatusOK}, + {"host3.com", "/1/hi", "Hi from host1", http.StatusOK}, + {"host3.com", "/2", "Hello from host2", http.StatusOK}, + {"host3.com", "/2/hi", "Hi from host2", http.StatusOK}, + {"host3.com", "/unknown", "No known route", http.StatusNotFound}, + + {"host4.com", "/1", "Hello from host1", http.StatusOK}, + {"host4.com", "/1/hi", "Hi from host1", http.StatusOK}, + {"host4.com", "/2", "Hello from host2", http.StatusOK}, + {"host4.com", "/2/hi", "Hi from host2", http.StatusOK}, + {"host4.com", "/unknown", "No known route", http.StatusNotFound}, + + {"unknown.com", "/", "No known route", http.StatusNotFound}, + } + + client := &http.Client{} + + for _, tt := range tests { + req, _ := http.NewRequest("GET", server.URL+tt.path, nil) + req.Host = tt.host + resp, err := client.Do(req) + + assert.NoError(t, err) + + body := make([]byte, resp.ContentLength) + _, err = resp.Body.Read(body) + if err != nil { + return + } + + assert.Equal(t, tt.statusCode, resp.StatusCode) + assert.Equal(t, tt.expected, string(body)) + + err = resp.Body.Close() + if err != nil { + return + } + } +}