$ opm get xiangnanscu/lua-resty-ipmatcher

lua-resty-ipmatcher

OpenResty Lua 高性能 IP 地址匹配。

API

    local ipmatcher = require("resty.ipmatcher")
    local ip = ipmatcher.new({
        "127.0.0.1",
        "192.168.0.0/16",
        "::1",
        "fe80::/32",
    })
    
    ngx.say(ip:match("127.0.0.1"))
    ngx.say(ip:match("192.168.1.100"))
    ngx.say(ip:match("::1"))

ipmatcher.new

语法: ok, err = ipmatcher.new(ips)

ips 是一个数组表，例如 {ip1, ip2, ip3, ...}，数组中的每个元素都是一个字符串类型的 IP 地址。

    local ip, err = ipmatcher.new({"127.0.0.1", "192.168.0.0/16"})

如果创建新的 ipmatcher 实例失败，则返回 nil 和错误消息。

它支持 IPv4 和 IPv6 的任何 CIDR 格式。

    local ip, err = ipmatcher.new({
            "127.0.0.1", "192.168.0.0/16",
            "::1", "fe80::/16",
        })

ipmatcher.new_with_value

语法: matcher, err = ipmatcher.new_with_value(ips)

ips 是一个哈希表，例如 {[ip1] = val1, [ip2] = val2, ...}，哈希中的每个键都是一个字符串类型的 IP 地址。

当 matcher 由 new_with_value 创建时，对其调用 match 或 match_bin 将返回匹配的 CIDR 范围对应的值，而不是 true。

    local ip, err = ipmatcher.new_with_value({
        ["127.0.0.1"] = {info = "a"},
        ["192.168.0.0/16"] = {info = "b"},
    })
    local data, err = ip:match("192.168.0.1")
    print(data.info) -- the value is "b"

如果创建新的 ipmatcher 实例失败，则返回 nil 和错误消息。

它支持 IPv4 和 IPv6 的任何 CIDR 格式。

    local ip, err = ipmatcher.new_with_value({
        ["127.0.0.1"] = {info = "a"},
        ["192.168.0.0/16"] = {info = "b"},
        ["::1"] = 1,
        ["fe80::/32"] = "xx",
    })

如果 IP 地址可以满足多个 CIDR 范围，则返回值未定义（取决于内部实现）。例如，

    local ip, err = ipmatcher.new_with_value({
        ["192.168.0.1"] = {info = "a"},
        ["192.168.0.0/16"] = {info = "b"},
    })
    local data, err = ip:match("192.168.0.1")
    print(data.info) -- the value can be "a" or "b"

ip.match

语法: ok, err = ip:match(ip)

如果 IP 存在于指定的 IP 列表中，则返回 true。如果 IP 不存在于指定的 IP 列表中，则返回 false。如果 IP 地址无效，则返回 false 和错误消息。

    local ok, err = ip:match("127.0.0.1")

ip.match_bin

语法: ok, err = ip:match_bin(bin_ip)

如果二进制格式的 IP 存在于指定的 IP 列表中，则返回 true。

如果二进制 IP 地址无效，则返回 nil 和错误消息。

    local ok, err = ip:match_bin(ngx.var.binary_remote_addr)

ipmatcher.parse_ipv4

语法: res = ipmatcher.parse_ipv4(ip)

尝试将 IPv4 地址解析为主机字节序 FFI uint32_t 类型整数。

如果 ip 不是有效的 IPv4 地址，则返回 false。

ipmatcher.parse_ipv6

语法: res = ipmatcher.parse_ipv6(ip)

尝试将 IPv6 地址解析为包含四个主机字节序 FFI uint32_t 类型整数的表。给定的 IPv6 地址可以用方括号括起来，例如 [::1]。

如果 ip 不是有效的 IPv6 地址，则返回 false。