Add tracing hooks to BlindSignAuth. See go/ipp-measuring-bsa-perf for details. #ai-assisted PiperOrigin-RevId: 795156558
diff --git a/build/source_list.bzl b/build/source_list.bzl index 400bbfa..4836be9 100644 --- a/build/source_list.bzl +++ b/build/source_list.bzl
@@ -1722,6 +1722,7 @@ "blind_sign_auth/blind_sign_auth_test_data.h", "blind_sign_auth/blind_sign_message_interface.h", "blind_sign_auth/blind_sign_message_response.h", + "blind_sign_auth/blind_sign_tracing_hooks.h", "blind_sign_auth/cached_blind_sign_auth.h", "blind_sign_auth/test_tools/mock_blind_sign_auth_interface.h", "blind_sign_auth/test_tools/mock_blind_sign_message_interface.h",
diff --git a/build/source_list.gni b/build/source_list.gni index 010e827..cea3274 100644 --- a/build/source_list.gni +++ b/build/source_list.gni
@@ -1726,6 +1726,7 @@ "src/quiche/blind_sign_auth/blind_sign_auth_test_data.h", "src/quiche/blind_sign_auth/blind_sign_message_interface.h", "src/quiche/blind_sign_auth/blind_sign_message_response.h", + "src/quiche/blind_sign_auth/blind_sign_tracing_hooks.h", "src/quiche/blind_sign_auth/cached_blind_sign_auth.h", "src/quiche/blind_sign_auth/test_tools/mock_blind_sign_auth_interface.h", "src/quiche/blind_sign_auth/test_tools/mock_blind_sign_message_interface.h",
diff --git a/build/source_list.json b/build/source_list.json index 50a3965..d36463d 100644 --- a/build/source_list.json +++ b/build/source_list.json
@@ -1725,6 +1725,7 @@ "quiche/blind_sign_auth/blind_sign_auth_test_data.h", "quiche/blind_sign_auth/blind_sign_message_interface.h", "quiche/blind_sign_auth/blind_sign_message_response.h", + "quiche/blind_sign_auth/blind_sign_tracing_hooks.h", "quiche/blind_sign_auth/cached_blind_sign_auth.h", "quiche/blind_sign_auth/test_tools/mock_blind_sign_auth_interface.h", "quiche/blind_sign_auth/test_tools/mock_blind_sign_message_interface.h"
diff --git a/quiche/blind_sign_auth/blind_sign_auth.cc b/quiche/blind_sign_auth/blind_sign_auth.cc index 72e4d7a..ffb833d 100644 --- a/quiche/blind_sign_auth/blind_sign_auth.cc +++ b/quiche/blind_sign_auth/blind_sign_auth.cc
@@ -4,6 +4,7 @@ #include "quiche/blind_sign_auth/blind_sign_auth.h" +#include <array> #include <cstddef> #include <cstdint> #include <cstring> @@ -14,6 +15,7 @@ #include <vector> #include "absl/algorithm/container.h" +#include "absl/cleanup/cleanup.h" #include "absl/functional/bind_front.h" #include "absl/status/status.h" #include "absl/status/statusor.h" @@ -82,6 +84,9 @@ int num_tokens, ProxyLayer proxy_layer, BlindSignAuthServiceType service_type, SignedTokenCallback callback) { + if (hooks_ != nullptr) { + hooks_->OnGetInitialDataStart(); + } // Create GetInitialData RPC. GetInitialDataRequest request; request.set_use_attestation(false); @@ -106,6 +111,9 @@ ProxyLayer proxy_layer, BlindSignAuthServiceType service_type, SignedTokenCallback callback, absl::StatusOr<BlindSignMessageResponse> response) { + if (hooks_ != nullptr) { + hooks_->OnGetInitialDataEnd(); + } absl::StatusOr<GetInitialDataResponse> initial_data_response = ParseGetInitialDataResponseMessage(response); if (!initial_data_response.ok()) { @@ -156,10 +164,16 @@ return; } + if (hooks_ != nullptr) { + hooks_->OnGenerateBlindedTokenRequestsStart(); + } absl::StatusOr<GeneratedTokenRequests> token_requests_data = GenerateBlindedTokenRequests(num_tokens, *pp_context->rsa_public_key, *token_challenge, pp_context->token_key_id, pp_context->extensions); + if (hooks_ != nullptr) { + hooks_->OnGenerateBlindedTokenRequestsEnd(); + } if (!token_requests_data.ok()) { std::move(callback)(token_requests_data.status()); return; @@ -179,6 +193,9 @@ sign_request.set_do_not_use_rsa_public_exponent(true); sign_request.set_proxy_layer(QuicheProxyLayerToPpnProxyLayer(proxy_layer)); + if (hooks_ != nullptr) { + hooks_->OnAuthAndSignStart(); + } BlindSignMessageCallback auth_and_sign_callback = absl::bind_front(&BlindSignAuth::PrivacyPassAuthAndSignCallback, this, *std::move(pp_context), @@ -197,6 +214,9 @@ privacy_pass_clients, SignedTokenCallback callback, absl::StatusOr<BlindSignMessageResponse> response) { + if (hooks_ != nullptr) { + hooks_->OnAuthAndSignEnd(); + } // Validate response. if (!response.ok()) { QUICHE_LOG(WARNING) << "AuthAndSign failed: " << response.status(); @@ -229,6 +249,15 @@ return; } + if (hooks_ != nullptr) { + hooks_->OnUnblindTokensStart(); + } + absl::Cleanup unblind_tokens_end = [&]() { + if (hooks_ != nullptr) { + hooks_->OnUnblindTokensEnd(); + } + }; + // Create tokens using blinded signatures. std::vector<BlindSignToken> tokens_vec; for (int i = 0; i < sign_response.blinded_token_signature_size(); i++) {
diff --git a/quiche/blind_sign_auth/blind_sign_auth.h b/quiche/blind_sign_auth/blind_sign_auth.h index 93f711a..0ae049a 100644 --- a/quiche/blind_sign_auth/blind_sign_auth.h +++ b/quiche/blind_sign_auth/blind_sign_auth.h
@@ -5,18 +5,24 @@ #ifndef QUICHE_BLIND_SIGN_AUTH_BLIND_SIGN_AUTH_H_ #define QUICHE_BLIND_SIGN_AUTH_BLIND_SIGN_AUTH_H_ +#include <cstdint> #include <memory> #include <optional> #include <string> +#include <utility> +#include <vector> #include "absl/status/statusor.h" +#include "absl/strings/string_view.h" #include "absl/time/time.h" +#include "absl/types/span.h" #include "anonymous_tokens/cpp/privacy_pass/rsa_bssa_public_metadata_client.h" #include "anonymous_tokens/cpp/privacy_pass/token_encodings.h" #include "quiche/blind_sign_auth/blind_sign_auth_interface.h" #include "quiche/blind_sign_auth/blind_sign_auth_protos.h" #include "quiche/blind_sign_auth/blind_sign_message_interface.h" #include "quiche/blind_sign_auth/blind_sign_message_response.h" +#include "quiche/blind_sign_auth/blind_sign_tracing_hooks.h" #include "quiche/common/platform/api/quiche_export.h" namespace quiche { @@ -25,8 +31,11 @@ class QUICHE_EXPORT BlindSignAuth : public BlindSignAuthInterface { public: explicit BlindSignAuth(BlindSignMessageInterface* fetcher, - privacy::ppn::BlindSignAuthOptions auth_options) - : fetcher_(fetcher), auth_options_(std::move(auth_options)) {} + privacy::ppn::BlindSignAuthOptions auth_options, + BlindSignTracingHooks* hooks = nullptr) + : fetcher_(fetcher), + auth_options_(std::move(auth_options)), + hooks_(hooks) {} // Returns signed unblinded tokens, their expiration time, and their geo in a // callback. @@ -132,6 +141,7 @@ BlindSignMessageInterface* fetcher_ = nullptr; privacy::ppn::BlindSignAuthOptions auth_options_; + BlindSignTracingHooks* hooks_ = nullptr; }; std::string BlindSignAuthServiceTypeToString(
diff --git a/quiche/blind_sign_auth/blind_sign_auth_test.cc b/quiche/blind_sign_auth/blind_sign_auth_test.cc index 5c84808..a910e92 100644 --- a/quiche/blind_sign_auth/blind_sign_auth_test.cc +++ b/quiche/blind_sign_auth/blind_sign_auth_test.cc
@@ -6,8 +6,10 @@ #include <cstdint> #include <memory> +#include <optional> #include <string> #include <utility> +#include <vector> #include "absl/status/status.h" #include "absl/status/statusor.h" @@ -26,6 +28,7 @@ #include "quiche/blind_sign_auth/blind_sign_auth_protos.h" #include "quiche/blind_sign_auth/blind_sign_message_interface.h" #include "quiche/blind_sign_auth/blind_sign_message_response.h" +#include "quiche/blind_sign_auth/blind_sign_tracing_hooks.h" #include "quiche/blind_sign_auth/test_tools/mock_blind_sign_message_interface.h" #include "quiche/common/platform/api/quiche_test.h" #include "quiche/common/test_tools/quiche_test_utils.h" @@ -40,6 +43,18 @@ using ::testing::Invoke; using ::testing::Unused; +class MockBlindSignTracingHooks : public BlindSignTracingHooks { + public: + MOCK_METHOD(void, OnGetInitialDataStart, (), (override)); + MOCK_METHOD(void, OnGetInitialDataEnd, (), (override)); + MOCK_METHOD(void, OnGenerateBlindedTokenRequestsStart, (), (override)); + MOCK_METHOD(void, OnGenerateBlindedTokenRequestsEnd, (), (override)); + MOCK_METHOD(void, OnAuthAndSignStart, (), (override)); + MOCK_METHOD(void, OnAuthAndSignEnd, (), (override)); + MOCK_METHOD(void, OnUnblindTokensStart, (), (override)); + MOCK_METHOD(void, OnUnblindTokensEnd, (), (override)); +}; + class BlindSignAuthTest : public QuicheTest { protected: void SetUp() override { @@ -173,8 +188,8 @@ privacy::ppn::BlindSignAuthOptions options; options.set_enable_privacy_pass(true); - blind_sign_auth_ = - std::make_unique<BlindSignAuth>(&mock_message_interface_, options); + blind_sign_auth_ = std::make_unique<BlindSignAuth>( + &mock_message_interface_, options, &mock_tracing_hooks_); } void TearDown() override { blind_sign_auth_.reset(nullptr); } @@ -288,6 +303,7 @@ } MockBlindSignMessageInterface mock_message_interface_; + MockBlindSignTracingHooks mock_tracing_hooks_; std::unique_ptr<BlindSignAuth> blind_sign_auth_; anonymous_tokens::RSABlindSignaturePublicKey public_key_proto_; @@ -422,7 +438,7 @@ fake_get_initial_data_response_.SerializeAsString()); { InSequence seq; - + EXPECT_CALL(mock_tracing_hooks_, OnGetInitialDataStart); EXPECT_CALL( mock_message_interface_, DoRequest( @@ -432,7 +448,10 @@ .WillOnce([=](auto&&, auto&&, auto&&, auto get_initial_data_cb) { std::move(get_initial_data_cb)(fake_public_key_response); }); - + EXPECT_CALL(mock_tracing_hooks_, OnGetInitialDataEnd); + EXPECT_CALL(mock_tracing_hooks_, OnGenerateBlindedTokenRequestsStart); + EXPECT_CALL(mock_tracing_hooks_, OnGenerateBlindedTokenRequestsEnd); + EXPECT_CALL(mock_tracing_hooks_, OnAuthAndSignStart); EXPECT_CALL(mock_message_interface_, DoRequest(Eq(BlindSignMessageRequestType::kAuthAndSign), Eq(oauth_token_), _, _)) @@ -444,6 +463,9 @@ sign_response_.SerializeAsString()); std::move(callback)(response); })); + EXPECT_CALL(mock_tracing_hooks_, OnAuthAndSignEnd); + EXPECT_CALL(mock_tracing_hooks_, OnUnblindTokensStart); + EXPECT_CALL(mock_tracing_hooks_, OnUnblindTokensEnd); } int num_tokens = 1;
diff --git a/quiche/blind_sign_auth/blind_sign_tracing_hooks.h b/quiche/blind_sign_auth/blind_sign_tracing_hooks.h new file mode 100644 index 0000000..de0a481 --- /dev/null +++ b/quiche/blind_sign_auth/blind_sign_tracing_hooks.h
@@ -0,0 +1,33 @@ +#ifndef QUICHE_BLIND_SIGN_AUTH_BLIND_SIGN_TRACING_HOOKS_H_ +#define QUICHE_BLIND_SIGN_AUTH_BLIND_SIGN_TRACING_HOOKS_H_ + +#include "quiche/common/platform/api/quiche_export.h" + +namespace quiche { + +// Interface for performance tracing hooks. +class QUICHE_EXPORT BlindSignTracingHooks { + public: + virtual ~BlindSignTracingHooks() = default; + + // Called before (resp. after) the GetInitialData RPC. + virtual void OnGetInitialDataStart() = 0; + virtual void OnGetInitialDataEnd() = 0; + + // Called before (resp. after) initializing a batch of Privacy Pass clients + // and generating blinded token requests. + virtual void OnGenerateBlindedTokenRequestsStart() = 0; + virtual void OnGenerateBlindedTokenRequestsEnd() = 0; + + // Called before (resp. after) the AuthAndSign RPC. + virtual void OnAuthAndSignStart() = 0; + virtual void OnAuthAndSignEnd() = 0; + + // Called before (resp. after) finalizing a batch of tokens. + virtual void OnUnblindTokensStart() = 0; + virtual void OnUnblindTokensEnd() = 0; +}; + +} // namespace quiche + +#endif // QUICHE_BLIND_SIGN_AUTH_BLIND_SIGN_TRACING_HOOKS_H_