forked from Psiphon-Labs/psiphon-tunnel-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
geoip.go
227 lines (197 loc) · 7.23 KB
/
geoip.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*
* Copyright (c) 2016, Psiphon Inc.
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package server
import (
"crypto/hmac"
"crypto/sha256"
"net"
"time"
cache "github.com/Psiphon-Inc/go-cache"
maxminddb "github.com/Psiphon-Inc/maxminddb-golang"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common"
)
const (
GEOIP_SESSION_CACHE_TTL = 60 * time.Minute
GEOIP_UNKNOWN_VALUE = "None"
)
// GeoIPData is GeoIP data for a client session. Individual client
// IP addresses are neither logged nor explicitly referenced during a session.
// The GeoIP country, city, and ISP corresponding to a client IP address are
// resolved and then logged along with usage stats. The DiscoveryValue is
// a special value derived from the client IP that's used to compartmentalize
// discoverable servers (see calculateDiscoveryValue for details).
type GeoIPData struct {
Country string
City string
ISP string
DiscoveryValue int
}
// NewGeoIPData returns a GeoIPData initialized with the expected
// GEOIP_UNKNOWN_VALUE values to be used when GeoIP lookup fails.
func NewGeoIPData() GeoIPData {
return GeoIPData{
Country: GEOIP_UNKNOWN_VALUE,
City: GEOIP_UNKNOWN_VALUE,
ISP: GEOIP_UNKNOWN_VALUE,
}
}
// GeoIPService implements GeoIP lookup and session/GeoIP caching.
// Lookup is via a MaxMind database; the ReloadDatabase function
// supports hot reloading of MaxMind data while the server is
// running.
type GeoIPService struct {
databases []*geoIPDatabase
sessionCache *cache.Cache
discoveryValueHMACKey string
}
type geoIPDatabase struct {
common.ReloadableFile
maxMindReader *maxminddb.Reader
}
// NewGeoIPService initializes a new GeoIPService.
func NewGeoIPService(
databaseFilenames []string,
discoveryValueHMACKey string) (*GeoIPService, error) {
geoIP := &GeoIPService{
databases: make([]*geoIPDatabase, len(databaseFilenames)),
sessionCache: cache.New(GEOIP_SESSION_CACHE_TTL, 1*time.Minute),
discoveryValueHMACKey: discoveryValueHMACKey,
}
for i, filename := range databaseFilenames {
database := &geoIPDatabase{}
database.ReloadableFile = common.NewReloadableFile(
filename,
func(fileContent []byte) error {
maxMindReader, err := maxminddb.FromBytes(fileContent)
if err != nil {
// On error, database state remains the same
return common.ContextError(err)
}
if database.maxMindReader != nil {
database.maxMindReader.Close()
}
database.maxMindReader = maxMindReader
return nil
})
_, err := database.Reload()
if err != nil {
return nil, common.ContextError(err)
}
geoIP.databases[i] = database
}
return geoIP, nil
}
// Reloaders gets the list of reloadable databases in use
// by the GeoIPService. This list is used to hot reload
// these databases.
func (geoIP *GeoIPService) Reloaders() []common.Reloader {
reloaders := make([]common.Reloader, len(geoIP.databases))
for i, database := range geoIP.databases {
reloaders[i] = database
}
return reloaders
}
// Lookup determines a GeoIPData for a given client IP address.
func (geoIP *GeoIPService) Lookup(ipAddress string) GeoIPData {
result := NewGeoIPData()
ip := net.ParseIP(ipAddress)
if ip == nil || len(geoIP.databases) == 0 {
return result
}
var geoIPFields struct {
Country struct {
ISOCode string `maxminddb:"iso_code"`
} `maxminddb:"country"`
City struct {
Names map[string]string `maxminddb:"names"`
} `maxminddb:"city"`
ISP string `maxminddb:"isp"`
}
// Each database will populate geoIPFields with the values it contains. In the
// currnt MaxMind deployment, the City database populates Country and City and
// the separate ISP database populates ISP.
for _, database := range geoIP.databases {
database.ReloadableFile.RLock()
err := database.maxMindReader.Lookup(ip, &geoIPFields)
database.ReloadableFile.RUnlock()
if err != nil {
log.WithContextFields(LogFields{"error": err}).Warning("GeoIP lookup failed")
}
}
if geoIPFields.Country.ISOCode != "" {
result.Country = geoIPFields.Country.ISOCode
}
name, ok := geoIPFields.City.Names["en"]
if ok && name != "" {
result.City = name
}
if geoIPFields.ISP != "" {
result.ISP = geoIPFields.ISP
}
result.DiscoveryValue = calculateDiscoveryValue(
geoIP.discoveryValueHMACKey, ipAddress)
return result
}
// SetSessionCache adds the sessionID/geoIPData pair to the
// session cache. This value will not expire; the caller must
// call MarkSessionCacheToExpire to initiate expiry.
// Calling SetSessionCache for an existing sessionID will
// replace the previous value and reset any expiry.
func (geoIP *GeoIPService) SetSessionCache(sessionID string, geoIPData GeoIPData) {
geoIP.sessionCache.Set(sessionID, geoIPData, cache.NoExpiration)
}
// MarkSessionCacheToExpire initiates expiry for an existing
// session cache entry, if the session ID is found in the cache.
// Concurrency note: SetSessionCache and MarkSessionCacheToExpire
// should not be called concurrently for a single session ID.
func (geoIP *GeoIPService) MarkSessionCacheToExpire(sessionID string) {
geoIPData, found := geoIP.sessionCache.Get(sessionID)
// Note: potential race condition between Get and Set. In practice,
// the tunnel server won't clobber a SetSessionCache value by calling
// MarkSessionCacheToExpire concurrently.
if found {
geoIP.sessionCache.Set(sessionID, geoIPData, cache.DefaultExpiration)
}
}
// GetSessionCache returns the cached GeoIPData for the
// specified session ID; a blank GeoIPData is returned
// if the session ID is not found in the cache.
func (geoIP *GeoIPService) GetSessionCache(sessionID string) GeoIPData {
geoIPData, found := geoIP.sessionCache.Get(sessionID)
if !found {
return NewGeoIPData()
}
return geoIPData.(GeoIPData)
}
// calculateDiscoveryValue derives a value from the client IP address to be
// used as input in the server discovery algorithm. Since we do not explicitly
// store the client IP address, we must derive the value here and store it for
// later use by the discovery algorithm.
// See https://bitbucket.org/psiphon/psiphon-circumvention-system/src/tip/Automation/psi_ops_discovery.py
// for full details.
func calculateDiscoveryValue(discoveryValueHMACKey, ipAddress string) int {
// From: psi_ops_discovery.calculate_ip_address_strategy_value:
// # Mix bits from all octets of the client IP address to determine the
// # bucket. An HMAC is used to prevent pre-calculation of buckets for IPs.
// return ord(hmac.new(HMAC_KEY, ip_address, hashlib.sha256).digest()[0])
// TODO: use 3-octet algorithm?
hash := hmac.New(sha256.New, []byte(discoveryValueHMACKey))
hash.Write([]byte(ipAddress))
return int(hash.Sum(nil)[0])
}