StoredConfiguration module

class StoredConfiguration.StoredConfiguration(config_directory=None, logger=None, encrypter=None, configuration_file=None, store_dir=None, peer_id=None, peer_dict=None, store_id=None, store_dict=None, encryption_key=None, merkle_tree=None)

Contains configuration data which must be preserved across executions of StrongBox, and therefore is saved to storage. To maintain consistency and since such writes to storage can be time consuming, this class’s interface promotes batching small mutations together cohesively. Also note that StrongBox is (currently) set up so only one thread accesses this data at a time, therefore no access synchronization is attempted.

class StoredConfiguration_NamedTuple

Bases: StoredConfiguration._StoredConfiguration_NamedTuple

A class wrapper for _StoredConfiguration_NamedTuple. A _StoredConfiguration_NamedTuple contains only the configuration data from a StoredConfiguration object that should actually be saved to storage (e.g. not the encrypter attribute). Using a named tuple allows us to pickle/unpickle and save/load the data with explicit constraints on the order and number of attributes expected. This should help catch potential saving and loading errors as we evolve the StoredConfiguration class and its attribute list.

static StoredConfiguration.from_tuple(config_directory, logger, encrypter, stored_configuration_tuple)

static StoredConfiguration.get_configuration_file(config_directory)

StoredConfiguration.get_revision_data(peer_id, store_id)

A convenience function for retrieving a given peer’s revision data for a given store.

StoredConfiguration.gt_revision_data(store_id, revision_data_1, revision_data_2)

A revision is considered greater than another if its signature is valid and either the other’s signature is not, or the other revision is numbered lower.

StoredConfiguration.learn_peer_gossip(gossip_peer_id, gossip_peer_dict)

Update our knowledge of peers based on gossip from another peer.

static StoredConfiguration.load_configuration_file(config_directory, logger, encrypter)

static StoredConfiguration.load_stored_configuration(logger, encrypter, config_directory)

Attempt to load a previously stored configuration file, instead trying the backup copy if necessary.

Returns:A StoredConfiguration object or None if neither file could be loaded.

StoredConfiguration.record_peer_data(peer_id, peer_data)

Record data on a new peer or update existing information on a known peer in our stored configuration data. Also, accordingly make any necessary updates to our recorded store-peer associations.

StoredConfiguration.save_to_file(configuration_file=None)

StoredConfiguration.store_delete_item(store_id, item_relative_path)

Delete a file or directory from a locally held store (either the user’s or a backup of another user’s store).

StoredConfiguration.store_get_item_contents(store_id, item_relative_path)

Get the contents of a file (or return None for a directory) in preparation for transmission, decrypting on-the-fly if the item originates from the user’s store.

StoredConfiguration.store_put_item(store_id, item_relative_path, file_contents=None)

Save a new directory or file, or update a file within a locally held store (either the user’s own store or the backup of another store).

StoredConfiguration.to_tuple()

StoredConfiguration.update_network_address()

Update this peer’s already existing IP address data.

StoredConfiguration.update_peer_revision(peer_id, store_id, invalid=False)

After sending a peer synchronization data and verifying their store contents, update our recording of their revision for the store in question to match our own.

StoredConfiguration.update_store_revision(store_id, revision_data, lock=None)

Increment the revision number and recalculate the corresponding hash and revision signature for the current state of the user’s store.