summaryrefslogtreecommitdiff
path: root/vendor/github.com/oschwald/geoip2-golang
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2018-12-13 19:45:48 +0100
committerKali Kaneko (leap communications) <kali@leap.se>2018-12-13 19:47:11 +0100
commit81843a0477c5eba4b3d4f6ff932f748f9e1244e7 (patch)
tree6068ae0ff1d8ac617e2781fb8aa68200e71403f2 /vendor/github.com/oschwald/geoip2-golang
parentac56a90e21118dc1ddfc1bd5e69d87f157710412 (diff)
vendor packages
Diffstat (limited to 'vendor/github.com/oschwald/geoip2-golang')
-rw-r--r--vendor/github.com/oschwald/geoip2-golang/LICENSE15
-rw-r--r--vendor/github.com/oschwald/geoip2-golang/README.md90
-rw-r--r--vendor/github.com/oschwald/geoip2-golang/reader.go327
3 files changed, 432 insertions, 0 deletions
diff --git a/vendor/github.com/oschwald/geoip2-golang/LICENSE b/vendor/github.com/oschwald/geoip2-golang/LICENSE
new file mode 100644
index 0000000..2969677
--- /dev/null
+++ b/vendor/github.com/oschwald/geoip2-golang/LICENSE
@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2015, Gregory J. Oschwald <oschwald@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/vendor/github.com/oschwald/geoip2-golang/README.md b/vendor/github.com/oschwald/geoip2-golang/README.md
new file mode 100644
index 0000000..7a3c22a
--- /dev/null
+++ b/vendor/github.com/oschwald/geoip2-golang/README.md
@@ -0,0 +1,90 @@
+# GeoIP2 Reader for Go #
+
+[![Build Status](https://travis-ci.org/oschwald/geoip2-golang.png?branch=master)](https://travis-ci.org/oschwald/geoip2-golang)
+[![GoDoc](https://godoc.org/github.com/oschwald/geoip2-golang?status.png)](https://godoc.org/github.com/oschwald/geoip2-golang)
+
+This library reads MaxMind [GeoLite2](http://dev.maxmind.com/geoip/geoip2/geolite2/)
+and [GeoIP2](http://www.maxmind.com/en/geolocation_landing) databases.
+
+This library is built using
+[the Go maxminddb reader](https://github.com/oschwald/maxminddb-golang).
+All data for the database record is decoded using this library. If you only
+need several fields, you may get superior performance by using maxminddb's
+`Lookup` directly with a result struct that only contains the required fields.
+(See [example_test.go](https://github.com/oschwald/maxminddb-golang/blob/master/example_test.go)
+in the maxminddb repository for an example of this.)
+
+## Installation ##
+
+```
+go get github.com/oschwald/geoip2-golang
+```
+
+## Usage ##
+
+[See GoDoc](http://godoc.org/github.com/oschwald/geoip2-golang) for
+documentation and examples.
+
+## Example ##
+
+```go
+package main
+
+import (
+ "fmt"
+ "github.com/oschwald/geoip2-golang"
+ "log"
+ "net"
+)
+
+func main() {
+ db, err := geoip2.Open("GeoIP2-City.mmdb")
+ if err != nil {
+ log.Fatal(err)
+ }
+ defer db.Close()
+ // If you are using strings that may be invalid, check that ip is not nil
+ ip := net.ParseIP("81.2.69.142")
+ record, err := db.City(ip)
+ if err != nil {
+ log.Fatal(err)
+ }
+ fmt.Printf("Portuguese (BR) city name: %v\n", record.City.Names["pt-BR"])
+ fmt.Printf("English subdivision name: %v\n", record.Subdivisions[0].Names["en"])
+ fmt.Printf("Russian country name: %v\n", record.Country.Names["ru"])
+ fmt.Printf("ISO country code: %v\n", record.Country.IsoCode)
+ fmt.Printf("Time zone: %v\n", record.Location.TimeZone)
+ fmt.Printf("Coordinates: %v, %v\n", record.Location.Latitude, record.Location.Longitude)
+ // Output:
+ // Portuguese (BR) city name: Londres
+ // English subdivision name: England
+ // Russian country name: Великобритания
+ // ISO country code: GB
+ // Time zone: Europe/London
+ // Coordinates: 51.5142, -0.0931
+}
+```
+
+## Testing ##
+
+Make sure you checked out test data submodule:
+
+```
+git submodule init
+git submodule update
+```
+
+Execute test suite:
+
+```
+go test
+```
+
+## Contributing ##
+
+Contributions welcome! Please fork the repository and open a pull request
+with your changes.
+
+## License ##
+
+This is free software, licensed under the ISC license.
diff --git a/vendor/github.com/oschwald/geoip2-golang/reader.go b/vendor/github.com/oschwald/geoip2-golang/reader.go
new file mode 100644
index 0000000..ac5108f
--- /dev/null
+++ b/vendor/github.com/oschwald/geoip2-golang/reader.go
@@ -0,0 +1,327 @@
+// Package geoip2 provides an easy-to-use API for the MaxMind GeoIP2 and
+// GeoLite2 databases; this package does not support GeoIP Legacy databases.
+//
+// The structs provided by this package match the internal structure of
+// the data in the MaxMind databases.
+//
+// See github.com/oschwald/maxminddb-golang for more advanced used cases.
+package geoip2
+
+import (
+ "fmt"
+ "net"
+
+ "github.com/oschwald/maxminddb-golang"
+)
+
+// The City struct corresponds to the data in the GeoIP2/GeoLite2 City
+// databases.
+type City struct {
+ City struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"city"`
+ Continent struct {
+ Code string `maxminddb:"code"`
+ GeoNameID uint `maxminddb:"geoname_id"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"continent"`
+ Country struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"country"`
+ Location struct {
+ AccuracyRadius uint16 `maxminddb:"accuracy_radius"`
+ Latitude float64 `maxminddb:"latitude"`
+ Longitude float64 `maxminddb:"longitude"`
+ MetroCode uint `maxminddb:"metro_code"`
+ TimeZone string `maxminddb:"time_zone"`
+ } `maxminddb:"location"`
+ Postal struct {
+ Code string `maxminddb:"code"`
+ } `maxminddb:"postal"`
+ RegisteredCountry struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"registered_country"`
+ RepresentedCountry struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ Type string `maxminddb:"type"`
+ } `maxminddb:"represented_country"`
+ Subdivisions []struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"subdivisions"`
+ Traits struct {
+ IsAnonymousProxy bool `maxminddb:"is_anonymous_proxy"`
+ IsSatelliteProvider bool `maxminddb:"is_satellite_provider"`
+ } `maxminddb:"traits"`
+}
+
+// The Country struct corresponds to the data in the GeoIP2/GeoLite2
+// Country databases.
+type Country struct {
+ Continent struct {
+ Code string `maxminddb:"code"`
+ GeoNameID uint `maxminddb:"geoname_id"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"continent"`
+ Country struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"country"`
+ RegisteredCountry struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ } `maxminddb:"registered_country"`
+ RepresentedCountry struct {
+ GeoNameID uint `maxminddb:"geoname_id"`
+ IsInEuropeanUnion bool `maxminddb:"is_in_european_union"`
+ IsoCode string `maxminddb:"iso_code"`
+ Names map[string]string `maxminddb:"names"`
+ Type string `maxminddb:"type"`
+ } `maxminddb:"represented_country"`
+ Traits struct {
+ IsAnonymousProxy bool `maxminddb:"is_anonymous_proxy"`
+ IsSatelliteProvider bool `maxminddb:"is_satellite_provider"`
+ } `maxminddb:"traits"`
+}
+
+// The AnonymousIP struct corresponds to the data in the GeoIP2
+// Anonymous IP database.
+type AnonymousIP struct {
+ IsAnonymous bool `maxminddb:"is_anonymous"`
+ IsAnonymousVPN bool `maxminddb:"is_anonymous_vpn"`
+ IsHostingProvider bool `maxminddb:"is_hosting_provider"`
+ IsPublicProxy bool `maxminddb:"is_public_proxy"`
+ IsTorExitNode bool `maxminddb:"is_tor_exit_node"`
+}
+
+// The ASN struct corresponds to the data in the GeoLite2 ASN database.
+type ASN struct {
+ AutonomousSystemNumber uint `maxminddb:"autonomous_system_number"`
+ AutonomousSystemOrganization string `maxminddb:"autonomous_system_organization"`
+}
+
+// The ConnectionType struct corresponds to the data in the GeoIP2
+// Connection-Type database.
+type ConnectionType struct {
+ ConnectionType string `maxminddb:"connection_type"`
+}
+
+// The Domain struct corresponds to the data in the GeoIP2 Domain database.
+type Domain struct {
+ Domain string `maxminddb:"domain"`
+}
+
+// The ISP struct corresponds to the data in the GeoIP2 ISP database.
+type ISP struct {
+ AutonomousSystemNumber uint `maxminddb:"autonomous_system_number"`
+ AutonomousSystemOrganization string `maxminddb:"autonomous_system_organization"`
+ ISP string `maxminddb:"isp"`
+ Organization string `maxminddb:"organization"`
+}
+
+type databaseType int
+
+const (
+ isAnonymousIP = 1 << iota
+ isASN
+ isCity
+ isConnectionType
+ isCountry
+ isDomain
+ isEnterprise
+ isISP
+)
+
+// Reader holds the maxminddb.Reader struct. It can be created using the
+// Open and FromBytes functions.
+type Reader struct {
+ mmdbReader *maxminddb.Reader
+ databaseType databaseType
+}
+
+// InvalidMethodError is returned when a lookup method is called on a
+// database that it does not support. For instance, calling the ISP method
+// on a City database.
+type InvalidMethodError struct {
+ Method string
+ DatabaseType string
+}
+
+func (e InvalidMethodError) Error() string {
+ return fmt.Sprintf(`geoip2: the %s method does not support the %s database`,
+ e.Method, e.DatabaseType)
+}
+
+// UnknownDatabaseTypeError is returned when an unknown database type is
+// opened.
+type UnknownDatabaseTypeError struct {
+ DatabaseType string
+}
+
+func (e UnknownDatabaseTypeError) Error() string {
+ return fmt.Sprintf(`geoip2: reader does not support the "%s" database type`,
+ e.DatabaseType)
+}
+
+// Open takes a string path to a file and returns a Reader struct or an error.
+// The database file is opened using a memory map. Use the Close method on the
+// Reader object to return the resources to the system.
+func Open(file string) (*Reader, error) {
+ reader, err := maxminddb.Open(file)
+ if err != nil {
+ return nil, err
+ }
+ dbType, err := getDBType(reader)
+ return &Reader{reader, dbType}, err
+}
+
+// FromBytes takes a byte slice corresponding to a GeoIP2/GeoLite2 database
+// file and returns a Reader struct or an error. Note that the byte slice is
+// use directly; any modification of it after opening the database will result
+// in errors while reading from the database.
+func FromBytes(bytes []byte) (*Reader, error) {
+ reader, err := maxminddb.FromBytes(bytes)
+ if err != nil {
+ return nil, err
+ }
+ dbType, err := getDBType(reader)
+ return &Reader{reader, dbType}, err
+}
+
+func getDBType(reader *maxminddb.Reader) (databaseType, error) {
+ switch reader.Metadata.DatabaseType {
+ case "GeoIP2-Anonymous-IP":
+ return isAnonymousIP, nil
+ case "GeoLite2-ASN":
+ return isASN, nil
+ // We allow City lookups on Country for back compat
+ case "GeoLite2-City",
+ "GeoIP2-City",
+ "GeoIP2-City-Africa",
+ "GeoIP2-City-Asia-Pacific",
+ "GeoIP2-City-Europe",
+ "GeoIP2-City-North-America",
+ "GeoIP2-City-South-America",
+ "GeoIP2-Precision-City",
+ "GeoLite2-Country",
+ "GeoIP2-Country":
+ return isCity | isCountry, nil
+ case "GeoIP2-Connection-Type":
+ return isConnectionType, nil
+ case "GeoIP2-Domain":
+ return isDomain, nil
+ case "GeoIP2-Enterprise":
+ return isEnterprise | isCity | isCountry, nil
+ case "GeoIP2-ISP", "GeoIP2-Precision-ISP":
+ return isISP, nil
+ default:
+ return 0, UnknownDatabaseTypeError{reader.Metadata.DatabaseType}
+ }
+}
+
+// City takes an IP address as a net.IP struct and returns a City struct
+// and/or an error. Although this can be used with other databases, this
+// method generally should be used with the GeoIP2 or GeoLite2 City databases.
+func (r *Reader) City(ipAddress net.IP) (*City, error) {
+ if isCity&r.databaseType == 0 {
+ return nil, InvalidMethodError{"City", r.Metadata().DatabaseType}
+ }
+ var city City
+ err := r.mmdbReader.Lookup(ipAddress, &city)
+ return &city, err
+}
+
+// Country takes an IP address as a net.IP struct and returns a Country struct
+// and/or an error. Although this can be used with other databases, this
+// method generally should be used with the GeoIP2 or GeoLite2 Country
+// databases.
+func (r *Reader) Country(ipAddress net.IP) (*Country, error) {
+ if isCountry&r.databaseType == 0 {
+ return nil, InvalidMethodError{"Country", r.Metadata().DatabaseType}
+ }
+ var country Country
+ err := r.mmdbReader.Lookup(ipAddress, &country)
+ return &country, err
+}
+
+// AnonymousIP takes an IP address as a net.IP struct and returns a
+// AnonymousIP struct and/or an error.
+func (r *Reader) AnonymousIP(ipAddress net.IP) (*AnonymousIP, error) {
+ if isAnonymousIP&r.databaseType == 0 {
+ return nil, InvalidMethodError{"AnonymousIP", r.Metadata().DatabaseType}
+ }
+ var anonIP AnonymousIP
+ err := r.mmdbReader.Lookup(ipAddress, &anonIP)
+ return &anonIP, err
+}
+
+// ASN takes an IP address as a net.IP struct and returns a ASN struct and/or
+// an error
+func (r *Reader) ASN(ipAddress net.IP) (*ASN, error) {
+ if isASN&r.databaseType == 0 {
+ return nil, InvalidMethodError{"ASN", r.Metadata().DatabaseType}
+ }
+ var val ASN
+ err := r.mmdbReader.Lookup(ipAddress, &val)
+ return &val, err
+}
+
+// ConnectionType takes an IP address as a net.IP struct and returns a
+// ConnectionType struct and/or an error
+func (r *Reader) ConnectionType(ipAddress net.IP) (*ConnectionType, error) {
+ if isConnectionType&r.databaseType == 0 {
+ return nil, InvalidMethodError{"ConnectionType", r.Metadata().DatabaseType}
+ }
+ var val ConnectionType
+ err := r.mmdbReader.Lookup(ipAddress, &val)
+ return &val, err
+}
+
+// Domain takes an IP address as a net.IP struct and returns a
+// Domain struct and/or an error
+func (r *Reader) Domain(ipAddress net.IP) (*Domain, error) {
+ if isDomain&r.databaseType == 0 {
+ return nil, InvalidMethodError{"Domain", r.Metadata().DatabaseType}
+ }
+ var val Domain
+ err := r.mmdbReader.Lookup(ipAddress, &val)
+ return &val, err
+}
+
+// ISP takes an IP address as a net.IP struct and returns a ISP struct and/or
+// an error
+func (r *Reader) ISP(ipAddress net.IP) (*ISP, error) {
+ if isISP&r.databaseType == 0 {
+ return nil, InvalidMethodError{"ISP", r.Metadata().DatabaseType}
+ }
+ var val ISP
+ err := r.mmdbReader.Lookup(ipAddress, &val)
+ return &val, err
+}
+
+// Metadata takes no arguments and returns a struct containing metadata about
+// the MaxMind database in use by the Reader.
+func (r *Reader) Metadata() maxminddb.Metadata {
+ return r.mmdbReader.Metadata
+}
+
+// Close unmaps the database file from virtual memory and returns the
+// resources to the system.
+func (r *Reader) Close() error {
+ return r.mmdbReader.Close()
+}