field_validator.hpp

Go to the documentation of this file.

#ifndef IROHA_SHARED_MODEL_FIELD_VALIDATOR_HPP
#define IROHA_SHARED_MODEL_FIELD_VALIDATOR_HPP

#include <regex>

#include "datetime/time.hpp"
#include "interfaces/base/signable.hpp"
#include "interfaces/permissions.hpp"
#include "interfaces/queries/query_payload_meta.hpp"
#include "validators/answer.hpp"

namespace shared_model {

  namespace interface {
    class Amount;
    class BatchMeta;
    class Peer;
    class TxPaginationMeta;
  }  // namespace interface

  namespace validation {

    class FieldValidator {
     private:
      using TimeFunction = std::function<iroha::ts64_t()>;

     public:
      FieldValidator(time_t future_gap = kDefaultFutureGap,
                     TimeFunction time_provider = [] {
                       return iroha::time::now();
                     });

      void validateAccountId(
          ReasonsGroupType &reason,
          const interface::types::AccountIdType &account_id) const;

      void validateAssetId(ReasonsGroupType &reason,
                           const interface::types::AssetIdType &asset_id) const;

      void validatePeer(ReasonsGroupType &reason,
                        const interface::Peer &peer) const;

      void validateAmount(ReasonsGroupType &reason,
                          const interface::Amount &amount) const;

      void validatePubkey(ReasonsGroupType &reason,
                          const interface::types::PubkeyType &pubkey) const;

      void validatePeerAddress(
          ReasonsGroupType &reason,
          const interface::types::AddressType &address) const;

      void validateRoleId(ReasonsGroupType &reason,
                          const interface::types::RoleIdType &role_id) const;

      void validateAccountName(
          ReasonsGroupType &reason,
          const interface::types::AccountNameType &account_name) const;

      // clang-format off
      // clang-format on
      void validateDomainId(
          ReasonsGroupType &reason,
          const interface::types::DomainIdType &domain_id) const;

      void validateAssetName(
          ReasonsGroupType &reason,
          const interface::types::AssetNameType &asset_name) const;

      void validateAccountDetailKey(
          ReasonsGroupType &reason,
          const interface::types::AccountDetailKeyType &key) const;

      void validateAccountDetailValue(
          ReasonsGroupType &reason,
          const interface::types::AccountDetailValueType &value) const;

      void validatePrecision(
          ReasonsGroupType &reason,
          const interface::types::PrecisionType &precision) const;

      void validateRolePermission(
          ReasonsGroupType &reason,
          const interface::permissions::Role &permission) const;

      void validateGrantablePermission(
          ReasonsGroupType &reason,
          const interface::permissions::Grantable &permission) const;

      void validateQuorum(ReasonsGroupType &reason,
                          const interface::types::QuorumType &quorum) const;

      void validateCreatorAccountId(
          ReasonsGroupType &reason,
          const interface::types::AccountIdType &account_id) const;

      void validateCreatedTime(ReasonsGroupType &reason,
                               interface::types::TimestampType timestamp,
                               interface::types::TimestampType now) const;

      void validateCreatedTime(ReasonsGroupType &reason,
                               interface::types::TimestampType timestamp) const;

      void validateCounter(ReasonsGroupType &reason,
                           const interface::types::CounterType &counter) const;

      void validateSignatures(
          ReasonsGroupType &reason,
          const interface::types::SignatureRangeType &signatures,
          const crypto::Blob &source) const;

      void validateQueryPayloadMeta(
          ReasonsGroupType &reason,
          const interface::QueryPayloadMeta &meta) const;

      void validateDescription(
          ReasonsGroupType &reason,
          const interface::types::DescriptionType &description) const;

      void validateBatchMeta(ReasonsGroupType &reason,
                             const interface::BatchMeta &description) const;

      void validateHeight(ReasonsGroupType &reason,
                          const interface::types::HeightType &height) const;

      void validateHash(ReasonsGroupType &reason,
                        const crypto::Hash &hash) const;

      void validateTxPaginationMeta(
          ReasonsGroupType &reason,
          const interface::TxPaginationMeta &tx_pagination_meta) const;

     private:
      const static std::string account_name_pattern_;
      const static std::string asset_name_pattern_;
      const static std::string domain_pattern_;
      const static std::string ip_v4_pattern_;
      const static std::string peer_address_pattern_;
      const static std::string account_id_pattern_;
      const static std::string asset_id_pattern_;
      const static std::string detail_key_pattern_;
      const static std::string role_id_pattern_;

      const static std::regex account_name_regex_;
      const static std::regex asset_name_regex_;
      const static std::regex domain_regex_;
      const static std::regex ip_v4_regex_;
      const static std::regex peer_address_regex_;
      const static std::regex account_id_regex_;
      const static std::regex asset_id_regex_;
      const static std::regex detail_key_regex_;
      const static std::regex role_id_regex_;

      // gap for future transactions
      time_t future_gap_;
      // time provider callback
      TimeFunction time_provider_;

     public:
      // max-delay between tx creation and validation
      static constexpr auto kMaxDelay =
          std::chrono::hours(24) / std::chrono::milliseconds(1);
      // default value for future_gap field of FieldValidator
      static constexpr auto kDefaultFutureGap =
          std::chrono::minutes(5) / std::chrono::milliseconds(1);

      // size of key
      static const size_t public_key_size;
      static const size_t signature_size;
      static const size_t hash_size;
      static const size_t value_size;
      static const size_t description_size;
    };

    boost::optional<ConcreteReasonType> validatePubkey(
        const interface::types::PubkeyType &pubkey);

  }  // namespace validation
}  // namespace shared_model

#endif  // IROHA_SHARED_MODEL_FIELD_VALIDATOR_HPP