robertomachorro / swift-mmdb

Swift native library for reading MMDB files, including GeoLite2 IP files.

swift-mmdb

A native swift library for reading MMDB files, which include GeoLite2 files for mapping IP addresses to countries.

What Horror Will This Inflict on My Code?

    let suspectCountries = Set(["CX", "EC"])
    guard let cc = GeoLite2CountryDatabase( from: someFileUrlWhereTheDatabaseLives) else {
        // do something, you don't have a readable country code database.
    }
    
    if let isoCode = cc.countryCode("199.217.175.1"), suspectCountries.contains( isoCode) {
        // do additional checks for these people that may live on islands named after holidays.
    }
}

You will need to get a database, I can't legally let you use mine. This will take registering for a MaxMind developer account and downloading your own copy of it. (You can then also use scripts to regularly pull a fresh copy.)

If you are just testing IP addresses for their country of origin, then you really only need the .countryCode method. If you would like to also know their continent and have access to localized strings for several languages then you will want to use the .search(address:String) method.

If you want to know more, then you will need a more complete database than I am using and to use the MMDB layer instead of the GeoLite2CountryDatabase layer, but it isn't hard. Just feed addresses into its .search method.

What Do You Promise?

• Once your MMDB constructor returns the database, there will be no I/O done. No disk reading (unless you are swapping) and no network access.
• No amount of corrupted database file will allow it to access outside its own bytes. (I reengineered away from 'unsafe' to guarantee this.)
• It is possible to create a database file which will recurse beyond any stack you might have. I do not have a limiter. Use a database you trust.
• IP lookups take 200-300µS on the original M1 Mac Mini. That's fast enough for me, for now.

What Can Go Wrong?

• It is possible to create a database file which will recurse beyond any stack you might have. I do not have a limiter. Use a database you trust.
• It is possible to generate an arithmetic exception from a corrupt database.
• Some data types, (dataCacheContainer, endMarker), are not implemented and will give you a fatalError. I need to find a database which uses them to test them.

Can I Use Thise?

Yes! It is licensed under an MIT license, included in the source tree. If you have an attorney telling you that isn't good enough, contact me with what is good enough.

Do pay attention to the MaxMind terms you agree to when you license their data.

Building

• clone the repository
• Run the tests. If it complains about not having a test-data file, then go to your checked out copy and git submodule update --init --recursive since Xcode and swift build probably didn't do that for you. You only need to do that once after checkout. If your Tests/MMDBTests/MaxMind-DB directory is empty, then you need to do this.

How Mature Is This?

It works for me. I just use the GeoLite2-Country database. It "passes" all of the MaxMind "good" tests. I don't know the right answers, but it doesn't explode and looks reasonable. It doesn't explode on any of the "bad-data" tests for corrupted databases, but many of those are corrupted in more than one way and this code bails out reading the metadata so we don't actually test what was intended.

What More Can I Get?

MaxMind has a number of databases for looking up country, city, ASN, domains, enterprises, ISPs, connection type, and known IP anonymizers. Most of these require payments, a few stripped down ones are freely available to developers.

I don't know if anyone else provides data in this format. It is reasonably well suited to attaching data to partitions of natural numbers in a fairly compact format.

Why?

My personal blog keeps getting run over by spam comments which exclusively come from two countries. I want to prevent anonymous comments from just those countries.

Searching around I found the MaxMind's GeoLite2 database) is freely available and is kept reasonably current. Sadly the only Swift library I found was a wrapper of the C library, and since I develop under macos and deploy on Debian, I didn't want to wrestle with the nusiance that is to build.

Since MaxMind publishes MaxMind DB File Format Specification, how hard could it be to just read that directly…

Survey says: "Two half days with a sleep in between"… then 2 more days to integrate the tests and catch the defects and unimplemented features those revealed.