1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-12-04 10:34:59 +02:00
oauth2-proxy/pkg/middleware/healthcheck.go
Jordan Crawford 6346dafc1e (#649) Remove blank helthcheck user agents and paths when setting up the healthcheck middleware
A blank user agent is considered == to an empty string. When no -ping-user-agent option is specified, this is considered to be an empty string.

This reveals two problems:
- When no ping-user-agent is specified, main.go sets up a health check user agent of ""
- When no user agent is specified, the empty string is still checked against the health check user agents.

Now the health check middleware ignores blank user agents and paths in order to sanitise it's input to avoid this issue.

Additional tests have been added to verify these situations.
2020-07-06 14:07:38 +12:00

53 lines
1.2 KiB
Go

package middleware
import (
"fmt"
"net/http"
"github.com/justinas/alice"
)
func NewHealthCheck(paths, userAgents []string) alice.Constructor {
return func(next http.Handler) http.Handler {
return healthCheck(paths, userAgents, next)
}
}
func healthCheck(paths, userAgents []string, next http.Handler) http.Handler {
// Use a map as a set to check health check paths
pathSet := make(map[string]struct{})
for _, path := range paths {
if len(path) > 0 {
pathSet[path] = struct{}{}
}
}
// Use a map as a set to check health check paths
userAgentSet := make(map[string]struct{})
for _, userAgent := range userAgents {
if len(userAgent) > 0 {
userAgentSet[userAgent] = struct{}{}
}
}
return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
if isHealthCheckRequest(pathSet, userAgentSet, req) {
rw.WriteHeader(http.StatusOK)
fmt.Fprintf(rw, "OK")
return
}
next.ServeHTTP(rw, req)
})
}
func isHealthCheckRequest(paths, userAgents map[string]struct{}, req *http.Request) bool {
if _, ok := paths[req.URL.EscapedPath()]; ok {
return true
}
if _, ok := userAgents[req.Header.Get("User-Agent")]; ok {
return true
}
return false
}