×
MaxMind

Overview

Security Flow MaxMind Plugin provides geolocation information for a particular host or IP address.

Functionality

The MaxMind plugin supports host_lookup operations, which allow one to find the physical location of a particular host by:

  • IP address
  • Domain name

Instance Configuration Parameters

Property
Description

Instance Name

Name for the MaxMind instance.


Hours Between Updates

Time between checks for a new database.

Flow Node

The DXL MaxMind node is a helper node which appends DXL topic and DXL host information into the received message. The node properties are in the following table.
Property
Description

Name

The display name of the node within the flows.


Domain Source

This field defines the location from the message, flow, global, or JavaScript expression to use as the data source of the name to be used for the host or domain lookup operation. Additionally, the node context can also be changed. The following contexts are supported:

  • msg. – This selects part of the incoming message as the source of the data. This is typical choice.
  • flow. – This selects part of the flow context’s saved data as the source. This information is shared with only the nodes on a given tab.
  • global. – This selects part of the global context’s saved data as the source. This information is shared by all nodes regardless of tab.
  • J: expression – JSONata expression language to perform query and transform operations on the payload.

Learn More

JSON Message Format

The following samples show the JSON content added to the message payload, which conform to Node Messaging Format. The content exists within the maxmind object.

Success

The italicized, green text is inserted into the message payload upon a successful request. The node in the following sample was configured to use www.google.com.

"payload": {
    "maxmind": {
        "topic":"/nevelexlabs/service/geolocation/host_lookup",
        "response":{
            "country":{
                "names":{
                    "de":"USA",
                    "en":"United States",
                    "es":"Estados Unidos",
                    "fr":"\u00c9tats-Unis",
                    "ja":"\u30a2\u30e1\u30ea\u30ab\u5408\u8846\u56fd",
                    "ru":"\u0421\u0428\u0410",
                    "pt-BR":"Estados Unidos",
                    "zh-CN":"\u7f8e\u56fd"
                },
                "iso_code":"US",
                "geoname_id":6252001
            },
            "location":{
                "latitude":37.751,
                "longitude":-97.822,
                "accuracy_radius":1000
            },
            "continent":{
                "code":"NA",
                "names":{
                    "de":"Nordamerika",
                    "en":"North America",
                    "es":"Norteam\u00e9rica",
                    "fr":"Am\u00e9rique du Nord",
                    "ja":"\u5317\u30a2\u30e1\u30ea\u30ab",
                    "ru":"\u0421\u0435\u0432\u0435\u0440\u043d\u0430\u044f \u0410\u043c\u0435\u0440\u0438\u043a\u0430",
                    "pt-BR":"Am\u00e9rica do Norte",
                    "zh-CN":"\u5317\u7f8e\u6d32"
                },
                "geoname_id":6255149
            },
            "registered_country":{
                "names":{
                    "de":"USA",
                    "en":"United States",
                    "es":"Estados Unidos",
                    "fr":"\u00c9tats-Unis",
                    "ja":"\u30a2\u30e1\u30ea\u30ab\u5408\u8846\u56fd",
                    "ru":"\u0421\u0428\u0410",
                    "pt-BR":"Estados Unidos",
                    "zh-CN":"\u7f8e\u56fd"
                },
                "iso_code":"US",
                "geoname_id":6252001
            }
        }
    }
}

Error

The italicized, maroon text is inserted into the message payload upon a failed request. This example used an unregistered domain.

"payload": {
    "maxmind": {
    "error":{
        "error_code":5
        "error_message":"[Errno 8] hostname nor servname provided, or not known"
    }"
}
"topic":string"/nevelexlabs/service/geolocation/host_lookup"
}
Nevelex Labs, Main Office

Metro Office Park
2950 Metro Drive, Suite 104
Bloomington, MN 55425
Phone: +1 952-500-8921

©Nevelex Labs, LLC. 2018-2021, All Rights Reserved.

EULA