[Backport]util: Filter control characters out of log messages
ClosedPublic
Actions

Authored by PiRK on Sep 22 2020, 12:33.

Details

Reviewers

Group Reviewers

Restricted Owners Package	(Owns No Changed Paths)
Restricted Project

Commits

rABC14dccf6b478f: [Backport]util: Filter control characters out of log messages

Summary

Belts and suspenders: make sure outgoing log messages don't contain
potentially suspicious characters, such as terminal control codes.

This escapes control characters except newline ('\n') in C syntax.
It escapes instead of removes them to still allow for troubleshooting
issues where they accidentally end up in strings.

Backport of Bitcoin Core PR17095

Test Plan

ninja && ninja check

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Sep 22 2020, 12:33

Owners added a reviewer: Restricted Owners Package.Sep 22 2020, 12:33

Herald added a reviewer: Restricted Project. · View Herald TranscriptSep 22 2020, 12:33

PiRK requested review of this revision.Sep 22 2020, 12:33

[Bot Message]
One or more PR numbers were detected in the summary.
Links to those PRs have been inserted into the summary for reference.

Harbormaster completed remote builds in B12848: Diff 23660.Sep 22 2020, 12:57

Build Bitcoin ABC Diffs / Diff Testing (build-diff) failed.

Snippet of first build failure:

[0m[0;32mrpc_estimatefee.py                      | ✓ Passed  | 1 s
[0m[0;32mrpc_getblockfilter.py                   | ✓ Passed  | 1 s
[0m[0;32mrpc_getblockstats.py                    | ✓ Passed  | 1 s
[0m[0;32mrpc_getchaintips.py                     | ✓ Passed  | 3 s
[0m[0;32mrpc_help.py                             | ✓ Passed  | 1 s
[0m[0;32mrpc_invalidateblock.py                  | ✓ Passed  | 6 s
[0m[0;32mrpc_misc.py                             | ✓ Passed  | 1 s
[0m[0;32mrpc_named_arguments.py                  | ✓ Passed  | 1 s
[0m[0;32mrpc_net.py                              | ✓ Passed  | 1 s
[0m[0;32mrpc_preciousblock.py                    | ✓ Passed  | 1 s
[0m[0;32mrpc_psbt.py                             | ✓ Passed  | 29 s
[0m[0;32mrpc_scantxoutset.py                     | ✓ Passed  | 4 s
[0m[0;32mrpc_setban.py                           | ✓ Passed  | 2 s
[0m[0;32mrpc_signmessage.py                      | ✓ Passed  | 1 s
[0m[0;32mrpc_signrawtransaction.py               | ✓ Passed  | 1 s
[0m[0;32mrpc_txoutproof.py                       | ✓ Passed  | 2 s
[0m[0;32mrpc_uptime.py                           | ✓ Passed  | 1 s
[0m[0;32mrpc_users.py                            | ✓ Passed  | 2 s
[0m[0;32mrpc_whitelist.py                        | ✓ Passed  | 1 s
[0m[0;32mtool_wallet.py                          | ✓ Passed  | 3 s
[0m[0;32mwallet_abandonconflict.py               | ✓ Passed  | 6 s
[0m[0;32mwallet_address_types.py                 | ✓ Passed  | 13 s
[0m[0;32mwallet_avoidreuse.py                    | ✓ Passed  | 3 s
[0m[0;32mwallet_balance.py                       | ✓ Passed  | 10 s
[0m[0;32mwallet_basic.py                         | ✓ Passed  | 25 s
[0m[0;32mwallet_coinbase_category.py             | ✓ Passed  | 1 s
[0m[0;32mwallet_create_tx.py                     | ✓ Passed  | 5 s
[0m[0;32mwallet_createwallet.py                  | ✓ Passed  | 2 s
[0m[0;32mwallet_createwallet.py --usecli         | ✓ Passed  | 3 s
[0m[0;32mwallet_disable.py                       | ✓ Passed  | 0 s
[0m[0;32mwallet_dump.py                          | ✓ Passed  | 3 s
[0m[0;32mwallet_encryption.py                    | ✓ Passed  | 5 s
[0m[0;32mwallet_groups.py                        | ✓ Passed  | 18 s
[0m[0;32mwallet_hd.py                            | ✓ Passed  | 5 s
[0m[0;32mwallet_import_rescan.py                 | ✓ Passed  | 4 s
[0m[0;32mwallet_import_with_label.py             | ✓ Passed  | 1 s
[0m[0;32mwallet_importmulti.py                   | ✓ Passed  | 3 s
[0m[0;32mwallet_importprunedfunds.py             | ✓ Passed  | 2 s
[0m[0;32mwallet_keypool.py                       | ✓ Passed  | 3 s
[0m[0;32mwallet_keypool_topup.py                 | ✓ Passed  | 2 s
[0m[0;32mwallet_labels.py                        | ✓ Passed  | 1 s
[0m[0;32mwallet_listreceivedby.py                | ✓ Passed  | 14 s
[0m[0;32mwallet_listsinceblock.py                | ✓ Passed  | 4 s
[0m[0;32mwallet_listtransactions.py              | ✓ Passed  | 26 s
[0m[0;32mwallet_multiwallet.py                   | ✓ Passed  | 12 s
[0m[0;32mwallet_multiwallet.py --usecli          | ✓ Passed  | 14 s
[0m[0;32mwallet_reorgsrestore.py                 | ✓ Passed  | 3 s
[0m[0;32mwallet_resendwallettransactions.py      | ✓ Passed  | 6 s
[0m[0;32mwallet_txn_clone.py                     | ✓ Passed  | 1 s
[0m[0;32mwallet_txn_clone.py --mineblock         | ✓ Passed  | 3 s
[0m[0;32mwallet_txn_doublespend.py               | ✓ Passed  | 1 s
[0m[0;32mwallet_txn_doublespend.py --mineblock   | ✓ Passed  | 3 s
[0m[0;32mwallet_watchonly.py                     | ✓ Passed  | 1 s
[0m[0;32mwallet_watchonly.py --usecli            | ✓ Passed  | 1 s
[0m[0;32mwallet_zapwallettxes.py                 | ✓ Passed  | 3 s
[0m[1m
ALL                                     | ✓ Passed  | 647 s (accumulated) 
[0mRuntime: 130 s

Build build-diff timed out after 1200.0s

deadalnix accepted this revision.Sep 22 2020, 12:58

This revision is now accepted and ready to land.Sep 22 2020, 12:58

handle conflict between this diff and recently landed D7502

Harbormaster completed remote builds in B12850: Diff 23663.Sep 22 2020, 14:42

Closed by commit rABC14dccf6b478f: [Backport]util: Filter control characters out of log messages (authored by Wladimir J. van der Laan <laanwj@protonmail.com>, committed by PiRK). · Explain WhySep 22 2020, 14:54

This revision was automatically updated to reflect the committed changes.

PiRK added a commit: rABC14dccf6b478f: [Backport]util: Filter control characters out of log messages.