Skip to content

fix(system): Fix issue where accessing with an unbound domain returns an error #8014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wanghe-fit2cloud merged 1 commit into from
Feb 26, 2025
Merged

fix(system): Fix issue where accessing with an unbound domain returns an error #8014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion core/app/api/v2/setting.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,14 @@ func (b *BaseApi) UpdateSetting(c *gin.Context) {
if err := helper.CheckBindAndValidate(&req, c); err != nil {
return
}

if err := settingService.Update(req.Key, req.Value); err != nil {
helper.InternalServer(c, err)
return
}
if req.Key == "SecurityEntrance" {
entranceValue := base64.StdEncoding.EncodeToString([]byte(req.Value))
c.SetCookie("SecurityEntrance", entranceValue, 0, "", "", false, true)
}
helper.SuccessWithOutData(c)
}

Expand Down
73 changes: 68 additions & 5 deletions core/init/router/router.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ package router
import (
"encoding/base64"
"fmt"
"github.com/1Panel-dev/1Panel/core/app/repo"
"github.com/1Panel-dev/1Panel/core/utils/common"
"net/http"
"regexp"
"strconv"
Expand Down Expand Up @@ -61,7 +63,7 @@ func checkEntrance(c *gin.Context) bool {
return string(entranceValue) == entrance
}

func handleNoRoute(c *gin.Context) {
func handleNoRoute(c *gin.Context, resType string) {
resPage, err := service.NewIAuthService().GetResponsePage()
if err != nil {
c.String(http.StatusInternalServerError, "Internal Server Error")
Expand All @@ -73,6 +75,9 @@ func handleNoRoute(c *gin.Context) {
}

file := fmt.Sprintf("html/%s.html", resPage)
if resPage == "200" && resType != "" {
file = fmt.Sprintf("html/200_%s.html", resType)
}
data, err := res.ErrorMsg.ReadFile(file)
if err != nil {
c.String(http.StatusInternalServerError, "Internal Server Error")
Expand Down Expand Up @@ -110,6 +115,43 @@ func checkFrontendPath(c *gin.Context) bool {
return true
}

func checkBindDomain(c *gin.Context) bool {
settingRepo := repo.NewISettingRepo()
status, _ := settingRepo.Get(repo.WithByKey("BindDomain"))
if len(status.Value) == 0 {
return true
}
domains := c.Request.Host
parts := strings.Split(c.Request.Host, ":")
if len(parts) > 0 {
domains = parts[0]
}
return domains == status.Value
}

func checkIPLimit(c *gin.Context) bool {
settingRepo := repo.NewISettingRepo()
status, _ := settingRepo.Get(repo.WithByKey("AllowIPs"))
if len(status.Value) == 0 {
return true
}
clientIP := c.ClientIP()
for _, ip := range strings.Split(status.Value, ",") {
if len(ip) == 0 {
continue
}
if ip == clientIP || (strings.Contains(ip, "/") && common.CheckIpInCidr(ip, clientIP)) {
return true
}
}
return false
}

func checkSession(c *gin.Context) bool {
_, err := global.SESSION.Get(c)
return err == nil
}

func setWebStatic(rootRouter *gin.RouterGroup) {
rootRouter.StaticFS("/public", http.FS(web.Favicon))
rootRouter.StaticFS("/favicon.ico", http.FS(web.Favicon))
Expand All @@ -128,17 +170,30 @@ func setWebStatic(rootRouter *gin.RouterGroup) {
rootRouter.GET("/"+entrance, func(c *gin.Context) {
currentEntrance := authService.GetSecurityEntrance()
if currentEntrance != entrance {
handleNoRoute(c)
handleNoRoute(c, "")
return
}
toIndexHtml(c)
})
}
rootRouter.GET("/", func(c *gin.Context) {
if !checkEntrance(c) {
handleNoRoute(c)
if !checkEntrance(c) && !checkSession(c) {
handleNoRoute(c, "")
return
}
if !checkBindDomain(c) {
handleNoRoute(c, "err_domain")
return
}
if !checkIPLimit(c) {
handleNoRoute(c, "err_ip_limit")
return
}
entrance = authService.GetSecurityEntrance()
if entrance != "" {
entranceValue := base64.StdEncoding.EncodeToString([]byte(entrance))
c.SetCookie("SecurityEntrance", entranceValue, 0, "", "", false, true)
}
staticServer := http.FileServer(http.FS(web.IndexHtml))
staticServer.ServeHTTP(c.Writer, c.Request)
})
Expand Down Expand Up @@ -173,6 +228,14 @@ func Routers() *gin.Engine {
}

Router.NoRoute(func(c *gin.Context) {
if !checkBindDomain(c) {
handleNoRoute(c, "err_domain")
return
}
if !checkIPLimit(c) {
handleNoRoute(c, "err_ip_limit")
return
}
if checkFrontendPath(c) {
toIndexHtml(c)
return
Expand All @@ -181,7 +244,7 @@ func Routers() *gin.Engine {
toIndexHtml(c)
return
}
handleNoRoute(c)
handleNoRoute(c, "")
})

return Router
Copy link
Member

@wanghe-fit2cloud wanghe-fit2cloud Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The provided code snippet is incomplete and contains a known bug that needs to be addressed:

  1. handleNoRoute function's name has been changed from handleNoRoute: It should not include an underscore (_) in variable names as it can cause issues during compilation.

Here's the correct code after fixing up mentioned points:

package main

import (
	"encoding/json"
	"html/template"
	"net/http"

	"github.com/gin-gonic/gin"
)

// Example of how to fix this issue
func CheckEntranceHandler(c *gin.Context) {
	if checkEntrance(c) {
		toIndexHtml(c)
	} else {
		fmt.Println("Error handling no route")
		c.JSON(http.StatusNotFound, gin.H{"error": "Unauthorized"})
	}

	func ToIndexHtml(w http.ResponseWriter, r *http.Request) {
	   // Code...
   }

	ToIndexHtmlTemplate := template.Must(template.ParseFiles("./src/templates/index.html"))
	err := ToIndexHtmlTemplate.Execute(w, gin.H{})
	if err != nil {
  		http.Error(w, err.Error(), http.StatusInternalServerError)
  		 // Code...
}

func checkEntrance(ctx *gin.Context) bool {
	return true
}

func main() {
	routing := gin.Default()

+routers...

This changes have been made based on my understanding of what needed to be corrected. I encourage you to reformat these corrections according to best practices if necessary.

Expand Down
28 changes: 2 additions & 26 deletions core/middleware/ip_limit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@ package middleware

import (
"errors"
"net"
"github.com/1Panel-dev/1Panel/core/utils/common"
"strings"

"github.com/1Panel-dev/1Panel/core/app/api/v2/helper"
"github.com/1Panel-dev/1Panel/core/app/repo"
"github.com/1Panel-dev/1Panel/core/global"
"github.com/gin-gonic/gin"
)

Expand All @@ -29,7 +28,7 @@ func WhiteAllow() gin.HandlerFunc {
if len(ip) == 0 {
continue
}
if ip == clientIP || (strings.Contains(ip, "/") && checkIpInCidr(ip, clientIP)) {
if ip == clientIP || (strings.Contains(ip, "/") && common.CheckIpInCidr(ip, clientIP)) {
c.Next()
return
}
Expand All @@ -41,26 +40,3 @@ func WhiteAllow() gin.HandlerFunc {
helper.ErrorWithDetail(c, 310, "ErrInternalServer", errors.New("IP address not allowed"))
}
}

func checkIpInCidr(cidr, checkIP string) bool {
ip, ipNet, err := net.ParseCIDR(cidr)
if err != nil {
global.LOG.Errorf("parse CIDR %s failed, err: %v", cidr, err)
return false
}
for ip := ip.Mask(ipNet.Mask); ipNet.Contains(ip); incIP(ip) {
if ip.String() == checkIP {
return true
}
}
return false
}

func incIP(ip net.IP) {
for j := len(ip) - 1; j >= 0; j-- {
ip[j]++
if ip[j] > 0 {
break
}
}
}
Copy link
Member

@wanghe-fit2cloud wanghe-fit2cloud Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As of the current date, no major coding style or functionality abnormalities detected with this code snippet.

The checkIpInCidr function seems to be working properly. However, consider the potential improvements that may include additional parameters validation and error handling logic for better clarity and reliability:

  • Add validations on inputs (ip, cidr). Example: Ensure valid IP addresses exist.
  • Implement error-handling for incorrect input types or invalid network-related operations.
    This will make the implementation more versatile and robust over time, especially considering it is likely used widely within various API endpoints across different services/modules in your ecosystem.

Note that I cannot provide specific changes since it was not provided in detail (e.g., without checking specific values). The focus here is identifying general areas where improvement would benefit from thorough review and possibly refactoring based on the project scope requirements.

23 changes: 23 additions & 0 deletions core/utils/common/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,26 @@ func GetLang(c *gin.Context) string {
}
return lang
}

func CheckIpInCidr(cidr, checkIP string) bool {
ip, ipNet, err := net.ParseCIDR(cidr)
if err != nil {
global.LOG.Errorf("parse CIDR %s failed, err: %v", cidr, err)
return false
}
for ip := ip.Mask(ipNet.Mask); ipNet.Contains(ip); incIP(ip) {
if ip.String() == checkIP {
return true
}
}
return false
}

func incIP(ip net.IP) {
for j := len(ip) - 1; j >= 0; j-- {
ip[j]++
if ip[j] > 0 {
break
}
}
}
Copy link
Member

@wanghe-fit2cloud wanghe-fit2cloud Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot check whether there are any irregularities, potential issues, or optimization suggestions without the specific code you provided. If you could provide the actual code, I'd be happy to review it for you. Please ensure that you have included all sections of the code that need to be checked (like function bodies, comments), so I can accurately assess its quality.

36 changes: 36 additions & 0 deletions frontend/src/assets/json/china/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"Anhui": "Anhui",
"Beijing": "Beijing",
"Fujian": "Fujian",
"Gansu": "Gansu",
"Guangdong": "Guangdong",
"Guangxi": "Guangxi",
"Guizhou": "Guizhou",
"Hainan": "Hainan",
"Hebei": "Hebei",
"Henan": "Henan",
"Heilongjiang": "Heilongjiang",
"Hubei": "Hubei",
"Hunan": "Hunan",
"Jilin": "Jilin",
"Jiangsu": "Jiangsu",
"Jiangxi": "Jiangxi",
"Liaoning": "Liaoning",
"Inner Mongolia": "Inner Mongolia",
"Ningxia": "Ningxia",
"Qinghai": "Qinghai",
"Shandong": "Shandong",
"Shanxi": "Shanxi",
"Shaanxi": "Shaanxi",
"Shanghai": "Shanghai",
"Sichuan": "Sichuan",
"Tianjin": "Tianjin",
"Tibet": "Tibet",
"Xinjiang": "Xinjiang",
"Yunnan": "Yunnan",
"Zhejiang": "Zhejiang",
"Chongqing": "Chongqing",
"HongKong": "Hong Kong",
"Macao": "Macau",
"Taiwan": "Taiwan"
}
0 frontend/src/assets/json/china-name.json → frontend/src/assets/json/china/zh.json
View file
Open in desktop
File renamed without changes.
10 changes: 10 additions & 0 deletions frontend/src/utils/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,3 +766,13 @@ export const encryptPassword = (password: string) => {
const passwordCipher = aesEncrypt(password, aesKey);
return `${keyCipher}:${passwordCipher}`;
};

export async function loadJson(lang: string): Promise<Object> {
try {
lang = lang == 'zh' ? 'zh' : 'en';
const jsonModule = await import(`@/assets/json/china/${lang}.json`);
return jsonModule.default;
} catch (error) {
throw new Error(`Language file not found: ${lang}`);
}
}
Loading