// Copyright (c) 2011 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. #include "chrome/common/service_process_util_posix.h" #import <Foundation/Foundation.h> #include <launch.h> #include <vector> #include "base/command_line.h" #include "base/file_path.h" #include "base/file_util.h" #include "base/mac/foundation_util.h" #include "base/mac/mac_util.h" #include "base/mac/scoped_nsautorelease_pool.h" #include "base/memory/scoped_nsobject.h" #include "base/path_service.h" #include "base/process_util.h" #include "base/stringprintf.h" #include "base/string_util.h" #include "base/sys_string_conversions.h" #include "base/threading/thread_restrictions.h" #include "base/version.h" #include "chrome/common/chrome_paths.h" #include "chrome/common/chrome_switches.h" #include "chrome/common/chrome_version_info.h" #include "chrome/common/launchd_mac.h" #include "content/common/child_process_host.h" using ::base::files::FilePathWatcher; namespace { #define kServiceProcessSessionType "Background" CFStringRef CopyServiceProcessLaunchDName() { base::mac::ScopedNSAutoreleasePool pool; NSBundle* bundle = base::mac::MainAppBundle(); return CFStringCreateCopy(kCFAllocatorDefault, base::mac::NSToCFCast([bundle bundleIdentifier])); } NSString* GetServiceProcessLaunchDLabel() { scoped_nsobject<NSString> name( base::mac::CFToNSCast(CopyServiceProcessLaunchDName())); NSString *label = [name stringByAppendingString:@".service_process"]; FilePath user_data_dir; PathService::Get(chrome::DIR_USER_DATA, &user_data_dir); std::string user_data_dir_path = user_data_dir.value(); NSString *ns_path = base::SysUTF8ToNSString(user_data_dir_path); ns_path = [ns_path stringByReplacingOccurrencesOfString:@" " withString:@"_"]; label = [label stringByAppendingString:ns_path]; return label; } NSString* GetServiceProcessLaunchDSocketKey() { return @"ServiceProcessSocket"; } NSString* GetServiceProcessLaunchDSocketEnvVar() { NSString *label = GetServiceProcessLaunchDLabel(); NSString *env_var = [label stringByReplacingOccurrencesOfString:@"." withString:@"_"]; env_var = [env_var stringByAppendingString:@"_SOCKET"]; env_var = [env_var uppercaseString]; return env_var; } bool GetParentFSRef(const FSRef& child, FSRef* parent) { return FSGetCatalogInfo(&child, 0, NULL, NULL, NULL, parent) == noErr; } bool RemoveFromLaunchd() { // We're killing a file. base::ThreadRestrictions::AssertIOAllowed(); base::mac::ScopedCFTypeRef<CFStringRef> name(CopyServiceProcessLaunchDName()); return Launchd::GetInstance()->DeletePlist(Launchd::User, Launchd::Agent, name); } class ExecFilePathWatcherDelegate : public FilePathWatcher::Delegate { public: ExecFilePathWatcherDelegate() { } virtual ~ExecFilePathWatcherDelegate() { } bool Init(const FilePath& path); virtual void OnFilePathChanged(const FilePath& path) OVERRIDE; private: FSRef executable_fsref_; }; } // namespace // Gets the name of the service process IPC channel. IPC::ChannelHandle GetServiceProcessChannel() { base::mac::ScopedNSAutoreleasePool pool; std::string socket_path; scoped_nsobject<NSDictionary> dictionary( base::mac::CFToNSCast(Launchd::GetInstance()->CopyExports())); NSString *ns_socket_path = [dictionary objectForKey:GetServiceProcessLaunchDSocketEnvVar()]; if (ns_socket_path) { socket_path = base::SysNSStringToUTF8(ns_socket_path); } return IPC::ChannelHandle(socket_path); } bool ForceServiceProcessShutdown(const std::string& /* version */, base::ProcessId /* process_id */) { base::mac::ScopedNSAutoreleasePool pool; CFStringRef label = base::mac::NSToCFCast(GetServiceProcessLaunchDLabel()); CFErrorRef err = NULL; bool ret = Launchd::GetInstance()->RemoveJob(label, &err); if (!ret) { LOG(ERROR) << "ForceServiceProcessShutdown: " << err; CFRelease(err); } return ret; } bool GetServiceProcessData(std::string* version, base::ProcessId* pid) { base::mac::ScopedNSAutoreleasePool pool; CFStringRef label = base::mac::NSToCFCast(GetServiceProcessLaunchDLabel()); scoped_nsobject<NSDictionary> launchd_conf(base::mac::CFToNSCast( Launchd::GetInstance()->CopyJobDictionary(label))); if (!launchd_conf.get()) { return false; } // Anything past here will return true in that there does appear // to be a service process of some sort registered with launchd. if (version) { *version = "0"; NSString *exe_path = [launchd_conf objectForKey:@ LAUNCH_JOBKEY_PROGRAM]; if (exe_path) { NSString *bundle_path = [[[exe_path stringByDeletingLastPathComponent] stringByDeletingLastPathComponent] stringByDeletingLastPathComponent]; NSBundle *bundle = [NSBundle bundleWithPath:bundle_path]; if (bundle) { NSString *ns_version = [bundle objectForInfoDictionaryKey:@"CFBundleShortVersionString"]; if (ns_version) { *version = base::SysNSStringToUTF8(ns_version); } else { LOG(ERROR) << "Unable to get version at: " << reinterpret_cast<CFStringRef>(bundle_path); } } else { // The bundle has been deleted out from underneath the registered // job. LOG(ERROR) << "Unable to get bundle at: " << reinterpret_cast<CFStringRef>(bundle_path); } } else { LOG(ERROR) << "Unable to get executable path for service process"; } } if (pid) { *pid = -1; NSNumber* ns_pid = [launchd_conf objectForKey:@ LAUNCH_JOBKEY_PID]; if (ns_pid) { *pid = [ns_pid intValue]; } } return true; } bool ServiceProcessState::Initialize() { CFErrorRef err = NULL; CFDictionaryRef dict = Launchd::GetInstance()->CopyDictionaryByCheckingIn(&err); if (!dict) { LOG(ERROR) << "CopyLaunchdDictionaryByCheckingIn: " << err; CFRelease(err); return false; } state_->launchd_conf_.reset(dict); return true; } IPC::ChannelHandle ServiceProcessState::GetServiceProcessChannel() { CHECK(state_); NSDictionary *ns_launchd_conf = base::mac::CFToNSCast(state_->launchd_conf_); NSDictionary* socket_dict = [ns_launchd_conf objectForKey:@ LAUNCH_JOBKEY_SOCKETS]; NSArray* sockets = [socket_dict objectForKey:GetServiceProcessLaunchDSocketKey()]; CHECK_EQ([sockets count], 1U); int socket = [[sockets objectAtIndex:0] intValue]; base::FileDescriptor fd(socket, false); return IPC::ChannelHandle(std::string(), fd); } bool CheckServiceProcessReady() { std::string version; pid_t pid; if (!GetServiceProcessData(&version, &pid)) { return false; } scoped_ptr<Version> service_version(Version::GetVersionFromString(version)); bool ready = true; if (!service_version.get()) { ready = false; } else { chrome::VersionInfo version_info; if (!version_info.is_valid()) { // Our own version is invalid. This is an error case. Pretend that we // are out of date. NOTREACHED() << "Failed to get current file version"; ready = true; } else { scoped_ptr<Version> running_version(Version::GetVersionFromString( version_info.Version())); if (!running_version.get()) { // Our own version is invalid. This is an error case. Pretend that we // are out of date. NOTREACHED() << "Failed to parse version info"; ready = true; } else if (running_version->CompareTo(*service_version) > 0) { ready = false; } else { ready = true; } } } if (!ready) { ForceServiceProcessShutdown(version, pid); } return ready; } CFDictionaryRef CreateServiceProcessLaunchdPlist(CommandLine* cmd_line, bool for_auto_launch) { base::mac::ScopedNSAutoreleasePool pool; NSString *program = base::SysUTF8ToNSString(cmd_line->GetProgram().value()); std::vector<std::string> args = cmd_line->argv(); NSMutableArray *ns_args = [NSMutableArray arrayWithCapacity:args.size()]; for (std::vector<std::string>::iterator iter = args.begin(); iter < args.end(); ++iter) { [ns_args addObject:base::SysUTF8ToNSString(*iter)]; } NSDictionary *socket = [NSDictionary dictionaryWithObject:GetServiceProcessLaunchDSocketEnvVar() forKey:@ LAUNCH_JOBSOCKETKEY_SECUREWITHKEY]; NSDictionary *sockets = [NSDictionary dictionaryWithObject:socket forKey:GetServiceProcessLaunchDSocketKey()]; // See the man page for launchd.plist. NSMutableDictionary *launchd_plist = [[NSMutableDictionary alloc] initWithObjectsAndKeys: GetServiceProcessLaunchDLabel(), @ LAUNCH_JOBKEY_LABEL, program, @ LAUNCH_JOBKEY_PROGRAM, ns_args, @ LAUNCH_JOBKEY_PROGRAMARGUMENTS, sockets, @ LAUNCH_JOBKEY_SOCKETS, nil]; if (for_auto_launch) { // We want the service process to be able to exit if there are no services // enabled. With a value of NO in the SuccessfulExit key, launchd will // relaunch the service automatically in any other case than exiting // cleanly with a 0 return code. NSDictionary *keep_alive = [NSDictionary dictionaryWithObject:[NSNumber numberWithBool:NO] forKey:@ LAUNCH_JOBKEY_KEEPALIVE_SUCCESSFULEXIT]; NSDictionary *auto_launchd_plist = [[NSDictionary alloc] initWithObjectsAndKeys: [NSNumber numberWithBool:YES], @ LAUNCH_JOBKEY_RUNATLOAD, keep_alive, @ LAUNCH_JOBKEY_KEEPALIVE, @ kServiceProcessSessionType, @ LAUNCH_JOBKEY_LIMITLOADTOSESSIONTYPE, nil]; [launchd_plist addEntriesFromDictionary:auto_launchd_plist]; } return reinterpret_cast<CFDictionaryRef>(launchd_plist); } // Writes the launchd property list into the user's LaunchAgents directory, // creating that directory if needed. This will cause the service process to be // auto launched on the next user login. bool ServiceProcessState::AddToAutoRun() { // We're creating directories and writing a file. base::ThreadRestrictions::AssertIOAllowed(); DCHECK(autorun_command_line_.get()); base::mac::ScopedCFTypeRef<CFStringRef> name(CopyServiceProcessLaunchDName()); base::mac::ScopedCFTypeRef<CFDictionaryRef> plist( CreateServiceProcessLaunchdPlist(autorun_command_line_.get(), true)); return Launchd::GetInstance()->WritePlistToFile(Launchd::User, Launchd::Agent, name, plist); } bool ServiceProcessState::RemoveFromAutoRun() { return RemoveFromLaunchd(); } bool ServiceProcessState::StateData::WatchExecutable() { base::mac::ScopedNSAutoreleasePool pool; NSDictionary* ns_launchd_conf = base::mac::CFToNSCast(launchd_conf_); NSString* exe_path = [ns_launchd_conf objectForKey:@ LAUNCH_JOBKEY_PROGRAM]; if (!exe_path) { LOG(ERROR) << "No " LAUNCH_JOBKEY_PROGRAM; return false; } FilePath executable_path = FilePath([exe_path fileSystemRepresentation]); scoped_ptr<ExecFilePathWatcherDelegate> delegate( new ExecFilePathWatcherDelegate); if (!delegate->Init(executable_path)) { LOG(ERROR) << "executable_watcher_.Init " << executable_path.value(); return false; } if (!executable_watcher_.Watch(executable_path, delegate.release())) { LOG(ERROR) << "executable_watcher_.watch " << executable_path.value(); return false; } return true; } bool ExecFilePathWatcherDelegate::Init(const FilePath& path) { return base::mac::FSRefFromPath(path.value(), &executable_fsref_); } void ExecFilePathWatcherDelegate::OnFilePathChanged(const FilePath& path) { base::mac::ScopedNSAutoreleasePool pool; bool needs_shutdown = false; bool needs_restart = false; bool good_bundle = false; FSRef macos_fsref; if (GetParentFSRef(executable_fsref_, &macos_fsref)) { FSRef contents_fsref; if (GetParentFSRef(macos_fsref, &contents_fsref)) { FSRef bundle_fsref; if (GetParentFSRef(contents_fsref, &bundle_fsref)) { base::mac::ScopedCFTypeRef<CFURLRef> bundle_url( CFURLCreateFromFSRef(kCFAllocatorDefault, &bundle_fsref)); if (bundle_url.get()) { base::mac::ScopedCFTypeRef<CFBundleRef> bundle( CFBundleCreate(kCFAllocatorDefault, bundle_url)); // Check to see if the bundle still has a minimal structure. good_bundle = CFBundleGetIdentifier(bundle) != NULL; } } } } if (!good_bundle) { needs_shutdown = true; } else { Boolean in_trash; OSErr err = FSDetermineIfRefIsEnclosedByFolder(kOnAppropriateDisk, kTrashFolderType, &executable_fsref_, &in_trash); if (err == noErr && in_trash) { needs_shutdown = true; } else { bool was_moved = true; FSRef path_ref; if (base::mac::FSRefFromPath(path.value(), &path_ref)) { if (FSCompareFSRefs(&path_ref, &executable_fsref_) == noErr) { was_moved = false; } } if (was_moved) { needs_restart = true; } } } if (needs_shutdown || needs_restart) { // First deal with the plist. base::mac::ScopedCFTypeRef<CFStringRef> name( CopyServiceProcessLaunchDName()); if (needs_restart) { base::mac::ScopedCFTypeRef<CFMutableDictionaryRef> plist( Launchd::GetInstance()->CreatePlistFromFile(Launchd::User, Launchd::Agent, name)); if (plist.get()) { NSMutableDictionary* ns_plist = base::mac::CFToNSCast(plist); std::string new_path = base::mac::PathFromFSRef(executable_fsref_); NSString* ns_new_path = base::SysUTF8ToNSString(new_path); [ns_plist setObject:ns_new_path forKey:@ LAUNCH_JOBKEY_PROGRAM]; scoped_nsobject<NSMutableArray> args( [[ns_plist objectForKey:@ LAUNCH_JOBKEY_PROGRAMARGUMENTS] mutableCopy]); [args replaceObjectAtIndex:0 withObject:ns_new_path]; [ns_plist setObject:args forKey:@ LAUNCH_JOBKEY_PROGRAMARGUMENTS]; if (!Launchd::GetInstance()->WritePlistToFile(Launchd::User, Launchd::Agent, name, plist)) { LOG(ERROR) << "Unable to rewrite plist."; needs_shutdown = true; } } else { LOG(ERROR) << "Unable to read plist."; needs_shutdown = true; } } if (needs_shutdown) { if (!RemoveFromLaunchd()) { LOG(ERROR) << "Unable to RemoveFromLaunchd."; } } // Then deal with the process. CFStringRef session_type = CFSTR(kServiceProcessSessionType); if (needs_restart) { if (!Launchd::GetInstance()->RestartJob(Launchd::User, Launchd::Agent, name, session_type)) { LOG(ERROR) << "RestartLaunchdJob"; needs_shutdown = true; } } if (needs_shutdown) { CFStringRef label = base::mac::NSToCFCast(GetServiceProcessLaunchDLabel()); CFErrorRef err = NULL; if (!Launchd::GetInstance()->RemoveJob(label, &err)) { base::mac::ScopedCFTypeRef<CFErrorRef> scoped_err(err); LOG(ERROR) << "RemoveJob " << err; // Exiting with zero, so launchd doesn't restart the process. exit(0); } } } }