ScriptApiSecurity Class Reference

#include <s_security.h>

Inheritance diagram for ScriptApiSecurity:

Collaboration diagram for ScriptApiSecurity:

Public Member Functions
int	getThread (lua_State *L)
void	createEmptyEnv (lua_State *L)
void	setLuaEnv (lua_State *L, int thread)
void	initializeSecurity ()
void	initializeSecurityClient ()
Public Member Functions inherited from ScriptApiBase
	ScriptApiBase (ScriptingType type)
	ScriptApiBase ()
virtual	~ScriptApiBase ()
	DISABLE_CLASS_COPY (ScriptApiBase)
void	loadMod (const std::string &script_path, const std::string &mod_name)
void	loadScript (const std::string &script_path)
void	loadModFromMemory (const std::string &mod_name)
void	runCallbacksRaw (int nargs, RunCallbacksMode mode, const char *fxn)
void	addObjectReference (ServerActiveObject *cobj)
void	removeObjectReference (ServerActiveObject *cobj)
IGameDef *	getGameDef ()
Server *	getServer ()
ScriptingType	getType ()
Client *	getClient ()
std::string	getOrigin ()
void	setOriginDirect (const char *origin)
void	setOriginFromTableRaw (int index, const char *fxn)
void	clientOpenLibs (lua_State *L)

Static Public Member Functions
static bool	isSecure (lua_State *L)
static bool	safeLoadString (lua_State *L, const std::string &code, const char *chunk_name)
static bool	safeLoadFile (lua_State *L, const char *path, const char *display_name=NULL)
static bool	checkPath (lua_State *L, const char *path, bool write_required, bool *write_allowed=NULL)

Static Private Member Functions
static int	sl_g_dofile (lua_State *L)
static int	sl_g_load (lua_State *L)
static int	sl_g_loadfile (lua_State *L)
static int	sl_g_loadstring (lua_State *L)
static int	sl_g_require (lua_State *L)
static int	sl_io_open (lua_State *L)
static int	sl_io_input (lua_State *L)
static int	sl_io_output (lua_State *L)
static int	sl_io_lines (lua_State *L)
static int	sl_os_rename (lua_State *L)
static int	sl_os_remove (lua_State *L)

Additional Inherited Members
Protected Member Functions inherited from ScriptApiBase
lua_State *	getStack ()
void	realityCheck ()
void	scriptError (int result, const char *fxn)
void	stackDump (std::ostream &o)
void	setGameDef (IGameDef *gamedef)
Environment *	getEnv ()
void	setEnv (Environment *env)
GUIEngine *	getGuiEngine ()
void	setGuiEngine (GUIEngine *guiengine)
void	objectrefGetOrCreate (lua_State *L, ServerActiveObject *cobj)
void	pushPlayerHPChangeReason (lua_State *L, const PlayerHPChangeReason &reason)
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
Static Protected Member Functions inherited from LuaHelper
static bool	isNaN (lua_State *L, int idx)
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua State L and index. More...
template<typename T >
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua State L and index. More...
Protected Attributes inherited from ScriptApiBase
std::recursive_mutex	m_luastackmutex
std::string	m_last_run_mod
bool	m_secure = false
int	m_lock_recursion_count {}
std::thread::id	m_owning_thread

Member Function Documentation

checkPath()

bool ScriptApiSecurity::checkPath ( lua_State *  L, const char *  path, bool  write_required, bool *  write_allowed = NULL  )

static

References fs::AbsolutePath(), BUILTIN_MOD_NAME, CUSTOM_RIDX_CURRENT_MOD_NAME, CUSTOM_RIDX_SCRIPTAPI, DIR_DELIM, g_settings_path, ScriptApiBase::getGameDef(), IGameDef::getMods(), IGameDef::getModSpec(), IGameDef::getWorldPath(), ModSpec::path, fs::PathStartsWith(), and fs::RemoveLastPathComponent().

Here is the call graph for this function:

createEmptyEnv()

void ScriptApiSecurity::createEmptyEnv

(

lua_State *

L

)

Referenced by initializeSecurity(), and initializeSecurityClient().

Here is the caller graph for this function:

getThread()

int ScriptApiSecurity::getThread

(

lua_State *

L

)

References FATAL_ERROR_IF.

Referenced by initializeSecurity(), and initializeSecurityClient().

Here is the caller graph for this function:

initializeSecurity()

void ScriptApiSecurity::initializeSecurity

(

)

References copy_safe(), createEmptyEnv(), CUSTOM_RIDX_GLOBALS_BACKUP, ScriptApiBase::getStack(), getThread(), ScriptApiBase::m_secure, SECURE_API, and setLuaEnv().

Referenced by ServerScripting::ServerScripting().

Here is the call graph for this function:

Here is the caller graph for this function:

initializeSecurityClient()

void ScriptApiSecurity::initializeSecurityClient

(

)

References copy_safe(), createEmptyEnv(), ScriptApiBase::getStack(), getThread(), ScriptApiBase::m_secure, SECURE_API, and setLuaEnv().

Referenced by ClientScripting::ClientScripting().

Here is the call graph for this function:

Here is the caller graph for this function:

isSecure()

bool ScriptApiSecurity::isSecure ( lua_State *  L )

static

References CUSTOM_RIDX_GLOBALS_BACKUP.

Referenced by ModApiUtil::l_request_insecure_environment().

Here is the caller graph for this function:

safeLoadFile()

bool ScriptApiSecurity::safeLoadFile ( lua_State *  L, const char *  path, const char *  display_name = NULL  )

static

References safeLoadString().

Referenced by ScriptApiBase::loadScript(), and sl_g_loadfile().

Here is the call graph for this function:

Here is the caller graph for this function:

safeLoadString()

bool ScriptApiSecurity::safeLoadString ( lua_State *  L, const std::string &  code, const char *  chunk_name  )

static

Referenced by ScriptApiBase::loadModFromMemory(), safeLoadFile(), sl_g_load(), sl_g_loadfile(), and sl_g_loadstring().

Here is the caller graph for this function:

setLuaEnv()

void ScriptApiSecurity::setLuaEnv	(	lua_State *	L,
		int	thread
	)

References FATAL_ERROR_IF.

Referenced by initializeSecurity(), and initializeSecurityClient().

Here is the caller graph for this function:

sl_g_dofile()

int ScriptApiSecurity::sl_g_dofile ( lua_State *  L )

staticprivate

References sl_g_loadfile().

Here is the call graph for this function:

sl_g_load()

int ScriptApiSecurity::sl_g_load ( lua_State *  L )

staticprivate

References safeLoadString().

Here is the call graph for this function:

sl_g_loadfile()

int ScriptApiSecurity::sl_g_loadfile ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, Client, CUSTOM_RIDX_SCRIPTAPI, ScriptApiBase::getClient(), Client::getModFile(), ScriptApiBase::getType(), safeLoadFile(), and safeLoadString().

Referenced by sl_g_dofile().

Here is the call graph for this function:

Here is the caller graph for this function:

sl_g_loadstring()

int ScriptApiSecurity::sl_g_loadstring ( lua_State *  L )

staticprivate

References safeLoadString().

Here is the call graph for this function:

sl_g_require()

int ScriptApiSecurity::sl_g_require ( lua_State *  L )

staticprivate

sl_io_input()

int ScriptApiSecurity::sl_io_input ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

sl_io_lines()

int ScriptApiSecurity::sl_io_lines ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

sl_io_open()

int ScriptApiSecurity::sl_io_open ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

sl_io_output()

int ScriptApiSecurity::sl_io_output ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

sl_os_remove()

int ScriptApiSecurity::sl_os_remove ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

sl_os_rename()

int ScriptApiSecurity::sl_os_rename ( lua_State *  L )

staticprivate

References CHECK_SECURE_PATH_INTERNAL, and push_original().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• script/cpp_api/s_security.h
• script/cpp_api/s_security.cpp