core package

Submodules

core.cipherfactory module

class core.cipherfactory.CipherFactory

Bases: object

Factory wrapper for dispatching appropriate cipher-based encryptor/decryptor

create_vault()

Vault creation helper method

property decryptor

Returns a decryptor instance

property encryptor

Returns an encryptor instance

is_requested(operation)

load_cmd_cfg(parse_obj: argparse.Namespace)

Maintains command line arguments

load_param_cfg(config_obj: core.config.CipherConfig)

Maintains yaml config arguments

update_cfg_file()

Flushes new content into the config file

core.collection module

class core.collection.Collection

Bases: object

Houses a collection of records

add_record(rcrd: core.record.Record)

Helper for record insertion

Parameters

record – The record object to insert

:type Record

del_record(record_id)

Helper for record deletion

Parameters

record_id – The identifier of the record to delete

:type int

display(mode='table', indent=1)

Helper for displaying a collection

get_collection(enc: ciphers.cipher.Encryptor)

get_record(record_id: int)

load_vault(vault_content: str, dec: ciphers.cipher.Decryptor)

modify_field(record_id, field, val)

Helper for field modification within a record

Parameters

record_id – The identifier of the record to delete

:type int

Parameters

field – The field name within the record

:type str

Parameters

value – The value of corresponding field

:type str

modify_record(record_id, record)

Helper for record modification

Parameters

record_id – The identifier of the record to delete

:type int

Parameters

record – The record object with modification

:type Record

core.config module

class core.config.CipherConfig

Bases: object

Wrapper for handling yaml-based parameter configs

load(cfg_path)

Template method for loading yaml file

:returns config object associated with cfg_path :returntype dict

property overwrite

store(cfg_filename, cfg_dirname, **config)

Template method for dumping config into yaml file

core.model module

class core.model.Model(model, is_path=False)

Bases: object

Represents a data model for a credential record

get_fields()

load()

Loads model from schema file

store()

validate_record(content: dict)

Validator method for a given record

:param record content :returntype bool

core.parser module

class core.parser.CLIParser(*args, **kwargs)

Bases: argparse.ArgumentParser

Exposes options passed as arguments to sec-vault

parse_args(args=None, namespace=None)

core.record module

class core.record.Record(model_type: str)

Bases: object

Wrapper for an individual record maintained in the vault file

create_interactive()

Populates record content interactively via end user

display(mode='table', indent=1)

Displays contents of a record

Parameters

mode (str (json, yaml, table)) – The display format

load(content: dict)

Populates record content from existing data

Parameters

content (dict) – Indexed record contents

modify_field(key: str, val: str)

Modifies content of the given field

:param key :type key: str

:param val :type val: str

core.util module

class core.util.CollectionMeta(*args, **kwargs)

Bases: type

Metaclass for accrual of supported suites and models

property cipher_suites

property model_collection

class core.util.Schema(*args, **kwargs)

Bases: type

Metaclass for reserving the schema blueprint

property field_template

property model_template

core.util.copy(src: str, dst: str)

core.util.get_abs_path(relative_path)

Abstracts absolute path

Parameters

relative_path (str) – The current path relative to a reference

Return type

str

core.util.get_models_path()

core.util.is_valid_dir(abs_path)

core.util.is_valid_file(abs_path)

core.util.is_valid_suite(suite_name: str)

Cipher suite validity checker

Parameters

suite_name (str) – Name of the cipher suite

Return type

bool

core.util.join_path(parent_path, relative_path)

Abstracts file path concatenation

Parameters

• parent_path (str) – The path housing the relative path

• relative_path (str) – The current path referenced from the base location

Return type

str

core.util.safe_write(directory, name, content, overwrite=False)

Writes content in a temporary location and renames/overwrites the file accordingly

Parameters

• directory (str) – The dir hosting the final file

• name (str) – propogated name of the regular file

• content (str) – Data to be written onto the file

• overwrite (bool) – Overwrite file if existing

core.util.valid_encr_attr(attr)

Filter for arg_param attributes for a cipher suite

Parameters

attr (str) – Argument field to be validated for a given cipher

Return type

bool

core.view module

class core.view.View

Bases: object

Wrapper for the stdout messages directed to the end-user

print(*args, **kwargs)

prompt_read(field)

tabulate(*args)

Module contents