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[] = {
99 static const char *os_whitelist[] = {
108 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[] = {
254 // Completely safe libraries
260 static const char *os_whitelist[] = {
266 static const char *debug_whitelist[] = {
271 static const char *jit_whitelist[] = {
286 lua_State *L = getStack();
287 int thread = getThread(L);
289 // create an empty environment
292 // Copy safe base functions
293 lua_getglobal(L, "_G");
294 lua_getfield(L, -2, "_G");
295 copy_safe(L, whitelist, sizeof(whitelist));
297 // And replace unsafe ones
298 SECURE_API(g, dofile);
300 SECURE_API(g, loadfile);
301 SECURE_API(g, loadstring);
302 SECURE_API(g, require);
307 // Copy safe OS functions
308 lua_getglobal(L, "os");
310 copy_safe(L, os_whitelist, sizeof(os_whitelist));
311 lua_setfield(L, -3, "os");
312 lua_pop(L, 1); // Pop old OS
315 // Copy safe debug functions
316 lua_getglobal(L, "debug");
318 copy_safe(L, debug_whitelist, sizeof(debug_whitelist));
319 lua_setfield(L, -3, "debug");
320 lua_pop(L, 1); // Pop old debug
323 // Copy safe jit functions, if they exist
324 lua_getglobal(L, "jit");
326 copy_safe(L, jit_whitelist, sizeof(jit_whitelist));
327 lua_setfield(L, -3, "jit");
328 lua_pop(L, 1); // Pop old jit
331 // Set the environment to the one we created earlier
332 setLuaEnv(L, thread);
335 int ScriptApiSecurity::getThread(lua_State *L)
337 #if LUA_VERSION_NUM <= 501
338 int is_main = lua_pushthread(L); // Push the main thread
339 FATAL_ERROR_IF(!is_main, "Security: ScriptApi's Lua state "
340 "isn't the main Lua thread!");
341 return lua_gettop(L);
346 void ScriptApiSecurity::createEmptyEnv(lua_State *L)
348 lua_newtable(L); // Create new environment
349 lua_pushvalue(L, -1);
350 lua_setfield(L, -2, "_G"); // Create the _G loop
353 void ScriptApiSecurity::setLuaEnv(lua_State *L, int thread)
355 #if LUA_VERSION_NUM >= 502 // Lua >= 5.2
356 // Set the global environment
357 lua_rawseti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS);
359 // Set the environment of the main thread
360 FATAL_ERROR_IF(!lua_setfenv(L, thread), "Security: Unable to set "
361 "environment of the main Lua thread!");
362 lua_pop(L, 1); // Pop thread
366 bool ScriptApiSecurity::isSecure(lua_State *L)
368 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_GLOBALS_BACKUP);
369 bool secure = !lua_isnil(L, -1);
375 #define CHECK_FILE_ERR(ret, fp) \
377 lua_pushfstring(L, "%s: %s", path, strerror(errno)); \
378 if (fp) std::fclose(fp); \
383 bool ScriptApiSecurity::safeLoadFile(lua_State *L, const char *path, const char *display_name)
391 chunk_name = const_cast<char *>("=stdin");
393 fp = fopen(path, "rb");
395 lua_pushfstring(L, "%s: %s", path, strerror(errno));
398 chunk_name = new char[strlen(display_name) + 2];
400 chunk_name[1] = '\0';
401 strcat(chunk_name, display_name);
405 int c = std::getc(fp);
407 // Skip the first line
408 while ((c = std::getc(fp)) != EOF && c != '\n');
409 if (c == '\n') c = std::getc(fp);
410 start = std::ftell(fp);
413 if (c == LUA_SIGNATURE[0]) {
414 lua_pushliteral(L, "Bytecode prohibited when mod security is enabled.");
417 delete [] chunk_name;
423 int ret = std::fseek(fp, 0, SEEK_END);
425 lua_pushfstring(L, "%s: %s", path, strerror(errno));
428 delete [] chunk_name;
433 size_t size = std::ftell(fp) - start;
434 char *code = new char[size];
435 ret = std::fseek(fp, start, SEEK_SET);
437 lua_pushfstring(L, "%s: %s", path, strerror(errno));
441 delete [] chunk_name;
446 size_t num_read = std::fread(code, 1, size, fp);
450 if (num_read != size) {
451 lua_pushliteral(L, "Error reading file to load.");
454 delete [] chunk_name;
459 if (luaL_loadbuffer(L, code, size, chunk_name)) {
467 delete [] chunk_name;
473 bool ScriptApiSecurity::checkPath(lua_State *L, const char *path,
474 bool write_required, bool *write_allowed)
477 *write_allowed = false;
479 std::string str; // Transient
481 std::string abs_path = fs::AbsolutePath(path);
483 if (!abs_path.empty()) {
484 // Don't allow accessing the settings file
485 str = fs::AbsolutePath(g_settings_path);
486 if (str == abs_path) return false;
489 // If we couldn't find the absolute path (path doesn't exist) then
490 // try removing the last components until it works (to allow
491 // non-existent files/folders for mkdir).
492 std::string cur_path = path;
494 while (abs_path.empty() && !cur_path.empty()) {
495 std::string component;
496 cur_path = fs::RemoveLastPathComponent(cur_path, &component);
497 if (component == "..") {
498 // Parent components can't be allowed or we could allow something like
499 // /home/user/minetest/worlds/foo/noexist/../../../../../../etc/passwd.
500 // If we have previous non-relative elements in the path we might be
501 // able to remove them so that things like worlds/foo/noexist/../auth.txt
502 // could be allowed, but those paths will be interpreted as nonexistent
503 // by the operating system anyways.
506 removed.append(component).append(removed.empty() ? "" : DIR_DELIM + removed);
507 abs_path = fs::AbsolutePath(cur_path);
509 if (abs_path.empty())
511 // Add the removed parts back so that you can't, eg, create a
512 // directory in worldmods if worldmods doesn't exist.
513 if (!removed.empty())
514 abs_path += DIR_DELIM + removed;
516 // Get server from registry
517 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
518 ScriptApiBase *script = (ScriptApiBase *) lua_touserdata(L, -1);
520 const IGameDef *gamedef = script->getGameDef();
525 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
526 if (lua_isstring(L, -1)) {
527 std::string mod_name = readParam<std::string>(L, -1);
529 // Builtin can access anything
530 if (mod_name == BUILTIN_MOD_NAME) {
531 if (write_allowed) *write_allowed = true;
535 // Allow paths in mod path
536 // Don't bother if write access isn't important, since it will be handled later
537 if (write_required || write_allowed != NULL) {
538 const ModSpec *mod = gamedef->getModSpec(mod_name);
540 str = fs::AbsolutePath(mod->path);
541 if (!str.empty() && fs::PathStartsWith(abs_path, str)) {
542 if (write_allowed) *write_allowed = true;
548 lua_pop(L, 1); // Pop mod name
550 // Allow read-only access to all mod directories
551 if (!write_required) {
552 const std::vector<ModSpec> &mods = gamedef->getMods();
553 for (const ModSpec &mod : mods) {
554 str = fs::AbsolutePath(mod.path);
555 if (!str.empty() && fs::PathStartsWith(abs_path, str)) {
561 str = fs::AbsolutePath(gamedef->getWorldPath());
563 // Don't allow access to other paths in the world mod/game path.
564 // These have to be blocked so you can't override a trusted mod
565 // by creating a mod with the same name in a world mod directory.
566 // We add to the absolute path of the world instead of getting
567 // the absolute paths directly because that won't work if they
569 if (fs::PathStartsWith(abs_path, str + DIR_DELIM + "worldmods") ||
570 fs::PathStartsWith(abs_path, str + DIR_DELIM + "game")) {
573 // Allow all other paths in world path
574 if (fs::PathStartsWith(abs_path, str)) {
575 if (write_allowed) *write_allowed = true;
580 // Default to disallowing
585 int ScriptApiSecurity::sl_g_dofile(lua_State *L)
587 int nret = sl_g_loadfile(L);
590 // code after this function isn't executed
592 int top_precall = lua_gettop(L);
593 lua_call(L, 0, LUA_MULTRET);
594 // Return number of arguments returned by the function,
595 // adjusting for the function being poped.
596 return lua_gettop(L) - (top_precall - 1);
600 int ScriptApiSecurity::sl_g_load(lua_State *L)
605 const char *chunk_name = "=(load)";
607 luaL_checktype(L, 1, LUA_TFUNCTION);
608 if (!lua_isnone(L, 2)) {
609 luaL_checktype(L, 2, LUA_TSTRING);
610 chunk_name = lua_tostring(L, 2);
616 int t = lua_type(L, -1);
621 if (t != LUA_TSTRING) {
623 lua_pushliteral(L, "Loader didn't return a string");
626 buf = lua_tolstring(L, -1, &len);
627 code += std::string(buf, len);
628 lua_pop(L, 1); // Pop return value
630 if (code[0] == LUA_SIGNATURE[0]) {
632 lua_pushliteral(L, "Bytecode prohibited when mod security is enabled.");
635 if (luaL_loadbuffer(L, code.data(), code.size(), chunk_name)) {
637 lua_insert(L, lua_gettop(L) - 1);
644 int ScriptApiSecurity::sl_g_loadfile(lua_State *L)
647 lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
648 ScriptApiBase *script = (ScriptApiBase *) lua_touserdata(L, -1);
651 if (script->getType() == ScriptingType::Client) {
652 std::string display_path = readParam<std::string>(L, 1);
653 const std::string *path = script->getClient()->getModFile(display_path);
655 std::string error_msg = "Coudln't find script called:" + display_path;
657 lua_pushstring(L, error_msg.c_str());
660 if (!safeLoadFile(L, path->c_str(), display_path.c_str())) {
668 const char *path = NULL;
669 if (lua_isstring(L, 1)) {
670 path = lua_tostring(L, 1);
671 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
674 if (!safeLoadFile(L, path)) {
684 int ScriptApiSecurity::sl_g_loadstring(lua_State *L)
686 const char *chunk_name = "=(load)";
688 luaL_checktype(L, 1, LUA_TSTRING);
689 if (!lua_isnone(L, 2)) {
690 luaL_checktype(L, 2, LUA_TSTRING);
691 chunk_name = lua_tostring(L, 2);
695 const char *code = lua_tolstring(L, 1, &size);
697 if (size > 0 && code[0] == LUA_SIGNATURE[0]) {
699 lua_pushliteral(L, "Bytecode prohibited when mod security is enabled.");
702 if (luaL_loadbuffer(L, code, size, chunk_name)) {
704 lua_insert(L, lua_gettop(L) - 1);
711 int ScriptApiSecurity::sl_g_require(lua_State *L)
713 lua_pushliteral(L, "require() is disabled when mod security is on.");
718 int ScriptApiSecurity::sl_io_open(lua_State *L)
720 bool with_mode = lua_gettop(L) > 1;
722 luaL_checktype(L, 1, LUA_TSTRING);
723 const char *path = lua_tostring(L, 1);
725 bool write_requested = false;
727 luaL_checktype(L, 2, LUA_TSTRING);
728 const char *mode = lua_tostring(L, 2);
729 write_requested = strchr(mode, 'w') != NULL ||
730 strchr(mode, '+') != NULL ||
731 strchr(mode, 'a') != NULL;
733 CHECK_SECURE_PATH_INTERNAL(L, path, write_requested, NULL);
735 push_original(L, "io", "open");
741 lua_call(L, with_mode ? 2 : 1, 2);
746 int ScriptApiSecurity::sl_io_input(lua_State *L)
748 if (lua_isstring(L, 1)) {
749 const char *path = lua_tostring(L, 1);
750 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
753 push_original(L, "io", "input");
760 int ScriptApiSecurity::sl_io_output(lua_State *L)
762 if (lua_isstring(L, 1)) {
763 const char *path = lua_tostring(L, 1);
764 CHECK_SECURE_PATH_INTERNAL(L, path, true, NULL);
767 push_original(L, "io", "output");
774 int ScriptApiSecurity::sl_io_lines(lua_State *L)
776 if (lua_isstring(L, 1)) {
777 const char *path = lua_tostring(L, 1);
778 CHECK_SECURE_PATH_INTERNAL(L, path, false, NULL);
781 int top_precall = lua_gettop(L);
782 push_original(L, "io", "lines");
784 lua_call(L, 1, LUA_MULTRET);
785 // Return number of arguments returned by the function,
786 // adjusting for the function being poped.
787 return lua_gettop(L) - top_precall;
791 int ScriptApiSecurity::sl_os_rename(lua_State *L)
793 luaL_checktype(L, 1, LUA_TSTRING);
794 const char *path1 = lua_tostring(L, 1);
795 CHECK_SECURE_PATH_INTERNAL(L, path1, true, NULL);
797 luaL_checktype(L, 2, LUA_TSTRING);
798 const char *path2 = lua_tostring(L, 2);
799 CHECK_SECURE_PATH_INTERNAL(L, path2, true, NULL);
801 push_original(L, "os", "rename");
809 int ScriptApiSecurity::sl_os_remove(lua_State *L)
811 luaL_checktype(L, 1, LUA_TSTRING);
812 const char *path = lua_tostring(L, 1);
813 CHECK_SECURE_PATH_INTERNAL(L, path, true, NULL);
815 push_original(L, "os", "remove");