Skip to content

Commit 753e621

Browse files
maksimorlovichparkera
maksimorlovich
authored and
parkera
committed
Various Cookie fixes (#1706)
* Various Cookie fixes - Add support for additional Set-Cookie formats that web servers can return - Properly handle HTTP header parsing to extract values since values can contain colons - Make sure to set cookies on redirect requests - Use setValue instead of addValue when applying cookies to requests otherwise, Cookie header might contain: cookie1=value1,cookie1=value1; cookie2=value2 - New unit tests for cookie formats and redirect with Set-Cookie (cherry picked from commit 97a93b5) * Remove two-digit year cookie format support & unit test (fails on Ubuntu 14.04) (#1707)
1 parent 5e15ebc commit 753e621

File tree

7 files changed

+105
-20
lines changed

7 files changed

+105
-20
lines changed

‎Foundation/HTTPCookie.swift‎

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,38 @@ open class HTTPCookie : NSObject {
9393
let _version: Int
9494
var _properties: [HTTPCookiePropertyKey : Any]
9595

96+
// See: https://tools.ietf.org/html/rfc2616#section-3.3.1
97+
98+
// Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
99+
static let _formatter1: DateFormatter = {
100+
let formatter = DateFormatter()
101+
formatter.locale = Locale(identifier: "en_US_POSIX")
102+
formatter.dateFormat = "EEE, dd MMM yyyy HH:mm:ss O"
103+
formatter.timeZone = TimeZone(abbreviation: "GMT")
104+
return formatter
105+
}()
106+
107+
// Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
108+
static let _formatter2: DateFormatter = {
109+
let formatter = DateFormatter()
110+
formatter.locale = Locale(identifier: "en_US_POSIX")
111+
formatter.dateFormat = "EEE MMM d HH:mm:ss yyyy"
112+
formatter.timeZone = TimeZone(abbreviation: "GMT")
113+
return formatter
114+
}()
115+
116+
// Sun, 06-Nov-1994 08:49:37 GMT ; Tomcat servers sometimes return cookies in this format
117+
static let _formatter3: DateFormatter = {
118+
let formatter = DateFormatter()
119+
formatter.locale = Locale(identifier: "en_US_POSIX")
120+
formatter.dateFormat = "EEE, dd-MMM-yyyy HH:mm:ss O"
121+
formatter.timeZone = TimeZone(abbreviation: "GMT")
122+
return formatter
123+
}()
124+
125+
static let _allFormatters: [DateFormatter]
126+
= [_formatter1, _formatter2, _formatter3]
127+
96128
static let _attributes: [HTTPCookiePropertyKey]
97129
= [.name, .value, .originURL, .version, .domain,
98130
.path, .secure, .expires, .comment, .commentURL,
@@ -292,12 +324,8 @@ open class HTTPCookie : NSObject {
292324
if let date = expiresProperty as? Date {
293325
expDate = date
294326
} else if let dateString = expiresProperty as? String {
295-
let formatter = DateFormatter()
296-
formatter.locale = Locale(identifier: "en_US_POSIX")
297-
formatter.dateFormat = "EEE, dd MMM yyyy HH:mm:ss O" // per RFC 6265 '<rfc1123-date, defined in [RFC2616], Section 3.3.1>'
298-
let timeZone = TimeZone(abbreviation: "GMT")
299-
formatter.timeZone = timeZone
300-
expDate = formatter.date(from: dateString)
327+
let results = HTTPCookie._allFormatters.compactMap { $0.date(from: dateString) }
328+
expDate = results.first
301329
}
302330
}
303331
_expiresDate = expDate
@@ -418,7 +446,7 @@ open class HTTPCookie : NSObject {
418446
let name = pair.components(separatedBy: "=")[0]
419447
var value = pair.components(separatedBy: "\(name)=")[1] //a value can have an "="
420448
if canonicalize(name) == .expires {
421-
value = value.insertComma(at: 3) //re-insert the comma
449+
value = value.unmaskCommas() //re-insert the comma
422450
}
423451
properties[canonicalize(name)] = value
424452
}
@@ -439,7 +467,7 @@ open class HTTPCookie : NSObject {
439467
//we pass this to a map()
440468
private class func removeCommaFromDate(_ value: String) -> String {
441469
if value.hasPrefix("Expires") || value.hasPrefix("expires") {
442-
return value.removeCommas()
470+
return value.maskCommas()
443471
}
444472
return value
445473
}
@@ -623,12 +651,12 @@ fileprivate extension String {
623651
return self.trimmingCharacters(in: NSCharacterSet.whitespacesAndNewlines)
624652
}
625653

626-
func removeCommas() -> String {
627-
return self.replacingOccurrences(of: ",", with: "")
654+
func maskCommas() -> String {
655+
return self.replacingOccurrences(of: ",", with: "&comma")
628656
}
629657

630-
func insertComma(at index:Int) -> String {
631-
return String(self.prefix(index)) + "," + String(self.suffix(self.count-index))
658+
func unmaskCommas() -> String {
659+
return self.replacingOccurrences(of: "&comma", with: ",")
632660
}
633661
}
634662

‎Foundation/URLSession/Configuration.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ internal extension URLSession._Configuration {
115115
if let cookieStorage = self.httpCookieStorage, let url = request.url, let cookies = cookieStorage.cookies(for: url) {
116116
let cookiesHeaderFields = HTTPCookie.requestHeaderFields(with: cookies)
117117
if let cookieValue = cookiesHeaderFields["Cookie"], cookieValue != "" {
118-
request.addValue(cookieValue, forHTTPHeaderField: "Cookie")
118+
request.setValue(cookieValue, forHTTPHeaderField: "Cookie")
119119
}
120120
}
121121
}

‎Foundation/URLSession/http/HTTPURLProtocol.swift‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,9 @@ internal class _HTTPURLProtocol: _NativeProtocol {
120120
httpHeaders = hh
121121
}
122122

123-
if let hh = self.task?.originalRequest?.allHTTPHeaderFields {
123+
// In case this is a redirect, take the headers from the current (redirect) request.
124+
if let hh = self.task?.currentRequest?.allHTTPHeaderFields ??
125+
self.task?.originalRequest?.allHTTPHeaderFields {
124126
if httpHeaders == nil {
125127
httpHeaders = hh
126128
} else {
@@ -211,8 +213,9 @@ internal class _HTTPURLProtocol: _NativeProtocol {
211213
}
212214
}
213215
case .noDelegate, .dataCompletionHandler, .downloadCompletionHandler:
214-
// Follow the redirect.
215-
startNewTransfer(with: request)
216+
// Follow the redirect. Need to configure new request with cookies, etc.
217+
let configuredRequest = session._configuration.configure(request: request)
218+
startNewTransfer(with: configuredRequest)
216219
}
217220
}
218221

‎Foundation/URLSession/libcurl/EasyHandle.swift‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -540,9 +540,10 @@ fileprivate extension _EasyHandle {
540540
fileprivate func setCookies(headerData data: Data) {
541541
guard let config = _config, config.httpCookieAcceptPolicy != HTTPCookie.AcceptPolicy.never else { return }
542542
guard let headerData = String(data: data, encoding: String.Encoding.utf8) else { return }
543-
//Convert headerData from a string to a dictionary.
544-
//Ignore headers like 'HTTP/1.1 200 OK\r\n' which do not have a key value pair.
545-
let headerComponents = headerData.split { $0 == ":" }
543+
// Convert headerData from a string to a dictionary.
544+
// Ignore headers like 'HTTP/1.1 200 OK\r\n' which do not have a key value pair.
545+
// Value can have colons (ie, date), so only split at the first one, ie header:value
546+
let headerComponents = headerData.split(separator: ":", maxSplits: 1)
546547
var headers: [String: String] = [:]
547548
//Trim the leading and trailing whitespaces (if any) before adding the header information to the dictionary.
548549
if headerComponents.count > 1 {

‎TestFoundation/HTTPServer.swift‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,10 @@ public class TestURLSessionServer {
435435
let text = request.getCommaSeparatedHeaders()
436436
return _HTTPResponse(response: .OK, headers: "Content-Length: \(text.data(using: .utf8)!.count)", body: text)
437437
}
438+
439+
if uri == "/redirectSetCookies" {
440+
return _HTTPResponse(response: .REDIRECT, headers: "Location: /setCookies\r\nSet-Cookie: redirect=true; Max-Age=7776000; path=/", body: "")
441+
}
438442

439443
if uri == "/UnitedStates" {
440444
let value = capitals[String(uri.dropFirst())]!

‎TestFoundation/TestHTTPCookie.swift‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ class TestHTTPCookie: XCTestCase {
1717
("test_cookiesWithResponseHeader0cookies", test_cookiesWithResponseHeader0cookies),
1818
("test_cookiesWithResponseHeader2cookies", test_cookiesWithResponseHeader2cookies),
1919
("test_cookiesWithResponseHeaderNoDomain", test_cookiesWithResponseHeaderNoDomain),
20-
("test_cookiesWithResponseHeaderNoPathNoDomain", test_cookiesWithResponseHeaderNoPathNoDomain)
20+
("test_cookiesWithResponseHeaderNoPathNoDomain", test_cookiesWithResponseHeaderNoPathNoDomain),
21+
("test_cookieExpiresDateFormats", test_cookieExpiresDateFormats),
2122
]
2223
}
2324

@@ -168,4 +169,26 @@ class TestHTTPCookie: XCTestCase {
168169
XCTAssertEqual(cookies[0].domain, "example.com")
169170
XCTAssertEqual(cookies[0].path, "/")
170171
}
172+
173+
func test_cookieExpiresDateFormats() {
174+
let testDate = Date(timeIntervalSince1970: 1577881800)
175+
let cookieString =
176+
"""
177+
format1=true; expires=Wed, 01 Jan 2020 12:30:00 GMT; path=/; domain=swift.org; secure; httponly,
178+
format2=true; expires=Wed Jan 1 12:30:00 2020; path=/; domain=swift.org; secure; httponly,
179+
format3=true; expires=Wed, 01-Jan-2020 12:30:00 GMT; path=/; domain=swift.org; secure; httponly
180+
"""
181+
182+
let header = ["header1":"value1",
183+
"Set-Cookie": cookieString,
184+
"header2":"value2",
185+
"header3":"value3"]
186+
let cookies = HTTPCookie.cookies(withResponseHeaderFields: header, for: URL(string: "https://swift.org")!)
187+
XCTAssertEqual(cookies.count, 3)
188+
cookies.forEach { cookie in
189+
XCTAssertEqual(cookie.expiresDate, testDate)
190+
XCTAssertEqual(cookie.domain, "swift.org")
191+
XCTAssertEqual(cookie.path, "/")
192+
}
193+
}
171194
}

‎TestFoundation/TestURLSession.swift‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ class TestURLSession : LoopbackServerTest {
4242
("test_cookiesStorage", test_cookiesStorage),
4343
("test_setCookies", test_setCookies),
4444
("test_dontSetCookies", test_dontSetCookies),
45+
("test_redirectionWithSetCookies", test_redirectionWithSetCookies),
4546
]
4647
}
4748

@@ -575,6 +576,31 @@ class TestURLSession : LoopbackServerTest {
575576
XCTAssertEqual(cookies?.count, 1)
576577
}
577578

579+
func test_redirectionWithSetCookies() {
580+
let config = URLSessionConfiguration.default
581+
config.timeoutIntervalForRequest = 5
582+
if let storage = config.httpCookieStorage, let cookies = storage.cookies {
583+
for cookie in cookies {
584+
storage.deleteCookie(cookie)
585+
}
586+
}
587+
let urlString = "http://127.0.0.1:\(TestURLSession.serverPort)/redirectSetCookies"
588+
let session = URLSession(configuration: config, delegate: nil, delegateQueue: nil)
589+
var expect = expectation(description: "POST \(urlString)")
590+
var req = URLRequest(url: URL(string: urlString)!)
591+
var task = session.dataTask(with: req) { (data, _, error) -> Void in
592+
defer { expect.fulfill() }
593+
XCTAssertNotNil(data)
594+
XCTAssertNil(error as? URLError, "error = \(error as! URLError)")
595+
guard let data = data else { return }
596+
let headers = String(data: data, encoding: String.Encoding.utf8) ?? ""
597+
print("headers here = \(headers)")
598+
XCTAssertNotNil(headers.range(of: "Cookie: redirect=true"))
599+
}
600+
task.resume()
601+
waitForExpectations(timeout: 30)
602+
}
603+
578604
func test_setCookies() {
579605
let config = URLSessionConfiguration.default
580606
config.timeoutIntervalForRequest = 5

0 commit comments

Comments
 (0)