Fix the iOS build after <http://trac.webkit.org/changeset/162208>
[WebKit-https.git] / Source / WebCore / platform / network / cf / CookieJarCFNet.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2012 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 COMPUTER, 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 COMPUTER, 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 #include "config.h"
27 #include "PlatformCookieJar.h"
28
29 #if USE(CFNETWORK)
30
31 #include "Cookie.h"
32 #include "URL.h"
33 #include "NetworkStorageSession.h"
34 #include "SoftLinking.h"
35 #include <CFNetwork/CFHTTPCookiesPriv.h>
36 #include <CoreFoundation/CoreFoundation.h>
37 #include <wtf/text/WTFString.h>
38
39 #if PLATFORM(WIN)
40 #include <WebKitSystemInterface/WebKitSystemInterface.h>
41 #include <windows.h>
42 #endif
43
44 #if PLATFORM(WIN) || (!PLATFORM(IOS) && PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED <= 1090)
45 enum {
46     CFHTTPCookieStorageAcceptPolicyExclusivelyFromMainDocumentDomain = 3
47 };
48 #endif
49
50 namespace WebCore {
51
52 static const CFStringRef s_setCookieKeyCF = CFSTR("Set-Cookie");
53 static const CFStringRef s_cookieCF = CFSTR("Cookie");
54
55 static inline RetainPtr<CFStringRef> cookieDomain(CFHTTPCookieRef cookie)
56 {
57     return adoptCF(CFHTTPCookieCopyDomain(cookie));
58 }
59
60 static inline CFAbsoluteTime cookieExpirationTime(CFHTTPCookieRef cookie)
61 {
62     return CFHTTPCookieGetExpirationTime(cookie);
63 }
64
65 static inline RetainPtr<CFStringRef> cookieName(CFHTTPCookieRef cookie)
66 {
67     return adoptCF(CFHTTPCookieCopyName(cookie));
68 }
69
70 static inline RetainPtr<CFStringRef> cookiePath(CFHTTPCookieRef cookie)
71 {
72     return adoptCF(CFHTTPCookieCopyPath(cookie));
73 }
74
75 static inline RetainPtr<CFStringRef> cookieValue(CFHTTPCookieRef cookie)
76 {
77     return adoptCF(CFHTTPCookieCopyValue(cookie));
78 }
79
80 static RetainPtr<CFArrayRef> filterCookies(CFArrayRef unfilteredCookies)
81 {
82     CFIndex count = CFArrayGetCount(unfilteredCookies);
83     RetainPtr<CFMutableArrayRef> filteredCookies = adoptCF(CFArrayCreateMutable(0, count, &kCFTypeArrayCallBacks));
84     for (CFIndex i = 0; i < count; ++i) {
85         CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(unfilteredCookies, i);
86
87         // <rdar://problem/5632883> CFHTTPCookieStorage would store an empty cookie,
88         // which would be sent as "Cookie: =". We have a workaround in setCookies() to prevent
89         // that, but we also need to avoid sending cookies that were previously stored, and
90         // there's no harm to doing this check because such a cookie is never valid.
91         if (!CFStringGetLength(cookieName(cookie).get()))
92             continue;
93
94         if (CFHTTPCookieIsHTTPOnly(cookie))
95             continue;
96
97         CFArrayAppendValue(filteredCookies.get(), cookie);
98     }
99     return filteredCookies;
100 }
101
102 static RetainPtr<CFArrayRef> copyCookiesForURLWithFirstPartyURL(const NetworkStorageSession& session, const URL& firstParty, const URL& url)
103 {
104     bool secure = url.protocolIs("https");
105
106 #if PLATFORM(IOS) || (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 10100)
107     return adoptCF(_CFHTTPCookieStorageCopyCookiesForURLWithMainDocumentURL(session.cookieStorage().get(), url.createCFURL().get(), firstParty.createCFURL().get(), secure));
108 #else
109     // _CFHTTPCookieStorageCopyCookiesForURLWithMainDocumentURL is not available on other platforms.
110     UNUSED_PARAM(firstParty);
111     return adoptCF(CFHTTPCookieStorageCopyCookiesForURL(session.cookieStorage().get(), url.createCFURL().get(), secure));
112 #endif
113 }
114
115 void setCookiesFromDOM(const NetworkStorageSession& session, const URL& firstParty, const URL& url, const String& value)
116 {
117     // <rdar://problem/5632883> CFHTTPCookieStorage stores an empty cookie, which would be sent as "Cookie: =".
118     if (value.isEmpty())
119         return;
120
121     RetainPtr<CFURLRef> urlCF = url.createCFURL();
122     RetainPtr<CFURLRef> firstPartyForCookiesCF = firstParty.createCFURL();
123
124     // <http://bugs.webkit.org/show_bug.cgi?id=6531>, <rdar://4409034>
125     // cookiesWithResponseHeaderFields doesn't parse cookies without a value
126     String cookieString = value.contains('=') ? value : value + "=";
127
128     RetainPtr<CFStringRef> cookieStringCF = cookieString.createCFString();
129     RetainPtr<CFDictionaryRef> headerFieldsCF = adoptCF(CFDictionaryCreate(kCFAllocatorDefault,
130         (const void**)&s_setCookieKeyCF, (const void**)&cookieStringCF, 1,
131         &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
132
133     RetainPtr<CFArrayRef> cookiesCF = adoptCF(CFHTTPCookieCreateWithResponseHeaderFields(kCFAllocatorDefault,
134         headerFieldsCF.get(), urlCF.get()));
135
136     CFHTTPCookieStorageSetCookies(session.cookieStorage().get(), filterCookies(cookiesCF.get()).get(), urlCF.get(), firstPartyForCookiesCF.get());
137 }
138
139 String cookiesForDOM(const NetworkStorageSession& session, const URL& firstParty, const URL& url)
140 {
141     RetainPtr<CFArrayRef> cookiesCF = copyCookiesForURLWithFirstPartyURL(session, firstParty, url);
142     RetainPtr<CFDictionaryRef> headerCF = adoptCF(CFHTTPCookieCopyRequestHeaderFields(kCFAllocatorDefault, filterCookies(cookiesCF.get()).get()));
143     return (CFStringRef)CFDictionaryGetValue(headerCF.get(), s_cookieCF);
144 }
145
146 String cookieRequestHeaderFieldValue(const NetworkStorageSession& session, const URL& firstParty, const URL& url)
147 {
148     RetainPtr<CFArrayRef> cookiesCF = copyCookiesForURLWithFirstPartyURL(session, firstParty, url);
149     RetainPtr<CFDictionaryRef> headerCF = adoptCF(CFHTTPCookieCopyRequestHeaderFields(kCFAllocatorDefault, cookiesCF.get()));
150     return (CFStringRef)CFDictionaryGetValue(headerCF.get(), s_cookieCF);
151 }
152
153 bool cookiesEnabled(const NetworkStorageSession& session, const URL& /*firstParty*/, const URL& /*url*/)
154 {
155     CFHTTPCookieStorageAcceptPolicy policy = CFHTTPCookieStorageGetCookieAcceptPolicy(session.cookieStorage().get());
156     return policy == CFHTTPCookieStorageAcceptPolicyOnlyFromMainDocumentDomain || policy == CFHTTPCookieStorageAcceptPolicyExclusivelyFromMainDocumentDomain || policy == CFHTTPCookieStorageAcceptPolicyAlways;
157 }
158
159 bool getRawCookies(const NetworkStorageSession& session, const URL& firstParty, const URL& url, Vector<Cookie>& rawCookies)
160 {
161     rawCookies.clear();
162
163     RetainPtr<CFArrayRef> cookiesCF = copyCookiesForURLWithFirstPartyURL(session, firstParty, url);
164
165     CFIndex count = CFArrayGetCount(cookiesCF.get());
166     rawCookies.reserveCapacity(count);
167
168     for (CFIndex i = 0; i < count; i++) {
169        CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(cookiesCF.get(), i);
170        String name = cookieName(cookie).get();
171        String value = cookieValue(cookie).get();
172        String domain = cookieDomain(cookie).get();
173        String path = cookiePath(cookie).get();
174
175        double expires = (cookieExpirationTime(cookie) + kCFAbsoluteTimeIntervalSince1970) * 1000;
176
177        bool httpOnly = CFHTTPCookieIsHTTPOnly(cookie);
178        bool secure = CFHTTPCookieIsSecure(cookie);
179        bool session = false;    // FIXME: Need API for if a cookie is a session cookie.
180
181        rawCookies.uncheckedAppend(Cookie(name, value, domain, path, expires, httpOnly, secure, session));
182     }
183
184     return true;
185 }
186
187 void deleteCookie(const NetworkStorageSession& session, const URL& url, const String& name)
188 {
189     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = session.cookieStorage();
190
191     RetainPtr<CFURLRef> urlCF = url.createCFURL();
192
193     bool sendSecureCookies = url.protocolIs("https");
194     RetainPtr<CFArrayRef> cookiesCF = adoptCF(CFHTTPCookieStorageCopyCookiesForURL(cookieStorage.get(), urlCF.get(), sendSecureCookies));
195
196     CFIndex count = CFArrayGetCount(cookiesCF.get());
197     for (CFIndex i = 0; i < count; i++) {
198         CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(cookiesCF.get(), i);
199         if (String(cookieName(cookie).get()) == name) {
200             CFHTTPCookieStorageDeleteCookie(cookieStorage.get(), cookie);
201             break;
202         }
203     }
204 }
205
206 void getHostnamesWithCookies(const NetworkStorageSession& session, HashSet<String>& hostnames)
207 {
208     RetainPtr<CFArrayRef> cookiesCF = adoptCF(CFHTTPCookieStorageCopyCookies(session.cookieStorage().get()));
209     if (!cookiesCF)
210         return;
211
212     CFIndex count = CFArrayGetCount(cookiesCF.get());
213     for (CFIndex i = 0; i < count; ++i) {
214         CFHTTPCookieRef cookie = static_cast<CFHTTPCookieRef>(const_cast<void *>(CFArrayGetValueAtIndex(cookiesCF.get(), i)));
215         RetainPtr<CFStringRef> domain = cookieDomain(cookie);
216         hostnames.add(domain.get());
217     }
218 }
219
220 void deleteCookiesForHostname(const NetworkStorageSession& session, const String& hostname)
221 {
222     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = session.cookieStorage();
223
224     RetainPtr<CFArrayRef> cookiesCF = adoptCF(CFHTTPCookieStorageCopyCookies(cookieStorage.get()));
225     if (!cookiesCF)
226         return;
227
228     CFIndex count = CFArrayGetCount(cookiesCF.get());
229     for (CFIndex i = count - 1; i >=0; i--) {
230         CFHTTPCookieRef cookie = static_cast<CFHTTPCookieRef>(const_cast<void *>(CFArrayGetValueAtIndex(cookiesCF.get(), i)));
231         RetainPtr<CFStringRef> domain = cookieDomain(cookie);
232         if (String(domain.get()) == hostname)
233             CFHTTPCookieStorageDeleteCookie(cookieStorage.get(), cookie);
234     }
235 }
236
237 void deleteAllCookies(const NetworkStorageSession& session)
238 {
239     CFHTTPCookieStorageDeleteAllCookies(session.cookieStorage().get());
240 }
241
242 } // namespace WebCore
243
244 #endif // USE(CFNETWORK)