geoip

README

ContainerSSH IP to Country Code Library

This library provides IP to Country Code lookup services for ContainerSSH.

Using this library

This library needs a configuration structure described in config.go in the public package. This configuration structure can be passed to the geoip.New() method:

provider, err := geoip.New(geoip.Config{
    // Can be "dummy" or "maxmind".
    Provider: "maxmind",
    // MMDB2 file for the MaxMind provider.
    GeoIP2File: "/path/to/maxmind/file.mmdb2",
})
if err != nil {
    // handle error
}

The GeoIP lookup can be performed using the Lookup() method:

countryCode := provider.Lookup("127.0.0.1")

The countryCode field will contain the value of XX if the lookup failed.

Implementing a lookup provider

A custom provider can be written by implementing the following interface:

type LookupProvider interface {
	Lookup(remoteAddr net.IP) (countryCode string)
}

Once implemented you will need to add the necessary configuration options to config.go and add a factory method to factory.go.

Documentation

Index

• func New(cfg config.GeoIPConfig) (geoipprovider.LookupProvider, error)

Functions

func New

func New(cfg config.GeoIPConfig) (geoipprovider.LookupProvider, error)

New creates a new lookup provider based on the configuration.