http_vary_data.h revision c7f5f8508d98d5952d42ed7648c2a8f30a4da156
1c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef NET_HTTP_HTTP_VARY_DATA_H__ 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define NET_HTTP_HTTP_VARY_DATA_H__ 7c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "base/md5.h" 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass Pickle; 11c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace net { 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass HttpRequestInfo; 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass HttpResponseHeaders; 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Used to implement the HTTP/1.1 Vary header. This class contains a MD5 hash 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// over the request headers indicated by a Vary header. 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// While RFC 2616 requires strict request header comparisons, it is much 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// cheaper to store a MD5 sum, which should be sufficient. Storing a hash also 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// avoids messy privacy issues as some of the request headers could hold 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// sensitive data (e.g., cookies). 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// NOTE: This class does not hold onto the contents of the Vary header. 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Instead, it relies on the consumer to store that and to supply it again to 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// the MatchesRequest function for comparing against future HTTP requests. 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass HttpVaryData { 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott public: 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott HttpVaryData(); 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool is_valid() const { return is_valid_; } 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Initialize from a request and its corresponding response headers. 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns true if a Vary header was found in the response headers and that 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Vary header was not empty and did not contain the '*' value. Upon 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // success, the object is also marked as valid such that is_valid() will 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // return true. Otherwise, false is returned to indicate that this object 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // is marked as invalid. 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool Init(const HttpRequestInfo& request_info, 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const HttpResponseHeaders& response_headers); 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Initialize from a pickle that contains data generated by a call to the 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // vary data's Persist method. 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Upon success, true is returned and the object is marked as valid such that 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // is_valid() will return true. Otherwise, false is returned to indicate 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // that this object is marked as invalid. 52c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // 53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool InitFromPickle(const Pickle& pickle, void** pickle_iter); 54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Call this method to persist the vary data. Illegal to call this on an 56c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // invalid object. 57c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void Persist(Pickle* pickle) const; 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Call this method to test if the given request matches the previous request 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // with which this vary data corresponds. The |cached_response_headers| must 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // be the same response headers used to generate this vary data. 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool MatchesRequest(const HttpRequestInfo& request_info, 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const HttpResponseHeaders& cached_response_headers) const; 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott private: 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Returns the corresponding request header value. 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott static std::string GetRequestValue(const HttpRequestInfo& request_info, 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const std::string& request_header); 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Append to the MD5 context for the given request header. 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott static void AddField(const HttpRequestInfo& request_info, 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const std::string& request_header, 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott MD5Context* context); 74c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 75c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // A digested version of the request headers corresponding to the Vary header. 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott MD5Digest request_digest_; 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 78c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // True when request_digest_ contains meaningful data. 79c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool is_valid_; 80c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}; 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 82c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace net 83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // NET_HTTP_HTTP_VARY_DATA_H__ 85