blob: 1c94fd3107389d9dc05f755e8b429df8fcc167af [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// mini_installer.exe is the first exe that is run when chrome is being
// installed or upgraded. It is designed to be extremely small (~5KB with no
// extra resources linked) and it has two main jobs:
// 1) unpack the resources (possibly decompressing some)
// 2) run the real installer (setup.exe) with appropriate flags.
//
// In order to be really small the app doesn't link against the CRT and
// defines the following compiler/linker flags:
// EnableIntrinsicFunctions="true" compiler: /Oi
// BasicRuntimeChecks="0"
// BufferSecurityCheck="false" compiler: /GS-
// EntryPointSymbol="MainEntryPoint" linker: /ENTRY
// /ENTRY also stops the CRT from being pulled in and does this more
// precisely than /NODEFAULTLIB
// OptimizeForWindows98="1" linker: /OPT:NOWIN98
// linker: /SAFESEH:NO
#include "chrome/installer/mini_installer/mini_installer.h"
#include <windows.h>
// #define needed to link in RtlGenRandom(), a.k.a. SystemFunction036. See the
// "Community Additions" comment on MSDN here:
// http://msdn.microsoft.com/en-us/library/windows/desktop/aa387694.aspx
#define SystemFunction036 NTAPI SystemFunction036
#include <NTSecAPI.h>
#undef SystemFunction036
#include <sddl.h>
#include <shellapi.h>
#include <stddef.h>
#include <stdlib.h>
#include <initializer_list>
#include "build/branding_buildflags.h"
#include "chrome/installer/mini_installer/appid.h"
#include "chrome/installer/mini_installer/configuration.h"
#include "chrome/installer/mini_installer/decompress.h"
#include "chrome/installer/mini_installer/mini_installer_constants.h"
#include "chrome/installer/mini_installer/pe_resource.h"
#include "chrome/installer/mini_installer/regkey.h"
namespace mini_installer {
typedef StackString<MAX_PATH> PathString;
// This structure passes data back and forth for the processing
// of resource callbacks.
struct Context {
// Input to the call back method. Specifies the dir to save resources.
const wchar_t* base_path;
// First output from call back method. Full path of Chrome archive.
PathString* chrome_resource_path;
// Second output from call back method. Full path of Setup archive/exe.
PathString* setup_resource_path;
// A Windows error code corresponding to an extraction error.
DWORD error_code;
};
// TODO(grt): Frame this in terms of whether or not the brand supports
// integration with Omaha, where Google Update is the Google-specific fork of
// the open-source Omaha project.
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
// Opens the Google Update ClientState key for the current install mode.
bool OpenInstallStateKey(const Configuration& configuration, RegKey* key) {
const HKEY root_key =
configuration.is_system_level() ? HKEY_LOCAL_MACHINE : HKEY_CURRENT_USER;
const wchar_t* app_guid = configuration.chrome_app_guid();
const REGSAM key_access = KEY_QUERY_VALUE | KEY_SET_VALUE;
return OpenClientStateKey(root_key, app_guid, key_access, key) ==
ERROR_SUCCESS;
}
// Writes install results into the registry where it is read by Google Update.
// Don't write anything if there is already a result present, likely
// written by setup.exe.
void WriteInstallResults(const Configuration& configuration,
ProcessExitResult result) {
// Calls to setup.exe will write a "success" result if everything was good
// so we don't need to write anything from here.
if (result.IsSuccess())
return;
// Write the value in Chrome ClientState key.
RegKey key;
DWORD value;
if (OpenInstallStateKey(configuration, &key)) {
if (key.ReadDWValue(kInstallerResultRegistryValue, &value) !=
ERROR_SUCCESS ||
value == 0) {
key.WriteDWValue(kInstallerResultRegistryValue,
result.exit_code ? 1 /* FAILED_CUSTOM_ERROR */
: 0 /* SUCCESS */);
key.WriteDWValue(kInstallerErrorRegistryValue, result.exit_code);
key.WriteDWValue(kInstallerExtraCode1RegistryValue, result.windows_error);
}
}
}
// Writes the value |extra_code_1| into ExtraCode1 for reporting by Omaha.
void WriteExtraCode1(const Configuration& configuration, DWORD extra_code_1) {
// Write the value in Chrome ClientState key.
RegKey key;
if (OpenInstallStateKey(configuration, &key))
key.WriteDWValue(kInstallerExtraCode1RegistryValue, extra_code_1);
}
// This function sets the flag in registry to indicate that Google Update
// should try full installer next time. If the current installer works, this
// flag is cleared by setup.exe at the end of install.
void SetInstallerFlags(const Configuration& configuration) {
StackString<128> value;
RegKey key;
if (!OpenInstallStateKey(configuration, &key))
return;
// TODO(grt): Trim legacy modifiers (chrome,chromeframe,apphost,applauncher,
// multi,readymode,stage,migrating,multifail) from the ap value.
LONG ret = key.ReadSZValue(kApRegistryValue, value.get(), value.capacity());
// The conditions below are handling two cases:
// 1. When ap value is present, we want to add the required tag only if it
// is not present.
// 2. When ap value is missing, we are going to create it with the required
// tag.
if ((ret == ERROR_SUCCESS) || (ret == ERROR_FILE_NOT_FOUND)) {
if (ret == ERROR_FILE_NOT_FOUND)
value.clear();
if (!StrEndsWith(value.get(), kFullInstallerSuffix) &&
value.append(kFullInstallerSuffix)) {
key.WriteSZValue(kApRegistryValue, value.get());
}
}
}
#endif // BUILDFLAG(GOOGLE_CHROME_BRANDING)
// Gets the setup.exe path from Registry by looking at the value of Uninstall
// string. |size| is measured in wchar_t units.
ProcessExitResult GetSetupExePathForAppGuid(bool system_level,
const wchar_t* app_guid,
const wchar_t* previous_version,
wchar_t* path,
size_t size) {
const HKEY root_key = system_level ? HKEY_LOCAL_MACHINE : HKEY_CURRENT_USER;
RegKey key;
LONG result = OpenClientStateKey(root_key, app_guid, KEY_QUERY_VALUE, &key);
if (result == ERROR_SUCCESS)
result = key.ReadSZValue(kUninstallRegistryValue, path, size);
if (result != ERROR_SUCCESS)
return ProcessExitResult(UNABLE_TO_FIND_REGISTRY_KEY, result);
// Check that the path to the existing installer includes the expected
// version number. It's not necessary for accuracy to verify before/after
// delimiters.
if (!SearchStringI(path, previous_version))
return ProcessExitResult(PATCH_NOT_FOR_INSTALLED_VERSION);
// Strip double-quotes surrounding the string, if present.
if (size >= 1 && path[0] == '\"') {
size_t path_length = SafeStrLen(path, size);
if (path_length >= 2 && path[path_length - 1] == '\"') {
if (!SafeStrCopy(path, size, path + 1))
return ProcessExitResult(PATH_STRING_OVERFLOW);
path[path_length - 2] = '\0';
}
}
return ProcessExitResult(SUCCESS_EXIT_CODE);
}
// Gets the path to setup.exe of the previous version. The overall path is found
// in the Uninstall string in the registry. A previous version number specified
// in |configuration| is used if available. |size| is measured in wchar_t units.
ProcessExitResult GetPreviousSetupExePath(const Configuration& configuration,
wchar_t* path,
size_t size) {
// Check Chrome's ClientState key for the path to setup.exe. This will have
// the correct path for all well-functioning installs.
return GetSetupExePathForAppGuid(
configuration.is_system_level(), configuration.chrome_app_guid(),
configuration.previous_version(), path, size);
}
// Calls CreateProcess with good default parameters and waits for the process to
// terminate returning the process exit code. In case of CreateProcess failure,
// returns a results object with the provided codes as follows:
// - ERROR_FILE_NOT_FOUND: (file_not_found_code, attributes of setup.exe).
// - ERROR_PATH_NOT_FOUND: (path_not_found_code, attributes of setup.exe).
// - Otherwise: (generic_failure_code, CreateProcess error code).
// In case of error waiting for the process to exit, returns a results object
// with (WAIT_FOR_PROCESS_FAILED, last error code). Otherwise, returns a results
// object with the subprocess's exit code.
ProcessExitResult RunProcessAndWait(const wchar_t* exe_path,
wchar_t* cmdline,
DWORD file_not_found_code,
DWORD path_not_found_code,
DWORD generic_failure_code) {
STARTUPINFOW si = {sizeof(si)};
PROCESS_INFORMATION pi = {0};
if (!::CreateProcess(exe_path, cmdline, nullptr, nullptr, FALSE,
CREATE_NO_WINDOW, nullptr, nullptr, &si, &pi)) {
// Split specific failure modes. If setup.exe couldn't be launched because
// its file/path couldn't be found, report its attributes in ExtraCode1.
// This will help diagnose the prevalence of launch failures due to Image
// File Execution Options tampering. See https://crbug.com/672813 for more
// details.
const DWORD last_error = ::GetLastError();
const DWORD attributes = ::GetFileAttributes(exe_path);
switch (last_error) {
case ERROR_FILE_NOT_FOUND:
return ProcessExitResult(file_not_found_code, attributes);
case ERROR_PATH_NOT_FOUND:
return ProcessExitResult(path_not_found_code, attributes);
default:
break;
}
// Lump all other errors into a distinct failure bucket.
return ProcessExitResult(generic_failure_code, last_error);
}
::CloseHandle(pi.hThread);
DWORD exit_code = SUCCESS_EXIT_CODE;
DWORD wr = ::WaitForSingleObject(pi.hProcess, INFINITE);
if (WAIT_OBJECT_0 != wr || !::GetExitCodeProcess(pi.hProcess, &exit_code)) {
// Note: We've assumed that WAIT_OBJCT_0 != wr means a failure. The call
// could return a different object but since we never spawn more than one
// sub-process at a time that case should never happen.
return ProcessExitResult(WAIT_FOR_PROCESS_FAILED, ::GetLastError());
}
::CloseHandle(pi.hProcess);
return ProcessExitResult(exit_code);
}
void AppendCommandLineFlags(const wchar_t* command_line,
CommandString* buffer) {
// The program name (the first argument parsed by CommandLineToArgvW) is
// delimited by whitespace or a double quote based on the first character of
// the full command line string. Use the same logic here to scan past the
// program name in the program's command line (obtained during startup from
// GetCommandLine). See
// http://www.windowsinspired.com/how-a-windows-programs-splits-its-command-line-into-individual-arguments/
// for gory details regarding how CommandLineToArgvW works.
wchar_t a_char = 0;
if (*command_line == L'"') {
// Scan forward past the closing double quote.
++command_line;
while (true) {
a_char = *command_line;
if (!a_char)
break;
++command_line;
if (a_char == L'"') {
a_char = *command_line;
break;
}
} // postcondition: |a_char| contains the character at *command_line.
} else {
// Scan forward for the first space or tab character.
while (true) {
a_char = *command_line;
if (!a_char || a_char == L' ' || a_char == L'\t')
break;
++command_line;
} // postcondition: |a_char| contains the character at *command_line.
}
if (!a_char)
return;
// Append a space if |command_line| doesn't begin with one.
if (a_char != ' ' && a_char != '\t' && !buffer->append(L" "))
return;
buffer->append(command_line);
}
// Processes a resource of type |type| in |module| on behalf of a call to
// EnumResourceNames. On each call, |name| contains the name of a resource. A
// TRUE return value continues the enumeration, whereas FALSE stops it. This
// function extracts the first resource starting with "chrome" and/or "setup",
// populating |context| (which must be a pointer to a Context struct) with the
// path(s) of the extracted file(s). Enumeration stops early in case of error,
// which includes any unexpected resources or duplicate matching resources.
// |context|'s |error_code| member may be populated with a Windows error code
// corresponding to an error condition.
BOOL CALLBACK OnResourceFound(HMODULE module,
const wchar_t* type,
wchar_t* name,
LONG_PTR l_param) {
if (!l_param)
return FALSE; // Break: impossible condition.
if (IS_INTRESOURCE(name))
return FALSE; // Break: resources with integer names are unexpected.
Context& context = *reinterpret_cast<Context*>(l_param);
PEResource resource(name, type, module);
if (!resource.IsValid() || resource.Size() < 1)
return FALSE; // Break: invalid/empty resources are unexpected.
PathString full_path;
if (!full_path.assign(context.base_path) || !full_path.append(name))
return FALSE; // Break: failed to form the output path.
if (StrStartsWith(name, kChromeArchivePrefix) &&
context.chrome_resource_path->empty()) {
if (!resource.WriteToDisk(full_path.get())) {
context.error_code = ::GetLastError();
return FALSE; // Break: failed to write resource.
}
context.chrome_resource_path->assign(full_path);
} else if (StrStartsWith(name, kSetupPrefix) &&
context.setup_resource_path->empty()) {
if (!resource.WriteToDisk(full_path.get())) {
context.error_code = ::GetLastError();
return FALSE; // Break: failed to write resource.
}
context.setup_resource_path->assign(full_path);
} else {
// Break: unexpected resource names or multiple {chrome,setup}* resources
// are unexpected.
return FALSE;
}
return TRUE; // Continue: advance to the next resource.
}
#if defined(COMPONENT_BUILD)
// An EnumResNameProc callback that writes the resource |name| to disk in the
// directory |base_path_ptr| (which must end with a path separator).
BOOL CALLBACK WriteResourceToDirectory(HMODULE module,
const wchar_t* type,
wchar_t* name,
LONG_PTR base_path_ptr) {
const wchar_t* base_path = reinterpret_cast<const wchar_t*>(base_path_ptr);
PathString full_path;
PEResource resource(name, type, module);
return (resource.IsValid() && full_path.assign(base_path) &&
full_path.append(name) && resource.WriteToDisk(full_path.get()));
}
#endif
// Finds and writes to disk resources of various types. Returns false
// if there is a problem in writing any resource to disk. setup.exe resource
// can come in one of three possible forms:
// - Resource type 'B7', compressed using LZMA (*.7z)
// - Resource type 'BL', compressed using LZ (*.ex_)
// - Resource type 'BN', uncompressed (*.exe)
// If setup.exe is present in more than one form, the precedence order is
// BN < BL < B7
// For more details see chrome/tools/build/win/create_installer_archive.py.
// For component builds (where setup.ex_ is always used), all files stored as
// uncompressed 'BN' resources are also extracted. This is generally the set of
// DLLs/resources needed by setup.exe to run.
ProcessExitResult UnpackBinaryResources(const Configuration& configuration,
HMODULE module,
const wchar_t* base_path,
PathString* archive_path,
PathString* setup_path) {
// Generate the setup.exe path where we patch/uncompress setup resource.
PathString setup_dest_path;
if (!setup_dest_path.assign(base_path) || !setup_dest_path.append(kSetupExe))
return ProcessExitResult(PATH_STRING_OVERFLOW);
// Prepare the input to OnResourceFound method that needs a location where
// it will write all the resources.
Context context = {
base_path,
archive_path,
setup_path,
ERROR_SUCCESS,
};
// Get the resources of type 'B7' (7zip archive).
// We need a chrome archive to do the installation. So if there
// is a problem in fetching B7 resource, just return an error.
if (!::EnumResourceNames(module, kLZMAResourceType, OnResourceFound,
reinterpret_cast<LONG_PTR>(&context)) ||
archive_path->empty()) {
const DWORD enum_error = ::GetLastError();
return ProcessExitResult(UNABLE_TO_EXTRACT_CHROME_ARCHIVE,
enum_error == ERROR_RESOURCE_ENUM_USER_STOP
? context.error_code
: enum_error);
}
ProcessExitResult exit_code = ProcessExitResult(SUCCESS_EXIT_CODE);
// If we found setup 'B7' resource (used for differential updates), handle
// it. Note that this is only for Chrome; Chromium installs are always
// "full" installs.
if (!setup_path->empty()) {
CommandString cmd_line;
PathString exe_path;
// Get the path to setup.exe first.
exit_code = GetPreviousSetupExePath(configuration, exe_path.get(),
exe_path.capacity());
if (exit_code.IsSuccess()) {
if (!cmd_line.append(L"\"") || !cmd_line.append(exe_path.get()) ||
!cmd_line.append(L"\" --") || !cmd_line.append(kCmdUpdateSetupExe) ||
!cmd_line.append(L"=\"") || !cmd_line.append(setup_path->get()) ||
!cmd_line.append(L"\" --") || !cmd_line.append(kCmdNewSetupExe) ||
!cmd_line.append(L"=\"") || !cmd_line.append(setup_dest_path.get()) ||
!cmd_line.append(L"\"")) {
exit_code = ProcessExitResult(COMMAND_STRING_OVERFLOW);
}
}
// Get any command line option specified for mini_installer and pass them
// on to setup.exe.
AppendCommandLineFlags(configuration.command_line(), &cmd_line);
if (exit_code.IsSuccess()) {
exit_code = RunProcessAndWait(
exe_path.get(), cmd_line.get(), SETUP_PATCH_FAILED_FILE_NOT_FOUND,
SETUP_PATCH_FAILED_PATH_NOT_FOUND,
SETUP_PATCH_FAILED_COULD_NOT_CREATE_PROCESS);
}
if (!exit_code.IsSuccess())
DeleteFile(setup_path->get());
else
setup_path->assign(setup_dest_path);
return exit_code;
}
// setup.exe wasn't sent as 'B7', lets see if it was sent as 'BL'
// (compressed setup).
context.error_code = ERROR_SUCCESS;
if (!::EnumResourceNames(module, kLZCResourceType, OnResourceFound,
reinterpret_cast<LONG_PTR>(&context)) ||
setup_path->empty()) {
const DWORD enum_error = ::GetLastError();
return ProcessExitResult(UNABLE_TO_EXTRACT_SETUP,
enum_error == ERROR_RESOURCE_ENUM_USER_STOP
? context.error_code
: enum_error);
}
// Uncompress LZ compressed resource. Setup is packed with 'MSCF'
// as opposed to old DOS way of 'SZDD'. Hence we don't use LZCopy.
bool success =
mini_installer::Expand(setup_path->get(), setup_dest_path.get());
::DeleteFile(setup_path->get());
if (success)
setup_path->assign(setup_dest_path);
else
exit_code = ProcessExitResult(UNABLE_TO_EXTRACT_SETUP_EXE);
#if defined(COMPONENT_BUILD)
if (exit_code.IsSuccess()) {
// Extract the modules in component build required by setup.exe.
if (!::EnumResourceNames(module, kBinResourceType, WriteResourceToDirectory,
reinterpret_cast<LONG_PTR>(base_path))) {
return ProcessExitResult(UNABLE_TO_EXTRACT_SETUP, ::GetLastError());
}
}
#endif
return exit_code;
}
// Executes setup.exe, waits for it to finish and returns the exit code.
ProcessExitResult RunSetup(const Configuration& configuration,
const wchar_t* archive_path,
const wchar_t* setup_path) {
// Get the path to setup.exe.
PathString setup_exe;
if (*setup_path != L'\0') {
if (!setup_exe.assign(setup_path))
return ProcessExitResult(COMMAND_STRING_OVERFLOW);
} else {
ProcessExitResult exit_code = GetPreviousSetupExePath(
configuration, setup_exe.get(), setup_exe.capacity());
if (!exit_code.IsSuccess())
return exit_code;
}
// There could be three full paths in the command line for setup.exe (path
// to exe itself, path to archive and path to log file), so we declare
// total size as three + one additional to hold command line options.
CommandString cmd_line;
// Put the quoted path to setup.exe in cmd_line first.
if (!cmd_line.assign(L"\"") || !cmd_line.append(setup_exe.get()) ||
!cmd_line.append(L"\"")) {
return ProcessExitResult(COMMAND_STRING_OVERFLOW);
}
// Append the command line param for chrome archive file.
if (!cmd_line.append(L" --") ||
#if defined(SKIP_ARCHIVE_COMPRESSION)
!cmd_line.append(kCmdUncompressedArchive) ||
#else
!cmd_line.append(kCmdInstallArchive) ||
#endif
!cmd_line.append(L"=\"") || !cmd_line.append(archive_path) ||
!cmd_line.append(L"\"")) {
return ProcessExitResult(COMMAND_STRING_OVERFLOW);
}
// Append the command line param for the previous version of Chrome.
if (configuration.previous_version() &&
(!cmd_line.append(L" --") || !cmd_line.append(kCmdPreviousVersion) ||
!cmd_line.append(L"=\"") ||
!cmd_line.append(configuration.previous_version()) ||
!cmd_line.append(L"\""))) {
return ProcessExitResult(COMMAND_STRING_OVERFLOW);
}
// Get any command line option specified for mini_installer and pass them
// on to setup.exe
AppendCommandLineFlags(configuration.command_line(), &cmd_line);
return RunProcessAndWait(setup_exe.get(), cmd_line.get(),
RUN_SETUP_FAILED_FILE_NOT_FOUND,
RUN_SETUP_FAILED_PATH_NOT_FOUND,
RUN_SETUP_FAILED_COULD_NOT_CREATE_PROCESS);
}
// Deletes given files and working dir.
void DeleteExtractedFiles(const wchar_t* base_path,
const wchar_t* archive_path,
const wchar_t* setup_path) {
::DeleteFile(archive_path);
::DeleteFile(setup_path);
// Delete the temp dir (if it is empty, otherwise fail).
::RemoveDirectory(base_path);
}
// Returns true if the supplied path supports ACLs.
bool IsAclSupportedForPath(const wchar_t* path) {
PathString volume;
DWORD flags = 0;
return ::GetVolumePathName(path, volume.get(),
static_cast<DWORD>(volume.capacity())) &&
::GetVolumeInformation(volume.get(), nullptr, 0, nullptr, nullptr,
&flags, nullptr, 0) &&
(flags & FILE_PERSISTENT_ACLS);
}
// Retrieves the SID of the default owner for objects created by this user
// token (accounting for different behavior under UAC elevation, etc.).
// NOTE: On success the |sid| parameter must be freed with LocalFree().
bool GetCurrentOwnerSid(wchar_t** sid) {
HANDLE token;
if (!::OpenProcessToken(::GetCurrentProcess(), TOKEN_QUERY, &token))
return false;
DWORD size = 0;
bool result = false;
// We get the TokenOwner rather than the TokenUser because e.g. under UAC
// elevation we want the admin to own the directory rather than the user.
::GetTokenInformation(token, TokenOwner, nullptr, 0, &size);
if (size && GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
if (TOKEN_OWNER* owner =
reinterpret_cast<TOKEN_OWNER*>(::LocalAlloc(LPTR, size))) {
if (::GetTokenInformation(token, TokenOwner, owner, size, &size))
result = !!::ConvertSidToStringSid(owner->Owner, sid);
::LocalFree(owner);
}
}
::CloseHandle(token);
return result;
}
// Populates |sd| suitable for use when creating directories within |path| with
// ACLs allowing access to only the current owner, admin, and system.
// NOTE: On success the |sd| parameter must be freed with LocalFree().
bool SetSecurityDescriptor(const wchar_t* path, PSECURITY_DESCRIPTOR* sd) {
*sd = nullptr;
// We succeed without doing anything if ACLs aren't supported.
if (!IsAclSupportedForPath(path))
return true;
wchar_t* sid = nullptr;
if (!GetCurrentOwnerSid(&sid))
return false;
// The largest SID is under 200 characters, so 300 should give enough slack.
StackString<300> sddl;
bool result = sddl.append(
L"D:PAI" // Protected, auto-inherited DACL.
L"(A;;FA;;;BA)" // Admin: Full control.
L"(A;OIIOCI;GA;;;BA)"
L"(A;;FA;;;SY)" // System: Full control.
L"(A;OIIOCI;GA;;;SY)"
L"(A;OIIOCI;GA;;;CO)" // Owner: Full control.
L"(A;;FA;;;") &&
sddl.append(sid) && sddl.append(L")");
if (result) {
result = !!::ConvertStringSecurityDescriptorToSecurityDescriptor(
sddl.get(), SDDL_REVISION_1, sd, nullptr);
}
::LocalFree(sid);
return result;
}
bool GetModuleDir(HMODULE module, PathString* directory) {
DWORD len = ::GetModuleFileName(module, directory->get(),
static_cast<DWORD>(directory->capacity()));
if (!len || len >= directory->capacity())
return false; // Failed to get module path.
// Chop off the basename of the path.
wchar_t* name = GetNameFromPathExt(directory->get(), len);
if (name == directory->get())
return false; // No path separator found.
*name = L'\0';
return true;
}
bool GetTempDir(PathString* directory, ProcessExitResult* exit_code) {
DWORD len = ::GetTempPath(static_cast<DWORD>(directory->capacity()),
directory->get());
if (!len) {
*exit_code =
ProcessExitResult(UNABLE_TO_GET_WORK_DIRECTORY, ::GetLastError());
return false;
}
if (len >= directory->capacity()) {
*exit_code = ProcessExitResult(PATH_STRING_OVERFLOW);
return false;
}
return true;
}
// Creates a temporary directory under |base_path| and returns the full path
// of created directory in |work_dir|. If successful return true, otherwise
// false. When successful, the returned |work_dir| will always have a trailing
// backslash and this function requires that |base_path| always includes a
// trailing backslash as well.
// We do not use GetTempFileName here to avoid running into AV software that
// might hold on to the temp file as soon as we create it and then we can't
// delete it and create a directory in its place. So, we use our own mechanism
// for creating a directory with a hopefully-unique name. In the case of a
// collision, we retry a few times with a new name before failing.
bool CreateWorkDir(const wchar_t* base_path,
PathString* work_dir,
ProcessExitResult* exit_code) {
*exit_code = ProcessExitResult(PATH_STRING_OVERFLOW);
if (!work_dir->assign(base_path) || !work_dir->append(kTempPrefix))
return false;
// Store the location where we'll append the id.
size_t end = work_dir->length();
// Check if we'll have enough buffer space to continue.
// The name of the directory will use up 11 chars and then we need to append
// the trailing backslash and a terminator. We've already added the prefix
// to the buffer, so let's just make sure we've got enough space for the rest.
if ((work_dir->capacity() - end) < (_countof("fffff.tmp") + 1))
return false;
// Add an ACL if supported by the filesystem. Otherwise system-level installs
// are potentially vulnerable to file squatting attacks.
SECURITY_ATTRIBUTES sa = {};
sa.nLength = sizeof(SECURITY_ATTRIBUTES);
if (!SetSecurityDescriptor(base_path, &sa.lpSecurityDescriptor)) {
*exit_code =
ProcessExitResult(UNABLE_TO_SET_DIRECTORY_ACL, ::GetLastError());
return false;
}
unsigned int id;
*exit_code = ProcessExitResult(UNABLE_TO_GET_WORK_DIRECTORY);
for (int max_attempts = 10; max_attempts; --max_attempts) {
::RtlGenRandom(&id, sizeof(id)); // Try a different name.
// This converts 'id' to a string in the format "78563412" on windows
// because of little endianness, but we don't care since it's just
// a name. Since we checked capaity at the front end, we don't need to
// duplicate it here.
HexEncode(&id, sizeof(id), work_dir->get() + end,
work_dir->capacity() - end);
// We only want the first 5 digits to remain within the 8.3 file name
// format (compliant with previous implementation).
work_dir->truncate_at(end + 5);
// for consistency with the previous implementation which relied on
// GetTempFileName, we append the .tmp extension.
work_dir->append(L".tmp");
if (::CreateDirectory(work_dir->get(),
sa.lpSecurityDescriptor ? &sa : nullptr)) {
// Yay! Now let's just append the backslash and we're done.
work_dir->append(L"\\");
*exit_code = ProcessExitResult(SUCCESS_EXIT_CODE);
break;
}
}
if (sa.lpSecurityDescriptor)
LocalFree(sa.lpSecurityDescriptor);
return exit_code->IsSuccess();
}
// Creates and returns a temporary directory in |work_dir| that can be used to
// extract mini_installer payload. |work_dir| ends with a path separator.
// |used_fallback| is set to true if the %TMP% directory was used rather than
// the directory containing |module|.
bool GetWorkDir(HMODULE module,
PathString* work_dir,
bool* used_fallback,
ProcessExitResult* exit_code) {
PathString base_path;
// Try to create a directory next to the current module.
if (GetModuleDir(module, &base_path) &&
CreateWorkDir(base_path.get(), work_dir, exit_code)) {
return true;
}
// Failing that, try to create one in the TMP directory.
return GetTempDir(&base_path, exit_code) &&
CreateWorkDir(base_path.get(), work_dir, exit_code);
}
// Returns true for ".." and "." directories.
bool IsCurrentOrParentDirectory(const wchar_t* dir) {
return dir && dir[0] == L'.' &&
(dir[1] == L'\0' || (dir[1] == L'.' && dir[2] == L'\0'));
}
// Best effort directory tree deletion including the directory specified
// by |path|, which must not end in a separator.
// The |path| argument is writable so that each recursion can use the same
// buffer as was originally allocated for the path. The path will be unchanged
// upon return.
void RecursivelyDeleteDirectory(PathString* path) {
// |path| will never have a trailing backslash.
size_t end = path->length();
if (!path->append(L"\\*.*"))
return;
WIN32_FIND_DATA find_data = {0};
HANDLE find = ::FindFirstFile(path->get(), &find_data);
if (find != INVALID_HANDLE_VALUE) {
do {
// Use the short name if available to make the most of our buffer.
const wchar_t* name = find_data.cAlternateFileName[0]
? find_data.cAlternateFileName
: find_data.cFileName;
if (IsCurrentOrParentDirectory(name))
continue;
path->truncate_at(end + 1); // Keep the trailing backslash.
if (!path->append(name))
continue; // Continue in spite of too long names.
if ((find_data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) &&
!(find_data.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
RecursivelyDeleteDirectory(path);
} else {
::DeleteFile(path->get());
}
} while (::FindNextFile(find, &find_data));
::FindClose(find);
}
// Restore the path and delete the directory before we return.
path->truncate_at(end);
::RemoveDirectory(path->get());
}
// Enumerates subdirectories of |parent_dir| and deletes all subdirectories
// that match with a given |prefix|. |parent_dir| must have a trailing
// backslash.
// The process is done on a best effort basis, so conceivably there might
// still be matches left when the function returns.
void DeleteDirectoriesWithPrefix(const wchar_t* parent_dir,
const wchar_t* prefix) {
// |parent_dir| is guaranteed to always have a trailing backslash.
PathString spec;
if (!spec.assign(parent_dir) || !spec.append(prefix) || !spec.append(L"*.*"))
return;
WIN32_FIND_DATA find_data = {0};
HANDLE find = ::FindFirstFileEx(spec.get(), FindExInfoStandard, &find_data,
FindExSearchLimitToDirectories, nullptr, 0);
if (find == INVALID_HANDLE_VALUE)
return;
PathString path;
do {
// Skip over directories that have reparse points, since these represent
// such things as mounted folders, links, etc, and were therefore not
// created by a previous run of this installer.
if ((find_data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) &&
!(find_data.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
// Use the short name if available to make the most of our buffer.
const wchar_t* name = find_data.cAlternateFileName[0]
? find_data.cAlternateFileName
: find_data.cFileName;
if (IsCurrentOrParentDirectory(name))
continue;
if (path.assign(parent_dir) && path.append(name))
RecursivelyDeleteDirectory(&path);
}
} while (::FindNextFile(find, &find_data));
::FindClose(find);
}
// Attempts to free up space by deleting temp directories that previous
// installer runs have failed to clean up.
void DeleteOldChromeTempDirectories() {
static const wchar_t* const kDirectoryPrefixes[] = {
kTempPrefix,
L"chrome_" // Previous installers created directories with this prefix
// and there are still some lying around.
};
ProcessExitResult ignore(SUCCESS_EXIT_CODE);
PathString temp;
// GetTempDir always returns a path with a trailing backslash.
if (!GetTempDir(&temp, &ignore))
return;
for (size_t i = 0; i < _countof(kDirectoryPrefixes); ++i) {
DeleteDirectoriesWithPrefix(temp.get(), kDirectoryPrefixes[i]);
}
}
// Checks the command line for specific mini installer flags.
// If the function returns true, the command line has been processed and all
// required actions taken. The installer must exit and return the returned
// |exit_code|.
bool ProcessNonInstallOperations(const Configuration& configuration,
ProcessExitResult* exit_code) {
switch (configuration.operation()) {
case Configuration::CLEANUP:
// Cleanup has already taken place in DeleteOldChromeTempDirectories at
// this point, so just tell our caller to exit early.
*exit_code = ProcessExitResult(SUCCESS_EXIT_CODE);
return true;
default:
return false;
}
}
ProcessExitResult WMain(HMODULE module) {
// Always start with deleting potential leftovers from previous installations.
// This can make the difference between success and failure. We've seen
// many installations out in the field fail due to out of disk space problems
// so this could buy us some space.
DeleteOldChromeTempDirectories();
ProcessExitResult exit_code = ProcessExitResult(SUCCESS_EXIT_CODE);
// Parse configuration from the command line and resources.
Configuration configuration;
if (!configuration.Initialize(module))
return ProcessExitResult(GENERIC_INITIALIZATION_FAILURE, ::GetLastError());
// Exit early if an invalid switch (e.g., "--chrome-frame") was found on the
// command line.
if (configuration.has_invalid_switch())
return ProcessExitResult(INVALID_OPTION);
// If the --cleanup switch was specified on the command line, then that means
// we should only do the cleanup and then exit.
if (ProcessNonInstallOperations(configuration, &exit_code))
return exit_code;
// First get a path where we can extract payload
bool work_dir_in_fallback = false;
PathString base_path;
if (!GetWorkDir(module, &base_path, &work_dir_in_fallback, &exit_code))
return exit_code;
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
// Set the magic suffix in registry to try full installer next time. We ignore
// any errors here and we try to set the suffix for user level unless
// GoogleUpdateIsMachine=1 is present in the environment or --system-level is
// on the command line in which case we set it for system level instead. This
// only applies to the Google Chrome distribution.
SetInstallerFlags(configuration);
#endif
PathString archive_path;
PathString setup_path;
exit_code = UnpackBinaryResources(configuration, module, base_path.get(),
&archive_path, &setup_path);
// While unpacking the binaries, we paged in a whole bunch of memory that
// we don't need anymore. Let's give it back to the pool before running
// setup.
::SetProcessWorkingSetSize(::GetCurrentProcess(), (SIZE_T)-1, (SIZE_T)-1);
if (exit_code.IsSuccess())
exit_code = RunSetup(configuration, archive_path.get(), setup_path.get());
if (configuration.should_delete_extracted_files())
DeleteExtractedFiles(base_path.get(), archive_path.get(), setup_path.get());
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
if (exit_code.IsSuccess()) {
// Send up a signal in ExtraCode1 upon successful install where the fallback
// work dir location was used. This means that GetWorkDir failed to create a
// temporary directory next to the executable (in a directory owned by
// Omaha) then succeeded to create one in %TMP% and ultimately resulted in
// a successful install/update. If we ~never see this signal, then we know
// that it's safe to remove the fallback code and associated cleanup. See
// https://crbug.com/516207 for more info.
// Pick two arbitrary values that should stand out obviously in queries.
constexpr DWORD kSucceededWithFallback = 0x1U << 16;
constexpr DWORD kSucceededWithoutFallback = 0x2U << 16;
WriteExtraCode1(configuration, work_dir_in_fallback
? kSucceededWithFallback
: kSucceededWithoutFallback);
} else {
WriteInstallResults(configuration, exit_code);
}
#endif
return exit_code;
}
} // namespace mini_installer