sysio::login_plugin Class Reference

#include <login_plugin.hpp>

Inheritance diagram for sysio::login_plugin:

Collaboration diagram for sysio::login_plugin:

Classes
struct	do_not_use_gen_r1_key_params
struct	do_not_use_gen_r1_key_results
struct	do_not_use_get_secret_params
struct	do_not_use_get_secret_results
struct	do_not_use_sign_params
struct	do_not_use_sign_results
struct	finalize_login_request_params
struct	finalize_login_request_results
struct	start_login_request_params
struct	start_login_request_results

Public Member Functions
	APPBASE_PLUGIN_REQUIRES ((chain_plugin)(http_plugin)) login_plugin()
virtual	~login_plugin ()
virtual void	set_program_options (options_description &, options_description &) override
void	plugin_initialize (const variables_map &)
void	plugin_startup ()
void	plugin_shutdown ()
start_login_request_results	start_login_request (const start_login_request_params &)
finalize_login_request_results	finalize_login_request (const finalize_login_request_params &)
do_not_use_gen_r1_key_results	do_not_use_gen_r1_key (const do_not_use_gen_r1_key_params &)
do_not_use_sign_results	do_not_use_sign (const do_not_use_sign_params &)
do_not_use_get_secret_results	do_not_use_get_secret (const do_not_use_get_secret_params &)
Public Member Functions inherited from appbase::plugin< login_plugin >
	plugin ()
virtual	~plugin ()
virtual state	get_state () const override
virtual const std::string &	name () const override
virtual void	register_dependencies ()
virtual void	initialize (const variables_map &options) override
virtual void	handle_sighup () override
virtual void	startup () override
virtual void	shutdown () override
Public Member Functions inherited from appbase::abstract_plugin
virtual	~abstract_plugin ()

Additional Inherited Members
Public Types inherited from appbase::abstract_plugin
enum	state { registered , initialized , started , stopped }
Protected Member Functions inherited from appbase::plugin< login_plugin >
	plugin (const string &name)

Detailed Description

Definition at line 10 of file login_plugin.hpp.

Constructor & Destructor Documentation

~login_plugin()

sysio::login_plugin::~login_plugin ( )

virtual

Definition at line 46 of file login_plugin.cpp.

{}

Member Function Documentation

APPBASE_PLUGIN_REQUIRES()

sysio::login_plugin::APPBASE_PLUGIN_REQUIRES

(

(chain_plugin)(http_plugin)

)

do_not_use_gen_r1_key()

login_plugin::do_not_use_gen_r1_key_results sysio::login_plugin::do_not_use_gen_r1_key

(

const do_not_use_gen_r1_key_params &

params

)

Definition at line 145 of file login_plugin.cpp.

                                                                                          {
   auto priv = chain::private_key_type::generate_r1();
   return {priv.get_public_key(), priv};
}

Here is the call graph for this function:

do_not_use_get_secret()

login_plugin::do_not_use_get_secret_results sysio::login_plugin::do_not_use_get_secret

(

const do_not_use_get_secret_params &

params

)

Definition at line 156 of file login_plugin.cpp.

                                                                                          {
   return {params.priv_key.generate_shared_secret(params.pub_key)};
}

do_not_use_sign()

login_plugin::do_not_use_sign_results sysio::login_plugin::do_not_use_sign

(

const do_not_use_sign_params &

params

)

Definition at line 151 of file login_plugin.cpp.

                                                                              {
   return {params.priv_key.sign(chain::sha256::hash(params.data))};
}

finalize_login_request()

login_plugin::finalize_login_request_results sysio::login_plugin::finalize_login_request

(

const finalize_login_request_params &

params

)

Definition at line 105 of file login_plugin.cpp.

                                                                                            {
   finalize_login_request_results result;
   my->expire_requests();
   auto& index = my->requests.get<login_request_pub_key_index>();
   auto it = index.find(params.server_ephemeral_pub_key);
   if (it == index.end()) {
      result.error = "server_ephemeral_pub_key expired or not found";
      return result;
   }
   auto request = *it;
   index.erase(it);
 
   auto shared_secret = request.server_ephemeral_priv_key.generate_shared_secret(params.client_ephemeral_pub_key);
 
   chain::bytes combined_data(1024 * 1024);
   chain::datastream<char*> sig_data_ds{combined_data.data(), combined_data.size()};
   fc::raw::pack(sig_data_ds, params.permission);
   fc::raw::pack(sig_data_ds, shared_secret);
   fc::raw::pack(sig_data_ds, params.data);
   combined_data.resize(sig_data_ds.tellp());
 
   result.digest = chain::sha256::hash(combined_data);
   for (auto& sig : params.signatures)
      result.recovered_keys.insert(chain::public_key_type{sig, result.digest});
 
   try {
      auto noop_checktime = [] {};
      auto& chain = app().get_plugin<chain_plugin>().chain();
      chain.get_authorization_manager().check_authorization( //
          params.permission.actor, params.permission.permission, result.recovered_keys, {}, fc::microseconds(0),
          noop_checktime, true);
      result.permission_satisfied = true;
   } catch (...) {
      result.error = "keys do not satisfy permission";
   }
 
   return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

plugin_initialize()

void sysio::login_plugin::plugin_initialize

(

const variables_map &

options

)

Definition at line 56 of file login_plugin.cpp.

                                                                 {
   my->max_login_requests = options.at("max-login-requests").as<uint32_t>();
   my->max_login_timeout = options.at("max-login-timeout").as<uint32_t>();
}

plugin_shutdown()

void sysio::login_plugin::plugin_shutdown

(

)

Definition at line 86 of file login_plugin.cpp.

{}

plugin_startup()

void sysio::login_plugin::plugin_startup

(

)

Definition at line 75 of file login_plugin.cpp.

                                  {
   ilog("starting login_plugin");
   app().get_plugin<http_plugin>().add_api({
       CALL(start_login_request, 200), //
       CALL(finalize_login_request, 200),
       // CALL(do_not_use_gen_r1_key, 200),  //
       // CALL(do_not_use_sign, 200),        //
       // CALL(do_not_use_get_secret, 200),  //
   });
}

Here is the call graph for this function:

set_program_options()

void sysio::login_plugin::set_program_options ( options_description & , options_description & cfg )

overridevirtual

Implements appbase::abstract_plugin.

Definition at line 48 of file login_plugin.cpp.

                                                                                     {
   cfg.add_options() //
       ("max-login-requests", bpo::value<uint32_t>()->default_value(1000000),
        "The maximum number of pending login requests") //
       ("max-login-timeout", bpo::value<uint32_t>()->default_value(60),
        "The maximum timeout for pending login requests (in seconds)");
}

start_login_request()

login_plugin::start_login_request_results sysio::login_plugin::start_login_request

(

const start_login_request_params &

params

)

Definition at line 89 of file login_plugin.cpp.

                                                                                      {
   my->expire_requests();
   SYS_ASSERT(params.expiration_time > fc::time_point::now(), fc::timeout_exception,
              "Requested expiration time ${expiration_time} is in the past",
              ("expiration_time", params.expiration_time));
   SYS_ASSERT(my->requests.size() < my->max_login_requests, fc::timeout_exception, "Too many pending login requests");
   login_request request;
   request.server_ephemeral_priv_key = chain::private_key_type::generate_r1();
   request.server_ephemeral_pub_key = request.server_ephemeral_priv_key.get_public_key();
   request.expiration_time =
       std::min(params.expiration_time, fc::time_point_sec{fc::time_point::now()} + my->max_login_timeout);
   my->requests.insert(request);
   return {request.server_ephemeral_pub_key};
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• plugins/login_plugin/include/sysio/login_plugin/login_plugin.hpp
• plugins/login_plugin/login_plugin.cpp