Home | History | Annotate | Download | only in chrome_elf 
      1 // Copyright 2014 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 // This module contains the necessary code to register the Breakpad exception
      6 // handler. This implementation is based on Chrome's crash reporting code.
      7 
      8 #include "chrome_elf/breakpad.h"
      9 
     10 #include <sddl.h>
     11 
     12 #include "base/macros.h"
     13 #include "breakpad/src/client/windows/handler/exception_handler.h"
     14 #include "chrome_elf/chrome_elf_util.h"
     15 #include "version.h"  // NOLINT
     16 
     17 google_breakpad::ExceptionHandler* g_elf_breakpad = NULL;
     18 
     19 namespace {
     20 
     21 const wchar_t kBreakpadProductName[] = L"Chrome";
     22 const wchar_t kBreakpadVersionEntry[] = L"ver";
     23 const wchar_t kBreakpadProdEntry[] = L"prod";
     24 const wchar_t kBreakpadPlatformEntry[] = L"plat";
     25 const wchar_t kBreakpadPlatformWin32[] = L"Win32";
     26 
     27 // The protocol for connecting to the out-of-process Breakpad crash
     28 // reporter is different for x86-32 and x86-64: the message sizes
     29 // are different because the message struct contains a pointer.  As
     30 // a result, there are two different named pipes to connect to.  The
     31 // 64-bit one is distinguished with an "-x64" suffix.
     32 const wchar_t kChromePipeName[] = L"\\\\.\\pipe\\ChromeCrashServices\\";
     33 const wchar_t kGoogleUpdatePipeName[] = L"\\\\.\\pipe\\GoogleCrashServices\\";
     34 const wchar_t kSystemPrincipalSid[] = L"S-1-5-18";
     35 
     36 const wchar_t kNoErrorDialogs[] = L"noerrdialogs";
     37 const wchar_t kChromeHeadless[] = L"CHROME_HEADLESS";
     38 
     39 google_breakpad::CustomClientInfo* GetCustomInfo() {
     40   static google_breakpad::CustomInfoEntry ver_entry(
     41       kBreakpadVersionEntry, TEXT(CHROME_VERSION_STRING));
     42   static google_breakpad::CustomInfoEntry prod_entry(
     43       kBreakpadProdEntry, kBreakpadProductName);
     44   static google_breakpad::CustomInfoEntry plat_entry(
     45       kBreakpadPlatformEntry, kBreakpadPlatformWin32);
     46   static google_breakpad::CustomInfoEntry entries[] = {
     47       ver_entry, prod_entry, plat_entry  };
     48   static google_breakpad::CustomClientInfo custom_info = {
     49       entries, arraysize(entries) };
     50   return &custom_info;
     51 }
     52 
     53 base::string16 GetUserSidString() {
     54   // Get the current token.
     55   HANDLE token = NULL;
     56   base::string16 user_sid;
     57   if (!::OpenProcessToken(::GetCurrentProcess(), TOKEN_QUERY, &token))
     58     return user_sid;
     59 
     60   DWORD size = sizeof(TOKEN_USER) + SECURITY_MAX_SID_SIZE;
     61   BYTE user_bytes[sizeof(TOKEN_USER) + SECURITY_MAX_SID_SIZE] = {};
     62   TOKEN_USER* user = reinterpret_cast<TOKEN_USER*>(user_bytes);
     63 
     64   wchar_t* sid_string = NULL;
     65   if (::GetTokenInformation(token, TokenUser, user, size, &size) &&
     66       user->User.Sid &&
     67       ::ConvertSidToStringSid(user->User.Sid, &sid_string)) {
     68     user_sid = sid_string;
     69     ::LocalFree(sid_string);
     70   }
     71 
     72   CloseHandle(token);
     73   return user_sid;
     74 }
     75 
     76 bool IsHeadless() {
     77   DWORD ret = ::GetEnvironmentVariable(L"CHROME_HEADLESS", NULL, 0);
     78   if (ret != 0)
     79     return true;
     80 
     81   wchar_t* command_line = ::GetCommandLine();
     82 
     83   // Note: Since this is a pure substring search rather than a check for a
     84   // switch, there is a small chance that this code will match things that the
     85   // Chrome code (which executes a similar check) does not. However, as long as
     86   // no other switches contain the string "noerrdialogs", it should not be an
     87   // issue.
     88   return (command_line && wcsstr(command_line, kNoErrorDialogs));
     89 }
     90 
     91 }  // namespace
     92 
     93 int GenerateCrashDump(EXCEPTION_POINTERS* exinfo) {
     94   DWORD code = exinfo->ExceptionRecord->ExceptionCode;
     95   if (code == EXCEPTION_BREAKPOINT || code == EXCEPTION_SINGLE_STEP)
     96     return EXCEPTION_CONTINUE_SEARCH;
     97 
     98   if (g_elf_breakpad != NULL)
     99     g_elf_breakpad->WriteMinidumpForException(exinfo);
    100   return EXCEPTION_CONTINUE_SEARCH;
    101 }
    102 
    103 void InitializeCrashReporting() {
    104   wchar_t exe_path[MAX_PATH] = {};
    105   if (!::GetModuleFileName(NULL, exe_path, arraysize(exe_path)))
    106     return;
    107 
    108   // Disable the message box for assertions.
    109   _CrtSetReportMode(_CRT_ASSERT, 0);
    110 
    111   // Get the alternate dump directory. We use the temp path.
    112   // N.B. We don't use base::GetTempDir() here to avoid running more code then
    113   //      necessary before crashes can be properly reported.
    114   wchar_t temp_directory[MAX_PATH + 1] = {};
    115   DWORD length = GetTempPath(MAX_PATH, temp_directory);
    116   if (length == 0)
    117     return;
    118 
    119   // Minidump with stacks, PEB, TEBs and unloaded module list.
    120   MINIDUMP_TYPE dump_type = static_cast<MINIDUMP_TYPE>(
    121       MiniDumpWithProcessThreadData |  // Get PEB and TEB.
    122       MiniDumpWithUnloadedModules |  // Get unloaded modules when available.
    123       MiniDumpWithIndirectlyReferencedMemory);  // Get memory referenced by
    124                                                 // stack.
    125 
    126 #if defined(GOOGLE_CHROME_BUILD) && defined(OFFICIAL_BUILD)
    127   bool is_official_chrome_build = true;
    128 #else
    129   bool is_official_chrome_build = false;
    130 #endif
    131 
    132   base::string16 pipe_name;
    133 
    134   bool enabled_by_policy = false;
    135   bool use_policy = ReportingIsEnforcedByPolicy(&enabled_by_policy);
    136 
    137   if (!use_policy && IsHeadless()) {
    138     pipe_name = kChromePipeName;
    139   } else if (use_policy ?
    140                  enabled_by_policy :
    141                  (is_official_chrome_build && AreUsageStatsEnabled(exe_path))) {
    142     // Build the pipe name. It can be one of:
    143     // 32-bit system: \\.\pipe\GoogleCrashServices\S-1-5-18
    144     // 32-bit user: \\.\pipe\GoogleCrashServices\<user SID>
    145     // 64-bit system: \\.\pipe\GoogleCrashServices\S-1-5-18-x64
    146     // 64-bit user: \\.\pipe\GoogleCrashServices\<user SID>-x64
    147     base::string16 user_sid = IsSystemInstall(exe_path) ? kSystemPrincipalSid :
    148                                                           GetUserSidString();
    149     if (user_sid.empty())
    150       return;
    151 
    152     pipe_name = kGoogleUpdatePipeName;
    153     pipe_name += user_sid;
    154 
    155 #if defined(_WIN64)
    156     pipe_name += L"-x64";
    157 #endif
    158   } else {
    159     // Either this is a Chromium build, reporting is disabled by policy or the
    160     // user has not given consent.
    161     return;
    162   }
    163 
    164   g_elf_breakpad = new google_breakpad::ExceptionHandler(
    165       temp_directory,
    166       NULL,
    167       NULL,
    168       NULL,
    169       google_breakpad::ExceptionHandler::HANDLER_ALL,
    170       dump_type,
    171       pipe_name.c_str(),
    172       GetCustomInfo());
    173 
    174   if (g_elf_breakpad->IsOutOfProcess()) {
    175     // Tells breakpad to handle breakpoint and single step exceptions.
    176     g_elf_breakpad->set_handle_debug_exceptions(true);
    177   }
    178 }
    179