ntopng/include/LuaEngine.h
2026-03-15 10:50:50 +01:00

247 lines
7.6 KiB
C++

/*
*
* (C) 2013-26 - ntop.org
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#ifndef _LUA_H_
#define _LUA_H_
#include "ntop_includes.h"
/** @defgroup LuaEngine LuaEngine
* Main ntopng lua group.
*/
/* ******************************* */
/** @class LuaEngine
* @brief Main class of lua.
*
* @ingroup LuaEngine
*
*/
class ThreadedActivity;
class ThreadedActivityStats;
class LuaEngine {
protected:
lua_State* L; /**< The LuaEngine state. */
char* loaded_script_path;
bool is_system_vm; /* Executed by callbacks */
std::string cloud_string;
std::set<std::string> require_list;
size_t mem_used;
u_int32_t start_epoch;
NtopngLuaContext* lua_context;
void lua_register_classes(lua_State* L, LuaEngineMode mode);
public:
/**
* @brief A Constructor
* @details Creating a new lua state.
*
* @return A new instance of lua.
*/
LuaEngine();
/**
* @brief A Destructor.
*
*/
virtual ~LuaEngine();
/* Set Hosts and Networks into the Lua context */
void setHost(Host* h);
void setNetwork(NetworkStats* ns);
void setFlow(Flow* f);
void setThreadedActivityData(const ThreadedActivity* ta,
ThreadedActivityStats* tas, time_t deadline);
Host* getHost();
NetworkInterface* getNetworkInterface();
NetworkStats* getNetwork();
int load_script(char* script_path, LuaEngineMode mode,
NetworkInterface* iface);
int run_loaded_script();
/**
* @brief Handling of request info of script.
* @details Read from the request the parameters and put the GET parameters
* and the _SESSION parameters into the environment. Once all parameters have
* been load we running the script.
*
* @param conn This structure contains handle for the individual connection.
* @param request_info This structure contains information about the HTTP
* request.
* @param script_path Full path of lua script.
* @return The result of the execution of the script.
*/
int handle_script_request(struct mg_connection* conn,
const struct mg_request_info* request_info,
char* script_path, bool* attack_attempt,
const char* user, const char* group,
const char* session_csrf, bool localuser);
bool setParamsTable(lua_State* vm, const struct mg_request_info* request_info,
const char* table_name, const char* query) const;
void luaRegister(lua_State* L, const char* class_name,
luaL_Reg* class_methods);
inline lua_State* getState() const { return (L); }
bool switchInterface(struct lua_State* vm, const char* ifid,
const char* observation_point_id, const char* user,
const char* group, const char* session);
void setInterface(const char* user, char* const ifname, u_int16_t ifname_len,
bool* const is_allowed) const;
inline void setAsSystemVM() { is_system_vm = true; }
inline bool isSystemVM() { return (is_system_vm); }
void pushResultString(char* str);
void pushResultNumber(float f);
const char* getCloudString() { return (cloud_string.c_str()); }
inline lua_State* getState() { return (L); }
inline size_t getMemUsed() { return (mem_used); }
inline void incMemUsed(size_t v) { mem_used += v; }
bool require(std::string name);
};
/**
* @brief Push string value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
extern void lua_push_str_table_entry(lua_State* L, const char* key,
const char* value);
/**
* @brief Push string value to table entry specify the key and lenght.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
* @param value_len lenght of the value field
*/
extern void lua_push_str_len_table_entry(lua_State* L, const char* key,
const char* value,
unsigned int value_len);
/**
* @brief Push null value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
*/
extern void lua_push_nil_table_entry(lua_State* L, const char* key);
/**
* @brief Push int value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
extern void lua_push_uint64_table_entry(lua_State* L, const char* key,
u_int64_t value);
/**
* @brief Push int64 value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
void lua_push_int64_table_entry(lua_State* L, const char* key, int64_t value);
/**
* @brief Push int32 value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
void lua_push_int32_table_entry(lua_State* L, const char* key, int32_t value);
/**
* @brief Push uint32 value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
void lua_push_uint32_table_entry(lua_State* L, const char* key,
u_int32_t value);
/**
* @brief Push bool value to table entry specify the key.
* @details Using LUA_NUMBER (double: 64 bit) in place of LUA_INTEGER
* (ptrdiff_t: 32 or 64 bit according to the platform) to handle big counters.
* (luaconf.h)
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
extern void lua_push_bool_table_entry(lua_State* L, const char* key,
bool value);
/**
* @brief Push float value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
extern void lua_push_float_table_entry(lua_State* L, const char* key,
float value);
/**
* @brief Push boolean value to table entry specify the key.
*
* @param L The lua state.
* @param key The key of hash table.
* @param value The value of hash table.
*/
extern void lua_push_bool_table_entry(lua_State* L, const char* key,
bool value);
int ntop_lua_check(lua_State* vm, const char* func, int pos, int expected_type);
/**
* @brief Checks the lua stack after a C function is called
*
* @param vm The lua state.
* @param function_name The function name that triggered the error
* @param val The return value
*/
extern int ntop_lua_return_value(lua_State* vm, const char* function_name,
int val);
extern void get_host_vlan_info(char* lua_ip, char** host_ip, u_int16_t* vlan_id,
char* buf, u_int buf_len);
#endif /* _LUA_H_ */