SecureDebugString() helper (#4492)

Author: CyberROFL

ydb/core/persqueue/partition_monitoring.cpp

@@ -23,14 +23,6 @@
 
 namespace NKikimr::NPQ {
 
-TString PrintConfig(const NKikimrPQ::TPQTabletConfig& cfg) {
-    TSecurityTextFormatPrinter<NKikimrPQ::TPQTabletConfig> printer;
-    printer.SetSingleLineMode(true);
-    TString string;
-    printer.PrintToString(cfg, &string);
-    return string;
-}
-
 void HtmlOutput(IOutputStream& out, const TString& line, const std::deque<std::pair<TKey, ui32>>& keys) {
     HTML(out) {
         TABLE() {
@@ -116,7 +108,7 @@ void TPartition::HandleMonitoring(TEvPQ::TEvMonRequest::TPtr& ev, const TActorCo
         out << "AvgWriteSize per " << avg.GetDuration().ToString() << " is " << avg.GetValue() << " bytes";
         res.push_back(out.Str()); out.Clear();
     }
-    out << PrintConfig(Config); res.push_back(out.Str()); out.Clear();
+    out << SecureDebugString(Config); res.push_back(out.Str()); out.Clear();
     HTML(out) {
         DIV_CLASS_ID("tab-pane fade", Sprintf("partition_%u", Partition.InternalPartitionId)) {
             TABLE_SORTABLE_CLASS("table") {

ydb/core/tx/replication/common/sensitive_event_pb.h

@@ -10,11 +10,7 @@ namespace NKikimr::NReplication {
 template <typename TEv, typename TRecord, ui32 EventType>
 struct TSensitiveEventPB: public NActors::TEventPB<TEv, TRecord, EventType> {
     TString ToString() const override {
-        TSecurityTextFormatPrinter<TRecord> printer;
-        printer.SetSingleLineMode(true);
-        TString string;
-        printer.PrintToString(this->Record, &string);
-        return TStringBuilder() << this->ToStringHeader() << " " << string;
+        return TStringBuilder() << this->ToStringHeader() << " " << SecureDebugString<TRecord>(this->Record);
     }
 };
 

ydb/core/tx/schemeshard/schemeshard__operation.cpp

@@ -87,14 +87,6 @@ NKikimrScheme::TEvModifySchemeTransaction GetRecordForPrint(const NKikimrScheme:
     return recordForPrint;
 }
 
-TString PrintSecurely(const NKikimrScheme::TEvModifySchemeTransaction& record) {
-    TSecurityTextFormatPrinter<NKikimrScheme::TEvModifySchemeTransaction> printer;
-    printer.SetSingleLineMode(true);
-    TString string;
-    printer.PrintToString(record, &string);
-    return string;
-}
-
 THolder<TProposeResponse> TSchemeShard::IgniteOperation(TProposeRequest& request, TOperationContext& context) {
     THolder<TProposeResponse> response = nullptr;
 
@@ -193,7 +185,7 @@ THolder<TProposeResponse> TSchemeShard::IgniteOperation(TProposeRequest& request
                                     << ", already accepted parts: " << operation->Parts.size()
                                     << ", propose result status: " << NKikimrScheme::EStatus_Name(response->Record.GetStatus())
                                     << ", with reason: " << response->Record.GetReason()
-                                    << ", tx message: " << PrintSecurely(record));
+                                    << ", tx message: " << SecureDebugString(record));
                 }
 
                 Y_VERIFY_S(context.IsUndoChangesSafe(),
@@ -204,7 +196,7 @@ THolder<TProposeResponse> TSchemeShard::IgniteOperation(TProposeRequest& request
                                << ", already accepted parts: " << operation->Parts.size()
                                << ", propose result status: " << NKikimrScheme::EStatus_Name(response->Record.GetStatus())
                                << ", with reason: " << response->Record.GetReason()
-                               << ", tx message: " << PrintSecurely(record));
+                               << ", tx message: " << SecureDebugString(record));
 
                 context.OnComplete = {}; // recreate
                 context.DbChanges = {};
@@ -247,7 +239,7 @@ struct TSchemeShard::TTxOperationPropose: public NTabletFlatExecutor::TTransacti
 
         LOG_DEBUG_S(ctx, NKikimrServices::FLAT_TX_SCHEMESHARD,
                     "TTxOperationPropose Execute"
-                        << ", message: " << PrintSecurely(Request->Get()->Record)
+                        << ", message: " << SecureDebugString(Request->Get()->Record)
                         << ", at schemeshard: " << selfId);
 
         txc.DB.NoMoreReadsForTx();

ydb/core/tx/tx_proxy/schemereq.cpp

@@ -1,18 +1,18 @@
 #include "proxy.h"
 
-#include <ydb/core/docapi/traits.h>
-#include <ydb/core/tx/schemeshard/schemeshard.h>
-#include <ydb/core/protos/flat_scheme_op.pb.h>
-#include <ydb/public/api/protos/ydb_issue_message.pb.h>
-#include <ydb/core/base/tablet_pipe.h>
 #include <ydb/core/base/appdata.h>
-#include <ydb/core/base/tx_processing.h>
-#include <ydb/library/ydb_issue/issue_helpers.h>
 #include <ydb/core/base/path.h>
-
+#include <ydb/core/base/tablet_pipe.h>
+#include <ydb/core/base/tx_processing.h>
+#include <ydb/core/docapi/traits.h>
+#include <ydb/core/protos/flat_scheme_op.pb.h>
+#include <ydb/core/tx/schemeshard/schemeshard.h>
 #include <ydb/library/aclib/aclib.h>
-
 #include <ydb/library/actors/core/hfunc.h>
+#include <ydb/library/protobuf_printer/security_printer.h>
+#include <ydb/library/ydb_issue/issue_helpers.h>
+#include <ydb/public/api/protos/ydb_issue_message.pb.h>
+
 #include <util/string/cast.h>
 
 namespace NKikimr {
@@ -1168,7 +1168,7 @@ void TFlatSchemeReq::Bootstrap(const TActorContext &ctx) {
                 "Actor# " << ctx.SelfID.ToString()
                           << " txid# " << TxId
                           << " Bootstrap EvSchemeRequest"
-                          << " record: " << GetRequestProto().DebugString());
+                          << " record: " << SecureDebugString(GetRequestProto()));
     Y_ABORT_UNLESS(GetRequestEv().HasModifyScheme());
     Y_ABORT_UNLESS(!GetRequestEv().HasTransactionalModification());
 
@@ -1303,7 +1303,7 @@ void TSchemeTransactionalReq::Bootstrap(const TActorContext &ctx) {
                 "Actor# " << ctx.SelfID.ToString()
                           << " txid# " << TxId
                           << " Bootstrap EvSchemeRequest"
-                          << " record: " << GetRequestProto().DebugString());
+                          << " record: " << SecureDebugString(GetRequestProto()));
     Y_ABORT_UNLESS(!GetRequestEv().HasModifyScheme());
     Y_ABORT_UNLESS(GetRequestEv().HasTransactionalModification());
 

ydb/library/grpc/server/logger.h

@@ -50,11 +50,7 @@ template <typename TMsg>
 inline TString FormatMessage(const TMsg& message, bool ok = true) {
     if (ok) {
         if (LogBodyEnabled) {
-            TString text;
-            NKikimr::TSecurityTextFormatPrinter<TMsg> printer;
-            printer.SetSingleLineMode(true);
-            printer.PrintToString(message, &text);
-            return text;
+            return NKikimr::SecureDebugString<TMsg>(message);
         } else {
             return "<hidden>";
         }

ydb/library/protobuf_printer/security_printer.h

@@ -34,4 +34,13 @@ class TSecurityTextFormatPrinter : public google::protobuf::TextFormat::Printer
     }
 };
 
+template <typename TMsg>
+inline TString SecureDebugString(const TMsg& message) {
+    TString result;
+    TSecurityTextFormatPrinter<TMsg> printer;
+    printer.SetSingleLineMode(true);
+    printer.PrintToString(message, &result);
+    return result;
+}
+
 } // namespace NKikimr