forked from Psiphon-Labs/psiphon-tunnel-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
geoip.go
321 lines (270 loc) · 9.36 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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/*
* 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 (
"fmt"
"io"
"net"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/errors"
maxminddb "github.com/oschwald/maxminddb-golang"
cache "github.com/patrickmn/go-cache"
)
const (
GEOIP_SESSION_CACHE_TTL = 60 * time.Minute
GEOIP_UNKNOWN_VALUE = "None"
GEOIP_DATABASE_TYPE_ISP = "GeoIP2-ISP"
)
// 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.
type GeoIPData struct {
Country string
City string
ISP string
ASN string
ASO string
}
// 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,
ASN: GEOIP_UNKNOWN_VALUE,
ASO: GEOIP_UNKNOWN_VALUE,
}
}
// SetLogFields adds the GeoIPData fields to LogFields, following Psiphon
// metric field name and format conventions.
func (g GeoIPData) SetLogFields(logFields LogFields) {
g.SetLogFieldsWithPrefix("", logFields)
}
func (g GeoIPData) SetLogFieldsWithPrefix(prefix string, logFields LogFields) {
// In psi_web, the space replacement was done to accommodate space
// delimited logging, which is no longer required; we retain the
// transformation so that stats aggregation isn't impacted.
logFields[prefix+"client_region"] = strings.Replace(g.Country, " ", "_", -1)
logFields[prefix+"client_city"] = strings.Replace(g.City, " ", "_", -1)
logFields[prefix+"client_isp"] = strings.Replace(g.ISP, " ", "_", -1)
logFields[prefix+"client_asn"] = strings.Replace(g.ASN, " ", "_", -1)
logFields[prefix+"client_aso"] = strings.Replace(g.ASO, " ", "_", -1)
}
// 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
}
type geoIPDatabase struct {
common.ReloadableFile
filename string
tempFilename string
tempFileSuffix int64
isISPType bool
maxMindReader *maxminddb.Reader
}
// NewGeoIPService initializes a new GeoIPService.
func NewGeoIPService(databaseFilenames []string) (*GeoIPService, error) {
geoIP := &GeoIPService{
databases: make([]*geoIPDatabase, len(databaseFilenames)),
sessionCache: cache.New(GEOIP_SESSION_CACHE_TTL, 1*time.Minute),
}
for i, filename := range databaseFilenames {
database := &geoIPDatabase{
filename: filename,
}
database.ReloadableFile = common.NewReloadableFile(
filename,
false,
func(_ []byte, _ time.Time) error {
// In order to safely mmap the database file, a temporary copy
// is made and that copy is mmapped. The original file may be
// repaved without affecting the mmap; upon hot reload, a new
// temporary copy is made and once it is successful, the old
// mmap is closed and previous temporary file deleted.
//
// On any reload error, database state remains the same.
src, err := os.Open(database.filename)
if err != nil {
return errors.Trace(err)
}
tempFileSuffix := database.tempFileSuffix + 1
tempFilename := fmt.Sprintf(
"%s.%d",
filepath.Join(os.TempDir(), filepath.Base(database.filename)),
tempFileSuffix)
dst, err := os.Create(tempFilename)
if err != nil {
src.Close()
return errors.Trace(err)
}
_, err = io.Copy(dst, src)
src.Close()
dst.Close()
if err != nil {
_ = os.Remove(tempFilename)
return errors.Trace(err)
}
maxMindReader, err := maxminddb.Open(tempFilename)
if err != nil {
_ = os.Remove(tempFilename)
return errors.Trace(err)
}
if database.maxMindReader != nil {
database.maxMindReader.Close()
_ = os.Remove(database.tempFilename)
}
isISPType := (maxMindReader.Metadata.DatabaseType == GEOIP_DATABASE_TYPE_ISP)
database.maxMindReader = maxMindReader
database.isISPType = isISPType
database.tempFilename = tempFilename
database.tempFileSuffix = tempFileSuffix
return nil
})
_, err := database.Reload()
if err != nil {
return nil, errors.Trace(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 string client IP address.
func (geoIP *GeoIPService) Lookup(strIP string) GeoIPData {
return geoIP.LookupIP(net.ParseIP(strIP))
}
// LookupIP determines a GeoIPData for a given client IP address.
func (geoIP *GeoIPService) LookupIP(IP net.IP) GeoIPData {
return geoIP.lookupIP(IP, false)
}
// LookupISPForIP determines a GeoIPData for a given client IP address. Only
// ISP, ASN, and ASO fields will be populated. This lookup is faster than a
// full lookup.
func (geoIP *GeoIPService) LookupISPForIP(IP net.IP) GeoIPData {
return geoIP.lookupIP(IP, true)
}
func (geoIP *GeoIPService) lookupIP(IP net.IP, ISPOnly bool) GeoIPData {
result := NewGeoIPData()
if IP == nil {
return result
}
// Populate GeoIP fields.
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"`
ASN int `maxminddb:"autonomous_system_number"`
ASO string `maxminddb:"autonomous_system_organization"`
}
geoIPFields.ASN = -1
// Each database will populate geoIPFields with the values it contains. In the
// current MaxMind deployment, the City database populates Country and City and
// the separate ISP database populates ISP.
for _, database := range geoIP.databases {
database.ReloadableFile.RLock()
var err error
// Don't lookup the City database when only ISP fields are required;
// skipping the City lookup is 5-10x faster.
if !ISPOnly || database.isISPType {
err = database.maxMindReader.Lookup(IP, &geoIPFields)
}
database.ReloadableFile.RUnlock()
if err != nil {
log.WithTraceFields(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
}
if geoIPFields.ASN != -1 {
result.ASN = strconv.Itoa(geoIPFields.ASN)
}
if geoIPFields.ASO != "" {
result.ASO = geoIPFields.ASO
}
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)
}
// InSessionCache returns whether the session ID is present
// in the session cache.
func (geoIP *GeoIPService) InSessionCache(sessionID string) bool {
_, found := geoIP.sessionCache.Get(sessionID)
return found
}