Module:Sensitive IP addresses/API

Module documentation[view] [edit] [history] [purge]

This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This Lua module is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module provides an API for information about IP addresses that Wikipedia considers sensitive. The intention is that this one API can be used for templates, Lua modules, and software using the MediaWiki Action API such as JavaScript gadgets and bots.

Usage

From templates

Templates wishing to make use of this API need to use an intermediary Lua module to parse the results of API queries. One such module, used to create a wikitable summary of sensitive IPs, exists at Module:Sensitive IP addresses/summary.

From Lua

To load this module from Lua modules, use:

local querySensitiveIPs = require('Module:Sensitive IP addresses/API').query

The query function is called with named parameters. For example:

local result = querySensitiveIPs{
	test = {'1.2.3.4', '5.6.7.8'}
}

Parameters

The following parameters are available to the query function:

test - an array of IP addresses and/or IP ranges to test for sensitivity. IP addresses and ranges can be IPv4 or IPv6, and ranges must be in CIDR notation.
entities - an array of entity IDs to get information about. An entity is a country or organization which is considered sensitive, and for which blocks should be handled with care. Entity IDs are defined in Module:Sensitive IP addresses/list along with the rest of the sensitive IP data. For example, ushr is the ID for the United States House of Representatives. If the special ID all is contained in the array, information about all entities will be included in the result.
format - the format to return results in. Use json to return a JSON-formatted string, and use lua to return a Lua table. If this option is not specified, a Lua table is returned by default.

Results

By default, the query function returns a Lua table, but it can return a JSON object if the format option is set to json. Whether Lua or JSON, the structure of the object returned is similar to the structure of query results from the MediaWiki Action API.

Top-level object

The top level object contains exactly one child object. If the query executed successfully, this object has a key of sensitiveips and contains the query results.

{
    "sensitiveips": {
        [query results]
    }       
}

If there were any errors when executing the query, the child of the top-level object has a key of error and contains error information. The error object has three keys: code, the error ID; info, the error message; and *, a message about where to find the API documentation. The error IDs all have a prefix of "sipa". For example:

{
    "error": {
        "code": "sipa-invalid-test-string",
        "info": "test string #1 'foo' was not a valid IP address or CIDR string",
        "*": "See https://en.wikipedia.org/wiki/Module:Sensitive_IP_addresses/API for API usage"
    }       
}

Sensitive IPs object

If the query was successful, the sensitiveips child object will be present and can contain the following objects and arrays:

matches - an array of IP address objects or IP range objects, where the corresponding IP address or IP range string was specified in the test query option, and where Wikipedia regards that IP address or IP range as being sensitive. If no IPs or ranges were tested for, or if no matches were found, this array will not be present in the results.
matched-ranges - an object with CIDR IP range strings as keys, and matched-range objects as values, where the IP range matches one of the IP addresses or IP ranges tested for with the test query option. If no IPs or ranges were tested for, or if no matches were found, this object will not be present.
entities - an object with entity IDs as keys, and entity objects as values. An entity is a country or organization which has IP addresses that Wikipedia considers sensitive. Entity IDs are defined in Module:Sensitive IP addresses/list; for example, ushr is the ID for the United States House of Representatives. Entities will be included in this object if an IP range belonging to them is matched by one of the IP addresses or IP ranges tested for with the test query option, or if their entity ID is specified in the entities query option.
entity-ids - an array of entity ID strings, in the order they are defined in Module:Sensitive IP addresses/list. The entity IDs in this array correspond one-to-one with the entity ID keys of the entities result object. This array can be useful for outputting the IDs in the same order that they were defined in the list.

IP address objects

An IP address object represents a single IPv4 or IPv6 address that matches a sensitive IP range. IP address objects contain the following fields:

ip - the string representation of the IP address, e.g. "1.2.3.4" or "2001:d8::ffff:ab:cdef".
type - the string "ip" (used to differentiate between IP address objects and IP range objects).
ip-version - the version of the IP protocol the address uses. This is either "IPv4" or "IPv6".
matches-range - the sensitive IP range that the address matches, in CIDR notation.
entity-id - the entity ID of the entity that owns the sensitive IP range that the address matches.

IP range objects

An IP range object represents an IPv4 or IPv6 range that overlaps with a sensitive IP range. IP range objects contain the following fields:

range - the CIDR string representation of the range, e.g. "1.2.3.0/24" or "2001:d8::ffff:ab:0/16".
type - the string "range" (used to differentiate between IP range objects and IP address objects).
ip-version - the version of the IP protocol the range uses. This is either "IPv4" or "IPv6".
matches-range - the sensitive IP range that the tested range overlaps, in CIDR notation.
entity-id - the entity ID of the entity that owns the sensitive IP range that the tested range overlaps.

Entity objects

An entity object represents a country or organization that has IP ranges which Wikipedia considers sensitive. Entity objects may contain the following fields:

id - the entity ID. This is a unique string used to identify the entity. This field is always present.
name - the name of the entity. This is a plain string, containing no wikitext, and is always present.
description - a description of the entity. This is a string, and may contain wikitext. This field is optional, and may not be present.
reason - the reason that the entity's IP ranges are sensitive. The possible reasons are Script error: The function "_getSensitivityReasons" does not exist..
ipv4-ranges - an array of IPv4 CIDR strings that belong to the entity, and are considered as sensitive by Wikipedia. This field is optional, and may not be present.
ipv6-ranges - an array of IPv6 CIDR strings that belong to the entity, and are considered as sensitive by Wikipedia. This field is optional, and may not be present.
notes - notes about the entity or its ranges. This field is optional, and may not be present.

Examples

Here are some examples of some queries from Lua and the results they produce.

No matches

Query:

querySensitiveIPs{
    test = {'1.2.3.4'}
}

Result:

{
  ["sensitiveips"] = {
  }
}

One match

Query:

querySensitiveIPs{
    test = {'156.33.5.76'}
}

Result:

{
  ["sensitiveips"] = {
    ["matches"] = {
      {
        ["type"] = "ip",
        ["ip"] = "156.33.5.76",
        ["ip-version"] = "IPv4",
        ["matches-range"] = "156.33.0.0/16",
        ["entity-id"] = "ussenate",
      },
    },
    ["matched-ranges"] = {
      ["156.33.0.0/16"] = {
        ["range"] = "156.33.0.0/16",
        ["ip-version"] = "IPv4",
        ["entity-id"] = "ussenate",
      },
    },
    ["entities"] = {
      ["ussenate"] = {
        ["id"] = "ussenate",
        ["name"] = "United States Senate",
        ["description"] = "the [[United States Senate]]",
        ["reason"] = "political",
        ["ipv4Ranges"] = {
          "156.33.0.0/16",
        },
        ["ipv6Ranges"] = {
          "2620:0:8a0::/48",
          "2600:803:618::/48",
        }
      },
    },
    ["entity-ids"] = {
      "ussenate",
    },
  },
}

One match, JSON output

Query: Query:

querySensitiveIPs{
    format = 'json',
    test = {'156.33.5.76'}
}

Result:

{
   "sensitiveips":{
      "matches":[
         {
            "type": "ip",
            "ip": "156.33.5.76",
            "ip-version": "IPv4",
            "matches-range": "156.33.0.0/16",
            "entity-id": "ussenate"
         }
      ],
      "matched-ranges": {
         "156.33.0.0/16": {
            "range": "156.33.0.0/16",
            "ip-version": "IPv4",
            "entity-id": "ussenate"
         }
      },
      "entities": {
         "ussenate": {
            "id": "ussenate",
            "name": "United States Senate",
            "description": "the [[United States Senate]]",
            "reason": "political",
            "ipv6Ranges": [
               "2620:0:8a0::/48",
               "2600:803:618::/48"
            ],
            "ipv4Ranges": [
               "156.33.0.0/16"
            ]
         }
      },
      "entity-ids": [
         "ussenate"
      ]
   }
}

Entity IDs

querySensitiveIPs{
    format = 'json',
    entities = {'usdhs', 'usdoj'}
}

Result:

{
   "sensitiveips": {
      "entities": {
         "usdoj": {
            "id": "usdoj",
            "name": "United States Department of Justice",
            "description": "the [[United States Department of Justice]]",
            "reason": "political",
            "ipv4Ranges": [
               "149.101.0.0/16"
            ]
         },
         "usdhs": {
            "id": "usdhs",
            "name": "United States Department of Homeland Security",
            "description": "the [[United States Department of Homeland Security]]",
            "reason": "political",
            "ipv4Ranges": [
               "65.165.132.0/24",
               "204.248.24.0/24",
               "216.81.80.0/20"
            ]
         }
      },
      "entity-ids": [
         "usdoj",
         "usdhs"
      ]
   }
}

Invalid IP error

Query:

querySensitiveIPs{
    test = {'foo'}
}

Result:

{
  ["error"] = {
    ["code"] = "sipa-invalid-test-string",
    ["info"] = "test string #1 'foo' was not a valid IP address or CIDR string"
    ["*"] = "See https://en.wikipedia.org/wiki/Module:Sensitive_IP_addresses/API for API usage",
  }
}

The above documentation is transcluded from Module:Sensitive IP addresses/API/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

-- This module provides functions for handling sensitive IP addresses.

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local p = {}

local sensitivityReasons = {
	political = true,
	technical = true,
}

function p.isValidSensitivityReason(s)
	checkType('isValidSensitivityReason', 1, s, 'string')
	return sensitivityReasons[s] ~= nil
end

return p