sysio::chain::authority_checker< PermissionToAuthorityFunc > Class Template Reference

namespace detail More...

#include <authority_checker.hpp>

Public Types
enum	permission_cache_status { being_evaluated , permission_unsatisfied , permission_satisfied }
typedef map< permission_level, permission_cache_status >	permission_cache_type

Public Member Functions
	authority_checker (PermissionToAuthorityFunc permission_to_authority, uint16_t recursion_depth_limit, const flat_set< public_key_type > &provided_keys, const flat_set< permission_level > &provided_permissions, fc::microseconds provided_delay, const std::function< void()> &checktime)
bool	satisfied (const permission_level &permission, fc::microseconds override_provided_delay, permission_cache_type *cached_perms=nullptr)
bool	satisfied (const permission_level &permission, permission_cache_type *cached_perms=nullptr)
template<typename AuthorityType >
bool	satisfied (const AuthorityType &authority, fc::microseconds override_provided_delay, permission_cache_type *cached_perms=nullptr)
template<typename AuthorityType >
bool	satisfied (const AuthorityType &authority, permission_cache_type *cached_perms=nullptr)
bool	all_keys_used () const
flat_set< public_key_type >	used_keys () const
flat_set< public_key_type >	unused_keys () const

Static Public Member Functions
static std::optional< permission_cache_status >	permission_status_in_cache (const permission_cache_type &permissions, const permission_level &level)

Detailed Description

template<typename PermissionToAuthorityFunc>
class sysio::chain::authority_checker< PermissionToAuthorityFunc >

This class determines whether a set of signing keys are sufficient to satisfy an authority or not

To determine whether an authority is satisfied or not, we first determine which keys have approved of a message, and then determine whether that list of keys is sufficient to satisfy the authority. This class takes a list of keys and provides the satisfied method to determine whether that list of keys satisfies a provided authority.

Template Parameters

F	A callable which takes a single argument of type AccountPermission and returns the corresponding authority

Definition at line 35 of file authority_checker.hpp.

Member Typedef Documentation

permission_cache_type

template<typename PermissionToAuthorityFunc >

map<permission_level, permission_cache_status> sysio::chain::authority_checker< PermissionToAuthorityFunc >::permission_cache_type

Definition at line 70 of file authority_checker.hpp.

Member Enumeration Documentation

permission_cache_status

template<typename PermissionToAuthorityFunc >

enum sysio::chain::authority_checker::permission_cache_status

Enumerator
being_evaluated
permission_unsatisfied
permission_satisfied

Definition at line 64 of file authority_checker.hpp.

                                      {
            being_evaluated,
            permission_unsatisfied,
            permission_satisfied
         };

Constructor & Destructor Documentation

authority_checker()

template<typename PermissionToAuthorityFunc >

sysio::chain::authority_checker< PermissionToAuthorityFunc >::authority_checker ( PermissionToAuthorityFunc permission_to_authority, uint16_t recursion_depth_limit, const flat_set< public_key_type > & provided_keys, const flat_set< permission_level > & provided_permissions, fc::microseconds provided_delay, const std::function< void()> & checktime )

inline

Definition at line 46 of file authority_checker.hpp.

         :permission_to_authority(permission_to_authority)
         ,checktime( checktime )
         ,provided_keys(provided_keys.begin(), provided_keys.end())
         ,provided_permissions(provided_permissions)
         ,_used_keys(provided_keys.size(), false)
         ,provided_delay(provided_delay)
         ,recursion_depth_limit(recursion_depth_limit)
         {
            SYS_ASSERT( static_cast<bool>(checktime), authorization_exception, "checktime cannot be empty" );
         }

Member Function Documentation

all_keys_used()

template<typename PermissionToAuthorityFunc >

bool sysio::chain::authority_checker< PermissionToAuthorityFunc >::all_keys_used ( ) const

inline

Definition at line 121 of file authority_checker.hpp.

{ return boost::algorithm::all_of_equal(_used_keys, true); }

permission_status_in_cache()

template<typename PermissionToAuthorityFunc >

static std::optional< permission_cache_status > sysio::chain::authority_checker< PermissionToAuthorityFunc >::permission_status_in_cache ( const permission_cache_type & permissions, const permission_level & level )

inlinestatic

Definition at line 133 of file authority_checker.hpp.

         {
            auto itr = permissions.find( level );
            if( itr != permissions.end() )
               return itr->second;
 
            itr = permissions.find( {level.actor, permission_name()} );
            if( itr != permissions.end() )
               return itr->second;
 
            return std::optional<permission_cache_status>();
         }

satisfied() [1/4]

template<typename PermissionToAuthorityFunc >

template<typename AuthorityType >

bool sysio::chain::authority_checker< PermissionToAuthorityFunc >::satisfied ( const AuthorityType & authority, fc::microseconds override_provided_delay, permission_cache_type * cached_perms = nullptr )

inline

Definition at line 97 of file authority_checker.hpp.

         {
            auto delay_reverter = fc::make_scoped_exit( [this, delay = provided_delay] () mutable {
               provided_delay = delay;
            });
 
            provided_delay = override_provided_delay;
 
            return satisfied( authority, cached_perms );
         }

Here is the call graph for this function:

satisfied() [2/4]

template<typename PermissionToAuthorityFunc >

template<typename AuthorityType >

bool sysio::chain::authority_checker< PermissionToAuthorityFunc >::satisfied ( const AuthorityType & authority, permission_cache_type * cached_perms = nullptr )

inline

Definition at line 112 of file authority_checker.hpp.

                                                                                                         {
            permission_cache_type cached_permissions;
 
            if( cached_perms == nullptr )
               cached_perms = initialize_permission_cache( cached_permissions );
 
            return satisfied( authority, *cached_perms, 0 );
         }

Here is the call graph for this function:

satisfied() [3/4]

template<typename PermissionToAuthorityFunc >

bool sysio::chain::authority_checker< PermissionToAuthorityFunc >::satisfied ( const permission_level & permission, fc::microseconds override_provided_delay, permission_cache_type * cached_perms = nullptr )

inline

Definition at line 72 of file authority_checker.hpp.

         {
            auto delay_reverter = fc::make_scoped_exit( [this, delay = provided_delay] () mutable {
               provided_delay = delay;
            });
 
            provided_delay = override_provided_delay;
 
            return satisfied( permission, cached_perms );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

satisfied() [4/4]

template<typename PermissionToAuthorityFunc >

bool sysio::chain::authority_checker< PermissionToAuthorityFunc >::satisfied ( const permission_level & permission, permission_cache_type * cached_perms = nullptr )

inline

Definition at line 86 of file authority_checker.hpp.

                                                                                                             {
            permission_cache_type cached_permissions;
 
            if( cached_perms == nullptr )
               cached_perms = initialize_permission_cache( cached_permissions );
 
            weight_tally_visitor visitor(*this, *cached_perms, 0);
            return ( visitor(permission_level_weight{permission, 1}) > 0 );
         }

unused_keys()

template<typename PermissionToAuthorityFunc >

flat_set< public_key_type > sysio::chain::authority_checker< PermissionToAuthorityFunc >::unused_keys ( ) const

inline

Definition at line 127 of file authority_checker.hpp.

                                                       {
            auto range = filter_data_by_marker(provided_keys, _used_keys, false);
            return {range.begin(), range.end()};
         }

Here is the call graph for this function:

used_keys()

template<typename PermissionToAuthorityFunc >

flat_set< public_key_type > sysio::chain::authority_checker< PermissionToAuthorityFunc >::used_keys ( ) const

inline

Definition at line 123 of file authority_checker.hpp.

                                                     {
            auto range = filter_data_by_marker(provided_keys, _used_keys, true);
            return {range.begin(), range.end()};
         }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• libraries/chain/include/sysio/chain/authority_checker.hpp