priv_wrapper-1.0.1/README.install000644 001750 000144 00000003562 14324463127 016552 0ustar00asnusers000000 000000 Obtaining the sources ===================== Source tarballs for priv_wrapper can be downloaded from https://ftp.samba.org/pub/cwrap/ The source code repository for priv wrapper is located under git://git.samba.org/priv_wrapper.git To create a local copy, run $ git clone git://git.samba.org/priv_wrapper.git $ cd priv_wrapper Building from sources ===================== priv_wrapper uses cmake (www.cmake.org) as its build system. In an unpacked sources base directory, create a directory to contain the build results, e.g. $ mkdir obj $ cd obj Note that "obj" is just an example. The directory can be named arbitrarily. Next, run cmake to configure the build, e.g. $ cmake -DCMAKE_INSTALL_PREFIX= .. or on a 64 bit red hat system: $ cmake -DCMAKE_INSTALL_PREFIX= -DLIB_SUFFIX=64 .. The "" should be replaced by the intended installation target prefix directory, typically /usr or /usr/local. Note that the target directory does not have to be a direct or indirect subdirectory of the source base directory: It can be an arbitrary directory in the system. In the general case, ".." has to be replaced by a relative or absolute path of the source base directory in the "cmake" command line. One can control the build type with "-DCMAKE_BUILD_TYPE=" where can be one of Debug, Release, RelWithDebInfo, and some more (see cmake.org). The default is "RelWithDebInfo". After configuring with cmake, run the build with $ make Unit testing ============ In order to support running the test suite after building, the cmocka unit test framework needs to be installed (cmocka.org), and you need to specify -DUNIT_TESTING=ON in the cmake run. After running "make", $ make test runs the test suite. Installing ========== priv_wrapper is installed into the prefix directory after running "cmake" and "make" with $ make install priv_wrapper-1.0.1/src/000755 001750 000144 00000000000 14337675300 015010 5ustar00asnusers000000 000000 priv_wrapper-1.0.1/src/CMakeLists.txt000644 001750 000144 00000001670 14324463127 017552 0ustar00asnusers000000 000000 project(libpriv_wrapper C) add_library(priv_wrapper SHARED priv_wrapper.c) target_include_directories(priv_wrapper PRIVATE ${CMAKE_BINARY_DIR}) target_compile_options(priv_wrapper PRIVATE -D_GNU_SOURCE) target_link_libraries(priv_wrapper PRIVATE defaults ${PWRAP_REQUIRED_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT}) set_target_properties(priv_wrapper PROPERTIES VERSION ${LIBRARY_VERSION} SOVERSION ${LIBRARY_SOVERSION}) install(TARGETS priv_wrapper RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) set(PRIV_WRAPPER_LOCATION "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}priv_wrapper${CMAKE_SHARED_LIBRARY_SUFFIX}" PARENT_SCOPE) priv_wrapper-1.0.1/src/priv_wrapper.c000644 001750 000144 00000040604 14337675116 017705 0ustar00asnusers000000 000000 /* * Copyright (c) 2018 Andreas Schneider * * 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, see . */ #include "config.h" #include #include #include #include #include #include #include #include #include #ifdef HAVE_SYS_PRCTL_H #include #endif #ifdef HAVE_SYS_TIME_H #include #endif #ifdef HAVE_SYS_RESOURCE_H #include #include #endif enum privwrap_dbglvl_e { PRIVWRAP_LOG_ERROR = 0, PRIVWRAP_LOG_WARN, PRIVWRAP_LOG_DEBUG, PRIVWRAP_LOG_TRACE }; /* GCC have printf type attribute check. */ #ifdef HAVE_FUNCTION_ATTRIBUTE_FORMAT #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b))) #else #define PRINTF_ATTRIBUTE(a,b) #endif /* HAVE_FUNCTION_ATTRIBUTE_FORMAT */ #ifdef HAVE_CONSTRUCTOR_ATTRIBUTE #define CONSTRUCTOR_ATTRIBUTE __attribute__ ((constructor)) #else #define CONSTRUCTOR_ATTRIBUTE #endif /* HAVE_CONSTRUCTOR_ATTRIBUTE */ #ifdef HAVE_DESTRUCTOR_ATTRIBUTE #define DESTRUCTOR_ATTRIBUTE __attribute__ ((destructor)) #else #define DESTRUCTOR_ATTRIBUTE #endif #ifndef FALL_THROUGH # ifdef HAVE_FALLTHROUGH_ATTRIBUTE # define FALL_THROUGH __attribute__ ((fallthrough)) # else /* HAVE_FALLTHROUGH_ATTRIBUTE */ # define FALL_THROUGH ((void)0) # endif /* HAVE_FALLTHROUGH_ATTRIBUTE */ #endif /* FALL_THROUGH */ #ifdef HAVE_ADDRESS_SANITIZER_ATTRIBUTE #define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE __attribute__((no_sanitize_address)) #else #define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE #endif #ifndef MIN #define MIN(a,b) ((a)<(b)?(a):(b)) #endif #ifndef ZERO_STRUCT #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x)) #endif #ifndef ZERO_STRUCTP #define ZERO_STRUCTP(x) do { \ if ((x) != NULL) \ memset((char *)(x), 0, sizeof(*(x))); \ } while(0) #endif #ifndef SAFE_FREE #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0) #endif #ifndef discard_const #define discard_const(ptr) ((void *)((uintptr_t)(ptr))) #endif #ifndef discard_const_p #define discard_const_p(type, ptr) ((type *)discard_const(ptr)) #endif #define UNUSED(x) (void)(x) bool priv_wrapper_enabled(void); void privwrap_constructor(void) CONSTRUCTOR_ATTRIBUTE; void privwrap_destructor(void) DESTRUCTOR_ATTRIBUTE; static void privwrap_log(enum privwrap_dbglvl_e dbglvl, const char *func, const char *format, ...) PRINTF_ATTRIBUTE(3, 4); # define PRIVWRAP_LOG(dbglvl, ...) privwrap_log((dbglvl), __func__, __VA_ARGS__) /* * DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE is used to avoid libasan to check all calls * used by setrlimit(). setrlimit() is called by every process too early, * already from _dl_init(), before call of __asan_init(), thus libasan is not * yet fully initialized. This causes SIGSEGV and process crash. */ DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static void privwrap_log(enum privwrap_dbglvl_e dbglvl, const char *func, const char *format, ...) { char buffer[1024]; va_list va; const char *d; unsigned int lvl = 0; const char *prefix = "PRIVWRAP"; d = getenv("PRIV_WRAPPER_DEBUGLEVEL"); if (d != NULL) { lvl = atoi(d); } if (lvl < dbglvl) { return; } va_start(va, format); vsnprintf(buffer, sizeof(buffer), format, va); va_end(va); switch (dbglvl) { case PRIVWRAP_LOG_ERROR: prefix = "PRIVWRAP_ERROR"; break; case PRIVWRAP_LOG_WARN: prefix = "PRIVWRAP_WARN"; break; case PRIVWRAP_LOG_DEBUG: prefix = "PRIVWRAP_DEBUG"; break; case PRIVWRAP_LOG_TRACE: prefix = "PRIVWRAP_TRACE"; break; } fprintf(stderr, "%s(%d) - %s: %s\n", prefix, (int)getpid(), func, buffer); } /********************************************************* * PRIVWRAP LOADING LIBC FUNCTIONS *********************************************************/ #include typedef int (*__libc_chroot)(const char *path); #ifdef HAVE_PRCTL typedef int (*__libc_prctl)(int option, ...); #endif #ifdef HAVE_PLEDGE typedef int (*__libc_pledge)(const char *promises, const char *execpromises); #endif #ifdef HAVE_SETRLIMIT typedef int (*__libc_setrlimit)(int resource, const struct rlimit *rlp); #endif #define PRIVWRAP_SYMBOL_ENTRY(i) \ union { \ __libc_##i f; \ void *obj; \ } _libc_##i struct privwrap_libc_symbols { #ifdef HAVE_PRCTL PRIVWRAP_SYMBOL_ENTRY(prctl); #endif #ifdef HAVE_SETRLIMIT PRIVWRAP_SYMBOL_ENTRY(setrlimit); #endif PRIVWRAP_SYMBOL_ENTRY(chroot); #ifdef HAVE_PLEDGE PRIVWRAP_SYMBOL_ENTRY(pledge); #endif }; struct privwrap { bool enabled; struct { void *handle; struct privwrap_libc_symbols symbols; } libc; }; static struct privwrap privwrap; #define LIBC_NAME "libc.so" enum privwrap_lib { PRIVWRAP_LIBC, }; static const char *privwrap_str_lib(enum privwrap_lib lib) { switch (lib) { case PRIVWRAP_LIBC: return "libc"; } /* Compiler would warn us about unhandled enum value if we get here */ return "unknown"; } DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static void *privwrap_load_lib_handle(enum privwrap_lib lib) { int flags = RTLD_LAZY; void *handle = NULL; int i; #ifdef RTLD_DEEPBIND const char *env_preload = getenv("LD_PRELOAD"); const char *env_deepbind = getenv("PRIV_WRAPPER_DISABLE_DEEPBIND"); bool enable_deepbind = true; /* Don't do a deepbind if we run with libasan */ if (env_preload != NULL && strlen(env_preload) < 1024) { const char *p = strstr(env_preload, "libasan.so"); if (p != NULL) { enable_deepbind = false; } } if (env_deepbind != NULL && strlen(env_deepbind) >= 1) { enable_deepbind = false; } if (enable_deepbind) { flags |= RTLD_DEEPBIND; } #endif switch (lib) { case PRIVWRAP_LIBC: handle = privwrap.libc.handle; #ifdef LIBC_SO if (handle == NULL) { handle = dlopen(LIBC_SO, flags); privwrap.libc.handle = handle; } #endif if (handle == NULL) { for (i = 10; i >= 0; i--) { char soname[256] = {0}; snprintf(soname, sizeof(soname), "libc.so.%d", i); handle = dlopen(soname, flags); if (handle != NULL) { break; } } privwrap.libc.handle = handle; } break; } if (handle == NULL) { #ifdef RTLD_NEXT handle = privwrap.libc.handle = RTLD_NEXT; #else PRIVWRAP_LOG(PRIVWRAP_LOG_ERROR, "Failed to dlopen library: %s\n", dlerror()); exit(-1); #endif } return handle; } static void *_privwrap_bind_symbol(enum privwrap_lib lib, const char *fn_name) { void *handle; void *func; handle = privwrap_load_lib_handle(lib); func = dlsym(handle, fn_name); if (func == NULL) { PRIVWRAP_LOG(PRIVWRAP_LOG_ERROR, "Failed to find %s: %s\n", fn_name, dlerror()); exit(-1); } PRIVWRAP_LOG(PRIVWRAP_LOG_TRACE, "Loaded %s from %s", fn_name, privwrap_str_lib(lib)); return func; } /* * These macros have a thread race condition on purpose! * * This is an optimization to avoid locking each time we check if the symbol is * bound. */ #define privwrap_bind_symbol_libc(sym_name) \ if (privwrap.libc.symbols._libc_##sym_name.obj == NULL) { \ privwrap.libc.symbols._libc_##sym_name.obj = \ _privwrap_bind_symbol(PRIVWRAP_LIBC, #sym_name); \ } DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static void __pwrap_bind_symbol_all_once(void) { #ifdef HAVE_SETRLIMIT privwrap_bind_symbol_libc(setrlimit); #endif privwrap_bind_symbol_libc(chroot); #ifdef HAVE_PRCTL privwrap_bind_symbol_libc(prctl); #endif #ifdef HAVE_PLEDGE privwrap_bind_symbol_libc(pledge); #endif } DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static void pwrap_bind_symbol_all(void) { static pthread_once_t all_symbol_binding_once = PTHREAD_ONCE_INIT; pthread_once(&all_symbol_binding_once, __pwrap_bind_symbol_all_once); } /**************************************************************************** * IMPORTANT **************************************************************************** * * Functions especially from libc need to be loaded individually, you can't * load all at once or gdb will segfault at startup. The same applies to * valgrind and has probably something todo with with the linker. So we need * load each function at the point it is called the first time. * ****************************************************************************/ static int libc_chroot(const char *path) { pwrap_bind_symbol_all(); return privwrap.libc.symbols._libc_chroot.f(path); } #ifdef HAVE_PRCTL static int libc_vprctl(int option, va_list ap) { unsigned long arg2; unsigned long arg3; unsigned long arg4; unsigned long arg5; pwrap_bind_symbol_all(); arg2 = va_arg(ap, unsigned long); arg3 = va_arg(ap, unsigned long); arg4 = va_arg(ap, unsigned long); arg5 = va_arg(ap, unsigned long); return privwrap.libc.symbols._libc_prctl.f(option, arg2, arg3, arg4, arg5); } #endif /* HAVE_PRCTL */ #ifdef HAVE_SETRLIMIT DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static int libc_setrlimit(int resource, const struct rlimit *rlp) { pwrap_bind_symbol_all(); return privwrap.libc.symbols._libc_setrlimit.f(resource, rlp); } #endif /* HAVE_SETRLIMIT */ /********************************************************* * PRIVWRAP HELPER FUNCTIONS *********************************************************/ DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE bool priv_wrapper_enabled(void) { const char *env; privwrap.enabled = false; env = getenv("PRIV_WRAPPER"); if (env != NULL && env[0] == '1') { privwrap.enabled = true; } return privwrap.enabled; } /**************************** * CHROOT ***************************/ /* Allows also a normal (non root) user to call chroot() */ static int privwrap_chroot(const char *path) { bool privwrap_on = priv_wrapper_enabled(); const char *env = getenv("PRIV_WRAPPER_CHROOT_DISABLE"); if (privwrap_on && env != NULL && env[0] == '1') { return 0; } return libc_chroot(path); } int chroot(const char *path) { return privwrap_chroot(path); } /**************************** * PLEDGE ***************************/ #ifdef HAVE_PLEDGE static int libc_pledge(const char *promises, const char *execpromises) { pwrap_bind_symbol_all(); return privwrap.libc.symbols._libc_pledge.f(promises, execpromises); } static int privwrap_pledge(const char *promises, const char *execpromises) { bool privwrap_on = priv_wrapper_enabled(); const char *env = getenv("PRIV_WRAPPER_PLEDGE_DISABLE"); if (privwrap_on && env != NULL && env[0] == '1') { return 0; } return libc_pledge(promises, execpromises); } int pledge(const char *promises, const char *execpromises) { return privwrap_pledge(promises, execpromises); } #endif /* HAVE_PLEDGE */ /**************************** * PRCTL ***************************/ #ifdef HAVE_PRCTL static bool privwrap_prctl_disabled(const char *option) { const char *env = getenv("PRIV_WRAPPER_PRCTL_DISABLE"); const char *p; int cmp; if (env == NULL || strlen(env) == 0) { return false; } cmp = strcasecmp(env, "ALL"); if (cmp == 0) { return true; } p = strstr(env, option); if (p == NULL) { return false; } return true; } /* * We provide fine grained conrol for some (those seen in openssh) prctl options * - PR_SET_SECCOMP ... works only in kernel with CONFIG_SECCOMP_FILTER * - PR_SET_NO_NEW_PRIVS ... once set, cannot be reset * - PR_SET_DUMPABLE ... always succeeds if called with valid arguments */ static int privwrap_vprctl(int option, va_list va) { bool privwrap_on = priv_wrapper_enabled(); bool option_disabled = false; va_list ap; int rc = 0; if (!privwrap_on) { return libc_vprctl(option, va); } va_copy(ap, va); /* PRIV_WRAPPER_PRCTL_DISABLE=PR_SET_SECCOMP|PR_SET_NO_NEW_PRIVS */ switch(option) { #ifdef PR_SET_SECCOMP case PR_SET_SECCOMP: option_disabled = privwrap_prctl_disabled("PR_SET_SECCOMP"); break; #endif #ifdef PR_SET_NO_NEW_PRIVS case PR_SET_NO_NEW_PRIVS: option_disabled = privwrap_prctl_disabled("PR_SET_NO_NEW_PRIVS"); break; #endif #ifdef PR_SET_DUMPABLE case PR_SET_DUMPABLE: option_disabled = privwrap_prctl_disabled("PR_SET_DUMPABLE"); break; #endif } if (!option_disabled) { rc = libc_vprctl(option, va); } va_end(ap); return rc; } int prctl(int option, ...) { va_list va; int rc; va_start(va, option); rc = privwrap_vprctl(option, va); va_end(va); return rc; } #endif /* HAVE_PRCTL */ #ifdef HAVE_SETRLIMIT static bool privwrap_setrlimit_disabled(const char *resource) { const char *env = getenv("PRIV_WRAPPER_SETRLIMIT_DISABLE"); const char *p = NULL; int cmp; if (env == NULL || strlen(env) == 0) { return false; } cmp = strcasecmp(env, "ALL"); if (cmp == 0) { return true; } p = strstr(env, resource); if (p == NULL) { return false; } return true; } DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE static int privwrap_setrlimit(int resource, const struct rlimit *rlp) { bool setrlimit_disabled = false; int rc = 0; if (!priv_wrapper_enabled()) { return libc_setrlimit(resource, rlp); } switch(resource) { #ifdef RLIMIT_CPU case RLIMIT_CPU: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_CPU"); break; #endif /* RLIMIT_CPU */ #ifdef RLIMIT_FSIZE case RLIMIT_FSIZE: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_FSIZE"); break; #endif /* RLIMIT_FSIZE */ #ifdef RLIMIT_DATA case RLIMIT_DATA: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_DATA"); break; #endif /* RLIMIT_DATA */ #ifdef RLIMIT_STACK case RLIMIT_STACK: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_STACK"); break; #endif /* RLIMIT_STACK */ #ifdef RLIMIT_CORE case RLIMIT_CORE: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_CORE"); break; #endif /* RLIMIT_CORE */ #ifdef RLIMIT_RSS case RLIMIT_RSS: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_RSS"); break; #endif /* RLIMIT_RSS */ #ifdef RLIMIT_NOFILE case RLIMIT_NOFILE: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_NOFILE"); break; #endif /* RLIMIT_NOFILE */ #ifdef RLIMIT_AS case RLIMIT_AS: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_AS"); break; #endif /* RLIMIT_AS */ #ifdef RLIMIT_NPROC case RLIMIT_NPROC: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_NPROC"); break; #endif /* RLIMIT_NPROC */ #ifdef RLIMIT_MEMLOCK case RLIMIT_MEMLOCK: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_MEMLOCK"); break; #endif /* RLIMIT_MEMLOCK */ #ifdef RLIMIT_LOCKS case RLIMIT_LOCKS: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_LOCKS"); break; #endif /* RLIMIT_LOCKS */ #ifdef RLIMIT_SIGPENDING case RLIMIT_SIGPENDING: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_SIGPENDING"); break; #endif /* RLIMIT_SIGPENDING */ #ifdef RLIMIT_MSGQUEUE case RLIMIT_MSGQUEUE: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_MSGQUEUE"); break; #endif /* RLIMIT_MSGQUEUE */ #ifdef RLIMIT_NICE case RLIMIT_NICE: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_NICE"); break; #endif /* RLIMIT_NICE */ #ifdef RLIMIT_RTPRIO case RLIMIT_RTPRIO: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_RTPRIO"); break; #endif /* RLIMIT_RTPRIO */ #ifdef RLIMIT_RTTIME case RLIMIT_RTTIME: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_RTTIME"); break; #endif /* RLIMIT_RTTIME */ #ifdef RLIMIT_NLIMMITS case RLIMIT_NLIMITS: setrlimit_disabled = privwrap_setrlimit_disabled("RLIMIT_NLIMMITS"); break; #endif /* RLIMIT_NLIMMITS */ } if (!setrlimit_disabled) { rc = libc_setrlimit(resource, rlp); } return rc; } DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE #ifdef HAVE_SETRLIMIT_RLIMIT_RESOURCE_T int setrlimit(__rlimit_resource_t resource, const struct rlimit *rlp) #else int setrlimit(int resource, const struct rlimit *rlp) #endif { return privwrap_setrlimit(resource, rlp); } #endif /* HAVE_SETRLIMIT */ /**************************** * CONSTRUCTOR ***************************/ void privwrap_constructor(void) { PRIVWRAP_LOG(PRIVWRAP_LOG_WARN, "priv_wrapper loaded"); } /**************************** * DESTRUCTOR ***************************/ void privwrap_destructor(void) { if (privwrap.libc.handle != NULL #ifdef RTLD_NEXT && privwrap.libc.handle != RTLD_NEXT #endif ) { dlclose(privwrap.libc.handle); } } priv_wrapper-1.0.1/CTestConfig.cmake000644 001750 000144 00000000431 14324463127 017367 0ustar00asnusers000000 000000 set(UPDATE_TYPE "true") set(CTEST_PROJECT_NAME "priv_wrapper") set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") set(CTEST_DROP_METHOD "https") set(CTEST_DROP_SITE "test.cmocka.org") set(CTEST_DROP_LOCATION "/submit.php?project=${CTEST_PROJECT_NAME}") set(CTEST_DROP_SITE_CDASH TRUE) priv_wrapper-1.0.1/CompilerChecks.cmake000644 001750 000144 00000012274 14324463127 020122 0ustar00asnusers000000 000000 include(AddCCompilerFlag) include(CheckCCompilerFlagSSP) if (UNIX) # # Check for -Werror turned on if possible # # This will prevent that compiler flags are detected incorrectly. # check_c_compiler_flag("-Werror" REQUIRED_FLAGS_WERROR) if (REQUIRED_FLAGS_WERROR) set(CMAKE_REQUIRED_FLAGS "-Werror") if (PICKY_DEVELOPER) list(APPEND SUPPORTED_COMPILER_FLAGS "-Werror") endif() endif() add_c_compiler_flag("-std=gnu99" SUPPORTED_COMPILER_FLAGS) #add_c_compiler_flag("-Wpedantic" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wall" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wshadow" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wmissing-prototypes" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wcast-align" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wcast-qual" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=address" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wstrict-prototypes" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=strict-prototypes" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wwrite-strings" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=write-strings" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror-implicit-function-declaration" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wpointer-arith" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=pointer-arith" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wdeclaration-after-statement" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=declaration-after-statement" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wreturn-type" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=return-type" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wuninitialized" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=uninitialized" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wimplicit-fallthrough" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=strict-overflow" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wstrict-overflow=2" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wno-format-zero-length" SUPPORTED_COMPILER_FLAGS) check_c_compiler_flag("-Wformat" REQUIRED_FLAGS_WFORMAT) if (REQUIRED_FLAGS_WFORMAT) list(APPEND SUPPORTED_COMPILER_FLAGS "-Wformat") set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -Wformat") endif() add_c_compiler_flag("-Wformat-security" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Werror=format-security" SUPPORTED_COMPILER_FLAGS) # Allow zero for a variadic macro argument string(TOLOWER "${CMAKE_C_COMPILER_ID}" _C_COMPILER_ID) if ("${_C_COMPILER_ID}" STREQUAL "clang") add_c_compiler_flag("-Wno-gnu-zero-variadic-macro-arguments" SUPPORTED_COMPILER_FLAGS) endif() add_c_compiler_flag("-fno-common" SUPPORTED_COMPILER_FLAGS) if (CMAKE_BUILD_TYPE) string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LOWER) if (CMAKE_BUILD_TYPE_LOWER MATCHES (release|relwithdebinfo|minsizerel)) add_c_compiler_flag("-Wp,-D_FORTIFY_SOURCE=2" SUPPORTED_COMPILER_FLAGS) endif() endif() if (NOT SOLARIS) check_c_compiler_flag_ssp("-fstack-protector-strong" WITH_STACK_PROTECTOR_STRONG) if (WITH_STACK_PROTECTOR_STRONG) list(APPEND SUPPORTED_COMPILER_FLAGS "-fstack-protector-strong") # This is needed as Solaris has a seperate libssp if (SOLARIS) list(APPEND SUPPORTED_LINKER_FLAGS "-fstack-protector-strong") endif() else (WITH_STACK_PROTECTOR_STRONG) check_c_compiler_flag_ssp("-fstack-protector" WITH_STACK_PROTECTOR) if (WITH_STACK_PROTECTOR) list(APPEND SUPPORTED_COMPILER_FLAGS "-fstack-protector") # This is needed as Solaris has a seperate libssp if (SOLARIS) list(APPEND SUPPORTED_LINKER_FLAGS "-fstack-protector") endif() endif() endif (WITH_STACK_PROTECTOR_STRONG) check_c_compiler_flag_ssp("-fstack-clash-protection" WITH_STACK_CLASH_PROTECTION) if (WITH_STACK_CLASH_PROTECTION) list(APPEND SUPPORTED_COMPILER_FLAGS "-fstack-clash-protection") endif() endif() if (PICKY_DEVELOPER) add_c_compiler_flag("-Wno-error=deprecated-declarations" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("-Wno-error=tautological-compare" SUPPORTED_COMPILER_FLAGS) endif() # Unset CMAKE_REQUIRED_FLAGS unset(CMAKE_REQUIRED_FLAGS) endif() if (MSVC) add_c_compiler_flag("/D _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES=1" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("/D _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES_COUNT=1" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("/D _CRT_NONSTDC_NO_WARNINGS=1" SUPPORTED_COMPILER_FLAGS) add_c_compiler_flag("/D _CRT_SECURE_NO_WARNINGS=1" SUPPORTED_COMPILER_FLAGS) endif() add_library(defaults INTERFACE) if (SUPPORTED_COMPILER_FLAGS) target_compile_options(defaults INTERFACE ${SUPPORTED_COMPILER_FLAGS}) endif() if (SUPPORTED_LINKER_FLAGS) target_link_options(defaults INTERFACE ${SUPPORTED_LINKER_FLAGS}) endif() priv_wrapper-1.0.1/tests/000755 001750 000144 00000000000 14337675300 015363 5ustar00asnusers000000 000000 priv_wrapper-1.0.1/tests/CMakeLists.txt000644 001750 000144 00000004177 14324463127 020132 0ustar00asnusers000000 000000 project(tests C) include_directories( ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_SOURCE_DIR}/src ${CMOCKA_INCLUDE_DIR} ) set(PWRAP_TESTS test_setrlimit test_chroot) if (HAVE_PRCTL) list(APPEND PWRAP_TESTS test_prctl) endif() if (HAVE_PLEDGE) list(APPEND PWRAP_TESTS test_pledge) endif() function(ADD_CMOCKA_TEST_ENVIRONMENT _TEST_NAME) if (CMAKE_BUILD_TYPE) string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LOWER) if (CMAKE_BUILD_TYPE_LOWER STREQUAL "addresssanitizer") find_library(ASAN_LIBRARY NAMES asan) if (NOT ASAN_LIBRARY) foreach(version RANGE 10 1) if (NOT ASAN_LIBRARY) find_library(ASAN_LIBRARY libasan.so.${version}) endif() endforeach() endif() endif() endif() if (ASAN_LIBRARY) list(APPEND PRELOAD_LIBRARIES ${ASAN_LIBRARY}) endif() list(APPEND PRELOAD_LIBRARIES ${PRIV_WRAPPER_LOCATION}) if (OSX) set(TORTURE_ENVIRONMENT "DYLD_FORCE_FLAT_NAMESPACE=1;DYLD_INSERT_LIBRARIES=${PRIV_WRAPPER_LOCATION}") else () string(REPLACE ";" ":" _TMP_ENV "${PRELOAD_LIBRARIES}") set(TORTURE_ENVIRONMENT "LD_PRELOAD=${_TMP_ENV}") endif() if (CMAKE_BUILD_TYPE) string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_LOWER) if (CMAKE_BUILD_TYPE_LOWER STREQUAL "addresssanitizer" OR CMAKE_BUILD_TYPE_LOWER STREQUAL "threadsanitizer" OR CMAKE_BUILD_TYPE_LOWER STREQUAL "undefinedsanitizer") list(APPEND TORTURE_ENVIRONMENT "PRIV_WRAPPER_DISABLE_DEEPBIND=1") endif() endif() set_property(TEST ${_TEST_NAME} PROPERTY ENVIRONMENT "${TORTURE_ENVIRONMENT}") endfunction() foreach(_PWRAP_TEST ${PWRAP_TESTS}) add_cmocka_test(${_PWRAP_TEST} SOURCES ${_PWRAP_TEST}.c COMPILE_OPTIONS -D_GNU_SOURCE LINK_LIBRARIES ${CMOCKA_LIBRARY} PRIVATE defaults) add_cmocka_test_environment(${_PWRAP_TEST}) endforeach() priv_wrapper-1.0.1/tests/test_setrlimit.c000644 001750 000144 00000007052 14324463127 020604 0ustar00asnusers000000 000000 #include #include #include #include #include #include #include #include static int setup(void **state) { (void) state; /* unused */ setenv("PRIV_WRAPPER", "1", 1); return 0; } static void test_RLIMIT_FSIZE(void **state) { int rc; struct rlimit rlz, rli; (void) state; /* unused */ rlz.rlim_cur = rlz.rlim_max = 0; /* zero */ rli.rlim_cur = rli.rlim_max = -1; /* RLIM64_INFINITY */ setenv("PRIV_WRAPPER_SETRLIMIT_DISABLE", "ALL", 1); rc = setrlimit(RLIMIT_FSIZE, &rlz); assert_return_code(rc, errno); rc = setrlimit(RLIMIT_FSIZE, &rli); assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_SETRLIMIT_DISABLE"); setenv("PRIV_WRAPPER_SETRLIMIT_DISABLE", "RLIMIT_FSIZE", 1); rc = setrlimit(RLIMIT_FSIZE, &rlz); assert_return_code(rc, errno); rc = setrlimit(RLIMIT_FSIZE, &rli); assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_SETRLIMIT_DISABLE"); } /* Test with libc setrlimit() */ static void test_RLIMIT_FSIZE_fail(void **state) { int rc; struct rlimit rli = { .rlim_cur = 1000000, .rlim_max = 1000000, }; #ifdef __linux__ struct rlimit rlz = { .rlim_cur = 1, .rlim_max = 0, /* rlim_cur > rlim_max -> EINVAL */ }; #endif (void) state; /* unused */ rc = setrlimit(RLIMIT_FSIZE, &rli); assert_return_code(rc, errno); #ifdef __linux__ /* This works on BSD and smells like a bug! */ rc = setrlimit(RLIMIT_FSIZE, &rlz); assert_int_equal(rc, -1); assert_int_equal(errno, EINVAL); #endif } /* * Test combination of these options : * (first 5 are set in PRIV_WRAPPER_SETRLIMIT_DISABLE) * RLIMIT_CPU * RLIMIT_FSIZE * RLIMIT_DATA * RLIMIT_STACK * RLIMIT_CORE * RLIMIT_RSS * RLIMIT_NOFILE * RLIMIT_AS * RLIMIT_NPROC * RLIMIT_MEMLOCK * RLIMIT_LOCKS * RLIMIT_SIGPENDING * RLIMIT_MSGQUEUE * RLIMIT_NICE * RLIMIT_RTPRIO * RLIMIT_RTTIME * RLIMIT_NLIMITS */ static void test_setrlimit_combination(void **state) { int rc; struct rlimit rl_bad; (void) state; rl_bad.rlim_cur = 1000000; rl_bad.rlim_max = 100000; /* rlim_cur > rlim_max ... EINVAL */ setenv("PRIV_WRAPPER_SETRLIMIT_DISABLE", "RLIMIT_CPU|RLIMIT_FSIZE|RLIMIT_DATA|RLIMIT_STACK|RLIMIT_CORE", 1); #define setrlimit_wrapped(o) \ rc = setrlimit(o, &rl_bad); \ assert_return_code(rc, errno); #define setrlimit_unwrapped(o) \ rc = setrlimit(o, &rl_bad); \ assert_int_equal(rc, -1); \ assert_int_equal(errno, EINVAL); setrlimit_wrapped(RLIMIT_CPU); setrlimit_wrapped(RLIMIT_FSIZE); setrlimit_wrapped(RLIMIT_DATA); setrlimit_wrapped(RLIMIT_STACK); setrlimit_wrapped(RLIMIT_CORE); #ifdef __linux__ /* FreeBSD bugs (EINVAL not detected) */ setrlimit_unwrapped(RLIMIT_RSS); setrlimit_unwrapped(RLIMIT_NOFILE); setrlimit_unwrapped(RLIMIT_AS); setrlimit_unwrapped(RLIMIT_NPROC); setrlimit_unwrapped(RLIMIT_MEMLOCK); #endif #ifdef RLIMIT_LOCKS setrlimit_unwrapped(RLIMIT_LOCKS); #endif #ifdef RLIMIT_SIGPENDING setrlimit_unwrapped(RLIMIT_SIGPENDING); #endif #ifdef RLIMIT_MSGQUEUE setrlimit_unwrapped(RLIMIT_MSGQUEUE); #endif #ifdef RLIMIT_NICE setrlimit_unwrapped(RLIMIT_NICE); #endif #ifdef RLIMIT_RTPRIO setrlimit_unwrapped(RLIMIT_RTPRIO); #endif #ifdef RLIMIT_RTTIME setrlimit_unwrapped(RLIMIT_RTTIME); #endif #ifdef RLIMIT_NLIMITS setrlimit_unwrapped(RLIMIT_NLIMITS); #endif unsetenv("PRIV_WRAPPER_SETRLIMIT_DISABLE"); } int main(void) { const struct CMUnitTest tests[] = { cmocka_unit_test(test_RLIMIT_FSIZE), cmocka_unit_test(test_RLIMIT_FSIZE_fail), cmocka_unit_test(test_setrlimit_combination), }; return cmocka_run_group_tests(tests, setup, NULL); } priv_wrapper-1.0.1/tests/test_chroot.c000644 001750 000144 00000001643 14324463127 020066 0ustar00asnusers000000 000000 #include #include #include #include #include #include #include #include static int setup(void **state) { (void) state; /* unused */ setenv("PRIV_WRAPPER", "1", 1); return 0; } static void test_chroot(void **state) { int rc; (void) state; /* unused */ setenv("PRIV_WRAPPER_CHROOT_DISABLE", "1", 1); rc = chroot("non existing path"); unsetenv("PRIV_WRAPPER_CHROOT_DISABLE"); assert_return_code(rc, errno); } static void test_chroot_fail(void **state) { int rc; (void) state; /* unused */ rc = chroot("non existing path"); assert_int_equal(rc, -1); /* * Linux: ENOENT * FreeBSD: EPERM */ assert_in_range(errno, EPERM, ENOENT); } int main(void) { const struct CMUnitTest tests[] = { cmocka_unit_test(test_chroot), cmocka_unit_test(test_chroot_fail), }; return cmocka_run_group_tests(tests, setup, NULL); } priv_wrapper-1.0.1/tests/test_pledge.c000644 001750 000144 00000002007 14324463127 020023 0ustar00asnusers000000 000000 #include #include #include #include #include #include #include #include static int setup(void **state) { (void) state; /* unused */ setenv("PRIV_WRAPPER", "1", 1); return 0; } static void test_pledge(void **state) { int rc; (void) state; /* unused */ setenv("PRIV_WRAPPER_PLEDGE_DISABLE", "1", 1); rc = pledge("stdio", NULL); assert_return_code(rc, errno); rc = pledge("cpath", NULL); assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_PLEDGE_DISABLE"); } static void test_pledge_fail(void **state) { int rc; (void) state; /* unused */ rc = pledge("stdio", NULL); assert_return_code(rc, errno); rc = pledge("cpath", NULL); /* Attempting to increase permissions */ assert_int_equal(rc, -1); assert_int_equal(errno, EPERM); } int main(void) { const struct CMUnitTest tests[] = { cmocka_unit_test(test_pledge), cmocka_unit_test(test_pledge_fail), }; return cmocka_run_group_tests(tests, setup, NULL); } priv_wrapper-1.0.1/tests/test_prctl.c000644 001750 000144 00000005764 14324463127 017724 0ustar00asnusers000000 000000 #include #include #include #include #include #include #include #include #include static int setup(void **state) { (void)state; /* unused */ setenv("PRIV_WRAPPER", "1", 1); return 0; } static void test_prctl_ALL(void **state) { int rc; (void)state; /* unused */ setenv("PRIV_WRAPPER_PRCTL_DISABLE", "ALL", 1); rc = prctl(PR_SET_SECCOMP, SECCOMP_MODE_STRICT); assert_return_code(rc, errno); rc = prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0); assert_return_code(rc, errno); rc = prctl(PR_SET_NO_NEW_PRIVS, 0, 0, 0, 0); assert_return_code(rc, errno); rc = prctl(PR_SET_DUMPABLE, 2, 0, 0, 0); /* 2 is invalid value */ assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_PRCTL_DISABLE"); } static void test_prctl_PR_SET_SECCOMP(void **state) { int rc; (void)state; /* unused */ setenv("PRIV_WRAPPER_PRCTL_DISABLE", "PR_SET_SECCOMP", 1); rc = prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, NULL, 0, 0); assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_PRCTL_DISABLE"); } static void test_prctl_PR_SET_SECCOMP_fail(void **state) { int rc; (void)state; /* unused */ rc = prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, NULL, 0, 0); assert_int_equal(rc, -1); assert_int_equal(errno, EFAULT); } /* Once PR_SET_NO_NEW_PRIVS is set to 1, it cannot be reset to 0. */ static void test_prctl_PR_SET_NO_NEW_PRIVS(void **state) { int rc; (void)state; /* unused */ setenv("PRIV_WRAPPER_PRCTL_DISABLE", "PR_SET_NO_NEW_PRIVS", 1); rc = prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0); assert_return_code(rc, errno); rc = prctl(PR_SET_NO_NEW_PRIVS, 0, 0, 0, 0); assert_return_code(rc, errno); unsetenv("PRIV_WRAPPER_PRCTL_DISABLE"); } static void test_prctl_PR_SET_NO_NEW_PRIVS_fail(void **state) { int rc; (void)state; /* unused */ rc = prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0); assert_return_code(rc, errno); rc = prctl(PR_SET_NO_NEW_PRIVS, 0, 0, 0, 0); assert_int_equal(rc, -1); assert_int_equal(errno, EINVAL); } /* arg==2 is an invalid value which fails with real prctl syscall */ static void test_prctl_PR_SET_DUMPABLE(void **state) { int rc; (void)state; /* unused */ setenv("PRIV_WRAPPER_PRCTL_DISABLE", "PR_SET_DUMPABLE", 1); rc = prctl(PR_SET_DUMPABLE, 2, 0, 0, 0); unsetenv("PRIV_WRAPPER_PRCTL_DISABLE"); assert_return_code(rc, errno); } static void test_prctl_PR_SET_DUMPABLE_fail(void **state) { int rc; (void)state; /* unused */ rc = prctl(PR_SET_DUMPABLE, 2, 0, 0, 0); assert_int_equal(rc, -1); assert_int_equal(errno, EINVAL); } int main(void) { const struct CMUnitTest tests[] = { cmocka_unit_test(test_prctl_ALL), cmocka_unit_test(test_prctl_PR_SET_SECCOMP), cmocka_unit_test(test_prctl_PR_SET_SECCOMP_fail), cmocka_unit_test(test_prctl_PR_SET_NO_NEW_PRIVS), cmocka_unit_test(test_prctl_PR_SET_NO_NEW_PRIVS_fail), cmocka_unit_test(test_prctl_PR_SET_DUMPABLE), cmocka_unit_test(test_prctl_PR_SET_DUMPABLE_fail), }; return cmocka_run_group_tests(tests, setup, NULL); } priv_wrapper-1.0.1/doc/000755 001750 000144 00000000000 14337675300 014766 5ustar00asnusers000000 000000 priv_wrapper-1.0.1/doc/priv_wrapper.1000644 001750 000144 00000006467 14324463127 017603 0ustar00asnusers000000 000000 '\" t .\" Title: priv_wrapper .\" Author: Samba Team .\" Generator: Asciidoctor 2.0.17 .\" Date: 2022-09-14 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" .TH "PRIV_WRAPPER" "1" "2022-09-14" "\ \&" "\ \&" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 .nh .ad l .de URL \fI\\$2\fP <\\$1>\\$3 .. .als MTO URL .if \n[.g] \{\ . mso www.tmac . am URL . ad l . . . am MTO . ad l . . . LINKSTYLE blue R < > .\} .SH "NAME" priv_wrapper \- A library to disable resource limits and other priviledge dropping. .SH "SYNOPSIS" .sp LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 [PRIV_WRAPPER_CHROOT_DISABLE=1] [PRIV_WRAPPER_PRCTL_DISABLE=] [PRIV_WRAPPER_SETRLIMIT_DISABLE=] .SH "DESCRIPTION" .sp priv_wrapper aims to help running processes which are dropping privileges or are restricting resources in test environments. It can disable chroot, prctl, pledge and setrlmit system calls. A disabled call always succeeds (i.e. returns 0) and does nothing. The system call pledge exists only on OpenBSD. .SH "ENVIRONMENT VARIABLES" .sp \fBPRIV_WRAPPER\fP .RS 4 This variable activates priv_wrapper when set to \fI1\fP. .RE .sp \fBPRIV_WRAPPER_DISABLE_DEEPBIND\fP .RS 4 This allows you to disable deep binding in priv_wrapper. This is useful for running valgrind tools or sanitizers like (address, undefined, thread). .RE .sp \fBPRIV_WRAPPER_CHROOT_DISABLE\fP .RS 4 If this is set to \fI1\fP then chroot() system call will be disabled. .RE .sp \fBPRIV_WRAPPER_PRCTL_DISABLE\fP .RS 4 prctl calls can be disabled using this environment variable. You can either disable all calls using PRIV_WRAPPER_PRCTL_DISABLE=ALL or special options using e.g. PRIV_WRAPPER_PRCTL_DISABLE=PR_SET_SECCOMP|PR_SET_NO_NEW_PRIVS .RE .sp Supported options are: .sp PR_SET_SECCOMP PR_SET_NO_NEW_PRIVS PR_SET_DUMPABLE .sp \fBPRIV_WRAPPER_SETRLIMIT_DISABLE\fP .RS 4 Either all resource limits can be disabled using PRIV_WRAPPER_SETRLIMIT_DISABLE=ALL or you can pick specific resources using e.g: .RE .sp PRIV_WRAPPER_SETRLIMIT_DISABLE=RLIMIT_STACK|RLIMIT_CORE .sp Supported options are: .sp RLIMIT_CPU RLIMIT_FSIZE RLIMIT_DATA RLIMIT_STACK RLIMIT_CORE RLIMIT_RSS RLIMIT_NOFILE RLIMIT_AS RLIMIT_NPROC RLIMIT_MEMLOCK RLIMIT_LOCKS RLIMIT_SIGPENDING RLIMIT_MSGQUEUE RLIMIT_NICE RLIMIT_RTPRIO RLIMIT_RTTIME RLIMIT_NLIMITS .sp \fBPRIV_WRAPPER_PLEDGE_DISABLE\fP .RS 4 If this is set to \fI1\fP then pledge() system call will be disabled. .RE .sp \fBPRIV_WRAPPER_DEBUGLEVEL\fP .RS 4 If you need to see what is going on in priv_wrapper itself or try to find a bug, you can enable logging support in priv_wrapper if you built it with debug symbols. .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ . sp -1 . IP \(bu 2.3 .\} 0 = ERROR .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ . sp -1 . IP \(bu 2.3 .\} 1 = WARNING .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ . sp -1 . IP \(bu 2.3 .\} 2 = DEBUG .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ . sp -1 . IP \(bu 2.3 .\} 3 = TRACE .RE .RE .SH "EXAMPLE" .sp LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 PRIV_WRAPPER_PRCTL_DISABLE="PR_SET_SECCOMP|PR_SET_NO_NEW_PRIVS" .sp LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 PRIV_WRAPPER_CHROOT_DISABLE=1 PRIV_WRAPPER_PRCTL_DISABLE=ALL PRIV_WRAPPER_SETRLIMIT_DISABLE="RLIMIT_CPU|RLIMIT_DATA|RLIMIT_NLIMITS" .SH "AUTHOR" .sp Samba Teampriv_wrapper-1.0.1/doc/CMakeLists.txt000644 001750 000144 00000000147 14324463127 017526 0ustar00asnusers000000 000000 install(FILES priv_wrapper.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) priv_wrapper-1.0.1/doc/README000644 001750 000144 00000000202 14307550701 015632 0ustar00asnusers000000 000000 The manpage is written with asciidoc. To generate the manpage use: a2x --doctype manpage --format manpage doc/priv_wrapper.1.txt priv_wrapper-1.0.1/doc/priv_wrapper.1.txt000644 001750 000144 00000004747 14324463127 020420 0ustar00asnusers000000 000000 priv_wrapper(1) =============== :revdate: 2022-09-05 :author: Samba Team NAME ---- priv_wrapper - A library to disable resource limits and other priviledge dropping. SYNOPSIS -------- LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 [PRIV_WRAPPER_CHROOT_DISABLE=1] [PRIV_WRAPPER_PRCTL_DISABLE=] [PRIV_WRAPPER_SETRLIMIT_DISABLE=] DESCRIPTION ----------- priv_wrapper aims to help running processes which are dropping privileges or are restricting resources in test environments. It can disable chroot, prctl, pledge and setrlmit system calls. A disabled call always succeeds (i.e. returns 0) and does nothing. The system call pledge exists only on OpenBSD. ENVIRONMENT VARIABLES --------------------- *PRIV_WRAPPER*:: This variable activates priv_wrapper when set to '1'. *PRIV_WRAPPER_DISABLE_DEEPBIND*:: This allows you to disable deep binding in priv_wrapper. This is useful for running valgrind tools or sanitizers like (address, undefined, thread). *PRIV_WRAPPER_CHROOT_DISABLE*:: If this is set to '1' then chroot() system call will be disabled. *PRIV_WRAPPER_PRCTL_DISABLE*:: prctl calls can be disabled using this environment variable. You can either disable all calls using PRIV_WRAPPER_PRCTL_DISABLE=ALL or special options using e.g. PRIV_WRAPPER_PRCTL_DISABLE=PR_SET_SECCOMP|PR_SET_NO_NEW_PRIVS Supported options are: PR_SET_SECCOMP PR_SET_NO_NEW_PRIVS PR_SET_DUMPABLE *PRIV_WRAPPER_SETRLIMIT_DISABLE*:: Either all resource limits can be disabled using PRIV_WRAPPER_SETRLIMIT_DISABLE=ALL or you can pick specific resources using e.g: PRIV_WRAPPER_SETRLIMIT_DISABLE=RLIMIT_STACK|RLIMIT_CORE Supported options are: RLIMIT_CPU RLIMIT_FSIZE RLIMIT_DATA RLIMIT_STACK RLIMIT_CORE RLIMIT_RSS RLIMIT_NOFILE RLIMIT_AS RLIMIT_NPROC RLIMIT_MEMLOCK RLIMIT_LOCKS RLIMIT_SIGPENDING RLIMIT_MSGQUEUE RLIMIT_NICE RLIMIT_RTPRIO RLIMIT_RTTIME RLIMIT_NLIMITS *PRIV_WRAPPER_PLEDGE_DISABLE*:: If this is set to '1' then pledge() system call will be disabled. *PRIV_WRAPPER_DEBUGLEVEL*:: If you need to see what is going on in priv_wrapper itself or try to find a bug, you can enable logging support in priv_wrapper if you built it with debug symbols. - 0 = ERROR - 1 = WARNING - 2 = DEBUG - 3 = TRACE EXAMPLE ------- LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 PRIV_WRAPPER_PRCTL_DISABLE="PR_SET_SECCOMP|PR_SET_NO_NEW_PRIVS" LD_PRELOAD=libpriv_wrapper.so PRIV_WRAPPER=1 PRIV_WRAPPER_CHROOT_DISABLE=1 PRIV_WRAPPER_PRCTL_DISABLE=ALL PRIV_WRAPPER_SETRLIMIT_DISABLE="RLIMIT_CPU|RLIMIT_DATA|RLIMIT_NLIMITS" priv_wrapper-1.0.1/CMakeLists.txt000644 001750 000144 00000005232 14337675116 016770 0ustar00asnusers000000 000000 # Required cmake version cmake_minimum_required(VERSION 3.5.0) cmake_policy(SET CMP0048 NEW) # Specify search path for CMake modules to be loaded by include() # and find_package() list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules") # Add defaults for cmake # Those need to be set before the project() call. include(DefineCMakeDefaults) include(DefineCompilerFlags) project(priv_wrapper VERSION 1.0.1 LANGUAGES C) # global needed variables set(APPLICATION_NAME ${PROJECT_NAME}) # SOVERSION scheme: MAJOR.MINOR.PATCH # If there was an incompatible interface change: # Increment MAJOR. Set MINOR and PATCH to 0 # If there was a compatible interface change: # Increment MINOR. Set PATCH to 0 # If the source code was changed, but there were no interface changes: # Increment PATCH. set(LIBRARY_VERSION_MAJOR 0) set(LIBRARY_VERSION_MINOR 0) set(LIBRARY_VERSION_PATCH 2) set(LIBRARY_VERSION "${LIBRARY_VERSION_MAJOR}.${LIBRARY_VERSION_MINOR}.${LIBRARY_VERSION_PATCH}") set(LIBRARY_SOVERSION ${LIBRARY_VERSION_MAJOR}) # add definitions include(DefinePlatformDefaults) include(DefineOptions.cmake) include(CPackConfig.cmake) include(CompilerChecks.cmake) include(GNUInstallDirs) # disallow in-source build include(MacroEnsureOutOfSourceBuild) macro_ensure_out_of_source_build("${PROJECT_NAME} requires an out of source build. Please create a separate build directory and run 'cmake /path/to/${PROJECT_NAME} [options]' there.") # Find out if we have threading available set(CMAKE_THREAD_PREFER_PTHREADS ON) find_package(Threads) # config.h checks include(ConfigureChecks.cmake) configure_file(config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h) # check subdirectories add_subdirectory(src) if (UNIT_TESTING) find_package(cmocka 1.1.0 REQUIRED) include(AddCMockaTest) add_subdirectory(tests) endif (UNIT_TESTING) # pkg-config file get_filename_component(PRIV_WRAPPER_LIB ${PRIV_WRAPPER_LOCATION} NAME) configure_file(priv_wrapper.pc.cmake ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper.pc @ONLY) install( FILES ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig COMPONENT pkgconfig ) # cmake config files configure_file(priv_wrapper-config-version.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper-config-version.cmake @ONLY) configure_file(priv_wrapper-config.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper-config.cmake @ONLY) install( FILES ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper-config-version.cmake ${CMAKE_CURRENT_BINARY_DIR}/priv_wrapper-config.cmake DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/priv_wrapper COMPONENT devel ) add_subdirectory(doc) priv_wrapper-1.0.1/ConfigureChecks.cmake000644 001750 000144 00000007376 14324463127 020300 0ustar00asnusers000000 000000 include(CheckIncludeFile) include(CheckSymbolExists) include(CheckFunctionExists) include(CheckLibraryExists) include(CheckTypeSize) include(CheckStructHasMember) include(CheckPrototypeDefinition) include(TestBigEndian) set(PRIV_WRAPPER_PACKAGE ${PROJECT_NAME}) set(PRIV_WRAPPER_VERSION ${PROJECT_VERSION}) set(BINARYDIR ${CMAKE_BINARY_DIR}) set(SOURCEDIR ${CMAKE_SOURCE_DIR}) function(COMPILER_DUMPVERSION _OUTPUT_VERSION) # Remove whitespaces from the argument. # This is needed for CC="ccache gcc" cmake .. string(REPLACE " " "" _C_COMPILER_ARG "${CMAKE_C_COMPILER_ARG1}") execute_process( COMMAND ${CMAKE_C_COMPILER} ${_C_COMPILER_ARG} -dumpversion OUTPUT_VARIABLE _COMPILER_VERSION ) string(REGEX REPLACE "([0-9])\\.([0-9])(\\.[0-9])?" "\\1\\2" _COMPILER_VERSION "${_COMPILER_VERSION}") set(${_OUTPUT_VERSION} ${_COMPILER_VERSION} PARENT_SCOPE) endfunction() if(CMAKE_COMPILER_IS_GNUCC AND NOT MINGW AND NOT OS2) compiler_dumpversion(GNUCC_VERSION) if (NOT GNUCC_VERSION EQUAL 34) set(CMAKE_REQUIRED_FLAGS "-fvisibility=hidden") check_c_source_compiles( "void __attribute__((visibility(\"default\"))) test() {} int main(void){ return 0; } " WITH_VISIBILITY_HIDDEN) unset(CMAKE_REQUIRED_FLAGS) endif (NOT GNUCC_VERSION EQUAL 34) endif(CMAKE_COMPILER_IS_GNUCC AND NOT MINGW AND NOT OS2) # HEADERS check_include_file(sys/prctl.h HAVE_SYS_PRCTL_H) check_include_file(sys/time.h HAVE_SYS_TIME_H) check_include_file(sys/resource.h HAVE_SYS_RESOURCE_H) # FUNCTIONS check_function_exists(chroot HAVE_CHROOT) check_function_exists(prctl HAVE_PRCTL) check_function_exists(pledge HAVE_PLEDGE) check_function_exists(setrlimit HAVE_SETRLIMIT) check_prototype_definition(setrlimit "int setrlimit(__rlimit_resource_t resource, const struct rlimit *rlp)" "-1" "sys/resource.h" HAVE_SETRLIMIT_RLIMIT_RESOURCE_T) if (UNIX) find_library(DLFCN_LIBRARY dl) if (DLFCN_LIBRARY) list(APPEND _REQUIRED_LIBRARIES ${DLFCN_LIBRARY}) else() check_function_exists(dlopen HAVE_DLOPEN) if (NOT HAVE_DLOPEN) message(FATAL_ERROR "FATAL: No dlopen() function detected") endif() endif() endif (UNIX) ########################################################### # For detecting attributes we need to treat warnings as # errors set(CMAKE_REQUIRED_FLAGS "-Werror") check_c_source_compiles(" void test_constructor_attribute(void) __attribute__ ((constructor)); void test_constructor_attribute(void) { return; } int main(void) { return 0; }" HAVE_CONSTRUCTOR_ATTRIBUTE) check_c_source_compiles(" void test_destructor_attribute(void) __attribute__ ((destructor)); void test_destructor_attribute(void) { return; } int main(void) { return 0; }" HAVE_DESTRUCTOR_ATTRIBUTE) check_c_source_compiles(" #define FALL_THROUGH __attribute__((fallthrough)) int main(void) { int i = 2; switch (i) { case 0: FALL_THROUGH; case 1: break; default: break; } return 0; }" HAVE_FALLTHROUGH_ATTRIBUTE) check_c_source_compiles(" void log_fn(const char *format, ...) __attribute__ ((format (printf, 1, 2))); int main(void) { return 0; }" HAVE_FUNCTION_ATTRIBUTE_FORMAT) check_c_source_compiles(" void test_address_sanitizer_attribute(void) __attribute__((no_sanitize_address)); void test_address_sanitizer_attribute(void) { return; } int main(void) { return 0; }" HAVE_ADDRESS_SANITIZER_ATTRIBUTE) # Stop treating wanrings as errors unset(CMAKE_REQUIRED_FLAGS) ########################################################### # ENDIAN if (NOT WIN32) test_big_endian(WORDS_BIGENDIAN) endif (NOT WIN32) set(PWRAP_REQUIRED_LIBRARIES ${_REQUIRED_LIBRARIES} CACHE INTERNAL "priv_wrapper required system libraries") priv_wrapper-1.0.1/CHANGELOG.md000644 001750 000144 00000000266 14337675116 016043 0ustar00asnusers000000 000000 CHANGELOG ========= ## Version 1.0.1 (released 2022-11-24) * Fixed dclose() with RTLD_NEXT * Fixed prctl() dlsym prototype ## Version 1.0.0 (released 2022-10-24) * Initial release priv_wrapper-1.0.1/cmake/000755 001750 000144 00000000000 14337675300 015301 5ustar00asnusers000000 000000 priv_wrapper-1.0.1/cmake/Toolchain-Debian-mips.cmake000644 001750 000144 00000001173 14307550701 022345 0ustar00asnusers000000 000000 include(CMakeForceCompiler) set(TOOLCHAIN_PREFIX mips-linux-gnu) set(CMAKE_SYSTEM_NAME Linux) set(CMAKE_SYSTEM_VERSION 1) set(CMAKE_SYSTEM_PROCESSOR mips) # This is the location of the mips toolchain set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc) set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++) # This is the file system root of the target set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX}) # Search for programs in the build host directories set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) # For libraries and headers in the target directories set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) priv_wrapper-1.0.1/cmake/Modules/000755 001750 000144 00000000000 14337675300 016711 5ustar00asnusers000000 000000 priv_wrapper-1.0.1/cmake/Modules/DefineCMakeDefaults.cmake000644 001750 000144 00000001251 14307550701 023467 0ustar00asnusers000000 000000 # Always include srcdir and builddir in include path # This saves typing ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY} in # about every subdir # since cmake 2.4.0 set(CMAKE_INCLUDE_CURRENT_DIR ON) # Put the include dirs which are in the source or build tree # before all other include dirs, so the headers in the sources # are preferred over the already installed ones # since cmake 2.4.1 set(CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON) # Use colored output # since cmake 2.4.0 set(CMAKE_COLOR_MAKEFILE ON) # Create the compile command database for clang by default set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # Always build with -fPIC set(CMAKE_POSITION_INDEPENDENT_CODE ON) priv_wrapper-1.0.1/cmake/Modules/COPYING-CMAKE-SCRIPTS000644 001750 000144 00000002457 14307550701 021711 0ustar00asnusers000000 000000 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. priv_wrapper-1.0.1/cmake/Modules/AddCCompilerFlag.cmake000644 001750 000144 00000001515 14307550701 022767 0ustar00asnusers000000 000000 # # add_c_compiler_flag("-Werror" SUPPORTED_CFLAGS) # # Copyright (c) 2018 Andreas Schneider # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. include(CheckCCompilerFlag) macro(add_c_compiler_flag _COMPILER_FLAG _OUTPUT_VARIABLE) string(TOUPPER ${_COMPILER_FLAG} _COMPILER_FLAG_NAME) string(REGEX REPLACE "^-" "" _COMPILER_FLAG_NAME "${_COMPILER_FLAG_NAME}") string(REGEX REPLACE "(-|=|\ )" "_" _COMPILER_FLAG_NAME "${_COMPILER_FLAG_NAME}") check_c_compiler_flag("${_COMPILER_FLAG}" WITH_${_COMPILER_FLAG_NAME}_FLAG) if (WITH_${_COMPILER_FLAG_NAME}_FLAG) #string(APPEND ${_OUTPUT_VARIABLE} "${_COMPILER_FLAG} ") list(APPEND ${_OUTPUT_VARIABLE} ${_COMPILER_FLAG}) endif() endmacro() priv_wrapper-1.0.1/cmake/Modules/AddCMockaTest.cmake000644 001750 000144 00000006250 14307550701 022316 0ustar00asnusers000000 000000 # # Copyright (c) 2007 Daniel Gollub # Copyright (c) 2007-2018 Andreas Schneider # Copyright (c) 2018 Anderson Toshiyuki Sasaki # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. #.rst: # AddCMockaTest # ------------- # # This file provides a function to add a test # # Functions provided # ------------------ # # :: # # add_cmocka_test(target_name # SOURCES src1 src2 ... srcN # [COMPILE_OPTIONS opt1 opt2 ... optN] # [LINK_LIBRARIES lib1 lib2 ... libN] # [LINK_OPTIONS lopt1 lop2 .. loptN] # ) # # ``target_name``: # Required, expects the name of the test which will be used to define a target # # ``SOURCES``: # Required, expects one or more source files names # # ``COMPILE_OPTIONS``: # Optional, expects one or more options to be passed to the compiler # # ``LINK_LIBRARIES``: # Optional, expects one or more libraries to be linked with the test # executable. # # ``LINK_OPTIONS``: # Optional, expects one or more options to be passed to the linker # # # Example: # # .. code-block:: cmake # # add_cmocka_test(my_test # SOURCES my_test.c other_source.c # COMPILE_OPTIONS -g -Wall # LINK_LIBRARIES mylib # LINK_OPTIONS -Wl,--enable-syscall-fixup # ) # # Where ``my_test`` is the name of the test, ``my_test.c`` and # ``other_source.c`` are sources for the binary, ``-g -Wall`` are compiler # options to be used, ``mylib`` is a target of a library to be linked, and # ``-Wl,--enable-syscall-fixup`` is an option passed to the linker. # enable_testing() include(CTest) if (CMAKE_CROSSCOMPILING) if (WIN32) find_program(WINE_EXECUTABLE NAMES wine) set(TARGET_SYSTEM_EMULATOR ${WINE_EXECUTABLE} CACHE INTERNAL "") endif() endif() function(ADD_CMOCKA_TEST _TARGET_NAME) set(one_value_arguments ) set(multi_value_arguments SOURCES COMPILE_OPTIONS LINK_LIBRARIES LINK_OPTIONS ) cmake_parse_arguments(_add_cmocka_test "" "${one_value_arguments}" "${multi_value_arguments}" ${ARGN} ) if (NOT DEFINED _add_cmocka_test_SOURCES) message(FATAL_ERROR "No sources provided for target ${_TARGET_NAME}") endif() add_executable(${_TARGET_NAME} ${_add_cmocka_test_SOURCES}) if (DEFINED _add_cmocka_test_COMPILE_OPTIONS) target_compile_options(${_TARGET_NAME} PRIVATE ${_add_cmocka_test_COMPILE_OPTIONS} ) endif() if (DEFINED _add_cmocka_test_LINK_LIBRARIES) target_link_libraries(${_TARGET_NAME} PRIVATE ${_add_cmocka_test_LINK_LIBRARIES} ) endif() if (DEFINED _add_cmocka_test_LINK_OPTIONS) set_target_properties(${_TARGET_NAME} PROPERTIES LINK_FLAGS ${_add_cmocka_test_LINK_OPTIONS} ) endif() add_test(${_TARGET_NAME} ${TARGET_SYSTEM_EMULATOR} ${_TARGET_NAME} ) endfunction (ADD_CMOCKA_TEST) priv_wrapper-1.0.1/cmake/Modules/DefinePlatformDefaults.cmake000644 001750 000144 00000001460 14307550701 024275 0ustar00asnusers000000 000000 # Set system vars if (CMAKE_SYSTEM_NAME MATCHES "Linux") set(LINUX TRUE) endif(CMAKE_SYSTEM_NAME MATCHES "Linux") if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD") set(FREEBSD TRUE) set(BSD TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "FreeBSD") if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD") set(OPENBSD TRUE) set(BSD TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "OpenBSD") if (CMAKE_SYSTEM_NAME MATCHES "NetBSD") set(NETBSD TRUE) set(BSD TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "NetBSD") if (CMAKE_SYSTEM_NAME MATCHES "(Solaris|SunOS)") set(SOLARIS TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "(Solaris|SunOS)") if (CMAKE_SYSTEM_NAME MATCHES "OS2") set(OS2 TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "OS2") if (CMAKE_SYSTEM_NAME MATCHES "Darwin") set(OSX TRUE) endif (CMAKE_SYSTEM_NAME MATCHES "Darwin") priv_wrapper-1.0.1/cmake/Modules/MacroEnsureOutOfSourceBuild.cmake000644 001750 000144 00000001227 14307550701 025250 0ustar00asnusers000000 000000 # - MACRO_ENSURE_OUT_OF_SOURCE_BUILD() # MACRO_ENSURE_OUT_OF_SOURCE_BUILD() # Copyright (c) 2006, Alexander Neundorf, # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. macro (MACRO_ENSURE_OUT_OF_SOURCE_BUILD _errorMessage) string(COMPARE EQUAL "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" _insource) if (_insource) message(SEND_ERROR "${_errorMessage}") message(FATAL_ERROR "Remove the file CMakeCache.txt in ${CMAKE_SOURCE_DIR} first.") endif (_insource) endmacro (MACRO_ENSURE_OUT_OF_SOURCE_BUILD) priv_wrapper-1.0.1/cmake/Modules/CheckCCompilerFlagSSP.cmake000644 001750 000144 00000003560 14307550701 023704 0ustar00asnusers000000 000000 # - Check whether the C compiler supports a given flag in the # context of a stack checking compiler option. # CHECK_C_COMPILER_FLAG_SSP(FLAG VARIABLE) # # FLAG - the compiler flag # VARIABLE - variable to store the result # # This actually calls check_c_source_compiles. # See help for CheckCSourceCompiles for a listing of variables # that can modify the build. # Copyright (c) 2006, Alexander Neundorf, # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. # Requires cmake 3.10 #include_guard(GLOBAL) include(CheckCSourceCompiles) include(CMakeCheckCompilerFlagCommonPatterns) macro(CHECK_C_COMPILER_FLAG_SSP _FLAG _RESULT) set(SAFE_CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS}") set(CMAKE_REQUIRED_FLAGS "${_FLAG}") # Normalize locale during test compilation. set(_CheckCCompilerFlag_LOCALE_VARS LC_ALL LC_MESSAGES LANG) foreach(v ${_CheckCCompilerFlag_LOCALE_VARS}) set(_CheckCCompilerFlag_SAVED_${v} "$ENV{${v}}") set(ENV{${v}} C) endforeach() CHECK_COMPILER_FLAG_COMMON_PATTERNS(_CheckCCompilerFlag_COMMON_PATTERNS) check_c_source_compiles("int main(int argc, char **argv) { char buffer[256]; return buffer[argc]=0;}" ${_RESULT} # Some compilers do not fail with a bad flag FAIL_REGEX "command line option .* is valid for .* but not for C" # GNU ${_CheckCCompilerFlag_COMMON_PATTERNS}) foreach(v ${_CheckCCompilerFlag_LOCALE_VARS}) set(ENV{${v}} ${_CheckCCompilerFlag_SAVED_${v}}) unset(_CheckCCompilerFlag_SAVED_${v}) endforeach() unset(_CheckCCompilerFlag_LOCALE_VARS) unset(_CheckCCompilerFlag_COMMON_PATTERNS) set(CMAKE_REQUIRED_FLAGS "${SAFE_CMAKE_REQUIRED_FLAGS}") endmacro(CHECK_C_COMPILER_FLAG_SSP) priv_wrapper-1.0.1/cmake/Modules/DefineCompilerFlags.cmake000644 001750 000144 00000005551 14307550701 023555 0ustar00asnusers000000 000000 if (UNIX AND NOT WIN32) # Activate with: -DCMAKE_BUILD_TYPE=Profiling set(CMAKE_C_FLAGS_PROFILING "-O0 -g -fprofile-arcs -ftest-coverage" CACHE STRING "Flags used by the C compiler during PROFILING builds.") set(CMAKE_CXX_FLAGS_PROFILING "-O0 -g -fprofile-arcs -ftest-coverage" CACHE STRING "Flags used by the CXX compiler during PROFILING builds.") set(CMAKE_SHARED_LINKER_FLAGS_PROFILING "-fprofile-arcs -ftest-coverage" CACHE STRING "Flags used by the linker during the creation of shared libraries during PROFILING builds.") set(CMAKE_MODULE_LINKER_FLAGS_PROFILING "-fprofile-arcs -ftest-coverage" CACHE STRING "Flags used by the linker during the creation of shared libraries during PROFILING builds.") set(CMAKE_EXEC_LINKER_FLAGS_PROFILING "-fprofile-arcs -ftest-coverage" CACHE STRING "Flags used by the linker during PROFILING builds.") # Activate with: -DCMAKE_BUILD_TYPE=AddressSanitizer set(CMAKE_C_FLAGS_ADDRESSSANITIZER "-g -O1 -fsanitize=address -fno-omit-frame-pointer" CACHE STRING "Flags used by the C compiler during ADDRESSSANITIZER builds.") set(CMAKE_CXX_FLAGS_ADDRESSSANITIZER "-g -O1 -fsanitize=address -fno-omit-frame-pointer" CACHE STRING "Flags used by the CXX compiler during ADDRESSSANITIZER builds.") set(CMAKE_SHARED_LINKER_FLAGS_ADDRESSSANITIZER "-fsanitize=address" CACHE STRING "Flags used by the linker during the creation of shared libraries during ADDRESSSANITIZER builds.") set(CMAKE_MODULE_LINKER_FLAGS_ADDRESSSANITIZER "-fsanitize=address" CACHE STRING "Flags used by the linker during the creation of shared libraries during ADDRESSSANITIZER builds.") set(CMAKE_EXEC_LINKER_FLAGS_ADDRESSSANITIZER "-fsanitize=address" CACHE STRING "Flags used by the linker during ADDRESSSANITIZER builds.") # Activate with: -DCMAKE_BUILD_TYPE=UndefinedSanitizer set(CMAKE_C_FLAGS_UNDEFINEDSANITIZER "-g -O1 -fsanitize=undefined -fsanitize=null -fsanitize=alignment -fno-sanitize-recover" CACHE STRING "Flags used by the C compiler during UNDEFINEDSANITIZER builds.") set(CMAKE_CXX_FLAGS_UNDEFINEDSANITIZER "-g -O1 -fsanitize=undefined -fsanitize=null -fsanitize=alignment -fno-sanitize-recover" CACHE STRING "Flags used by the CXX compiler during UNDEFINEDSANITIZER builds.") set(CMAKE_SHARED_LINKER_FLAGS_UNDEFINEDSANITIZER "-fsanitize=undefined" CACHE STRING "Flags used by the linker during the creation of shared libraries during UNDEFINEDSANITIZER builds.") set(CMAKE_MODULE_LINKER_FLAGS_UNDEFINEDSANITIZER "-fsanitize=undefined" CACHE STRING "Flags used by the linker during the creation of shared libraries during UNDEFINEDSANITIZER builds.") set(CMAKE_EXEC_LINKER_FLAGS_UNDEFINEDSANITIZER "-fsanitize=undefined" CACHE STRING "Flags used by the linker during UNDEFINEDSANITIZER builds.") endif() priv_wrapper-1.0.1/config.h.cmake000644 001750 000144 00000002345 14324463127 016720 0ustar00asnusers000000 000000 /* Name of package */ #cmakedefine PRIV_WRAPPER_PACKAGE "${PRIV_WRAPPER_PACKAGE}" /* Version number of package */ #cmakedefine PRIV_WRAPPER_VERSION "${PRIV_WRAPPER_VERSION}" #cmakedefine BINARYDIR "${BINARYDIR}" #cmakedefine SOURCEDIR "${SOURCEDIR}" /************************** HEADER FILES *************************/ #cmakedefine HAVE_SYS_PRCTL_H 1 #cmakedefine HAVE_SYS_TIME_H 1 #cmakedefine HAVE_SYS_RESOURCE_H 1 /*************************** FUNCTIONS ***************************/ #cmakedefine HAVE_PRCTL 1 #cmakedefine HAVE_SETRLIMIT 1 #cmakedefine HAVE_CHROOT 1 #cmakedefine HAVE_PLEDGE 1 /************************** PROTOTYPES ***************************/ #cmakedefine HAVE_SETRLIMIT_RLIMIT_RESOURCE_T 1 /**************************** OPTIONS ****************************/ #cmakedefine HAVE_CONSTRUCTOR_ATTRIBUTE 1 #cmakedefine HAVE_DESTRUCTOR_ATTRIBUTE 1 #cmakedefine HAVE_FALLTHROUGH_ATTRIBUTE 1 #cmakedefine HAVE_ADDRESS_SANITIZER_ATTRIBUTE 1 #cmakedefine HAVE_FUNCTION_ATTRIBUTE_FORMAT 1 /*************************** ENDIAN *****************************/ /* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most significant byte first (like Motorola and SPARC, unlike Intel). */ #cmakedefine WORDS_BIGENDIAN 1 priv_wrapper-1.0.1/.editorconfig000644 001750 000144 00000000472 14324463127 016677 0ustar00asnusers000000 000000 root = true [*] charset = utf-8 max_line_length = 80 end_of_line = lf trim_trailing_whitespace = true insert_final_newline = true [*.{c,h}] indent_style = tab indent_size = 8 tab_width = 8 [*.cmake] indent_style = space indent_size = 4 tab_width = 4 [CMake*] indent_style = space indent_size = 4 tab_width = 4 priv_wrapper-1.0.1/.gitlab-ci.yml000644 001750 000144 00000014010 14324463127 016647 0ustar00asnusers000000 000000 --- variables: BUILD_IMAGES_PROJECT: cmocka/gitlab-build-images FEDORA_BUILD: buildenv-fedora CENTOS7_BUILD: buildenv-centos7 TUMBLEWEED_BUILD: buildenv-tumbleweed MINGW_BUILD: buildenv-mingw UBUNTU_BUILD: buildenv-ubuntu stages: - build - test - analysis centos7/x86_64: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$CENTOS7_BUILD script: - mkdir -p obj && cd obj && cmake3 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ fedora/x86_64: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$FEDORA_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ fedora/address-sanitizer: stage: build image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$FEDORA_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=AddressSanitizer -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ fedora/undefined-sanitizer: stage: analysis image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$FEDORA_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=UndefinedSanitizer -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ fedora/csbuild: stage: analysis image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$FEDORA_BUILD script: - | if [[ -z "$CI_COMMIT_BEFORE_SHA" ]]; then export CI_COMMIT_BEFORE_SHA=$(git rev-parse "${CI_COMMIT_SHA}~10") fi # Check if the commit exists in this branch # This is not the case for a force push git branch --contains $CI_COMMIT_BEFORE_SHA 2>/dev/null || export CI_COMMIT_BEFORE_SHA=$(git rev-parse "${CI_COMMIT_SHA}~10") export CI_COMMIT_RANGE="$CI_COMMIT_BEFORE_SHA..$CI_COMMIT_SHA" - csbuild --build-dir=obj-csbuild --prep-cmd="cmake -DCMAKE_BUILD_TYPE=Debug -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON @SRCDIR@" --build-cmd "make clean && make -j$(nproc)" --git-commit-range $CI_COMMIT_RANGE --color --print-current --print-fixed tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj-csbuild/ freebsd/x86_64: stage: test image: script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make && ctest --output-on-failure tags: - freebsd except: - tags only: - branches@cwrap/priv_wrapper - branches@cryptomilk/priv_wrapper artifacts: expire_in: 1 week when: on_failure paths: - obj/ tumbleweed/x86_64/gcc: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$TUMBLEWEED_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ tumbleweed/x86_64/gcc7: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$TUMBLEWEED_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_C_COMPILER=gcc-7 -DCMAKE_CXX_COMPILER=g++-7 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ tumbleweed/x86_64/clang: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$TUMBLEWEED_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ tumbleweed/static-analysis: stage: analysis image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$TUMBLEWEED_BUILD script: - export CCC_CC=clang - export CCC_CXX=clang++ - mkdir -p obj && cd obj && scan-build cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && scan-build --status-bugs -o scan make -j$(nproc) tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/scan tumbleweed/helgrind: stage: analysis image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$TUMBLEWEED_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=Debug -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON -DHELGRIND_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ only: variables: - $VALGRIND_SUPPORTS_FORKED_MUTEXES == "yes" ubuntu/x86_64: stage: test image: $CI_REGISTRY/$BUILD_IMAGES_PROJECT:$UBUNTU_BUILD script: - mkdir -p obj && cd obj && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPICKY_DEVELOPER=ON -DUNIT_TESTING=ON .. && make -j$(nproc) && ctest --output-on-failure tags: - shared except: - tags artifacts: expire_in: 1 week when: on_failure paths: - obj/ priv_wrapper-1.0.1/priv_wrapper.pc.cmake000644 001750 000144 00000000213 14324463127 020336 0ustar00asnusers000000 000000 Name: @PROJECT_NAME@ Description: The priv_wrapper library Version: @PROJECT_VERSION@ Libs: @CMAKE_INSTALL_FULL_LIBDIR@/@PRIV_WRAPPER_LIB@ priv_wrapper-1.0.1/README.md000644 001750 000144 00000001207 14337675116 015505 0ustar00asnusers000000 000000 PRIV_WRAPPER ============ This is a wrapper to disable resource limits and other privilege dropping. DESCRIPTION ----------- More details can be found in the manpage: man -l ./doc/priv_wrapper.1 or the raw text version: less ./doc/priv_wrapper.1.txt For installation instructions please take a look at the README.install file. UNIT TESTS ----------- Steps to run unit tests: mkdir obj cd obj cmake -DUNIT_TESTING=ON .. make ctest # ctest --output-on-failure MAILINGLIST ----------- As the mailing list samba-technical is used and can be found here: https://lists.samba.org/mailman/listinfo/samba-technical priv_wrapper-1.0.1/priv_wrapper-config.cmake.in000644 001750 000144 00000000111 14324463127 021602 0ustar00asnusers000000 000000 set(PRIV_WRAPPER_LIBRARY @CMAKE_INSTALL_FULL_LIBDIR@/@PRIV_WRAPPER_LIB@) priv_wrapper-1.0.1/CPackConfig.cmake000644 001750 000144 00000003350 14307550701 017325 0ustar00asnusers000000 000000 # For help take a look at: # http://www.cmake.org/Wiki/CMake:CPackConfiguration ### general settings set(CPACK_PACKAGE_NAME ${PROJECT_NAME}) set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "The SSH library") set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.md") set(CPACK_PACKAGE_VENDOR "The SSH Library Development Team") set(CPACK_PACKAGE_INSTALL_DIRECTORY ${CPACK_PACKAGE_NAME}) set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE") ### versions set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}") ### source generator set(CPACK_SOURCE_GENERATOR "TGZ") set(CPACK_SOURCE_IGNORE_FILES "~$;[.]swp$;/[.]svn/;/[.]git/;.gitignore;/build*;/obj*;tags;cscope.*") set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}") if (WIN32) set(CPACK_GENERATOR "ZIP") ### nsis generator find_package(NSIS) if (NSIS_MAKE) set(CPACK_GENERATOR "${CPACK_GENERATOR};NSIS") set(CPACK_NSIS_DISPLAY_NAME "The SSH Library") set(CPACK_NSIS_COMPRESSOR "/SOLID zlib") set(CPACK_NSIS_MENU_LINKS "http://www.libssh.org/" "libssh homepage") endif (NSIS_MAKE) endif (WIN32) set(CPACK_PACKAGE_INSTALL_DIRECTORY "libssh") set(CPACK_PACKAGE_FILE_NAME ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}) set(CPACK_COMPONENT_LIBRARIES_DISPLAY_NAME "Libraries") set(CPACK_COMPONENT_HEADERS_DISPLAY_NAME "C/C++ Headers") set(CPACK_COMPONENT_LIBRARIES_DESCRIPTION "Libraries used to build programs which use libssh") set(CPACK_COMPONENT_HEADERS_DESCRIPTION "C/C++ header files for use with libssh") set(CPACK_COMPONENT_HEADERS_DEPENDS libraries) #set(CPACK_COMPONENT_PROJECTS_GROUP "Runtime") set(CPACK_COMPONENT_LIBRARIES_GROUP "Development") set(CPACK_COMPONENT_HEADERS_GROUP "Development") include(CPack) priv_wrapper-1.0.1/DefineOptions.cmake000644 001750 000144 00000000265 14307550701 017766 0ustar00asnusers000000 000000 option(UNIT_TESTING "Build with unit tests" OFF) option(HELGRIND_TESTING "Run threaded unit tests with helgrind" OFF) option(PICKY_DEVELOPER "Build with picky developer flags" OFF) priv_wrapper-1.0.1/priv_wrapper-config-version.cmake.in000644 001750 000144 00000000605 14307550701 023271 0ustar00asnusers000000 000000 set(PACKAGE_VERSION @PROJECT_VERSION@) # Check whether the requested PACKAGE_FIND_VERSION is compatible if("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}") set(PACKAGE_VERSION_COMPATIBLE FALSE) else() set(PACKAGE_VERSION_COMPATIBLE TRUE) if ("${PACKAGE_VERSION}" VERSION_EQUAL "${PACKAGE_FIND_VERSION}") set(PACKAGE_VERSION_EXACT TRUE) endif() endif() priv_wrapper-1.0.1/AUTHORS000644 001750 000144 00000000144 14324463127 015266 0ustar00asnusers000000 000000 Andreas Schneider Nikos Mavrogiannopoulos Pavel Filipenský priv_wrapper-1.0.1/LICENSE000644 001750 000144 00000104513 14307550701 015224 0ustar00asnusers000000 000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read .