Return const& from SerializedKeyProto() to improve internal usability.

This should enable secrets to be assigned to string views. PiperOrigin-RevId: 595692793 Change-Id: Ibad0cc957023e894df5e6c3df35d53f144346483
tink-crypto · Jan 4, 2024 · 6907937 · 6907937
1 parent ae4830d
commit 6907937
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/tink/internal/BUILD.bazel b/tink/internal/BUILD.bazel
@@ -572,6 +572,7 @@ cc_test(
         "//tink/util:statusor",
         "//tink/util:test_matchers",
         "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings",
         "@com_google_absl//absl/types:optional",
         "@com_google_googletest//:gtest_main",
     ],

diff --git a/tink/internal/CMakeLists.txt b/tink/internal/CMakeLists.txt
@@ -534,6 +534,7 @@ tink_cc_test(
     tink::internal::proto_key_serialization
     gmock
     absl::status
+    absl::strings
     absl::optional
     tink::core::insecure_secret_key_access
     tink::core::restricted_data

diff --git a/tink/internal/proto_key_serialization.h b/tink/internal/proto_key_serialization.h
@@ -58,7 +58,7 @@ class ProtoKeySerialization : public Serialization {
   }
 
   // Returned value is only valid for the lifetime of this object.
-  RestrictedData SerializedKeyProto() const { return serialized_key_; }
+  const RestrictedData& SerializedKeyProto() const { return serialized_key_; }
 
   google::crypto::tink::KeyData::KeyMaterialType KeyMaterialType() const {
     return key_material_type_;

diff --git a/tink/internal/proto_key_serialization_test.cc b/tink/internal/proto_key_serialization_test.cc
@@ -19,6 +19,7 @@
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
 #include "absl/status/status.h"
+#include "absl/strings/string_view.h"
 #include "absl/types/optional.h"
 #include "tink/insecure_secret_key_access.h"
 #include "tink/restricted_data.h"
@@ -208,6 +209,24 @@ TEST_F(ProtoKeySerializationTest, IdRequirementNotEqual) {
   EXPECT_THAT(Equals(*serialization, *other_serialization), IsFalse());
 }
 
+TEST_F(ProtoKeySerializationTest, AssignSecretToStringView) {
+  RestrictedData serialized_key =
+      RestrictedData("secret", InsecureSecretKeyAccess::Get());
+  util::StatusOr<ProtoKeySerialization> serialization =
+      ProtoKeySerialization::Create("type_url", serialized_key,
+                                    KeyData::SYMMETRIC, OutputPrefixType::TINK,
+                                    /*id_requirement=*/12345);
+  ASSERT_THAT(serialization.status(), IsOk());
+  ASSERT_THAT(serialization->SerializedKeyProto(), Eq(serialized_key));
+  ASSERT_THAT(serialization->SerializedKeyProto().GetSecret(
+                  InsecureSecretKeyAccess::Get()),
+              Eq("secret"));
+
+  absl::string_view secret = serialization->SerializedKeyProto().GetSecret(
+      InsecureSecretKeyAccess::Get());
+  EXPECT_THAT(secret, Eq("secret"));
+}
+
 }  // namespace internal
 }  // namespace tink
 }  // namespace crypto