fc::crypto::private_key Class Reference

#include <private_key.hpp>

Public Types
using	storage_type = std::variant<ecc::private_key_shim, r1::private_key_shim, em::private_key_shim>

Public Member Functions
	private_key ()=default
	private_key (private_key &&)=default
	private_key (const private_key &)=default
private_key &	operator= (const private_key &)=default
public_key	get_public_key () const
signature	sign (const sha256 &digest, bool require_canonical=true) const
sha512	generate_shared_secret (const public_key &pub) const
	private_key (const string &base58str)
std::string	to_string (const fc::yield_function_t &yield=fc::yield_function_t()) const

Static Public Member Functions
template<typename KeyType = ecc::private_key_shim>
static private_key	generate ()
template<typename KeyType = r1::private_key_shim>
static private_key	generate_r1 ()
template<typename KeyType = ecc::private_key_shim>
static private_key	regenerate (const typename KeyType::data_type &data)

Friends
struct	reflector< private_key >
bool	operator== (const private_key &p1, const private_key &p2)
bool	operator!= (const private_key &p1, const private_key &p2)
bool	operator< (const private_key &p1, const private_key &p2)

Detailed Description

Definition at line 21 of file private_key.hpp.

Member Typedef Documentation

storage_type

using fc::crypto::private_key::storage_type = std::variant<ecc::private_key_shim, r1::private_key_shim, em::private_key_shim>

Definition at line 24 of file private_key.hpp.

Constructor & Destructor Documentation

private_key() [1/4]

fc::crypto::private_key::private_key ( )

default

Here is the caller graph for this function:

private_key() [2/4]

fc::crypto::private_key::private_key ( private_key && )

default

private_key() [3/4]

fc::crypto::private_key::private_key ( const private_key & )

default

private_key() [4/4]

fc::crypto::private_key::private_key ( const string & base58str )

explicit

Definition at line 110 of file private_key.cpp.

   :_storage(priv_parse_base58(base58str))
   {}

Member Function Documentation

generate()

template<typename KeyType = ecc::private_key_shim>

static private_key fc::crypto::private_key::generate ( )

inlinestatic

Definition at line 36 of file private_key.hpp.

                                       {
            return private_key(storage_type(KeyType::generate()));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

generate_r1()

template<typename KeyType = r1::private_key_shim>

static private_key fc::crypto::private_key::generate_r1 ( )

inlinestatic

Definition at line 41 of file private_key.hpp.

                                          {
            return private_key(storage_type(KeyType::generate()));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

generate_shared_secret()

sha512 fc::crypto::private_key::generate_shared_secret

(

const public_key &

pub

)

const

Definition at line 57 of file private_key.cpp.

   {
      return std::visit(generate_shared_secret_visitor(pub._storage), _storage);
   }

get_public_key()

public_key fc::crypto::private_key::get_public_key

(

)

const

Definition at line 16 of file private_key.cpp.

   {
      return public_key(std::visit(public_key_visitor(), _storage));
   }

Here is the caller graph for this function:

operator=()

private_key & fc::crypto::private_key::operator= ( const private_key & )

default

regenerate()

template<typename KeyType = ecc::private_key_shim>

static private_key fc::crypto::private_key::regenerate ( const typename KeyType::data_type & data )

inlinestatic

Definition at line 46 of file private_key.hpp.

                                                                                {
            return private_key(storage_type(KeyType(data)));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

sign()

signature fc::crypto::private_key::sign	(	const sha256 &	digest,
		bool	require_canonical = true ) const

Definition at line 37 of file private_key.cpp.

   {
      return signature(std::visit(sign_visitor(digest, require_canonical), _storage));
   }

Here is the call graph for this function:

to_string()

std::string fc::crypto::private_key::to_string

(

const fc::yield_function_t &

yield = fc::yield_function_t()

)

const

Definition at line 114 of file private_key.cpp.

   {
      auto which = _storage.index();
 
      if (which == 0) {
         using default_type = std::variant_alternative_t<0, private_key::storage_type>;
         return to_wif(std::template get<default_type>(_storage), yield);
      }
 
      auto data_str = std::visit(base58str_visitor<storage_type, config::private_key_prefix>(yield), _storage);
      return std::string(config::private_key_base_prefix) + "_" + data_str;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const private_key & p1, const private_key & p2 )

friend

operator<

bool operator< ( const private_key & p1, const private_key & p2 )

friend

Definition at line 136 of file private_key.cpp.

   {
      return less_comparator<private_key::storage_type>::apply(p1._storage, p2._storage);
   }

operator==

bool operator== ( const private_key & p1, const private_key & p2 )

friend

Definition at line 132 of file private_key.cpp.

                                                                    {
      return eq_comparator<private_key::storage_type>::apply(p1._storage, p2._storage);
   }

reflector< private_key >

friend struct reflector< private_key >

friend

Definition at line 63 of file private_key.hpp.

---

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

• libraries/fc/include/fc/crypto/private_key.hpp
• libraries/fc/src/crypto/private_key.cpp