permissions.hpp

Go to the documentation of this file.

#ifndef IROHA_SHARED_MODEL_PERMISSIONS_HPP
#define IROHA_SHARED_MODEL_PERMISSIONS_HPP

#include <bitset>
#include <functional>
#include <initializer_list>
#include <string>
#include <string_view>

namespace shared_model {
  namespace interface {
    namespace permissions {
      enum class Role {
        kAppendRole,
        kCreateRole,
        kDetachRole,
        kAddAssetQty,
        kSubtractAssetQty,
        kAddPeer,
        kAddSignatory,
        kRemoveSignatory,
        kSetQuorum,
        kCreateAccount,
        kSetDetail,
        kCreateAsset,
        kTransfer,
        kReceive,
        kCreateDomain,
        kReadAssets,
        kGetRoles,
        kGetMyAccount,
        kGetAllAccounts,
        kGetDomainAccounts,
        kGetMySignatories,
        kGetAllSignatories,
        kGetDomainSignatories,
        kGetMyAccAst,
        kGetAllAccAst,
        kGetDomainAccAst,
        kGetMyAccDetail,
        kGetAllAccDetail,
        kGetDomainAccDetail,
        kGetMyAccTxs,
        kGetAllAccTxs,
        kGetDomainAccTxs,
        kGetMyAccAstTxs,
        kGetAllAccAstTxs,
        kGetDomainAccAstTxs,
        kGetMyTxs,
        kGetAllTxs,
        kSetMyQuorum,
        kAddMySignatory,
        kRemoveMySignatory,
        kTransferMyAssets,
        kSetMyAccountDetail,
        kGetBlocks,
        kAddDomainAssetQty,
        kSubtractDomainAssetQty,
        kGetPeers,
        kRemovePeer,
        kRoot,
        kCallEngine,
        kGrantCallEngineOnMyBehalf,
        kGetMyEngineReceipts,
        kGetDomainEngineReceipts,
        kGetAllEngineReceipts,

        COUNT
      };

      enum class Grantable {
        kAddMySignatory,
        kRemoveMySignatory,
        kSetMyQuorum,
        kSetMyAccountDetail,
        kTransferMyAssets,
        kCallEngineOnMyBehalf,

        COUNT
      };

      Role permissionFor(Grantable);

      bool isValid(interface::permissions::Role perm) noexcept;

      bool isValid(interface::permissions::Grantable perm) noexcept;
    }  // namespace permissions

    template <typename Perm>
    class PermissionSet {
     public:
      PermissionSet();
      PermissionSet(std::initializer_list<Perm> list);
      explicit PermissionSet(std::string_view bitstring);

      // TODO [IR-1889] Akvinikym 21.11.18: introduce toString() method
      std::string toBitstring() const;

      static constexpr size_t size() {
        return static_cast<size_t>(Perm::COUNT);
      }

      PermissionSet &unsetAll();
      PermissionSet &setAll();
      PermissionSet &set(Perm p);
      PermissionSet &unset(Perm p);

      bool isSet(Perm p) const;
      bool isEmpty() const;

      bool isSubsetOf(const PermissionSet<Perm> &r) const;

      bool operator==(const PermissionSet<Perm> &r) const;
      bool operator!=(const PermissionSet<Perm> &r) const;
      PermissionSet<Perm> &operator&=(const PermissionSet<Perm> &r);
      PermissionSet<Perm> &operator|=(const PermissionSet<Perm> &r);
      PermissionSet<Perm> &operator^=(const PermissionSet<Perm> &r);

      void iterate(std::function<void(Perm)> f) const;

     private:
      std::bitset<static_cast<size_t>(Perm::COUNT)> perms_bitset_;
    };

    using RolePermissionSet = PermissionSet<permissions::Role>;
    using GrantablePermissionSet = PermissionSet<permissions::Grantable>;
  }  // namespace interface
}  // namespace shared_model

#endif  // IROHA_SHARED_MODEL_TRANSACTION_HPP