File: ad_auction_page_data.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (167 lines) | stat: -rw-r--r-- 6,348 bytes parent folder | download | duplicates (6)
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
// 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 CONTENT_BROWSER_INTEREST_GROUP_AD_AUCTION_PAGE_DATA_H_
#define CONTENT_BROWSER_INTEREST_GROUP_AD_AUCTION_PAGE_DATA_H_

#include <map>
#include <optional>
#include <ostream>
#include <set>
#include <string>
#include <string_view>
#include <vector>

#include "base/containers/flat_map.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "content/browser/interest_group/header_direct_from_seller_signals.h"
#include "content/public/browser/page_user_data.h"
#include "net/third_party/quiche/src/quiche/oblivious_http/oblivious_http_client.h"
#include "third_party/blink/public/common/interest_group/interest_group.h"
#include "url/origin.h"

namespace data_decoder {
class DataDecoder;
}  // namespace data_decoder

namespace content {

struct ContextMapKey {
  bool operator<(const ContextMapKey& other) const {
    return std::tie(request_id, seller) <
           std::tie(other.request_id, other.seller);
  }

  base::Uuid request_id;
  url::Origin seller;
};

struct CONTENT_EXPORT AdAuctionRequestContext {
  AdAuctionRequestContext(
      url::Origin seller,
      base::flat_map<url::Origin, std::vector<std::string>> group_names,
      quiche::ObliviousHttpRequest::Context context,
      base::TimeTicks start_time,
      base::flat_map<blink::InterestGroupKey, url::Origin>
          group_pagg_coordinators);
  AdAuctionRequestContext(AdAuctionRequestContext&& other);
  ~AdAuctionRequestContext();

  url::Origin seller;
  base::flat_map<url::Origin, std::vector<std::string>> group_names;
  quiche::ObliviousHttpRequest::Context context;
  base::TimeTicks start_time;
  base::flat_map<blink::InterestGroupKey, url::Origin> group_pagg_coordinators;
};

struct CONTENT_EXPORT SignedAdditionalBidWithMetadata {
  SignedAdditionalBidWithMetadata(std::string_view signed_additional_bid,
                                  std::optional<std::string_view> seller_nonce);
  ~SignedAdditionalBidWithMetadata();

  SignedAdditionalBidWithMetadata(SignedAdditionalBidWithMetadata&&);
  SignedAdditionalBidWithMetadata& operator=(SignedAdditionalBidWithMetadata&&);

  // JSON object with "bid" (containing more JSON encoded as a string) and
  // "signatures" fields.
  std::string signed_additional_bid;

  // The seller nonce for `signed_additional_bid`, if present.
  std::optional<std::string> seller_nonce;

  // ***** Please add new fields to the formatter below. *****
};

// Formatter for Google Test.
CONTENT_EXPORT std::ostream& operator<<(
    std::ostream& out,
    const SignedAdditionalBidWithMetadata& in);

// Contains auction header responses within a page. This will only be created
// for the outermost page (i.e. not within a fenced frame).
class CONTENT_EXPORT AdAuctionPageData
    : public PageUserData<AdAuctionPageData> {
 public:
  ~AdAuctionPageData() override;

  void AddAuctionResultWitnessForOrigin(const url::Origin& origin,
                                        const std::string& response);

  bool WitnessedAuctionResultForOrigin(const url::Origin& origin,
                                       const std::string& response) const;

  void AddAuctionResultNonceWitnessForOrigin(const url::Origin& origin,
                                             const std::string& nonce);

  bool WitnessedAuctionResultNonceForOrigin(const url::Origin& origin,
                                            const std::string& nonce) const;

  void AddAuctionSignalsWitnessForOrigin(const url::Origin& origin,
                                         const std::string& response);

  void ParseAndFindAdAuctionSignals(
      const url::Origin& origin,
      const std::string& ad_slot,
      HeaderDirectFromSellerSignals::ParseAndFindCompletedCallback callback);

  void AddAuctionAdditionalBidsWitnessForOrigin(
      const url::Origin& origin,
      std::map<std::string, std::vector<SignedAdditionalBidWithMetadata>>
          nonce_additional_bids_map);

  std::vector<SignedAdditionalBidWithMetadata>
  TakeAuctionAdditionalBidsForOriginAndNonce(const url::Origin& origin,
                                             const std::string& nonce);

  void RegisterAdAuctionRequestContext(const base::Uuid& id,
                                       AdAuctionRequestContext context);
  AdAuctionRequestContext* GetContextForAdAuctionRequest(
      const ContextMapKey& key);

  // Returns a pointer to a DataDecoder owned by this AdAuctionPageData instance
  // The DataDecoder is only valid for the life of the page.
  data_decoder::DataDecoder* GetDecoderFor(const url::Origin& origin);

  // Returns real time reporting quota left for `origin`.
  std::optional<std::pair<base::TimeTicks, double>> GetRealTimeReportingQuota(
      const url::Origin& origin);

  // Update real time reporting quota for `origin`.
  void UpdateRealTimeReportingQuota(const url::Origin& origin,
                                    std::pair<base::TimeTicks, double> quota);

 private:
  explicit AdAuctionPageData(Page& page);

  friend class PageUserData<AdAuctionPageData>;
  PAGE_USER_DATA_KEY_DECL();

  void OnAddAuctionSignalsWitnessForOriginCompleted(
      std::vector<std::string> errors);

  std::map<url::Origin, std::set<std::string>> origin_auction_result_map_;
  std::map<url::Origin, std::set<std::string>> origin_auction_result_nonce_map_;
  HeaderDirectFromSellerSignals header_direct_from_seller_signals_;
  std::map<url::Origin,
           std::map<std::string, std::vector<SignedAdditionalBidWithMetadata>>>
      origin_nonce_additional_bids_map_;
  std::map<ContextMapKey, AdAuctionRequestContext> context_map_;

  // The real time reporting quota left for origin at a certain timestamp. Used
  // to do per page per reporting origin rate limiting on real time reporting.
  // TODO(crbug.com/337132755): Clean this up after long enough time, in case
  // some pages live for a while.
  std::map<url::Origin, std::pair<base::TimeTicks, double>>
      real_time_reporting_quota_;

  // Must be declared last -- DataDecoder destruction cancels decoding
  // completion callbacks.
  std::map<url::Origin, std::unique_ptr<data_decoder::DataDecoder>>
      decoder_map_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_INTEREST_GROUP_AD_AUCTION_PAGE_DATA_H_