Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions Gopkg.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Gopkg.toml example
#
# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
# for detailed Gopkg.toml documentation.
#
# required = ["github.com/user/thing/cmd/thing"]
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
#
# [[constraint]]
# name = "github.com/user/project"
# version = "1.0.0"
#
# [[constraint]]
# name = "github.com/user/project2"
# branch = "dev"
# source = "github.com/myfork/project2"
#
# [[override]]
# name = "github.com/x/y"
# version = "2.4.0"
#
# [prune]
# non-go = false
# go-tests = true
# unused-packages = true


[prune]
go-tests = true
unused-packages = true
17 changes: 14 additions & 3 deletions realip.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ import (
"strings"
)

// Should use canonical format of the header key s
// https://golang.org/pkg/net/http/#CanonicalHeaderKey
var xForwardedFor = http.CanonicalHeaderKey("X-Forwarded-For")
var xRealIP = http.CanonicalHeaderKey("X-Real-IP")

// RFC7239 defines a new "Forwarded: " header designed to replace the
// existing use of X-Forwarded-* headers.
// e.g. Forwarded: for=192.0.2.60;proto=https;by=203.0.113.43
var forwarded = http.CanonicalHeaderKey("Forwarded")

var cidrs []*net.IPNet

func init() {
Expand Down Expand Up @@ -49,11 +59,12 @@ func isPrivateAddress(address string) (bool, error) {
return false, nil
}

// FromRequest return client's real public IP address from http request headers.
// FromRequest returns 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")
xRealIP := r.Header.Get(xRealIP)
xForwardedFor := r.Header.Get(xForwardedFor)
// forwarded := r.Header.Get(forwarded)

// If both empty, return IP from remote address
if xRealIP == "" && xForwardedFor == "" {
Expand Down
10 changes: 8 additions & 2 deletions realip_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package realip

import (
"fmt"
"net/http"
"testing"
)
Expand Down Expand Up @@ -50,11 +51,12 @@ func TestRealIP(t *testing.T) {

newRequest := func(remoteAddr, xRealIP string, xForwardedFor ...string) *http.Request {
h := http.Header{}
h.Set("X-Real-IP", xRealIP)
if xRealIP != "" {

Choose a reason for hiding this comment

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

this is a good catch!

h.Set("X-Real-IP", xRealIP)
}
for _, address := range xForwardedFor {
h.Set("X-Forwarded-For", address)
}

return &http.Request{
RemoteAddr: remoteAddr,
Header: h,
Expand All @@ -79,6 +81,10 @@ func TestRealIP(t *testing.T) {
name: "Has multiple X-Forwarded-For",
request: newRequest("", "", localAddr, publicAddr1, publicAddr2),
expected: publicAddr2,
}, {
name: "Has multiple address for X-Forwarded-For",
request: newRequest("", "", localAddr, fmt.Sprintf("%s,%s", publicAddr1, publicAddr2)),
expected: publicAddr1,
}, {
name: "Has X-Real-IP",
request: newRequest("", publicAddr1),
Expand Down