Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef NET_COOKIES_COOKIE_UTIL_H_ |
| 6 | #define NET_COOKIES_COOKIE_UTIL_H_ |
| 7 | |
| 8 | #include <string> |
Torne (Richard Coles) | 5f1c943 | 2014-08-12 13:47:38 +0100 | [diff] [blame] | 9 | #include <utility> |
| 10 | #include <vector> |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 11 | |
Torne (Richard Coles) | 5f1c943 | 2014-08-12 13:47:38 +0100 | [diff] [blame] | 12 | #include "base/strings/string_piece.h" |
Ben Murdoch | eb525c5 | 2013-07-10 11:40:50 +0100 | [diff] [blame] | 13 | #include "base/time/time.h" |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 14 | #include "net/base/net_export.h" |
| 15 | |
| 16 | class GURL; |
| 17 | |
| 18 | namespace net { |
| 19 | namespace cookie_util { |
| 20 | |
| 21 | // Returns the effective TLD+1 for a given host. This only makes sense for http |
| 22 | // and https schemes. For other schemes, the host will be returned unchanged |
| 23 | // (minus any leading period). |
| 24 | NET_EXPORT std::string GetEffectiveDomain(const std::string& scheme, |
| 25 | const std::string& host); |
| 26 | |
| 27 | // Determine the actual cookie domain based on the domain string passed |
| 28 | // (if any) and the URL from which the cookie came. |
| 29 | // On success returns true, and sets cookie_domain to either a |
| 30 | // -host cookie domain (ex: "google.com") |
| 31 | // -domain cookie domain (ex: ".google.com") |
| 32 | NET_EXPORT bool GetCookieDomainWithString(const GURL& url, |
| 33 | const std::string& domain_string, |
| 34 | std::string* result); |
| 35 | |
| 36 | // Returns true if a domain string represents a host-only cookie, |
| 37 | // i.e. it doesn't begin with a leading '.' character. |
| 38 | NET_EXPORT bool DomainIsHostOnly(const std::string& domain_string); |
| 39 | |
| 40 | // Parses the string with the cookie time (very forgivingly). |
| 41 | NET_EXPORT base::Time ParseCookieTime(const std::string& time_string); |
| 42 | |
Torne (Richard Coles) | c2e0dbd | 2013-05-09 18:35:53 +0100 | [diff] [blame] | 43 | // Convenience for converting a cookie origin (domain and https pair) to a URL. |
| 44 | NET_EXPORT GURL CookieOriginToURL(const std::string& domain, bool is_https); |
| 45 | |
Torne (Richard Coles) | 5f1c943 | 2014-08-12 13:47:38 +0100 | [diff] [blame] | 46 | // A ParsedRequestCookie consists of the key and value of the cookie. |
| 47 | typedef std::pair<base::StringPiece, base::StringPiece> ParsedRequestCookie; |
| 48 | typedef std::vector<ParsedRequestCookie> ParsedRequestCookies; |
| 49 | |
| 50 | // Assumes that |header_value| is the cookie header value of a HTTP Request |
| 51 | // following the cookie-string schema of RFC 6265, section 4.2.1, and returns |
| 52 | // cookie name/value pairs. If cookie values are presented in double quotes, |
| 53 | // these will appear in |parsed_cookies| as well. Assumes that the cookie |
| 54 | // header is written by Chromium and therefore well-formed. |
| 55 | NET_EXPORT void ParseRequestCookieLine(const std::string& header_value, |
| 56 | ParsedRequestCookies* parsed_cookies); |
| 57 | |
| 58 | // Writes all cookies of |parsed_cookies| into a HTTP Request header value |
| 59 | // that belongs to the "Cookie" header. The entries of |parsed_cookies| must |
| 60 | // already be appropriately escaped. |
| 61 | NET_EXPORT std::string SerializeRequestCookieLine( |
| 62 | const ParsedRequestCookies& parsed_cookies); |
| 63 | |
| 64 | } // namespace cookie_util |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 65 | } // namespace net |
| 66 | |
| 67 | #endif // NET_COOKIES_COOKIE_UTIL_H_ |