libc/bionic/libc_init_common.cpp

   1 /*
   2  * Copyright (C) 2008 The Android Open Source Project
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *  * Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *  * Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in
  12  *    the documentation and/or other materials provided with the
  13  *    distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include "libc_init_common.h"
  30
  31 #include <elf.h>
  32 #include <errno.h>
  33 #include <fcntl.h>
  34 #include <stddef.h>
  35 #include <stdint.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <sys/auxv.h>
  40 #include <sys/personality.h>
  41 #include <sys/time.h>
  42 #include <unistd.h>
  43
  44 #include "private/KernelArgumentBlock.h"
  45 #include "private/WriteProtected.h"
  46 #include "private/bionic_auxv.h"
  47 #include "private/bionic_globals.h"
  48 #include "private/bionic_tls.h"
  49 #include "private/libc_logging.h"
  50 #include "private/thread_private.h"
  51 #include "pthread_internal.h"
  52
  53 extern "C" abort_msg_t** __abort_message_ptr;
  54 extern "C" int __system_properties_init(void);
  55
  56 __LIBC_HIDDEN__ WriteProtected<libc_globals> __libc_globals;
  57
  58 // Not public, but well-known in the BSDs.
  59 const char* __progname;
  60
  61 // Declared in <unistd.h>.
  62 char** environ;
  63
  64 #if defined(__i386__)
  65 __LIBC_HIDDEN__ void* __libc_sysinfo = nullptr;
  66
  67 __LIBC_HIDDEN__ void __libc_init_sysinfo(KernelArgumentBlock& args) {
  68   __libc_sysinfo = reinterpret_cast<void*>(args.getauxval(AT_SYSINFO));
  69 }
  70
  71 // TODO: lose this function and just access __libc_sysinfo directly.
  72 __LIBC_HIDDEN__ extern "C" void* __kernel_syscall() {
  73   return __libc_sysinfo;
  74 }
  75 #endif
  76
  77 void __libc_init_globals(KernelArgumentBlock& args) {
  78 #if defined(__i386__)
  79   __libc_init_sysinfo(args);
  80 #endif
  81   // Initialize libc globals that are needed in both the linker and in libc.
  82   // In dynamic binaries, this is run at least twice for different copies of the
  83   // globals, once for the linker's copy and once for the one in libc.so.
  84   __libc_auxv = args.auxv;
  85   __libc_globals.initialize();
  86   __libc_globals.mutate([&args](libc_globals* globals) {
  87     __libc_init_vdso(globals, args);
  88     __libc_init_setjmp_cookie(globals, args);
  89   });
  90 }
  91
  92 #if !defined(__LP64__)
  93 static void __check_max_thread_id() {
  94   if (gettid() > 65535) {
  95     __libc_fatal("Limited by the size of pthread_mutex_t, 32 bit bionic libc only accepts "
  96                  "pid <= 65535, but current pid is %d", gettid());
  97   }
  98 }
  99 #endif
 100
 101 static void arc4random_fork_handler() {
 102   _rs_forked = 1;
 103   _thread_arc4_lock();
 104 }
 105
 106 void __libc_init_common(KernelArgumentBlock& args) {
 107   // Initialize various globals.
 108   environ = args.envp;
 109   errno = 0;
 110   __progname = args.argv[0] ? args.argv[0] : "<unknown>";
 111   __abort_message_ptr = args.abort_message_ptr;
 112
 113 #if !defined(__LP64__)
 114   __check_max_thread_id();
 115 #endif
 116
 117   // Register atfork handlers to take and release the arc4random lock.
 118   pthread_atfork(arc4random_fork_handler, _thread_arc4_unlock, _thread_arc4_unlock);
 119
 120   __system_properties_init(); // Requires 'environ'.
 121 }
 122
 123 __noreturn static void __early_abort(int line) {
 124   // We can't write to stdout or stderr because we're aborting before we've checked that
 125   // it's safe for us to use those file descriptors. We probably can't strace either, so
 126   // we rely on the fact that if we dereference a low address, either debuggerd or the
 127   // kernel's crash dump will show the fault address.
 128   *reinterpret_cast<int*>(line) = 0;
 129   _exit(EXIT_FAILURE);
 130 }
 131
 132 // Force any of the closed stdin, stdout and stderr to be associated with /dev/null.
 133 static void __nullify_closed_stdio() {
 134   int dev_null = TEMP_FAILURE_RETRY(open("/dev/null", O_RDWR));
 135   if (dev_null == -1) {
 136     // init won't have /dev/null available, but SELinux provides an equivalent.
 137     dev_null = TEMP_FAILURE_RETRY(open("/sys/fs/selinux/null", O_RDWR));
 138   }
 139   if (dev_null == -1) {
 140     __early_abort(__LINE__);
 141   }
 142
 143   // If any of the stdio file descriptors is valid and not associated
 144   // with /dev/null, dup /dev/null to it.
 145   for (int i = 0; i < 3; i++) {
 146     // If it is /dev/null already, we are done.
 147     if (i == dev_null) {
 148       continue;
 149     }
 150
 151     // Is this fd already open?
 152     int status = TEMP_FAILURE_RETRY(fcntl(i, F_GETFL));
 153     if (status != -1) {
 154       continue;
 155     }
 156
 157     // The only error we allow is that the file descriptor does not
 158     // exist, in which case we dup /dev/null to it.
 159     if (errno == EBADF) {
 160       // Try dupping /dev/null to this stdio file descriptor and
 161       // repeat if there is a signal. Note that any errors in closing
 162       // the stdio descriptor are lost.
 163       status = TEMP_FAILURE_RETRY(dup2(dev_null, i));
 164       if (status == -1) {
 165         __early_abort(__LINE__);
 166       }
 167     } else {
 168       __early_abort(__LINE__);
 169     }
 170   }
 171
 172   // If /dev/null is not one of the stdio file descriptors, close it.
 173   if (dev_null > 2) {
 174     if (close(dev_null) == -1) {
 175       __early_abort(__LINE__);
 176     }
 177   }
 178 }
 179
 180 // Check if the environment variable definition at 'envstr'
 181 // starts with '<name>=', and if so return the address of the
 182 // first character after the equal sign. Otherwise return null.
 183 static const char* env_match(const char* envstr, const char* name) {
 184   size_t i = 0;
 185
 186   while (envstr[i] == name[i] && name[i] != '\0') {
 187     ++i;
 188   }
 189
 190   if (name[i] == '\0' && envstr[i] == '=') {
 191     return envstr + i + 1;
 192   }
 193
 194   return nullptr;
 195 }
 196
 197 static bool __is_valid_environment_variable(const char* name) {
 198   // According to the kernel source, by default the kernel uses 32*PAGE_SIZE
 199   // as the maximum size for an environment variable definition.
 200   const int MAX_ENV_LEN = 32*4096;
 201
 202   if (name == nullptr) {
 203     return false;
 204   }
 205
 206   // Parse the string, looking for the first '=' there, and its size.
 207   int pos = 0;
 208   int first_equal_pos = -1;
 209   while (pos < MAX_ENV_LEN) {
 210     if (name[pos] == '\0') {
 211       break;
 212     }
 213     if (name[pos] == '=' && first_equal_pos < 0) {
 214       first_equal_pos = pos;
 215     }
 216     pos++;
 217   }
 218
 219   // Check that it's smaller than MAX_ENV_LEN (to detect non-zero terminated strings).
 220   if (pos >= MAX_ENV_LEN) {
 221     return false;
 222   }
 223
 224   // Check that it contains at least one equal sign that is not the first character
 225   if (first_equal_pos < 1) {
 226     return false;
 227   }
 228
 229   return true;
 230 }
 231
 232 static bool __is_unsafe_environment_variable(const char* name) {
 233   // None of these should be allowed when the AT_SECURE auxv
 234   // flag is set. This flag is set to inform userspace that a
 235   // security transition has occurred, for example, as a result
 236   // of executing a setuid program or the result of an SELinux
 237   // security transition.
 238   static constexpr const char* UNSAFE_VARIABLE_NAMES[] = {
 239     "GCONV_PATH",
 240     "GETCONF_DIR",
 241     "HOSTALIASES",
 242     "JE_MALLOC_CONF",
 243     "LD_AOUT_LIBRARY_PATH",
 244     "LD_AOUT_PRELOAD",
 245     "LD_AUDIT",
 246     "LD_DEBUG",
 247     "LD_DEBUG_OUTPUT",
 248     "LD_DYNAMIC_WEAK",
 249     "LD_LIBRARY_PATH",
 250     "LD_ORIGIN_PATH",
 251     "LD_PRELOAD",
 252     "LD_PROFILE",
 253     "LD_SHOW_AUXV",
 254     "LD_USE_LOAD_BIAS",
 255     "LOCALDOMAIN",
 256     "LOCPATH",
 257     "MALLOC_CHECK_",
 258     "MALLOC_CONF",
 259     "MALLOC_TRACE",
 260     "NIS_PATH",
 261     "NLSPATH",
 262     "RESOLV_HOST_CONF",
 263     "RES_OPTIONS",
 264     "TMPDIR",
 265     "TZDIR",
 266   };
 267   for (const auto& unsafe_variable_name : UNSAFE_VARIABLE_NAMES) {
 268     if (env_match(name, unsafe_variable_name) != nullptr) {
 269       return true;
 270     }
 271   }
 272   return false;
 273 }
 274
 275 static void __sanitize_environment_variables(char** env) {
 276   bool is_AT_SECURE = getauxval(AT_SECURE);
 277   char** src = env;
 278   char** dst = env;
 279   for (; src[0] != nullptr; ++src) {
 280     if (!__is_valid_environment_variable(src[0])) {
 281       continue;
 282     }
 283     // Remove various unsafe environment variables if we're loading a setuid program.
 284     if (is_AT_SECURE && __is_unsafe_environment_variable(src[0])) {
 285       continue;
 286     }
 287     dst[0] = src[0];
 288     ++dst;
 289   }
 290   dst[0] = nullptr;
 291 }
 292
 293 static void __initialize_personality() {
 294 #if !defined(__LP64__)
 295   int old_value = personality(0xffffffff);
 296   if (old_value == -1) {
 297     __libc_fatal("error getting old personality value: %s", strerror(errno));
 298   }
 299
 300   if (personality((static_cast<unsigned int>(old_value) & ~PER_MASK) | PER_LINUX32) == -1) {
 301     __libc_fatal("error setting PER_LINUX32 personality: %s", strerror(errno));
 302   }
 303 #endif
 304 }
 305
 306 void __libc_init_AT_SECURE(KernelArgumentBlock& args) {
 307   __libc_auxv = args.auxv;
 308   __abort_message_ptr = args.abort_message_ptr;
 309
 310   // Check that the kernel provided a value for AT_SECURE.
 311   bool found_AT_SECURE = false;
 312   for (ElfW(auxv_t)* v = __libc_auxv; v->a_type != AT_NULL; ++v) {
 313     if (v->a_type == AT_SECURE) {
 314       found_AT_SECURE = true;
 315       break;
 316     }
 317   }
 318   if (!found_AT_SECURE) __early_abort(__LINE__);
 319
 320   if (getauxval(AT_SECURE)) {
 321     // If this is a setuid/setgid program, close the security hole described in
 322     // https://www.freebsd.org/security/advisories/FreeBSD-SA-02:23.stdio.asc
 323     __nullify_closed_stdio();
 324
 325     __sanitize_environment_variables(args.envp);
 326   }
 327
 328   // Now the environment has been sanitized, make it available.
 329   environ = args.envp;
 330
 331   __initialize_personality();
 332 }
 333
 334 /* This function will be called during normal program termination
 335  * to run the destructors that are listed in the .fini_array section
 336  * of the executable, if any.
 337  *
 338  * 'fini_array' points to a list of function addresses. The first
 339  * entry in the list has value -1, the last one has value 0.
 340  */
 341 void __libc_fini(void* array) {
 342   typedef void (*Dtor)();
 343   Dtor* fini_array = reinterpret_cast<Dtor*>(array);
 344   const Dtor minus1 = reinterpret_cast<Dtor>(static_cast<uintptr_t>(-1));
 345
 346   // Sanity check - first entry must be -1.
 347   if (array == NULL || fini_array[0] != minus1) {
 348     return;
 349   }
 350
 351   // Skip over it.
 352   fini_array += 1;
 353
 354   // Count the number of destructors.
 355   int count = 0;
 356   while (fini_array[count] != NULL) {
 357     ++count;
 358   }
 359
 360   // Now call each destructor in reverse order.
 361   while (count > 0) {
 362     Dtor dtor = fini_array[--count];
 363
 364     // Sanity check, any -1 in the list is ignored.
 365     if (dtor == minus1) {
 366       continue;
 367     }
 368
 369     dtor();
 370   }
 371 }