1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_HTTP_HTTP_AUTH_CACHE_H_
#define NET_HTTP_HTTP_AUTH_CACHE_H_
#include <stddef.h>
#include <list>
#include <map>
#include <string>
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/time/default_clock.h"
#include "base/time/default_tick_clock.h"
#include "base/time/time.h"
#include "net/base/net_export.h"
#include "net/base/network_anonymization_key.h"
#include "net/http/http_auth.h"
#include "url/scheme_host_port.h"
namespace net {
// HttpAuthCache stores HTTP authentication identities and challenge info.
// For each (scheme_host_port, realm, scheme) triple the cache stores a
// HttpAuthCache::Entry, which holds:
// - the origin server {protocol scheme, host, port}
// - the last identity used (username/password)
// - the last auth handler used (contains realm and authentication scheme)
// - the list of paths which used this realm
// Entries can be looked up by either (origin, realm, scheme) or (origin, path).
class NET_EXPORT HttpAuthCache {
public:
class NET_EXPORT Entry {
public:
Entry(const Entry& other);
~Entry();
const url::SchemeHostPort& scheme_host_port() const {
return scheme_host_port_;
}
// The case-sensitive realm string of the challenge.
const std::string& realm() const { return realm_; }
// The authentication scheme of the challenge.
HttpAuth::Scheme scheme() const {
return scheme_;
}
// The authentication challenge.
const std::string& auth_challenge() const { return auth_challenge_; }
// The login credentials.
const AuthCredentials& credentials() const {
return credentials_;
}
int IncrementNonceCount() {
return ++nonce_count_;
}
void UpdateStaleChallenge(const std::string& auth_challenge);
bool IsEqualForTesting(const Entry& other) const;
bool operator==(const Entry& other) const = delete;
private:
friend class HttpAuthCache;
FRIEND_TEST_ALL_PREFIXES(HttpAuthCacheTest, AddPath);
FRIEND_TEST_ALL_PREFIXES(HttpAuthCacheTest, AddToExistingEntry);
typedef std::list<std::string> PathList;
Entry();
// Adds a path defining the realm's protection space. If the path is
// already contained in the protection space, is a no-op.
void AddPath(const std::string& path);
// Returns true if |dir| is contained within the realm's protection
// space. |*path_len| is set to the length of the enclosing path if
// such a path exists and |path_len| is non-nullptr. If no enclosing
// path is found, |*path_len| is left unmodified.
//
// If an enclosing path is found, moves it up by one place in the paths list
// so that more frequently used paths migrate to the front of the list.
//
// Note that proxy auth cache entries are associated with empty
// paths. Therefore it is possible for HasEnclosingPath() to return
// true and set |*path_len| to 0.
bool HasEnclosingPath(const std::string& dir, size_t* path_len);
// SchemeHostPort of the server.
url::SchemeHostPort scheme_host_port_;
std::string realm_;
HttpAuth::Scheme scheme_ = HttpAuth::AUTH_SCHEME_MAX;
// Identity.
std::string auth_challenge_;
AuthCredentials credentials_;
int nonce_count_ = 0;
// List of paths that define the realm's protection space.
PathList paths_;
// Times the entry was created and last used (by looking up, adding a path,
// or updating the challenge.)
base::TimeTicks creation_time_ticks_;
base::TimeTicks last_use_time_ticks_;
base::Time creation_time_;
};
// Prevent unbounded memory growth. These are safeguards for abuse; it is
// not expected that the limits will be reached in ordinary usage.
// This also defines the worst-case lookup times (which grow linearly
// with number of elements in the cache).
enum { kMaxNumPathsPerRealmEntry = 10 };
enum { kMaxNumRealmEntries = 20 };
// If |key_server_entries_by_network_anonymization_key| is true, all
// HttpAuth::AUTH_SERVER operations are keyed by NetworkAnonymizationKey.
// Otherwise, NetworkAnonymizationKey arguments are ignored.
explicit HttpAuthCache(bool key_server_entries_by_network_anonymization_key);
HttpAuthCache(const HttpAuthCache&) = delete;
HttpAuthCache& operator=(const HttpAuthCache&) = delete;
~HttpAuthCache();
// Sets whether server entries are keyed by NetworkAnonymizationKey.
// If this results in changing the value of the setting, all current server
// entries are deleted.
void SetKeyServerEntriesByNetworkAnonymizationKey(
bool key_server_entries_by_network_anonymization_key);
// Find the realm entry on server |origin| for realm |realm| and
// scheme |scheme|. If a matching entry is found, move it up by one place
// in the entries list, so that more frequently used entries migrate to the
// front of the list.
// |scheme_host_port| - the {scheme, host, port} of the server.
// |target| - whether this is for server or proxy auth.
// |realm| - case sensitive realm string.
// |scheme| - the authentication scheme (i.e. basic, negotiate).
// returns - the matched entry or nullptr.
Entry* Lookup(const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const std::string& realm,
HttpAuth::Scheme scheme,
const NetworkAnonymizationKey& network_anonymization_key);
// Find the entry on server |origin| whose protection space includes
// |path|. This uses the assumption in RFC 2617 section 2 that deeper
// paths lie in the same protection space. If a matching entry is found, move
// it up by one place in the entries list, so that more frequently used
// entries migrate to the front of the list.
// |scheme_host_port| - the {scheme, host, port} of the server.
// |path| - absolute path of the resource, or empty string in case of
// proxy auth (which does not use the concept of paths).
// returns - the matched entry or nullptr.
Entry* LookupByPath(const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const NetworkAnonymizationKey& network_anonymization_key,
const std::string& path);
// Add an entry on server |scheme_host_port| for realm |handler->realm()| and
// scheme |handler->scheme()|. If an entry for this (realm,scheme)
// already exists, update it rather than replace it -- this preserves the
// paths list.
// |scheme_host_port| - the {scheme, host, port} of the server.
// |realm| - the auth realm for the challenge.
// |scheme| - the authentication scheme (i.e. basic, negotiate).
// |credentials| - login information for the realm.
// |path| - absolute path for a resource contained in the protection
// space; this will be added to the list of known paths.
// returns - the entry that was just added/updated.
Entry* Add(const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const std::string& realm,
HttpAuth::Scheme scheme,
const NetworkAnonymizationKey& network_anonymization_key,
const std::string& auth_challenge,
const AuthCredentials& credentials,
const std::string& path);
// Remove entry on server |origin| for realm |realm| and scheme |scheme|
// if one exists AND if the cached credentials matches |credentials|.
// |scheme_host_port| - the {scheme, host, port} of the server.
// |realm| - case sensitive realm string.
// |scheme| - the authentication scheme (i.e. basic, negotiate).
// |credentials| - the credentials to match.
// returns - true if an entry was removed.
bool Remove(const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const std::string& realm,
HttpAuth::Scheme scheme,
const NetworkAnonymizationKey& network_anonymization_key,
const AuthCredentials& credentials);
// Clears cache entries added between |begin_time| inclusively and |end_time|
// exclusively. Clears all entries if |begin_time| and |end_time| are equal to
// base::Time::Min() and base::Time::Max() respectively.
// Returns true if any entries were cleared.
bool ClearEntriesAddedBetween(
base::Time begin_time,
base::Time end_time,
base::RepeatingCallback<bool(const GURL&)> url_matcher);
// Clears all added entries. Returns true if any entries were cleared.
bool ClearAllEntries();
// Updates a stale digest entry on server |scheme_host_port| for realm |realm|
// and scheme |scheme|. The cached auth challenge is replaced with
// |auth_challenge| and the nonce count is reset.
// |UpdateStaleChallenge()| returns true if a matching entry exists in the
// cache, false otherwise.
bool UpdateStaleChallenge(
const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const std::string& realm,
HttpAuth::Scheme scheme,
const NetworkAnonymizationKey& network_anonymization_key,
const std::string& auth_challenge);
// Copies all entries from |other| cache with a target of
// HttpAuth::AUTH_PROXY. |this| and |other| need not have the same
// |key_server_entries_by_network_anonymization_key_| value, since proxy
// credentials are not keyed on NetworkAnonymizationKey.
void CopyProxyEntriesFrom(const HttpAuthCache& other);
size_t GetEntriesSizeForTesting();
void set_tick_clock_for_testing(const base::TickClock* tick_clock) {
tick_clock_ = tick_clock;
}
void set_clock_for_testing(const base::Clock* clock) { clock_ = clock; }
bool key_server_entries_by_network_anonymization_key() const {
return key_server_entries_by_network_anonymization_key_;
}
private:
struct EntryMapKey {
EntryMapKey(const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const NetworkAnonymizationKey& network_anonymization_key,
bool key_server_entries_by_network_anonymization_key);
~EntryMapKey();
bool operator<(const EntryMapKey& other) const;
url::SchemeHostPort scheme_host_port;
HttpAuth::Target target;
// Empty if |key_server_entries_by_network_anonymization_key| is false,
// |target| is HttpAuth::AUTH_PROXY, or an empty NetworkAnonymizationKey is
// passed in to the EntryMap constructor.
NetworkAnonymizationKey network_anonymization_key;
};
using EntryMap = std::multimap<EntryMapKey, Entry>;
raw_ptr<const base::TickClock> tick_clock_ =
base::DefaultTickClock::GetInstance();
raw_ptr<const base::Clock> clock_ = base::DefaultClock::GetInstance();
EntryMap::iterator LookupEntryIt(
const url::SchemeHostPort& scheme_host_port,
HttpAuth::Target target,
const std::string& realm,
HttpAuth::Scheme scheme,
const NetworkAnonymizationKey& network_anonymization_key);
void EvictLeastRecentlyUsedEntry();
bool key_server_entries_by_network_anonymization_key_;
EntryMap entries_;
};
// An authentication realm entry.
} // namespace net
#endif // NET_HTTP_HTTP_AUTH_CACHE_H_
|