Function TEST

cpp/src/arrow/util/secure_string_test.cc:105–209

#undef COMPARE

TEST(TestSecureString, AssertSecurelyCleared) {
  // This tests AssertSecurelyCleared helper methods is actually able to identify secret
  // leakage. It retrieves assertion results and asserts result type and message.
  testing::AssertionResult result = testing::AssertionSuccess();

  // check short string with all zeros
  auto short_zeros = std::string(8, '\0');
  short_zeros.resize(short_zeros.capacity(), '\0');  // for string buffers longer than 8
  short_zeros.resize(8);  // now the entire string buffer has zeros
  // checks the entire string buffer (capacity)
  ASSERT_TRUE(IsSecurelyCleared(short_zeros));
  // checks only 10 bytes (length)
  ASSERT_TRUE(IsSecurelyCleared(std::string_view(short_zeros)));

  // check long string with all zeros
  auto long_zeros = std::string(1000, '\0');
  long_zeros.resize(long_zeros.capacity(), '\0');  // for longer string buffers
  long_zeros.resize(1000);  // now the entire string buffer has zeros
  // checks the entire string buffer (capacity)
  ASSERT_TRUE(IsSecurelyCleared(long_zeros));
  // checks only 1000 bytes (length)
  ASSERT_TRUE(IsSecurelyCleared(std::string_view(long_zeros)));

  auto no_zeros = std::string("abcdefghijklmnopqrstuvwxyz");
  // string buffer in no_zeros can be larger than no_zeros.length()
  // assert only the area that we can control
  auto no_zeros_view = std::string_view(no_zeros);
  result = IsSecurelyCleared(no_zeros_view);
  ASSERT_FALSE(result);
  ASSERT_EQ(std::string(result.message()),
            "Expected equality of these values:\n"
            "  area\n"
            "    Which is: \"abcdefghijklmnopqrstuvwxyz\"\n"
            "  std::string_view(zeros)\n"
            "    Which is: "
            "\"\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\"
            "0\\0\\0\\0\\0\"");

  // check short string with zeros and non-zeros after string length
  auto stars = std::string(12, '*');
  auto short_some_zeros = stars;
  memset(short_some_zeros.data(), '\0', 8);
  short_some_zeros.resize(8);
  // string buffer in short_some_zeros can be larger than 12
  // assert only the area that we can control
  auto short_some_zeros_view = std::string_view(short_some_zeros.data(), 12);
  result = IsSecurelyCleared(short_some_zeros_view);
  ASSERT_FALSE(result);
  ASSERT_EQ(std::string(result.message()),
            "Expected equality of these values:\n"
            "  area\n"
            "    Which is: \"\\0\\0\\0\\0\\0\\0\\0\\0\\0***\"\n"
            "  std::string_view(zeros)\n"
            "    Which is: \"\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\"");

  ASSERT_TRUE(IsSecurelyCleared(short_some_zeros, stars));
#if CAN_TEST_DEALLOCATED_AREAS
  result = IsSecurelyCleared(short_some_zeros_view, stars);