Skip to main content

Soft whitelisting

Features like brute_force, relay_domains and rbl support soft whitelists. You can dynamically adjust these lists from within Lua.

dynamic_loader("nauthilus_soft_whitelist")
local nauthilus_soft_whitelist = require("nauthilus_soft_whitelist")

nauthilus_soft_whitelist.soft_whitelist_set​

Add (or replace) an entry like this:

local username = "testuser"
local network = "192.168.0.0/24"
local feature = "brute_force"

local err = nauthilus_soft_whitelist.soft_whitelist_set(username, network, feature)

Network must be a valid network with a CIDR-mask, even for a single address!

The "err" variable will be set to nil on success. If you specify a wrong feature, "err" will contain a message about this issue.

nauthilus_soft_whitelist.soft_whitelist_get​

This method retrieves all associsated networks for a given username and feature.

local username = "testuser"
local feature = "brute_force"

local result_table = nauthilus_soft_whitelist.soft_whitelist_get(username, feature)

-- result_table will be { [1] = "192.168.0.0/24" } for the example above

nauthilus_soft_whitelist.soft_whitelist_delete​

Remove a network for a given username and feature.

local username = "testuser"
local network = "192.168.0.0/24"
local feature = "brute_force"

nauthilus_soft_whitelist.soft_whitelist_delete(username, network, feature)

-- Will remove the network "192.168.0.0/24" from the users' whitelist