mm-geofeed-verifier

README

mm-geofeed-verifier

mm-geofeed-verifier attempts to validate that a given file follows the format suggested at https://datatracker.ietf.org/doc/html/rfc8805, and makes some comparisons to a given MMDB, typically the latest available GeoIP2-City.mmdb

Usage

Default strict mode

By default strict mode requires exact ISO-3166-2 format compliance for region codes:

mm-geofeed-verifier -gf /path/to/geofeed-formatted-file -db /path/to/Database.mmdb

Lax mode

Use --lax mode to allow region codes to be provided without ISO-3166 country code prefix:

mm-geofeed-verifier --lax -gf /path/to/geofeed-formatted-file -db /path/to/Database.mmdb

Installation and release

Find a suitable archive for your system on the Releases tab. Extract the archive. Inside is the mm-geofeed-verifier binary.

Installation from source or Git

You need the Go compiler (Go 1.21+). You can get it at the Go website.

The easiest way is via go install:

$ go install github.com/maxmind/mm-geofeed-verifier/v2@latest

The program will be installed to $GOPATH/bin/mm-geofeed-verifier.

Bug Reports

Please report bugs by filing an issue with our GitHub issue tracker at https://github.com/maxmind/mm-geofeed-verifier/issues

Copyright and License

This software is Copyright (c) 2019 - 2024 by MaxMind, Inc.

This is free software, licensed under the Apache License, Version 2.0 or the MIT License, at your option.

Documentation

Overview

This script is meant to help verify 'bulk correction' files for submission to MaxMind. The files are expected to (mostly) follow the format provided by the RFC at https://datatracker.ietf.org/doc/rfc8805/ Region codes without the country prefix are accepted. eg, 'NY' is allowed, along with 'US-NY' for the state of New York in the United States. Beyond verifying that the format of the data is correct, the script will also compare the corrections against a given MMDB, reporting on how many corrections differ from the contents in the database.