highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-06-14 10:51:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge #19192: doc: Extract net permissions doc

Browse Source 
fa2c2b50d895ff3402b82ce3db69bfc43053b519 doc: Extract net permissions doc (MarcoFalke)

Pull request description:

  Moving the documentation of each flag form the already over-large init.cpp into the net permissions module should clean up the code a bit. Moreover, making the documentation available is also required for an (currently imaginary) `setnetpermissions` RPC.

ACKs for top commit:
  Sjors:
    re-utACK fa2c2b50d895ff3402b82ce3db69bfc43053b519

Tree-SHA512: c0a75facc9768913c28d2ffcdfaad8d60f7604d5584ee546adaf77d270563558d361aeaf354e49e349aca7e2e80814b27ffc24247e7b4f045c63cbdc079b449f
This commit is contained in:
MarcoFalke 2020-06-08 07:27:49 -04:00
commit 41fb69404c
No known key found for this signature in database
GPG Key ID: CE2B75697E69A548
3 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/init.cpp
View File

@ -51,6 +51,7 @@
#include <ui_interface.h> #include <ui_interface.h>
#include <util/asmap.h> #include <util/asmap.h>
#include <util/moneystr.h> #include <util/moneystr.h>
#include <util/string.h>
#include <util/system.h> #include <util/system.h>
#include <util/threadnames.h> #include <util/threadnames.h>
#include <util/translation.h> #include <util/translation.h>
@ -465,11 +466,7 @@ void SetupServerArgs(NodeContext& node)
hidden_args.emplace_back("-upnp"); hidden_args.emplace_back("-upnp");
#endif #endif
gArgs.AddArg("-whitebind=<[permissions@]addr>", "Bind to given address and whitelist peers connecting to it. " gArgs.AddArg("-whitebind=<[permissions@]addr>", "Bind to given address and whitelist peers connecting to it. "
"Use [host]:port notation for IPv6. Allowed permissions are bloomfilter (allow requesting BIP37 filtered blocks and transactions), " "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
"noban (do not ban for misbehavior), "
"forcerelay (relay transactions that are already in the mempool; implies relay), "
"relay (relay even in -blocksonly mode), "
"and mempool (allow requesting BIP35 mempool contents). "
"Specify multiple permissions separated by commas (default: noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION); "Specify multiple permissions separated by commas (default: noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
gArgs.AddArg("-whitelist=<[permissions@]IP address or network>", "Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or " gArgs.AddArg("-whitelist=<[permissions@]IP address or network>", "Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or "

8
src/net_permissions.cpp
View File

@ -8,6 +8,14 @@
#include <util/system.h> #include <util/system.h>
#include <util/translation.h> #include <util/translation.h>
const std::vector<std::string> NET_PERMISSIONS_DOC{
"bloomfilter (allow requesting BIP37 filtered blocks and transactions)",
"noban (do not ban for misbehavior)",
"forcerelay (relay transactions that are already in the mempool; implies relay)",
"relay (relay even in -blocksonly mode)",
"mempool (allow requesting BIP35 mempool contents)",
};
// The parse the following format "perm1,perm2@xxxxxx" // The parse the following format "perm1,perm2@xxxxxx"
bool TryParsePermissionFlags(const std::string str, NetPermissionFlags& output, size_t& readen, std::string& error) bool TryParsePermissionFlags(const std::string str, NetPermissionFlags& output, size_t& readen, std::string& error)
{ {

8
src/net_permissions.h
View File

@ -2,12 +2,16 @@
// Distributed under the MIT software license, see the accompanying // Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php. // file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <netaddress.h>
#include <string> #include <string>
#include <vector> #include <vector>
#include <netaddress.h>
#ifndef BITCOIN_NET_PERMISSIONS_H #ifndef BITCOIN_NET_PERMISSIONS_H
#define BITCOIN_NET_PERMISSIONS_H #define BITCOIN_NET_PERMISSIONS_H
extern const std::vector<std::string> NET_PERMISSIONS_DOC;
enum NetPermissionFlags enum NetPermissionFlags
{ {
PF_NONE = 0, PF_NONE = 0,
@ -27,6 +31,7 @@ enum NetPermissionFlags
PF_ISIMPLICIT = (1U << 31), PF_ISIMPLICIT = (1U << 31),
PF_ALL = PF_BLOOMFILTER | PF_FORCERELAY | PF_RELAY | PF_NOBAN | PF_MEMPOOL, PF_ALL = PF_BLOOMFILTER | PF_FORCERELAY | PF_RELAY | PF_NOBAN | PF_MEMPOOL,
}; };
class NetPermissions class NetPermissions
{ {
public: public:
@ -45,6 +50,7 @@ public:
flags = static_cast<NetPermissionFlags>(flags & ~f); flags = static_cast<NetPermissionFlags>(flags & ~f);
} }
}; };
class NetWhitebindPermissions : public NetPermissions class NetWhitebindPermissions : public NetPermissions
{ {
public: public: