Lua Processor
Netify Lua Scripting Extension Plugin
Introduction
Netify Lua plugin allows an integrator to work with events and data objects in the Lua scripting language.
License
Netify Lua Scripting Extension Plugin is a proprietary plugin requiring a license. Please contact us for details.
Installation
Netify plugins are packaged in the same workflow as the agent and can usually be installed using a similar syntax that was implemented during the installation of the Netify agent. Exceptions to this rule occur when the plugin requires a Software License Agreement or if an upgrade or downgrade to a different version of the plugin is required.
Alma Linux
Alma Linux 9
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/almalinux/9/stable/x86_64/netify-lua_1.0.22-1.os9.x86_64.rpm
apt install ./netify-lua_1.0.22-1.os9.x86_64.rpm
Alma Linux 8
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/almalinux/8/stable/x86_64/netify-lua_1.0.22-1.os8.x86_64.rpm
yum install ./netify-lua_1.0.22-1.os8.x86_64.rpm
Debian
Debian 13 (Bookworm)
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/debian/10/amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
Debian 11 (Bullseye)
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/debian/10/amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
Debian 10 (Buster)
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/debian/10/amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
OpenWRT
OpenWRT 23.05
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/openwrt/23.05/amd64/netify-lua_1.0.22-1_x86_64.ipk
OpenWRT 22.03
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/openwrt/22.03/amd64/netify-lua_1.0.22-1_x86_64.ipk
OpenWRT 21.02
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/openwrt/21.02/amd64/netify-lua_1.0.22-1_x86_64.ipk
OpenWRT 19.07
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/openwrt/19.07/amd64/netify-lua_1.0.22-1_x86_64.ipk
OPNsense
OPNsense 24.1 - Savvy Shark
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/freebsd/13.2/amd64/netify-lua_1.0.22,1.pkg
OPNsense 23.7 - Restless Roadrunner
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/freebsd/13.2/amd64/netify-lua_1.0.22,1.pkg
pfSense
pfSense Plus 23.x
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/freebsd/14.0/amd64/netify-lua_1.0.22,1.pkg
pfSense CE 2.7.x
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
pkg add https://client:secret@download.netify.ai/5/freebsd/13.2/amd64/netify-lua_1.0.22,1.pkg
Rocky Linux
Rocky Linux 9
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/rockylinux/9/stable/x86_64/netify-lua_1.0.22-1.os9.x86_64.rpm
apt install ./netify-lua_1.0.22-1.os9.x86_64.rpm
Rocky Linux 8
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/rockylinux/8/stable/x86_64/netify-lua_1.0.22-1.os8.x86_64.rpm
yum install ./netify-lua_1.0.22-1.os8.x86_64.rpm
openSUSE Linux
openSUSE Leap 15.5
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/opensuse/15.5/stable/x86_64/netify-lua_1.0.22-1.os15.5.x86_64.rpm
zypper install ./netify-lua_1.0.22-1.os15.5.x86_64.rpm
Ubuntu
Ubuntu 24.04 - Noble
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/ubuntu/noble/binary-amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
Ubuntu 22.04 - Jammy
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/ubuntu/jammy/binary-amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
Ubuntu 20.04 - Focal
The Netify Lua Scripting Extension plugin is a licensed (proprietary) plugin. Instructions to access this plugin will have been provided to you by a Netify representative. Typically, the package will be available via a web link with Basic authentication protection. Example:
cd /tmp/
wget https://client:secret@download.netify.ai/5/ubuntu/focal/binary-amd64/netify-lua_1.0.22-1_amd64.deb
apt install ./netify-lua_1.0.22-1_amd64.deb
Configuration
Plugin Loader Configuration
All plugins are disabled by default, and the Netify Lua Scripting Extension Processor plugin is no different. To enable:
netifyd --enable-plugin proc-lua
Alternatively, you can edit /etc/netifyd/plugins.d/10-netify-proc-lua.conf and set enable to yes.
# Netify Lua Scripting Extension Processor Plugin Loader
# Copyright (C) 2024 eGloo Incorporated
#
##############################################################################
[proc-lua]
enable = yes
plugin_library = /usr/lib64/libnetify-proc-lua.so.0.0.0
conf_filename = ${path_state_persistent}/netify-proc-lua.json
# vim: set ft=dosini :
Plugin Configuration
Once the plugin has been enabled, it can be configured using the JSON configuration file specified in the plugin loader configuration. Let's look at a configuration sample to review the syntax and parts of the file.
{
"script": "${path_state_persistent}/netify-proc-lua.lua"
}
Property | script |
---|---|
Description | The location of the Lua script. |
Type | string |
Examples
Lua Sample Code
Send device discovery data to the Sink Socket plugin to a channel name devices
.
{
"script": "${path_state_persistent}/netify-proc-lua.lua"
}
lua-proc-lua.lua
-- Netify Lua Processor Example Script
-- Copyright (C) 2024 eGloo, Incorporated
FLOWS = { }
function TableToCSV(t)
local escape = function(s)
if string.find(s, '[,"]') then
s = '"' .. string.gsub(s, '"', '""') .. '"'
end
return s
end
local csv = ''
for _, r in ipairs(t) do
local row = ''
for _, c in ipairs(r) do
row = row .. ',' .. escape(c)
end
csv = csv .. string.sub(row, 2) .. "\n"
end
return csv
end
function ResetFlows()
FLOWS = {
{
"iface", "digest", "lower_mac", "lower_addr", "lower_port",
"upper_mac", "upper_addr", "upper_port", "ip_protocol",
"detected_protocol", "detected_application"
}
}
end
-- Process an Agent event.
function ProcessAgentEvent(event)
local message = 'Agent event: '
if event == NPP_EVENT_UPDATE_INIT then
message = message .. 'update'
elseif event == NPP_EVENT_UPDATE_COMPLETE then
message = message .. 'update complete'
if #FLOWS > 1 then
npp.dispatch(
'sink-log', { 'lua-csv' },
TableToCSV(FLOWS),
NPP_FORMAT_RAW,
NPP_COMPRESSOR_NONE
)
ResetFlows()
end
else
message = message .. string.format('unknown [%d]', event)
end
npp.debug(message)
end
-- Process a flow event.
function ProcessFlowEvent(event, flows)
if event ~= NPP_EVENT_DPI_COMPLETE then
return
end
for _, flow in ipairs(flows) do
table.insert(FLOWS,
{
flow['iface']['name'], flow['digest_mdata'],
flow['lower_mac'], flow['lower_addr'], flow['lower_port'],
flow['upper_mac'], flow['upper_addr'], flow['upper_port'],
flow['ip_protocol'], flow['detected_protocol'], flow['detected_application']
}
)
end
end
function ProcessFlowStats(flows)
local active_flows = 0
local total_bytes = 0
local lower_rate = 0.0
local upper_rate = 0.0
for _, flow in ipairs(flows) do
if flow['stats']['lower_bytes'] > 0 or flow['stats']['upper_bytes'] > 0 then
active_flows = active_flows + 1
total_bytes = total_bytes + flow['stats']['total_bytes']
lower_rate = lower_rate + flow['stats']['lower_rate']
upper_rate = upper_rate + flow['stats']['upper_rate']
end
end
npp.debug(
string.format(
"active flows: %d, total bytes: %d, lower rate: %.1f, upper rate: %.1f",
active_flows, total_bytes, lower_rate, upper_rate
)
)
end
ResetFlows()
npp.print('Netify Lua Processor Example: initialized')