69692001a5ae4e4fbbbce340381b3e917179ccc2
[WebKit-https.git] / Source / WebCore / platform / network / cocoa / ResourceResponseCocoa.mm
1 /*
2  * Copyright (C) 2006, 2016 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import "config.h"
27 #import "ResourceResponse.h"
28
29 #if PLATFORM(COCOA)
30
31 #import "HTTPParsers.h"
32 #import "WebCoreURLResponse.h"
33 #import <Foundation/Foundation.h>
34 #import <limits>
35 #import <pal/spi/cf/CFNetworkSPI.h>
36 #import <wtf/AutodrainedPool.h>
37 #import <wtf/NeverDestroyed.h>
38 #import <wtf/StdLibExtras.h>
39 #import <wtf/text/StringView.h>
40
41 namespace WebCore {
42
43 void ResourceResponse::initNSURLResponse() const
44 {
45     if (!m_httpStatusCode || !m_url.protocolIsInHTTPFamily()) {
46         // Work around a mistake in the NSURLResponse class - <rdar://problem/6875219>.
47         // The init function takes an NSInteger, even though the accessor returns a long long.
48         // For values that won't fit in an NSInteger, pass -1 instead.
49         NSInteger expectedContentLength;
50         if (m_expectedContentLength < 0 || m_expectedContentLength > std::numeric_limits<NSInteger>::max())
51             expectedContentLength = -1;
52         else
53             expectedContentLength = static_cast<NSInteger>(m_expectedContentLength);
54
55         NSString* encodingNSString = nsStringNilIfEmpty(m_textEncodingName);
56         m_nsResponse = adoptNS([[NSURLResponse alloc] initWithURL:m_url MIMEType:m_mimeType expectedContentLength:expectedContentLength textEncodingName:encodingNSString]);
57         return;
58     }
59
60     // FIXME: We lose the status text and the HTTP version here.
61     NSMutableDictionary* headerDictionary = [NSMutableDictionary dictionary];
62     for (auto& header : m_httpHeaderFields)
63         [headerDictionary setObject:(NSString *)header.value forKey:(NSString *)header.key];
64
65     m_nsResponse = adoptNS([[NSHTTPURLResponse alloc] initWithURL:m_url statusCode:m_httpStatusCode HTTPVersion:(NSString*)kCFHTTPVersion1_1 headerFields:headerDictionary]);
66
67     // Mime type sniffing doesn't work with a synthesized response.
68     [m_nsResponse.get() _setMIMEType:(NSString *)m_mimeType];
69 }
70
71 void ResourceResponse::disableLazyInitialization()
72 {
73     lazyInit(AllFields);
74 }
75
76 CertificateInfo ResourceResponse::platformCertificateInfo() const
77 {
78 #if USE(CFURLCONNECTION)
79     ASSERT(m_cfResponse || source() == Source::ServiceWorker);
80     CFURLResponseRef cfResponse = m_cfResponse.get();
81 #else
82     ASSERT(m_nsResponse || source() == Source::ServiceWorker);
83     CFURLResponseRef cfResponse = [m_nsResponse _CFURLResponse];
84 #endif
85
86     if (!cfResponse)
87         return { };
88
89     CFDictionaryRef context = _CFURLResponseGetSSLCertificateContext(cfResponse);
90     if (!context)
91         return { };
92
93     auto trustValue = CFDictionaryGetValue(context, kCFStreamPropertySSLPeerTrust);
94     if (!trustValue)
95         return { };
96     ASSERT(CFGetTypeID(trustValue) == SecTrustGetTypeID());
97     auto trust = (SecTrustRef)trustValue;
98
99     SecTrustResultType trustResultType;
100     OSStatus result = SecTrustGetTrustResult(trust, &trustResultType);
101     if (result != errSecSuccess)
102         return { };
103
104     if (trustResultType == kSecTrustResultInvalid) {
105         result = SecTrustEvaluate(trust, &trustResultType);
106         if (result != errSecSuccess)
107             return { };
108     }
109
110 #if HAVE(SEC_TRUST_SERIALIZATION)
111     return CertificateInfo(trust);
112 #else
113     return CertificateInfo(CertificateInfo::certificateChainFromSecTrust(trust));
114 #endif
115 }
116
117 #if USE(CFURLCONNECTION)
118
119 NSURLResponse *ResourceResponse::nsURLResponse() const
120 {
121     if (!m_nsResponse && !m_cfResponse && !m_isNull) {
122         initNSURLResponse();
123         m_cfResponse = [m_nsResponse.get() _CFURLResponse];
124         return m_nsResponse.get();
125     }
126
127     if (!m_cfResponse)
128         return nil;
129
130     if (!m_nsResponse)
131         m_nsResponse = [NSURLResponse _responseWithCFURLResponse:m_cfResponse.get()];
132
133     return m_nsResponse.get();
134 }
135
136 ResourceResponse::ResourceResponse(NSURLResponse* nsResponse)
137     : m_initLevel(Uninitialized)
138     , m_cfResponse([nsResponse _CFURLResponse])
139     , m_nsResponse(nsResponse)
140 {
141     m_isNull = !nsResponse;
142 }
143
144 #else
145
146 static NSString* const commonHeaderFields[] = {
147     @"Age", @"Cache-Control", @"Content-Type", @"Date", @"Etag", @"Expires", @"Last-Modified", @"Pragma"
148 };
149
150 NSURLResponse *ResourceResponse::nsURLResponse() const
151 {
152     if (!m_nsResponse && !m_isNull)
153         initNSURLResponse();
154     return m_nsResponse.get();
155 }
156
157 static void addToHTTPHeaderMap(const void* key, const void* value, void* context)
158 {
159     HTTPHeaderMap* httpHeaderMap = (HTTPHeaderMap*)context;
160     httpHeaderMap->set((CFStringRef)key, (CFStringRef)value);
161 }
162
163 static inline AtomicString stripLeadingAndTrailingDoubleQuote(const String& value)
164 {
165     unsigned length = value.length();
166     if (length < 2 || value[0u] != '"' || value[length - 1] != '"')
167         return value;
168
169     return StringView(value).substring(1, length - 2).toAtomicString();
170 }
171
172 enum class OnlyCommonHeaders { No, Yes };
173 static inline void initializeHTTPHeaders(OnlyCommonHeaders onlyCommonHeaders, NSHTTPURLResponse *httpResponse, HTTPHeaderMap& headersMap)
174 {
175     headersMap.clear();
176     auto messageRef = CFURLResponseGetHTTPResponse([httpResponse _CFURLResponse]);
177
178     // Avoid calling [NSURLResponse allHeaderFields] to minimize copying (<rdar://problem/26778863>).
179     auto headers = adoptCF(CFHTTPMessageCopyAllHeaderFields(messageRef));
180     if (onlyCommonHeaders == OnlyCommonHeaders::Yes) {
181         for (auto& commonHeader : commonHeaderFields) {
182             const void* value;
183             if (CFDictionaryGetValueIfPresent(headers.get(), commonHeader, &value))
184                 headersMap.set(commonHeader, (CFStringRef) value);
185         }
186         return;
187     }
188     CFDictionaryApplyFunction(headers.get(), addToHTTPHeaderMap, &headersMap);
189 }
190
191 static inline AtomicString extractHTTPStatusText(CFHTTPMessageRef messageRef)
192 {
193     if (auto httpStatusLine = adoptCF(CFHTTPMessageCopyResponseStatusLine(messageRef)))
194         return extractReasonPhraseFromHTTPStatusLine(httpStatusLine.get());
195
196     static NeverDestroyed<AtomicString> defaultStatusText("OK", AtomicString::ConstructFromLiteral);
197     return defaultStatusText;
198 }
199
200 void ResourceResponse::platformLazyInit(InitLevel initLevel)
201 {
202     ASSERT(initLevel >= CommonFieldsOnly);
203
204     if (m_initLevel >= initLevel)
205         return;
206
207     if (m_isNull || !m_nsResponse)
208         return;
209     
210     AutodrainedPool pool;
211
212     NSHTTPURLResponse *httpResponse = [m_nsResponse.get() isKindOfClass:[NSHTTPURLResponse class]] ? (NSHTTPURLResponse *)m_nsResponse.get() : nullptr;
213
214     if (m_initLevel < CommonFieldsOnly) {
215         m_url = [m_nsResponse.get() URL];
216         m_mimeType = [m_nsResponse.get() MIMEType];
217         m_expectedContentLength = [m_nsResponse.get() expectedContentLength];
218         // Stripping double quotes as a workaround for <rdar://problem/8757088>, can be removed once that is fixed.
219         m_textEncodingName = stripLeadingAndTrailingDoubleQuote([m_nsResponse.get() textEncodingName]);
220         m_httpStatusCode = httpResponse ? [httpResponse statusCode] : 0;
221     }
222     if (httpResponse) {
223         if (initLevel == AllFields) {
224             auto messageRef = CFURLResponseGetHTTPResponse([httpResponse _CFURLResponse]);
225             m_httpStatusText = extractHTTPStatusText(messageRef);
226             m_httpVersion = String(adoptCF(CFHTTPMessageCopyVersion(messageRef)).get()).convertToASCIIUppercase();
227             initializeHTTPHeaders(OnlyCommonHeaders::No, httpResponse, m_httpHeaderFields);
228         } else
229             initializeHTTPHeaders(OnlyCommonHeaders::Yes, httpResponse, m_httpHeaderFields);
230     }
231
232     m_initLevel = initLevel;
233 }
234
235 String ResourceResponse::platformSuggestedFilename() const
236 {
237     return [nsURLResponse() suggestedFilename];
238 }
239
240 bool ResourceResponse::platformCompare(const ResourceResponse& a, const ResourceResponse& b)
241 {
242     return a.nsURLResponse() == b.nsURLResponse();
243 }
244
245 #endif // USE(CFURLCONNECTION)
246
247 } // namespace WebCore
248
249 #endif // PLATFORM(COCOA)