3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "cpp_api/s_security.h"
25 #include "client/client.h"
33 #define SECURE_API(lib, name) \
34 lua_pushcfunction(L, sl_##lib##_##name); \
35 lua_setfield(L, -2, #name);
38 static inline void copy_safe(lua_State *L, const char *list[], unsigned len, int from=-2, int to=-1)
40 if (from < 0) from = lua_gettop(L) + from + 1;
41 if (to < 0) to = lua_gettop(L) + to + 1;
42 for (unsigned i = 0; i < (len / sizeof(list[0])); i++) {
43 lua_getfield(L, from, list[i]);
44 lua_setfield(L, to, list[i]);
48 // Pushes the original version of a library function on the stack, from the old version
49 static inline void push_original(lua_State *L, const char *lib, const char *func)
51 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
52 lua_getfield(L, -1, lib);
53 lua_remove(L, -2); // Remove globals_backup
54 lua_getfield(L, -1, func);
55 lua_remove(L, -2); // Remove lib
59 void ScriptApiSecurity::initializeSecurity()
61 static const char *whitelist[] = {
86 // Completely safe libraries
92 static const char *io_whitelist[] = {
100 static const char *os_whitelist[] = {
109 static const char *debug_whitelist[] = {
121 static const char *package_whitelist[] = {
128 static const char *jit_whitelist[] = {
142 lua_State *L = getStack();
144 // Backup globals to the registry
145 lua_getglobal(L, "_G");
146 lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
148 // Replace the global environment with an empty one
149 int thread = getThread(L);
151 setLuaEnv(L, thread);
154 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
155 int old_globals = lua_gettop(L);
158 // Copy safe base functions
159 lua_getglobal(L, "_G");
160 copy_safe(L, whitelist, sizeof(whitelist));
162 // And replace unsafe ones
163 SECURE_API(g, dofile);
165 SECURE_API(g, loadfile);
166 SECURE_API(g, loadstring);
167 SECURE_API(g, require);
171 // Copy safe IO functions
172 lua_getfield(L, old_globals, "io");
174 copy_safe(L, io_whitelist, sizeof(io_whitelist));
176 // And replace unsafe ones
177 //SECURE_API(io, open);
178 SECURE_API(io, input);
179 SECURE_API(io, output);
180 SECURE_API(io, lines);
182 lua_setglobal(L, "io");
183 lua_pop(L, 1); // Pop old IO
186 // Copy safe OS functions
187 lua_getfield(L, old_globals, "os");
189 copy_safe(L, os_whitelist, sizeof(os_whitelist));
191 // And replace unsafe ones
192 SECURE_API(os, remove);
193 SECURE_API(os, rename);
195 lua_setglobal(L, "os");
196 lua_pop(L, 1); // Pop old OS
199 // Copy safe debug functions
200 lua_getfield(L, old_globals, "debug");
202 copy_safe(L, debug_whitelist, sizeof(debug_whitelist));
203 lua_setglobal(L, "debug");
204 lua_pop(L, 1); // Pop old debug
207 // Copy safe package fields
208 lua_getfield(L, old_globals, "package");
210 copy_safe(L, package_whitelist, sizeof(package_whitelist));
211 lua_setglobal(L, "package");
212 lua_pop(L, 1); // Pop old package
215 // Copy safe jit functions, if they exist
216 lua_getfield(L, -1, "jit");
217 if (!lua_isnil(L, -1)) {
219 copy_safe(L, jit_whitelist, sizeof(jit_whitelist));
220 lua_setglobal(L, "jit");
222 lua_pop(L, 1); // Pop old jit
225 lua_pop(L, 1); // Pop globals_backup
228 void ScriptApiSecurity::initializeSecurityClient()
230 static const char *whitelist[] = {
247 // getmetatable can be used to escape the sandbox
255 // Completely safe libraries
261 static const char *os_whitelist[] = {
267 static const char *debug_whitelist[] = {
272 static const char *jit_whitelist[] = {
287 lua_State *L = getStack();
288 int thread = getThread(L);
290 // Backup globals to the registry
291 lua_getglobal(L, "_G");
292 lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
294 // create an empty environment
297 // Copy safe base functions
298 lua_getglobal(L, "_G");
299 lua_getfield(L, -2, "_G");
300 copy_safe(L, whitelist, sizeof(whitelist));
302 // And replace unsafe ones
303 SECURE_API(g, dofile);
305 SECURE_API(g, loadfile);
306 SECURE_API(g, loadstring);
307 SECURE_API(g, require);
310 // Copy safe OS functions
311 lua_getglobal(L, "os");
313 copy_safe(L, os_whitelist, sizeof(os_whitelist));
314 lua_setfield(L, -3, "os");
315 lua_pop(L, 1); // Pop old OS
318 // Copy safe debug functions
319 lua_getglobal(L, "debug");
321 copy_safe(L, debug_whitelist, sizeof(debug_whitelist));
322 lua_setfield(L, -3, "debug");
323 lua_pop(L, 1); // Pop old debug
327 // Copy safe jit functions, if they exist
328 lua_getglobal(L, "jit");
330 copy_safe(L, jit_whitelist, sizeof(jit_whitelist));
331 lua_setfield(L, -3, "jit");
332 lua_pop(L, 1); // Pop old jit
335 // Set the environment to the one we created earlier
336 setLuaEnv(L, thread);
339 int ScriptApiSecurity::getThread(lua_State *L)
341 #if LUA_VERSION_NUM <= 501
342 int is_main = lua_pushthread(L); // Push the main thread
343 FATAL_ERROR_IF(!is_main, "Security: ScriptApi's Lua state "
344 "isn't the main Lua thread!");
345 return lua_gettop(L);
350 void ScriptApiSecurity::createEmptyEnv(lua_State *L)
352 lua_newtable(L); // Create new environment
353 lua_pushvalue(L, -1);
354 lua_setfield(L, -2, "_G"); // Create the _G loop
357 void ScriptApiSecurity::setLuaEnv(lua_State *L, int thread)
359 #if LUA_VERSION_NUM >= 502 // Lua >= 5.2
360 // Set the global environment
361 lua_rawseti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS);
363 // Set the environment of the main thread
364 FATAL_ERROR_IF(!lua_setfenv(L, thread), "Security: Unable to set "
365 "environment of the main Lua thread!");
366 lua_pop(L, 1); // Pop thread
370 bool ScriptApiSecurity::isSecure(lua_State *L)
372 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
373 bool secure = !lua_isnil(L, -1);
378 bool ScriptApiSecurity::safeLoadString(lua_State *L, const std::string &code, const char *chunk_name)
380 if (code.size() > 0 && code[0] == LUA_SIGNATURE[0]) {
381 lua_pushliteral(L, "Bytecode prohibited when mod security is enabled.");
384 if (luaL_loadbuffer(L, code.data(), code.size(), chunk_name))
389 bool ScriptApiSecurity::safeLoadFile(lua_State *L, const char *path, const char *display_name)
397 chunk_name = const_cast<char *>("=stdin");
399 fp = fopen(path, "rb");
401 lua_pushfstring(L, "%s: %s", path, strerror(errno));
404 chunk_name = new char[strlen(display_name) + 2];
406 chunk_name[1] = '\0';
407 strcat(chunk_name, display_name);
411 int c = std::getc(fp);
413 // Skip the first line
414 while ((c = std::getc(fp)) != EOF && c != '\n') {}
417 start = std::ftell(fp);
421 int ret = std::fseek(fp, 0, SEEK_END);
423 lua_pushfstring(L, "%s: %s", path, strerror(errno));
426 delete [] chunk_name;
431 size_t size = std::ftell(fp) - start;
432 std::string code(size, '\0');
433 ret = std::fseek(fp, start, SEEK_SET);
435 lua_pushfstring(L, "%s: %s", path, strerror(errno));
438 delete [] chunk_name;
443 size_t num_read = std::fread(&code[0], 1, size, fp);
446 if (num_read != size) {
447 lua_pushliteral(L, "Error reading file to load.");
449 delete [] chunk_name;
453 bool result = safeLoadString(L, code, chunk_name);
455 delete [] chunk_name;
460 bool ScriptApiSecurity::checkPath(lua_State *L, const char *path,
461 bool write_required, bool *write_allowed)
464 *write_allowed = false;
466 std::string str; // Transient
468 std::string abs_path = fs::AbsolutePath(path);
470 if (!abs_path.empty()) {
471 // Don't allow accessing the settings file
472 str = fs::AbsolutePath(g_settings_path);
473 if (str == abs_path) return false;
476 // If we couldn't find the absolute path (path doesn't exist) then
477 // try removing the last components until it works (to allow
478 // non-existent files/folders for mkdir).
479 std::string cur_path = path;
481 while (abs_path.empty() && !cur_path.empty()) {
482 std::string component;
483 cur_path = fs::RemoveLastPathComponent(cur_path, &component);
484 if (component == "..") {
485 // Parent components can't be allowed or we could allow something like
486 // /home/user/minetest/worlds/foo/noexist/../../../../../../etc/passwd.
487 // If we have previous non-relative elements in the path we might be
488 // able to remove them so that things like worlds/foo/noexist/../auth.txt
489 // could be allowed, but those paths will be interpreted as nonexistent
490 // by the operating system anyways.
493 removed.append(component).append(removed.empty() ? "" : DIR_DELIM + removed);
494 abs_path = fs::AbsolutePath(cur_path);
496 if (abs_path.empty())
498 // Add the removed parts back so that you can't, eg, create a
499 // directory in worldmods if worldmods doesn't exist.
500 if (!removed.empty())
501 abs_path += DIR_DELIM + removed;
503 // Get server from registry
504 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
505 ScriptApiBase *script;
506 #if INDIRECT_SCRIPTAPI_RIDX
507 script = (ScriptApiBase *) *(void**)(lua_touserdata(L, -1));
509 script = (ScriptApiBase *) lua_touserdata(L, -1);
512 const IGameDef *gamedef = script->getGameDef();
517 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
518 if (lua_isstring(L, -1)) {
519 std::string mod_name = readParam<std::string>(L, -1);
521 // Builtin can access anything
522 if (mod_name == BUILTIN_MOD_NAME) {
523 if (write_allowed) *write_allowed = true;
527 // Allow paths in mod path
528 // Don't bother if write access isn't important, since it will be handled later
529 if (write_required || write_allowed != NULL) {
530 const ModSpec *mod = gamedef->getModSpec(mod_name);
532 str = fs::AbsolutePath(mod->path);
533 if (!str.empty() && fs::PathStartsWith(abs_path, str)) {
534 if (write_allowed) *write_allowed = true;
540 lua_pop(L, 1); // Pop mod name
542 // Allow read-only access to all mod directories
543 if (!write_required) {
544 const std::vector<ModSpec> &mods = gamedef->getMods();
545 for (const ModSpec &mod : mods) {
546 str = fs::AbsolutePath(mod.path);
547 if (!str.empty() && fs::PathStartsWith(abs_path, str)) {
553 str = fs::AbsolutePath(gamedef->getWorldPath());
555 // Don't allow access to other paths in the world mod/game path.
556 // These have to be blocked so you can't override a trusted mod
557 // by creating a mod with the same name in a world mod directory.
558 // We add to the absolute path of the world instead of getting
559 // the absolute paths directly because that won't work if they
561 if (fs::PathStartsWith(abs_path, str + DIR_DELIM + "worldmods") ||
562 fs::PathStartsWith(abs_path, str + DIR_DELIM + "game")) {
565 // Allow all other paths in world path
566 if (fs::PathStartsWith(abs_path, str)) {
567 if (write_allowed) *write_allowed = true;
572 // Default to disallowing
577 int ScriptApiSecurity::sl_g_dofile(lua_State *L)
579 int nret = sl_g_loadfile(L);
582 // code after this function isn't executed
584 int top_precall = lua_gettop(L);
585 lua_call(L, 0, LUA_MULTRET);
586 // Return number of arguments returned by the function,
587 // adjusting for the function being poped.
588 return lua_gettop(L) - (top_precall - 1);
592 int ScriptApiSecurity::sl_g_load(lua_State *L)
597 const char *chunk_name = "=(load)";
599 luaL_checktype(L, 1, LUA_TFUNCTION);
600 if (!lua_isnone(L, 2)) {
601 luaL_checktype(L, 2, LUA_TSTRING);
602 chunk_name = lua_tostring(L, 2);
608 int t = lua_type(L, -1);
613 if (t != LUA_TSTRING) {
615 lua_pushliteral(L, "Loader didn't return a string");
618 buf = lua_tolstring(L, -1, &len);
619 code += std::string(buf, len);
620 lua_pop(L, 1); // Pop return value
622 if (!safeLoadString(L, code, chunk_name)) {
631 int ScriptApiSecurity::sl_g_loadfile(lua_State *L)
634 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
635 #if INDIRECT_SCRIPTAPI_RIDX
636 ScriptApiBase *script = (ScriptApiBase *) *(void**)(lua_touserdata(L, -1));
638 ScriptApiBase *script = (ScriptApiBase *) lua_touserdata(L, -1);
642 // Client implementation
643 if (script->getType() == ScriptingType::Client) {
644 std::string path = readParam<std::string>(L, 1);
645 const std::string *contents = script->getClient()->getModFile(path);
647 std::string error_msg = "Coudln't find script called: " + path;
649 lua_pushstring(L, error_msg.c_str());
653 std::string chunk_name = "@" + path;
654 if (!safeLoadString(L, *contents, chunk_name.c_str())) {
663 // Server implementation
664 const char *path = NULL;
665 if (lua_isstring(L, 1)) {
666 path = lua_tostring(L, 1);
667 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
670 if (!safeLoadFile(L, path)) {
680 int ScriptApiSecurity::sl_g_loadstring(lua_State *L)
682 const char *chunk_name = "=(load)";
684 luaL_checktype(L, 1, LUA_TSTRING);
685 if (!lua_isnone(L, 2)) {
686 luaL_checktype(L, 2, LUA_TSTRING);
687 chunk_name = lua_tostring(L, 2);
691 const char *code = lua_tolstring(L, 1, &size);
692 std::string code_s(code, size);
694 if (!safeLoadString(L, code_s, chunk_name)) {
703 int ScriptApiSecurity::sl_g_require(lua_State *L)
705 lua_pushliteral(L, "require() is disabled when mod security is on.");
710 int ScriptApiSecurity::sl_io_open(lua_State *L)
712 bool with_mode = lua_gettop(L) > 1;
714 luaL_checktype(L, 1, LUA_TSTRING);
715 const char *path = lua_tostring(L, 1);
717 bool write_requested = false;
719 luaL_checktype(L, 2, LUA_TSTRING);
720 const char *mode = lua_tostring(L, 2);
721 write_requested = strchr(mode, 'w') != NULL ||
722 strchr(mode, '+') != NULL ||
723 strchr(mode, 'a') != NULL;
725 CHECK_SECURE_PATH_INTERNAL(L, path, write_requested, NULL);
727 push_original(L, "io", "open");
733 lua_call(L, with_mode ? 2 : 1, 2);
738 int ScriptApiSecurity::sl_io_input(lua_State *L)
740 if (lua_isstring(L, 1)) {
741 const char *path = lua_tostring(L, 1);
742 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
745 push_original(L, "io", "input");
752 int ScriptApiSecurity::sl_io_output(lua_State *L)
754 if (lua_isstring(L, 1)) {
755 const char *path = lua_tostring(L, 1);
756 CHECK_SECURE_PATH_INTERNAL(L, path, true, NULL);
759 push_original(L, "io", "output");
766 int ScriptApiSecurity::sl_io_lines(lua_State *L)
768 if (lua_isstring(L, 1)) {
769 const char *path = lua_tostring(L, 1);
770 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
773 int top_precall = lua_gettop(L);
774 push_original(L, "io", "lines");
776 lua_call(L, 1, LUA_MULTRET);
777 // Return number of arguments returned by the function,
778 // adjusting for the function being poped.
779 return lua_gettop(L) - top_precall;
783 int ScriptApiSecurity::sl_os_rename(lua_State *L)
785 luaL_checktype(L, 1, LUA_TSTRING);
786 const char *path1 = lua_tostring(L, 1);
787 CHECK_SECURE_PATH_INTERNAL(L, path1, true, NULL);
789 luaL_checktype(L, 2, LUA_TSTRING);
790 const char *path2 = lua_tostring(L, 2);
791 CHECK_SECURE_PATH_INTERNAL(L, path2, true, NULL);
793 push_original(L, "os", "rename");
801 int ScriptApiSecurity::sl_os_remove(lua_State *L)
803 luaL_checktype(L, 1, LUA_TSTRING);
804 const char *path = lua_tostring(L, 1);
805 CHECK_SECURE_PATH_INTERNAL(L, path, true, NULL);
807 push_original(L, "os", "remove");