Unreviewed, rolling out r244437.
[WebKit-https.git] / Source / WebKit / WebProcess / InjectedBundle / mac / InjectedBundleMac.mm
1 /*
2  * Copyright (C) 2010-2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "InjectedBundle.h"
28
29 #import "APIArray.h"
30 #import "APIData.h"
31 #import "ObjCObjectGraph.h"
32 #import "WKBundleAPICast.h"
33 #import "WKBundleInitialize.h"
34 #import "WKWebProcessBundleParameters.h"
35 #import "WKWebProcessPlugInInternal.h"
36 #import "WebProcessCreationParameters.h"
37 #import <CoreFoundation/CFURL.h>
38 #import <Foundation/NSBundle.h>
39 #import <WebCore/PlatformKeyboardEvent.h>
40 #import <dlfcn.h>
41 #import <objc/runtime.h>
42 #import <pal/spi/cocoa/NSKeyedArchiverSPI.h>
43 #import <stdio.h>
44 #import <wtf/RetainPtr.h>
45 #import <wtf/text/CString.h>
46 #import <wtf/text/WTFString.h>
47
48 @interface NSBundle (WKAppDetails)
49 - (CFBundleRef)_cfBundle;
50 @end
51
52 namespace WebKit {
53 using namespace WebCore;
54
55 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
56 static NSEventModifierFlags currentModifierFlags(id self, SEL _cmd)
57 {
58     auto currentModifiers = PlatformKeyboardEvent::currentStateOfModifierKeys();
59     NSEventModifierFlags modifiers = 0;
60     
61     if (currentModifiers.contains(PlatformEvent::Modifier::ShiftKey))
62         modifiers |= NSEventModifierFlagShift;
63     if (currentModifiers.contains(PlatformEvent::Modifier::ControlKey))
64         modifiers |= NSEventModifierFlagControl;
65     if (currentModifiers.contains(PlatformEvent::Modifier::AltKey))
66         modifiers |= NSEventModifierFlagOption;
67     if (currentModifiers.contains(PlatformEvent::Modifier::MetaKey))
68         modifiers |= NSEventModifierFlagCommand;
69     if (currentModifiers.contains(PlatformEvent::Modifier::CapsLockKey))
70         modifiers |= NSEventModifierFlagCapsLock;
71     
72     return modifiers;
73 }
74 #endif
75
76 bool InjectedBundle::initialize(const WebProcessCreationParameters& parameters, API::Object* initializationUserData)
77 {
78     if (m_sandboxExtension) {
79         if (!m_sandboxExtension->consumePermanently()) {
80             WTFLogAlways("InjectedBundle::load failed - Could not consume bundle sandbox extension for [%s].\n", m_path.utf8().data());
81             return false;
82         }
83
84         m_sandboxExtension = nullptr;
85     }
86     
87     RetainPtr<CFStringRef> injectedBundlePathStr = m_path.createCFString();
88     if (!injectedBundlePathStr) {
89         WTFLogAlways("InjectedBundle::load failed - Could not create the path string.\n");
90         return false;
91     }
92     
93     RetainPtr<CFURLRef> bundleURL = adoptCF(CFURLCreateWithFileSystemPath(0, injectedBundlePathStr.get(), kCFURLPOSIXPathStyle, false));
94     if (!bundleURL) {
95         WTFLogAlways("InjectedBundle::load failed - Could not create the url from the path string.\n");
96         return false;
97     }
98
99     m_platformBundle = [[NSBundle alloc] initWithURL:(__bridge NSURL *)bundleURL.get()];
100     if (!m_platformBundle) {
101         WTFLogAlways("InjectedBundle::load failed - Could not create the bundle.\n");
102         return false;
103     }
104
105     WKBundleInitializeFunctionPtr initializeFunction = nullptr;
106     if (RetainPtr<CFURLRef> executableURL = adoptCF(CFBundleCopyExecutableURL([m_platformBundle _cfBundle]))) {
107         static constexpr size_t maxPathSize = 4096;
108         char pathToExecutable[maxPathSize];
109         if (CFURLGetFileSystemRepresentation(executableURL.get(), true, bitwise_cast<uint8_t*>(pathToExecutable), maxPathSize)) {
110             // We don't hold onto this handle anywhere more permanent since we never dlcose.
111             if (void* handle = dlopen(pathToExecutable, RTLD_LAZY | RTLD_GLOBAL | RTLD_FIRST))
112                 initializeFunction = bitwise_cast<WKBundleInitializeFunctionPtr>(dlsym(handle, "WKBundleInitialize"));
113         }
114     }
115         
116     if (!initializeFunction) {
117         if (![m_platformBundle load]) {
118             WTFLogAlways("InjectedBundle::load failed - Could not load the executable from the bundle.\n");
119             return false;
120         }
121     }
122
123     if (parameters.bundleParameterData) {
124         auto bundleParameterData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(parameters.bundleParameterData->bytes())) length:parameters.bundleParameterData->size() freeWhenDone:NO]);
125
126         auto unarchiver = secureUnarchiverFromData(bundleParameterData.get());
127
128         NSDictionary *dictionary = nil;
129         @try {
130             dictionary = [unarchiver.get() decodeObjectOfClass:[NSObject class] forKey:@"parameters"];
131             ASSERT([dictionary isKindOfClass:[NSDictionary class]]);
132         } @catch (NSException *exception) {
133             LOG_ERROR("Failed to decode bundle parameters: %@", exception);
134         }
135
136         ASSERT(!m_bundleParameters);
137         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:dictionary]);
138     }
139     
140 #if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
141     // Swizzle [NSEvent modiferFlags], since it always returns 0 when the WindowServer is blocked.
142     Method method = class_getClassMethod([NSEvent class], @selector(modifierFlags));
143     method_setImplementation(method, reinterpret_cast<IMP>(currentModifierFlags));
144 #endif
145     
146     if (!initializeFunction)
147         initializeFunction = bitwise_cast<WKBundleInitializeFunctionPtr>(CFBundleGetFunctionPointerForName([m_platformBundle _cfBundle], CFSTR("WKBundleInitialize")));
148
149     // First check to see if the bundle has a WKBundleInitialize function.
150     if (initializeFunction) {
151         initializeFunction(toAPI(this), toAPI(initializationUserData));
152         return true;
153     }
154
155     // Otherwise, look to see if the bundle has a principal class
156     Class principalClass = [m_platformBundle principalClass];
157     if (!principalClass) {
158         WTFLogAlways("InjectedBundle::load failed - No initialize function or principal class found in the bundle executable.\n");
159         return false;
160     }
161
162     if (![principalClass conformsToProtocol:@protocol(WKWebProcessPlugIn)]) {
163         WTFLogAlways("InjectedBundle::load failed - Principal class does not conform to the WKWebProcessPlugIn protocol.\n");
164         return false;
165     }
166
167     id <WKWebProcessPlugIn> instance = (id <WKWebProcessPlugIn>)[(NSObject *)[principalClass alloc] init];
168     if (!instance) {
169         WTFLogAlways("InjectedBundle::load failed - Could not initialize an instance of the principal class.\n");
170         return false;
171     }
172
173     WKWebProcessPlugInController* plugInController = WebKit::wrapper(*this);
174     [plugInController _setPrincipalClassInstance:instance];
175
176     if ([instance respondsToSelector:@selector(webProcessPlugIn:initializeWithObject:)]) {
177         RetainPtr<id> objCInitializationUserData;
178         if (initializationUserData && initializationUserData->type() == API::Object::Type::ObjCObjectGraph)
179             objCInitializationUserData = static_cast<ObjCObjectGraph*>(initializationUserData)->rootObject();
180         [instance webProcessPlugIn:plugInController initializeWithObject:objCInitializationUserData.get()];
181     }
182
183     return true;
184 }
185
186 WKWebProcessBundleParameters *InjectedBundle::bundleParameters()
187 {
188     // We must not return nil even if no parameters are currently set, in order to allow the client
189     // to use KVO.
190     if (!m_bundleParameters)
191         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:@{ }]);
192
193     return m_bundleParameters.get();
194 }
195
196 void InjectedBundle::extendClassesForParameterCoder(API::Array& classes)
197 {
198     size_t size = classes.size();
199
200     auto mutableSet = adoptNS([classesForCoder() mutableCopy]);
201
202     for (size_t i = 0; i < size; ++i) {
203         API::String* classNameString = classes.at<API::String>(i);
204         if (!classNameString) {
205             WTFLogAlways("InjectedBundle::extendClassesForParameterCoder - No class provided as argument %d.\n", i);
206             break;
207         }
208     
209         CString className = classNameString->string().utf8();
210         Class objectClass = objc_lookUpClass(className.data());
211         if (!objectClass) {
212             WTFLogAlways("InjectedBundle::extendClassesForParameterCoder - Class %s is not a valid Objective C class.\n", className.data());
213             break;
214         }
215
216         [mutableSet.get() addObject:objectClass];
217     }
218
219     m_classesForCoder = mutableSet;
220 }
221
222 NSSet* InjectedBundle::classesForCoder()
223 {
224     if (!m_classesForCoder)
225         m_classesForCoder = retainPtr([NSSet setWithObjects:[NSArray class], [NSData class], [NSDate class], [NSDictionary class], [NSNull class], [NSNumber class], [NSSet class], [NSString class], [NSTimeZone class], [NSURL class], [NSUUID class], nil]);
226
227     return m_classesForCoder.get();
228 }
229
230 void InjectedBundle::setBundleParameter(const String& key, const IPC::DataReference& value)
231 {
232     auto bundleParameterData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(value.data())) length:value.size() freeWhenDone:NO]);
233
234     auto unarchiver = secureUnarchiverFromData(bundleParameterData.get());
235
236     id parameter = nil;
237     @try {
238         parameter = [unarchiver decodeObjectOfClasses:classesForCoder() forKey:@"parameter"];
239     } @catch (NSException *exception) {
240         LOG_ERROR("Failed to decode bundle parameter: %@", exception);
241         return;
242     }
243
244     if (!m_bundleParameters && parameter)
245         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:[NSDictionary dictionary]]);
246
247     [m_bundleParameters setParameter:parameter forKey:key];
248 }
249
250 void InjectedBundle::setBundleParameters(const IPC::DataReference& value)
251 {
252     auto bundleParametersData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(value.data())) length:value.size() freeWhenDone:NO]);
253
254     auto unarchiver = secureUnarchiverFromData(bundleParametersData.get());
255
256     NSDictionary *parameters = nil;
257     @try {
258         parameters = [unarchiver decodeObjectOfClass:[NSDictionary class] forKey:@"parameters"];
259     } @catch (NSException *exception) {
260         LOG_ERROR("Failed to decode bundle parameter: %@", exception);
261     }
262
263     if (!parameters)
264         return;
265
266     if (!m_bundleParameters) {
267         m_bundleParameters = adoptNS([[WKWebProcessBundleParameters alloc] initWithDictionary:parameters]);
268         return;
269     }
270
271     [m_bundleParameters setParametersForKeyWithDictionary:parameters];
272 }
273
274 } // namespace WebKit