mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
109 lines
3.3 KiB
C++
109 lines
3.3 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/protocol/Rules.h>
|
|
#include <xrpl/protocol/TER.h>
|
|
#include <xrpl/protocol/TxFormats.h>
|
|
|
|
#include <optional>
|
|
#include <string>
|
|
#include <unordered_map>
|
|
#include <unordered_set>
|
|
|
|
namespace xrpl {
|
|
|
|
class STTx;
|
|
|
|
/**
|
|
* We have both transaction type permissions and granular type permissions.
|
|
* Since we will reuse the TransactionFormats to parse the Transaction
|
|
* Permissions, only the GranularPermissionType is defined here. To prevent
|
|
* conflicts with TxType, the GranularPermissionType is always set to a value
|
|
* greater than the maximum value of uint16.
|
|
*/
|
|
enum GranularPermissionType : std::uint32_t {
|
|
#pragma push_macro("GRANULAR_PERMISSION")
|
|
#undef GRANULAR_PERMISSION
|
|
|
|
#define GRANULAR_PERMISSION(name, txType, value, allowedFlags, allowedFields) name = value,
|
|
|
|
#include <xrpl/protocol/detail/permissions.macro>
|
|
|
|
#undef GRANULAR_PERMISSION
|
|
#pragma pop_macro("GRANULAR_PERMISSION")
|
|
};
|
|
|
|
enum Delegation { delegable, notDelegable };
|
|
|
|
class Permission
|
|
{
|
|
private:
|
|
Permission();
|
|
|
|
std::unordered_map<std::uint16_t, uint256> txFeatureMap_;
|
|
std::unordered_map<std::uint16_t, Delegation> delegableTx_;
|
|
std::unordered_map<std::string, GranularPermissionType> granularPermissionMap_;
|
|
|
|
std::unordered_map<GranularPermissionType, std::string> granularNameMap_;
|
|
std::unordered_map<GranularPermissionType, TxType> granularTxTypeMap_;
|
|
|
|
std::unordered_map<GranularPermissionType, std::uint32_t> granularPermittedFlags_;
|
|
std::unordered_map<GranularPermissionType, SOTemplate> granularTemplates_;
|
|
std::unordered_set<TxType> granularTxTypes_;
|
|
|
|
public:
|
|
static Permission const&
|
|
getInstance();
|
|
|
|
Permission(Permission const&) = delete;
|
|
Permission&
|
|
operator=(Permission const&) = delete;
|
|
|
|
std::optional<std::string>
|
|
getPermissionName(std::uint32_t const value) const;
|
|
|
|
std::optional<std::uint32_t>
|
|
getGranularValue(std::string const& name) const;
|
|
|
|
std::optional<std::string>
|
|
getGranularName(GranularPermissionType const& value) const;
|
|
|
|
std::optional<TxType>
|
|
getGranularTxType(GranularPermissionType const& gpType) const;
|
|
|
|
std::optional<std::reference_wrapper<uint256 const>>
|
|
getTxFeature(TxType txType) const;
|
|
|
|
bool
|
|
isDelegable(std::uint32_t const& permissionValue, Rules const& rules) const;
|
|
|
|
bool
|
|
hasGranularPermissions(TxType txType) const;
|
|
|
|
// for tx level permission, permission value is equal to tx type plus one
|
|
static uint32_t
|
|
txToPermissionType(TxType const& type);
|
|
|
|
// tx type value is permission value minus one
|
|
static TxType
|
|
permissionToTxType(uint32_t const& value);
|
|
|
|
/**
|
|
* @brief Verifies a delegated transaction against its granular permission template.
|
|
*
|
|
* @note WARNING: Do not move this check before standard transaction-level
|
|
* format checks, which is in preclaim. This function assumes the transaction's
|
|
* base structural integrity (fees, sequence, signatures) has already been
|
|
* validated.
|
|
*
|
|
* @param tx The transaction to verify.
|
|
* @param heldPermissions The granular permissions that the sender hold.
|
|
* @return true if the transaction fields and flags comply with the granular template.
|
|
*/
|
|
[[nodiscard]] bool
|
|
checkGranularSandbox(
|
|
STTx const& tx,
|
|
std::unordered_set<GranularPermissionType> const& heldPermissions) const;
|
|
};
|
|
|
|
} // namespace xrpl
|