Skip to content

Commit 36c6010

Browse files
karwakarwa
committed
Redo HTTP cookie parsing using strptime
1 parent d372bdc commit 36c6010

File tree

8 files changed

+409
-98
lines changed

8 files changed

+409
-98
lines changed

‎Package.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ let package = Package(
2929
.package(url: "https://github.com/apple/swift-log.git", from: "1.4.0"),
3030
],
3131
targets: [
32+
.target(name: "CAsyncHTTPClient"),
3233
.target(
3334
name: "AsyncHTTPClient",
3435
dependencies: [
36+
.target(name: "CAsyncHTTPClient"),
3537
.product(name: "NIO", package: "swift-nio"),
3638
.product(name: "NIOCore", package: "swift-nio"),
3739
.product(name: "NIOPosix", package: "swift-nio"),

‎Sources/AsyncHTTPClient/FoundationExtensions.swift

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2021 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
// Extensions which provide better ergonomics when using Foundation types,
16+
// or by using Foundation APIs.
17+
18+
import Foundation
19+
20+
extension HTTPClient.Cookie {
21+
/// The cookie's expiration date.
22+
public var expires: Date? {
23+
get {
24+
expires_timestamp.map { Date(timeIntervalSince1970: TimeInterval($0)) }
25+
}
26+
set {
27+
expires_timestamp = newValue.map { Int64($0.timeIntervalSince1970) }
28+
}
29+
}
30+
31+
/// Create HTTP cookie.
32+
///
33+
/// - parameters:
34+
/// - name: The name of the cookie.
35+
/// - value: The cookie's string value.
36+
/// - path: The cookie's path.
37+
/// - domain: The domain of the cookie, defaults to nil.
38+
/// - expires: The cookie's expiration date, defaults to nil.
39+
/// - maxAge: The cookie's age in seconds, defaults to nil.
40+
/// - httpOnly: Whether this cookie should be used by HTTP servers only, defaults to false.
41+
/// - secure: Whether this cookie should only be sent using secure channels, defaults to false.
42+
public init(name: String, value: String, path: String = "/", domain: String? = nil, expires: Date? = nil, maxAge: Int? = nil, httpOnly: Bool = false, secure: Bool = false) {
43+
self.init(
44+
name: name,
45+
value: value,
46+
path: path,
47+
domain: domain,
48+
expires_timestamp: expires.map { Int64($0.timeIntervalSince1970) },
49+
maxAge: maxAge,
50+
httpOnly: httpOnly,
51+
secure: secure
52+
)
53+
}
54+
}

‎Sources/AsyncHTTPClient/HTTPClient+HTTPCookie.swift

Lines changed: 110 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,13 @@
1212
//
1313
//===----------------------------------------------------------------------===//
1414

15-
import Foundation
1615
import NIOHTTP1
16+
#if canImport(Darwin)
17+
import Darwin
18+
#elseif canImport(Glibc)
19+
import Glibc
20+
#endif
21+
import CAsyncHTTPClient
1722

1823
extension HTTPClient {
1924
/// A representation of an HTTP cookie.
@@ -26,8 +31,8 @@ extension HTTPClient {
2631
public var path: String
2732
/// The domain of the cookie.
2833
public var domain: String?
29-
/// The cookie's expiration date.
30-
public var expires: Date?
34+
/// The cookie's expiration date, as a number of seconds since the Unix epoch.
35+
var expires_timestamp: Int64?
3136
/// The cookie's age in seconds.
3237
public var maxAge: Int?
3338
/// Whether the cookie should only be sent to HTTP servers.
@@ -42,74 +47,39 @@ extension HTTPClient {
4247
/// - defaultDomain: Default domain to use if cookie was sent without one.
4348
/// - returns: nil if the header is invalid.
4449
public init?(header: String, defaultDomain: String) {
45-
let components = header.components(separatedBy: ";").map {
46-
$0.trimmingCharacters(in: .whitespaces)
47-
}
48-
49-
if components.isEmpty {
50+
var components = header.utf8.split(separator: UInt8(ascii: ";"), omittingEmptySubsequences: false)[...]
51+
guard let keyValuePair = components.popFirst()?.trimmingASCIISpaces() else {
5052
return nil
5153
}
52-
53-
let nameAndValue = components[0].split(separator: "=", maxSplits: 1, omittingEmptySubsequences: false).map {
54-
$0.trimmingCharacters(in: .whitespaces)
55-
}
56-
57-
guard nameAndValue.count == 2 else {
54+
guard let (trimmedName, trimmedValue) = keyValuePair.parseKeyValuePair() else {
5855
return nil
5956
}
60-
61-
self.name = nameAndValue[0]
62-
self.value = nameAndValue[1].omittingQuotes()
63-
64-
guard !self.name.isEmpty else {
57+
guard !trimmedName.isEmpty else {
6558
return nil
6659
}
6760

61+
self.name = String(decoding: trimmedName, as: UTF8.self)
62+
self.value = String(decoding: trimmedValue.trimmingPairedASCIIQuote(), as: UTF8.self)
6863
self.path = "/"
6964
self.domain = defaultDomain
70-
self.expires = nil
65+
self.expires_timestamp = nil
7166
self.maxAge = nil
7267
self.httpOnly = false
7368
self.secure = false
7469

75-
for component in components[1...] {
76-
switch self.parseComponent(component) {
77-
case (nil, nil):
78-
continue
79-
case ("path", .some(let value)):
70+
for component in components {
71+
switch component.parseCookieComponent() {
72+
case ("path", .some(let value))?:
8073
self.path = value
81-
case ("domain", .some(let value)):
74+
case ("domain", .some(let value))?:
8275
self.domain = value
83-
case ("expires", let value):
84-
guard let value = value else {
85-
continue
86-
}
87-
88-
let formatter = DateFormatter()
89-
formatter.locale = Locale(identifier: "en_US")
90-
formatter.timeZone = TimeZone(identifier: "GMT")
91-
92-
formatter.dateFormat = "EEE, dd MMM yyyy HH:mm:ss z"
93-
if let date = formatter.date(from: value) {
94-
self.expires = date
95-
continue
96-
}
97-
98-
formatter.dateFormat = "EEE, dd-MMM-yy HH:mm:ss z"
99-
if let date = formatter.date(from: value) {
100-
self.expires = date
101-
continue
102-
}
103-
104-
formatter.dateFormat = "EEE MMM d hh:mm:s yyyy"
105-
if let date = formatter.date(from: value) {
106-
self.expires = date
107-
}
108-
case ("max-age", let value):
76+
case ("expires", .some(let value))?:
77+
self.expires_timestamp = parseCookieTime(value)
78+
case ("max-age", let value)?:
10979
self.maxAge = value.flatMap(Int.init)
110-
case ("secure", nil):
80+
case ("secure", nil)?:
11181
self.secure = true
112-
case ("httponly", nil):
82+
case ("httponly", nil)?:
11383
self.httpOnly = true
11484
default:
11585
continue
@@ -124,51 +94,111 @@ extension HTTPClient {
12494
/// - value: The cookie's string value.
12595
/// - path: The cookie's path.
12696
/// - domain: The domain of the cookie, defaults to nil.
127-
/// - expires: The cookie's expiration date, defaults to nil.
97+
/// - expires_timestamp: The cookie's expiration date, as a number of seconds since the Unix epoch. defaults to nil.
12898
/// - maxAge: The cookie's age in seconds, defaults to nil.
12999
/// - httpOnly: Whether this cookie should be used by HTTP servers only, defaults to false.
130100
/// - secure: Whether this cookie should only be sent using secure channels, defaults to false.
131-
public init(name: String, value: String, path: String = "/", domain: String? = nil, expires: Date? = nil, maxAge: Int? = nil, httpOnly: Bool = false, secure: Bool = false) {
101+
internal init(name: String, value: String, path: String = "/", domain: String? = nil, expires_timestamp: Int64? = nil, maxAge: Int? = nil, httpOnly: Bool = false, secure: Bool = false) {
132102
self.name = name
133103
self.value = value
134104
self.path = path
135105
self.domain = domain
136-
self.expires = expires
106+
self.expires_timestamp = expires_timestamp
137107
self.maxAge = maxAge
138108
self.httpOnly = httpOnly
139109
self.secure = secure
140110
}
111+
}
112+
}
141113

142-
func parseComponent(_ component: String) -> (String?, String?) {
143-
let nameAndValue = component.split(separator: "=", maxSplits: 1).map {
144-
$0.trimmingCharacters(in: .whitespaces)
145-
}
146-
if nameAndValue.count == 2 {
147-
return (nameAndValue[0].lowercased(), nameAndValue[1])
148-
} else if nameAndValue.count == 1 {
149-
return (nameAndValue[0].lowercased(), nil)
150-
}
151-
return (nil, nil)
152-
}
114+
extension HTTPClient.Response {
115+
/// List of HTTP cookies returned by the server.
116+
public var cookies: [HTTPClient.Cookie] {
117+
return self.headers["set-cookie"].compactMap { HTTPClient.Cookie(header: $0, defaultDomain: self.host) }
153118
}
154119
}
155120

156-
extension String {
157-
fileprivate func omittingQuotes() -> String {
158-
let dquote = "\""
159-
if !hasPrefix(dquote) || !hasSuffix(dquote) {
160-
return self
121+
extension String.UTF8View.SubSequence {
122+
fileprivate func trimmingASCIISpaces() -> SubSequence {
123+
guard let start = self.firstIndex(where: { $0 != UInt8(ascii: " ") }) else {
124+
return self[self.endIndex..<self.endIndex]
125+
}
126+
let end = self.lastIndex(where: { $0 != UInt8(ascii: " ") })!
127+
return self[start...end]
128+
}
129+
130+
/// If this collection begins and ends with an ASCII double-quote ("),
131+
/// returns a version of self trimmed of those quotes. Otherwise, returns self.
132+
fileprivate func trimmingPairedASCIIQuote() -> SubSequence {
133+
let quoteChar = UInt8(ascii: "\"")
134+
var trimmed = self
135+
if trimmed.popFirst() == quoteChar && trimmed.popLast() == quoteChar {
136+
return trimmed
137+
}
138+
return self
139+
}
140+
141+
/// Splits this collection in to a key and value at the first ASCII '=' character.
142+
/// Both the key and value are trimmed of ASCII spaces.
143+
fileprivate func parseKeyValuePair() -> (key: SubSequence, value: SubSequence)? {
144+
guard let keyValueSeparator = self.firstIndex(of: UInt8(ascii: "=")) else {
145+
return nil
161146
}
147+
let trimmedName = self[..<keyValueSeparator].trimmingASCIISpaces()
148+
let trimmedValue = self[self.index(after: keyValueSeparator)...].trimmingASCIISpaces()
149+
return (trimmedName, trimmedValue)
150+
}
162151

163-
let begin = index(after: startIndex)
164-
let end = index(before: endIndex)
165-
return String(self[begin..<end])
152+
/// Parses this collection as either a key-value pair, or a plain key.
153+
/// The returned key is trimmed of ASCII spaces and normalized to lowercase.
154+
/// The returned value is trimmed of ASCII spaces.
155+
fileprivate func parseCookieComponent() -> (key: String, value: String?)? {
156+
let (trimmedName, trimmedValue) = self.parseKeyValuePair() ?? (self.trimmingASCIISpaces(), nil)
157+
guard !trimmedName.isEmpty else {
158+
return nil
159+
}
160+
return (String(decoding: trimmedName, as: UTF8.self).lowercased(), trimmedValue.map { String(decoding: $0, as: UTF8.self) })
166161
}
167162
}
168163

169-
extension HTTPClient.Response {
170-
/// List of HTTP cookies returned by the server.
171-
public var cookies: [HTTPClient.Cookie] {
172-
return self.headers["set-cookie"].compactMap { HTTPClient.Cookie(header: $0, defaultDomain: self.host) }
164+
private let posixLocale: UnsafeMutableRawPointer = {
165+
// All POSIX systems must provide a "POSIX" locale, and its date/time formats are US English.
166+
// https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap07.html#tag_07_03_05
167+
let _posixLocale = newlocale(LC_TIME_MASK | LC_NUMERIC_MASK, "POSIX", nil)!
168+
return UnsafeMutableRawPointer(_posixLocale)
169+
}()
170+
171+
private func parseTimestamp(_ string: String, format: String) -> tm? {
172+
var timeComponents = tm()
173+
guard swiftahc_cshims_strptime_l(string, format, &timeComponents, posixLocale) else {
174+
return nil
175+
}
176+
return timeComponents
177+
}
178+
179+
private func parseCookieTime(_ string: String) -> Int64? {
180+
var string = string
181+
if string.utf8.contains(where: { $0 < 0x20 /* Control characters */ || $0 == 0x7F /* DEL */ }) {
182+
return nil
183+
}
184+
if string.hasSuffix("GMT") {
185+
let timezoneStart = string.index(string.endIndex, offsetBy: -3)
186+
guard let trimmedTimestampLast = string[..<timezoneStart].lastIndex(where: { $0 != " " }) else {
187+
return nil
188+
}
189+
let trimmedTimestampEndIndex = string.index(after: trimmedTimestampLast)
190+
guard trimmedTimestampEndIndex != timezoneStart else {
191+
return nil
192+
}
193+
string.removeSubrange(trimmedTimestampEndIndex...)
194+
}
195+
guard
196+
var timeComponents = parseTimestamp(string, format: "%a, %d %b %Y %H:%M:%S")
197+
?? parseTimestamp(string, format: "%a, %d-%b-%y %H:%M:%S")
198+
?? parseTimestamp(string, format: "%a %b %d %H:%M:%S %Y")
199+
else {
200+
return nil
173201
}
202+
let timestamp = Int64(timegm(&timeComponents))
203+
return timestamp == -1 && errno == EOVERFLOW ? nil : timestamp
174204
}

‎Sources/CAsyncHTTPClient/CAsyncHTTPClient.c

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2021 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
#if __APPLE__
16+
#include <xlocale.h>
17+
#elif __linux__
18+
#define _GNU_SOURCE
19+
#include <locale.h>
20+
#endif
21+
22+
#include <stdbool.h>
23+
#include <time.h>
24+
25+
bool swiftahc_cshims_strptime(const char * string, const char * format, struct tm * result) {
26+
const char * firstNonProcessed = strptime(string, format, result);
27+
if (firstNonProcessed) {
28+
return *firstNonProcessed == 0;
29+
}
30+
return false;
31+
}
32+
33+
bool swiftahc_cshims_strptime_l(const char * string, const char * format, struct tm * result, void * locale) {
34+
// The pointer cast is fine as long we make sure it really points to a locale_t.
35+
const char * firstNonProcessed = strptime_l(string, format, result, (locale_t)locale);
36+
if (firstNonProcessed) {
37+
return *firstNonProcessed == 0;
38+
}
39+
return false;
40+
}

‎Sources/CAsyncHTTPClient/include/CAsyncHTTPClient.h

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2021 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
#ifndef CASYNC_HTTP_CLIENT_H
16+
#define CASYNC_HTTP_CLIENT_H
17+
18+
#include <stdbool.h>
19+
#include <time.h>
20+
21+
bool swiftahc_cshims_strptime(
22+
const char * _Nonnull input,
23+
const char * _Nonnull format,
24+
struct tm * _Nonnull result
25+
);
26+
27+
bool swiftahc_cshims_strptime_l(
28+
const char * _Nonnull input,
29+
const char * _Nonnull format,
30+
struct tm * _Nonnull result,
31+
void * _Nullable locale
32+
);
33+
34+
#endif // CASYNC_HTTP_CLIENT_H

0 commit comments

Comments
 (0)