mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-27 11:43:26 -03:00
36fb036d25
NetPermissions::ClearFlag() is currently only called in the codebase with an `f` value of NetPermissionFlags::PF_ISIMPLICIT. If that should change in the future, ClearFlag() should not be called with `f` being a subflag of a multiflag, e.g. NetPermissionFlags::PF_RELAY or NetPermissionFlags::PF_DOWNLOAD, as that would leave `flags` in an invalid state corresponding to none of the existing NetPermissionFlags. Therefore, allow only calling ClearFlag with the implicit flag for now. Co-authored-by: Vasil Dimov <vd@FreeBSD.org>
80 lines
2.9 KiB
C++
80 lines
2.9 KiB
C++
// Copyright (c) 2009-2020 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include <netaddress.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#ifndef BITCOIN_NET_PERMISSIONS_H
|
|
#define BITCOIN_NET_PERMISSIONS_H
|
|
|
|
struct bilingual_str;
|
|
|
|
extern const std::vector<std::string> NET_PERMISSIONS_DOC;
|
|
|
|
enum NetPermissionFlags {
|
|
PF_NONE = 0,
|
|
// Can query bloomfilter even if -peerbloomfilters is false
|
|
PF_BLOOMFILTER = (1U << 1),
|
|
// Relay and accept transactions from this peer, even if -blocksonly is true
|
|
// This peer is also not subject to limits on how many transaction INVs are tracked
|
|
PF_RELAY = (1U << 3),
|
|
// Always relay transactions from this peer, even if already in mempool
|
|
// Keep parameter interaction: forcerelay implies relay
|
|
PF_FORCERELAY = (1U << 2) | PF_RELAY,
|
|
// Allow getheaders during IBD and block-download after maxuploadtarget limit
|
|
PF_DOWNLOAD = (1U << 6),
|
|
// Can't be banned/disconnected/discouraged for misbehavior
|
|
PF_NOBAN = (1U << 4) | PF_DOWNLOAD,
|
|
// Can query the mempool
|
|
PF_MEMPOOL = (1U << 5),
|
|
// Can request addrs without hitting a privacy-preserving cache
|
|
PF_ADDR = (1U << 7),
|
|
|
|
// True if the user did not specifically set fine grained permissions
|
|
PF_ISIMPLICIT = (1U << 31),
|
|
PF_ALL = PF_BLOOMFILTER | PF_FORCERELAY | PF_RELAY | PF_NOBAN | PF_MEMPOOL | PF_DOWNLOAD | PF_ADDR,
|
|
};
|
|
|
|
class NetPermissions
|
|
{
|
|
public:
|
|
NetPermissionFlags m_flags;
|
|
static std::vector<std::string> ToStrings(NetPermissionFlags flags);
|
|
static inline bool HasFlag(const NetPermissionFlags& flags, NetPermissionFlags f)
|
|
{
|
|
return (flags & f) == f;
|
|
}
|
|
static inline void AddFlag(NetPermissionFlags& flags, NetPermissionFlags f)
|
|
{
|
|
flags = static_cast<NetPermissionFlags>(flags | f);
|
|
}
|
|
//! ClearFlag is only called with `f` == NetPermissionFlags::PF_ISIMPLICIT.
|
|
//! If that should change in the future, be aware that ClearFlag should not
|
|
//! be called with a subflag of a multiflag, e.g. NetPermissionFlags::PF_RELAY
|
|
//! or NetPermissionFlags::PF_DOWNLOAD, as that would leave `flags` in an
|
|
//! invalid state corresponding to none of the existing flags.
|
|
static inline void ClearFlag(NetPermissionFlags& flags, NetPermissionFlags f)
|
|
{
|
|
assert(f == NetPermissionFlags::PF_ISIMPLICIT);
|
|
flags = static_cast<NetPermissionFlags>(flags & ~f);
|
|
}
|
|
};
|
|
|
|
class NetWhitebindPermissions : public NetPermissions
|
|
{
|
|
public:
|
|
static bool TryParse(const std::string str, NetWhitebindPermissions& output, bilingual_str& error);
|
|
CService m_service;
|
|
};
|
|
|
|
class NetWhitelistPermissions : public NetPermissions
|
|
{
|
|
public:
|
|
static bool TryParse(const std::string str, NetWhitelistPermissions& output, bilingual_str& error);
|
|
CSubNet m_subnet;
|
|
};
|
|
|
|
#endif // BITCOIN_NET_PERMISSIONS_H
|