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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_TOKEN_MANAGER_H_
#define COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_TOKEN_MANAGER_H_
#include <optional>
#include <string>
namespace ip_protection {
struct BlindSignedAuthToken;
// Manages the cache of blind-signed auth tokens.
//
// This class is responsible for checking, fetching, and refilling auth tokens
// for IpProtectionCore.
class IpProtectionTokenManager {
public:
virtual ~IpProtectionTokenManager() = default;
// Check whether tokens are available for the current geo id.
//
// This function is called on every URL load, so it should complete quickly.
virtual bool IsAuthTokenAvailable() = 0;
// Check whether tokens are available for a particular geo id.
//
// This function is called on every URL load, so it should complete quickly.
// If a geo_id is not provided and token caching by geo is not enabled, this
// will return false.
virtual bool IsAuthTokenAvailable(const std::string& geo_id) = 0;
// Get a token, if one is available for the current geo.
//
// Returns `nullopt` if no token is available, whether for a transient or
// permanent reason. This method may return `nullopt` even if
// `IsAuthTokenAvailable()` recently returned `true`.
virtual std::optional<BlindSignedAuthToken> GetAuthToken() = 0;
// Get a token, if one is available.
//
// Returns `nullopt` if no token is available, whether for a transient or
// permanent reason. This method may return `nullopt` even if
// `IsAuthTokenAvailable()` recently returned `true`.
virtual std::optional<BlindSignedAuthToken> GetAuthToken(
const std::string& geo_id) = 0;
// Invalidate any previous instruction that token requests should not be made
// until after a specified time.
virtual void InvalidateTryAgainAfterTime() = 0;
// Returns the current geo id. If no current geo id has been sent, an empty
// string will be returned. If token caching by geo is disabled, this will
// always return "EARTH".
virtual std::string CurrentGeo() const = 0;
// Set the "current" geo of the token cache manager. This function should only
// be called by the `IpProtectionCore` for when a geo change has been
// observed.
virtual void SetCurrentGeo(const std::string& geo_id) = 0;
// Returns a bool indicating whether the token cache was ever filled.
//
// Returns true if the token cache was filled at some point, false otherwise.
virtual bool WasTokenCacheEverFilled() = 0;
};
} // namespace ip_protection
#endif // COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_TOKEN_MANAGER_H_
|
