nectarstorage package

Submodules

• nectarstorage.base module
  • InRamConfigurationStore
  • InRamEncryptedKeyStore
  • InRamEncryptedTokenStore
  • InRamPlainKeyStore
    • InRamPlainKeyStore.add()
    • InRamPlainKeyStore.delete()
    • InRamPlainKeyStore.getPrivateKeyForPublicKey()
    • InRamPlainKeyStore.getPublicKeys()
  • InRamPlainTokenStore
    • InRamPlainTokenStore.add()
    • InRamPlainTokenStore.delete()
    • InRamPlainTokenStore.getPrivateKeyForPublicKey()
    • InRamPlainTokenStore.getPublicNames()
  • KeyEncryption
    • KeyEncryption.add()
    • KeyEncryption.getPrivateKeyForPublicKey()
    • KeyEncryption.getPublicKeys()
    • KeyEncryption.is_encrypted()
  • SqliteConfigurationStore
  • SqliteEncryptedKeyStore
  • SqliteEncryptedTokenStore
  • SqlitePlainKeyStore
    • SqlitePlainKeyStore.add()
    • SqlitePlainKeyStore.delete()
    • SqlitePlainKeyStore.getPrivateKeyForPublicKey()
    • SqlitePlainKeyStore.getPublicKeys()
    • SqlitePlainKeyStore.is_encrypted()
  • SqlitePlainTokenStore
    • SqlitePlainTokenStore.add()
    • SqlitePlainTokenStore.delete()
    • SqlitePlainTokenStore.getPrivateKeyForPublicKey()
    • SqlitePlainTokenStore.getPublicNames()
    • SqlitePlainTokenStore.is_encrypted()
    • SqlitePlainTokenStore.updateToken()
  • TokenEncryption
    • TokenEncryption.add()
    • TokenEncryption.getPrivateKeyForPublicKey()
    • TokenEncryption.getPublicNames()
    • TokenEncryption.is_encrypted()
    • TokenEncryption.updateToken()
• nectarstorage.exceptions module
  • KeyAlreadyInStoreException
  • WalletLocked
  • WrongMasterPasswordException
• nectarstorage.interfaces module
  • ConfigInterface
  • EncryptedKeyInterface
    • EncryptedKeyInterface.is_encrypted()
    • EncryptedKeyInterface.lock()
    • EncryptedKeyInterface.locked()
    • EncryptedKeyInterface.unlock()
  • EncryptedTokenInterface
    • EncryptedTokenInterface.is_encrypted()
    • EncryptedTokenInterface.lock()
    • EncryptedTokenInterface.locked()
    • EncryptedTokenInterface.unlock()
  • KeyInterface
    • KeyInterface.add()
    • KeyInterface.delete()
    • KeyInterface.getPrivateKeyForPublicKey()
    • KeyInterface.getPublicKeys()
    • KeyInterface.is_encrypted()
  • StoreInterface
    • StoreInterface.defaults
    • StoreInterface.delete()
    • StoreInterface.get()
    • StoreInterface.items()
    • StoreInterface.setdefault()
    • StoreInterface.wipe()
  • TokenInterface
    • TokenInterface.add()
    • TokenInterface.delete()
    • TokenInterface.getPrivateKeyForPublicKey()
    • TokenInterface.getPublicNames()
    • TokenInterface.is_encrypted()
• nectarstorage.masterpassword module
  • MasterPassword
    • MasterPassword.changePassword()
    • MasterPassword.change_password()
    • MasterPassword.decrypt()
    • MasterPassword.decrypt_text()
    • MasterPassword.deriveChecksum()
    • MasterPassword.encrypt()
    • MasterPassword.encrypt_text()
    • MasterPassword.has_masterpassword()
    • MasterPassword.lock()
    • MasterPassword.locked()
    • MasterPassword.masterkey
    • MasterPassword.unlock()
    • MasterPassword.unlocked()
    • MasterPassword.wipe_masterpassword()
• nectarstorage.ram module
  • InRamStore
    • InRamStore.delete()
    • InRamStore.wipe()
• nectarstorage.sqlite module
  • SQLiteCommon
    • SQLiteCommon.sql_execute()
    • SQLiteCommon.sql_fetchall()
    • SQLiteCommon.sql_fetchone()
    • SQLiteCommon.sqlite_file
    • SQLiteCommon.use_memory
  • SQLiteFile
    • SQLiteFile.clean_data()
    • SQLiteFile.data_dir
    • SQLiteFile.recover_with_latest_backup()
    • SQLiteFile.refreshBackup()
    • SQLiteFile.sqlite3_backup()
    • SQLiteFile.sqlite3_copy()
    • SQLiteFile.sqlite_file
    • SQLiteFile.storageDatabase
    • SQLiteFile.use_memory
  • SQLiteStore
    • SQLiteStore.create()
    • SQLiteStore.delete()
    • SQLiteStore.exists()
    • SQLiteStore.get()
    • SQLiteStore.items()
    • SQLiteStore.keys()
    • SQLiteStore.wipe()

Module contents

class nectarstorage.InRamConfigurationStore(*_args, **_kwargs)

Bases: InRamStore, ConfigInterface

A simple example that stores configuration in RAM.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.ConfigInterface.

class nectarstorage.InRamEncryptedKeyStore(*args, **kwargs)

Bases: InRamStore, KeyEncryption

An in-RAM Store that stores keys encrypted in RAM.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.KeyInterface.

Note

This module also inherits nectarstorage.masterpassword.MasterPassword which offers additional methods and deals with encrypting the keys.

class nectarstorage.InRamEncryptedTokenStore(*args, **kwargs)

Bases: InRamStore, TokenEncryption

An in-RAM Store that stores token encrypted in RAM.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.TokenInterface.

Note

This module also inherits nectarstorage.masterpassword.MasterPassword which offers additional methods and deals with encrypting the keys.

class nectarstorage.InRamPlainKeyStore(*_args, **_kwargs)

Bases: InRamStore, KeyInterface

A simple in-RAM Store that stores keys unencrypted in RAM

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.KeyInterface.

add(wif, pub=None)

Add a new public/private key pair (correspondence has to be checked elsewhere!)

Parameters:

• pub (str) – Public key

• wif (str) – Private key

delete(key)

Delete a key from the store

getPrivateKeyForPublicKey(pub)

Returns the (possibly encrypted) private key that

corresponds to a public key

Parameters:

pub (str) – Public key

The encryption scheme is BIP38

getPublicKeys()

Returns the public keys stored in the database

class nectarstorage.InRamPlainTokenStore(*_args, **_kwargs)

Bases: InRamStore, TokenInterface

A simple in-RAM Store that stores token unencrypted in RAM

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.TokenInterface.

add(token, name=None)

Add a new token entry (correspondence has to be checked elsewhere!)

Parameters:

• name (str) – Public identifier

• token (str) – Token value

delete(key)

Delete a key from the store

getPrivateKeyForPublicKey(pub)

Returns the (possibly encrypted) token that corresponds to a name

Parameters:

pub (str) – Public key

The encryption scheme is BIP38

getPublicNames()

Returns the public token names stored in the database

class nectarstorage.SQLiteCommon

Bases: object

This class abstracts away common sqlite3 operations.

This class should not be used directly.

When inheriting from this class, the following instance members must be defined:

• sqlite_file: Path to the SQLite Database file

sql_execute(query: Tuple[str, Tuple], lastid: bool = False) → int | None

sql_fetchall(query: Tuple[str, Tuple]) → list

sql_fetchone(query: Tuple[str, Tuple]) → Tuple | None

sqlite_file: Path | str

use_memory: bool

class nectarstorage.SQLiteFile(*args: Any, **kwargs: Any)

Bases: object

This class ensures that the user’s data is stored in its OS preotected user directory:

OSX:

• ~/Library/Application Support/<AppName>

Windows:

• C:Documents and Settings<User>Application DataLocal Settings<AppAuthor><AppName>

• C:Documents and Settings<User>Application Data<AppAuthor><AppName>

Linux:

• ~/.local/share/<AppName>

Furthermore, it offers an interface to generated backups in the backups/ directory every now and then.

Note

The file name can be overwritten when providing a keyword argument profile.

clean_data(backupdir: str | Path = 'backups') → None

Delete files older than 70 days

data_dir: Path

recover_with_latest_backup(backupdir: str | Path = 'backups') → None

Replace database with latest backup

refreshBackup() → None

Make a new backup

sqlite3_backup(backupdir: str | Path) → None

Create timestamped database copy

sqlite3_copy(src: Path | str, dst: Path | str) → None

Copy sql file from src to dst

sqlite_file: Path | str

storageDatabase: str

use_memory: bool

class nectarstorage.SqliteConfigurationStore(*args, **kwargs)

Bases: SQLiteStore, ConfigInterface

This is the configuration storage that stores key/value pairs in the config table of the SQLite3 database.

Internally, this works by simply inheriting nectarstorage.sqlite.SQLiteStore. The interface is defined in nectarstorage.interfaces.ConfigInterface.

class nectarstorage.SqliteEncryptedKeyStore(*args, **kwargs)

Bases: SQLiteStore, KeyEncryption

This is the key storage that stores the public key and the encrypted private key in the keys table in the SQLite3 database.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.KeyInterface.

Note

This module also inherits nectarstorage.masterpassword.MasterPassword which offers additional methods and deals with encrypting the keys.

class nectarstorage.SqliteEncryptedTokenStore(*args, **kwargs)

Bases: SQLiteStore, TokenEncryption

This is the key storage that stores the account name and the encrypted token in the token table in the SQLite3 database.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.TokenInterface.

Note

This module also inherits nectarstorage.masterpassword.MasterPassword which offers additional methods and deals with encrypting the token.

class nectarstorage.SqlitePlainKeyStore(*args, **kwargs)

Bases: SQLiteStore, KeyInterface

This is the key storage that stores the public key and the unencrypted private key in the keys table in the SQLite3 database.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.KeyInterface.

add(wif, pub=None)

Add a new public/private key pair (correspondence has to be checked elsewhere!)

Parameters:

• pub (str) – Public key

• wif (str) – Private key

delete(key)

Delete a key from the store

Parameters:

value (str) – Value

getPrivateKeyForPublicKey(pub)

Returns the (possibly encrypted) private key that

corresponds to a public key

Parameters:

pub (str) – Public key

The encryption scheme is BIP38

getPublicKeys()

Returns the public keys stored in the database

is_encrypted()

Returns False, as we are not encrypted here

class nectarstorage.SqlitePlainTokenStore(*args, **kwargs)

Bases: SQLiteStore, TokenInterface

This is the token storage that stores the public key and the unencrypted private key in the tokens table in the SQLite3 database.

Internally, this works by simply inheriting nectarstorage.ram.InRamStore. The interface is defined in nectarstorage.interfaces.TokenInterface.

add(token, name=None)

Add a new token entry (correspondence has to be checked elsewhere!)

Parameters:

• name (str) – Public identifier

• token (str) – Token value

delete(key)

Delete a key from the store

Parameters:

value (str) – Value

getPrivateKeyForPublicKey(pub)

Returns the (possibly encrypted) token that corresponds to a name

Parameters:

pub (str) – Public key

The encryption scheme is BIP38

getPublicNames()

Returns the public token names stored in the database

is_encrypted()

Returns False, as we are not encrypted here

updateToken(name, token)