Skip to content

Commit

Permalink
Merge pull request from GHSA-vjh7-5r6x-xh6g
Browse files Browse the repository at this point in the history
* fix:Incorrect identification of source IP addresses

* feat: support reverse proxy

* stash

* stash

* fix: the bug

* fix: the bug

* fix: the bug

* fix: the bug

* delete unused comment

* refacotr the proccess

* add comment to notice user to config correct proxy setting

* fix:some problems

* refactor the ip

* Update gateway_route.go
  • Loading branch information
CorrectRoadH committed Jul 7, 2023
1 parent f76b6bc commit 391dd7f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions route/gateway_route.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package route

import (
"net/http"
"strings"

"github.com/IceWhaleTech/CasaOS-Common/utils/logger"
"github.com/IceWhaleTech/CasaOS-Gateway/service"
Expand All @@ -18,6 +19,38 @@ func NewGatewayRoute(management *service.Management) *GatewayRoute {
}
}

// the function is to ensure the request source IP is correct.
func rewriteRequestSourceIP(r *http.Request) {
// we may receive two kinds of requests. a request from reverse proxy. a request from client.

// in reverse proxy, X-Forwarded-For will like
// `X-Forwarded-For:[192.168.6.102]`(normal)
// `X-Forwarded-For:[::1, 192.168.6.102]`(hacked) Note: the ::1 is inject by attacker.
// `X-Forwarded-For:[::1]`(normal or hacked) local request. But it from browser have JWT. So we can and need to verify it
// `X-Forwarded-For:[::1,::1]`(normal or hacked) attacker can build the request to bypass the verification.
// But in the case. the remoteAddress should be the real ip. So we can use remoteAddress to verify it.

ipList := strings.Split(r.Header.Get("X-Forwarded-For"), ",")

r.Header.Del("X-Forwarded-For")
r.Header.Del("X-Real-IP")

// Note: the X-Forwarded-For depend the correct config from reverse proxy.
// otherwise the X-Forwarded-For may be empty.
remoteIP := r.RemoteAddr[:strings.LastIndex(r.RemoteAddr, ":")]
if len(ipList) > 0 && (remoteIP == "127.0.0.1" || remoteIP == "::1") {
// to process the request from reverse proxy

// in reverse proxy, X-Forwarded-For will container multiple IPs.
// if the request is from reverse proxy, the r.RemoteAddr will be 127.0.0.1.
// So we need get ip from X-Forwarded-For
r.Header.Add("X-Forwarded-For", ipList[len(ipList)-1])
}
// to process the request from client.
// the gateway will add the X-Forwarded-For to request header.
// So we didn't need to add it.
}

func (g *GatewayRoute) GetRoute() *http.ServeMux {
gatewayMux := http.NewServeMux()
gatewayMux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
Expand All @@ -36,6 +69,10 @@ func (g *GatewayRoute) GetRoute() *http.ServeMux {
return
}

// to fix https://github.com/IceWhaleTech/CasaOS/security/advisories/GHSA-32h8-rgcj-2g3c#event-102885
// API V1 and V2 both read ip from request header. So the fix is effective for v1 and v2.
rewriteRequestSourceIP(r)

proxy.ServeHTTP(w, r)
})

Expand Down

0 comments on commit 391dd7f

Please sign in to comment.