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