mirror of
https://github.com/miniflux/v2.git
synced 2025-06-27 16:36:00 +00:00
Rewrite RealIP() to avoid returning an empty string
This commit is contained in:
parent
cf7a7e25fb
commit
3b39f0883c
11 changed files with 117 additions and 255 deletions
19
vendor/github.com/tomasen/realip/.travis.yml
generated
vendored
19
vendor/github.com/tomasen/realip/.travis.yml
generated
vendored
|
@ -1,19 +0,0 @@
|
|||
language: go
|
||||
|
||||
go:
|
||||
- tip
|
||||
|
||||
before_install:
|
||||
# lint
|
||||
- go get github.com/golang/lint/golint
|
||||
|
||||
# code complexity
|
||||
- go get github.com/on99/gocyclo
|
||||
|
||||
# test
|
||||
- go get github.com/smartystreets/goconvey/convey
|
||||
|
||||
script:
|
||||
- golint ./...
|
||||
- go vet ./...
|
||||
- gocyclo -skip-godeps=true -top 10 -over 10 . # over 10 is bad code
|
33
vendor/github.com/tomasen/realip/README.md
generated
vendored
33
vendor/github.com/tomasen/realip/README.md
generated
vendored
|
@ -1,33 +0,0 @@
|
|||
# RealIP
|
||||
|
||||
[](http://godoc.org/github.com/Tomasen/realip)
|
||||
|
||||
Go package that can be used to get client's real public IP, which usually useful for logging HTTP server.
|
||||
|
||||
### Feature
|
||||
|
||||
* Follows the rule of X-Real-IP
|
||||
* Follows the rule of X-Forwarded-For
|
||||
* Exclude local or private address
|
||||
|
||||
## Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import "github.com/Tomasen/realip"
|
||||
|
||||
func (h *Handler) ServeIndexPage(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
|
||||
clientIP := realip.FromRequest(r)
|
||||
log.Println("GET / from", clientIP)
|
||||
}
|
||||
```
|
||||
|
||||
## Developing
|
||||
|
||||
Commited code must pass:
|
||||
|
||||
* [golint](https://github.com/golang/lint)
|
||||
* [go vet](https://godoc.org/golang.org/x/tools/cmd/vet)
|
||||
* [gofmt](https://golang.org/cmd/gofmt)
|
||||
* [go test](https://golang.org/cmd/go/#hdr-Test_packages):
|
89
vendor/github.com/tomasen/realip/realip.go
generated
vendored
89
vendor/github.com/tomasen/realip/realip.go
generated
vendored
|
@ -1,89 +0,0 @@
|
|||
package realip
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var cidrs []*net.IPNet
|
||||
|
||||
func init() {
|
||||
maxCidrBlocks := []string{
|
||||
"127.0.0.1/8", // localhost
|
||||
"10.0.0.0/8", // 24-bit block
|
||||
"172.16.0.0/12", // 20-bit block
|
||||
"192.168.0.0/16", // 16-bit block
|
||||
"169.254.0.0/16", // link local address
|
||||
"::1/128", // localhost IPv6
|
||||
"fc00::/7", // unique local address IPv6
|
||||
"fe80::/10", // link local address IPv6
|
||||
}
|
||||
|
||||
cidrs = make([]*net.IPNet, len(maxCidrBlocks))
|
||||
for i, maxCidrBlock := range maxCidrBlocks {
|
||||
_, cidr, _ := net.ParseCIDR(maxCidrBlock)
|
||||
cidrs[i] = cidr
|
||||
}
|
||||
}
|
||||
|
||||
// isLocalAddress works by checking if the address is under private CIDR blocks.
|
||||
// List of private CIDR blocks can be seen on :
|
||||
//
|
||||
// https://en.wikipedia.org/wiki/Private_network
|
||||
//
|
||||
// https://en.wikipedia.org/wiki/Link-local_address
|
||||
func isPrivateAddress(address string) (bool, error) {
|
||||
ipAddress := net.ParseIP(address)
|
||||
if ipAddress == nil {
|
||||
return false, errors.New("address is not valid")
|
||||
}
|
||||
|
||||
for i := range cidrs {
|
||||
if cidrs[i].Contains(ipAddress) {
|
||||
return true, nil
|
||||
}
|
||||
}
|
||||
|
||||
return false, nil
|
||||
}
|
||||
|
||||
// FromRequest return client's real public IP address from http request headers.
|
||||
func FromRequest(r *http.Request) string {
|
||||
// Fetch header value
|
||||
xRealIP := r.Header.Get("X-Real-Ip")
|
||||
xForwardedFor := r.Header.Get("X-Forwarded-For")
|
||||
|
||||
// If both empty, return IP from remote address
|
||||
if xRealIP == "" && xForwardedFor == "" {
|
||||
var remoteIP string
|
||||
|
||||
// If there are colon in remote address, remove the port number
|
||||
// otherwise, return remote address as is
|
||||
if strings.ContainsRune(r.RemoteAddr, ':') {
|
||||
remoteIP, _, _ = net.SplitHostPort(r.RemoteAddr)
|
||||
} else {
|
||||
remoteIP = r.RemoteAddr
|
||||
}
|
||||
|
||||
return remoteIP
|
||||
}
|
||||
|
||||
// Check list of IP in X-Forwarded-For and return the first global address
|
||||
for _, address := range strings.Split(xForwardedFor, ",") {
|
||||
address = strings.TrimSpace(address)
|
||||
isPrivate, err := isPrivateAddress(address)
|
||||
if !isPrivate && err == nil {
|
||||
return address
|
||||
}
|
||||
}
|
||||
|
||||
// If nothing succeed, return X-Real-IP
|
||||
return xRealIP
|
||||
}
|
||||
|
||||
// RealIP is depreciated, use FromRequest instead
|
||||
func RealIP(r *http.Request) string {
|
||||
return FromRequest(r)
|
||||
}
|
95
vendor/github.com/tomasen/realip/realip_test.go
generated
vendored
95
vendor/github.com/tomasen/realip/realip_test.go
generated
vendored
|
@ -1,95 +0,0 @@
|
|||
package realip
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestIsPrivateAddr(t *testing.T) {
|
||||
testData := map[string]bool{
|
||||
"127.0.0.0": true,
|
||||
"10.0.0.0": true,
|
||||
"169.254.0.0": true,
|
||||
"192.168.0.0": true,
|
||||
"::1": true,
|
||||
"fc00::": true,
|
||||
|
||||
"172.15.0.0": false,
|
||||
"172.16.0.0": true,
|
||||
"172.31.0.0": true,
|
||||
"172.32.0.0": false,
|
||||
|
||||
"147.12.56.11": false,
|
||||
}
|
||||
|
||||
for addr, isLocal := range testData {
|
||||
isPrivate, err := isPrivateAddress(addr)
|
||||
if err != nil {
|
||||
t.Errorf("fail processing %s: %v", addr, err)
|
||||
}
|
||||
|
||||
if isPrivate != isLocal {
|
||||
format := "%s should "
|
||||
if !isLocal {
|
||||
format += "not "
|
||||
}
|
||||
format += "be local address"
|
||||
|
||||
t.Errorf(format, addr)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRealIP(t *testing.T) {
|
||||
// Create type and function for testing
|
||||
type testIP struct {
|
||||
name string
|
||||
request *http.Request
|
||||
expected string
|
||||
}
|
||||
|
||||
newRequest := func(remoteAddr, xRealIP string, xForwardedFor ...string) *http.Request {
|
||||
h := http.Header{}
|
||||
h.Set("X-Real-IP", xRealIP)
|
||||
for _, address := range xForwardedFor {
|
||||
h.Set("X-Forwarded-For", address)
|
||||
}
|
||||
|
||||
return &http.Request{
|
||||
RemoteAddr: remoteAddr,
|
||||
Header: h,
|
||||
}
|
||||
}
|
||||
|
||||
// Create test data
|
||||
publicAddr1 := "144.12.54.87"
|
||||
publicAddr2 := "119.14.55.11"
|
||||
localAddr := "127.0.0.0"
|
||||
|
||||
testData := []testIP{
|
||||
{
|
||||
name: "No header",
|
||||
request: newRequest(publicAddr1, ""),
|
||||
expected: publicAddr1,
|
||||
}, {
|
||||
name: "Has X-Forwarded-For",
|
||||
request: newRequest("", "", publicAddr1),
|
||||
expected: publicAddr1,
|
||||
}, {
|
||||
name: "Has multiple X-Forwarded-For",
|
||||
request: newRequest("", "", localAddr, publicAddr1, publicAddr2),
|
||||
expected: publicAddr2,
|
||||
}, {
|
||||
name: "Has X-Real-IP",
|
||||
request: newRequest("", publicAddr1),
|
||||
expected: publicAddr1,
|
||||
},
|
||||
}
|
||||
|
||||
// Run test
|
||||
for _, v := range testData {
|
||||
if actual := FromRequest(v.request); v.expected != actual {
|
||||
t.Errorf("%s: expected %s but get %s", v.name, v.expected, actual)
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue