Class: SafeDb::Indices

Inherits:

Object

Object
SafeDb::Indices

Defined in:: lib/model/indices.rb

Overview

Indices are key/value pairs that serve within the safe database index files for denoting, pinpointing, writing and retrieving data values as well as for naming of files folders and other artifacts.

Constant Summary collapse

COMMANDER = The command used to invoke the safe database

"safe"

SAFE_URL_NAME = The short url name of the safe personal database.

"safedb.net"

SAFE_APP_NAME = The name of the safe application and the safe gem as known by the operating system.

"safedb"

SAFE_BOOK_ID_LENGTH = The desired length of a safe book ergonomic identifier.

SAFE_DATABASE_FOLDER = The file-system location of the safe database tree

File.join( File.join( Dir.home, ".config" ), SAFE_APP_NAME )

SAFE_GEM_WEBSITE = The fully qualified domain name of the safedb home website

"https://www.#{SAFE_URL_NAME}"

SAFE_GITHUB_URL = The safe database github clonable url for the ruby software

"https://github.com/devops4me/#{SAFE_URL_NAME}"

MASTER_CRYPTS_FOLDER_NAME = The name of the master crypts folder.

"safedb-master-crypts"

MASTER_CRYPTS_FOLDER_PATH = The path to the master crypts folder.

File.join( SAFE_DATABASE_FOLDER, MASTER_CRYPTS_FOLDER_NAME )

MASTER_CRYPTS_GIT_PATH = The path to the master crypts .git directory.

File.join( MASTER_CRYPTS_FOLDER_PATH, ".git" )

MASTER_INDICES_FILE_NAME = The master indices file name

"safedb-master-keys.ini"

MASTER_INDICES_FILEPATH = The path to the master indices file

File.join( MASTER_CRYPTS_FOLDER_PATH, MASTER_INDICES_FILE_NAME )

BACKUP_CRYPTS_FOLDER_NAME = The name of the backup master crypts folder.

"safedb-backup-crypts"

BACKUP_CRYPTS_FOLDER_PATH = The path of the backup master crypts folder.

File.join( SAFE_DATABASE_FOLDER, BACKUP_CRYPTS_FOLDER_NAME )

BRANCH_INDICES_FOLDER_NAME = The name of the branch indices folder.

"safedb-branch-keys"

BRANCH_INDICES_FOLDER_PATH = The path to the branch indices folder.

File.join( SAFE_DATABASE_FOLDER, BRANCH_INDICES_FOLDER_NAME )

BRANCH_CRYPTS_FOLDER_NAME = The name of the branch crypts folder.

"safedb-branch-crypts"

BRANCH_CRYPTS_FOLDER_PATH = The path to the branch crypts folder.

File.join( SAFE_DATABASE_FOLDER, BRANCH_CRYPTS_FOLDER_NAME )

MACHINE_CONFIG_FILEPATH = The path to the remote storage configuration INI file

File.join( SAFE_DATABASE_FOLDER, "safedb-remote-storage.ini" )

MACHINE_REMOVABLE_DRIVE_PATH = The name of the machine removable drive path location directive

"removable.drive"

GIT_CLONE_BASE_PATH = The keyname whose value denotes a local folder path to clone to

"git.clone.base.path"

REMOTE_MIRROR_SECTION_NAME = The name of the keys section that holds remote mirror properties

"remote.mirror"

REMOTE_MIRROR_PAGE_NAME = The name of the property that points to the book/chapter/verse (page)

"remote.mirror.page"

REMOTE_MIRROR_PRIVATE_KEY_POSTFIX = The ending of the private key filename for remote mirror push access

"private-key.pem"

REMOTE_PRIVATE_KEY_KEYNAME = The key name that holds the remote mirror private key filename

"private.key.filename"

REMOTE_MIRROR_SSH_HOST_KEYNAME = The key name that holds the remote mirror ssh config host value

"ssh.config.host"

SSH_DIRECTORY_PATH = The path to the SSH directory

File.join( Dir.home(), ".ssh" )

SSH_CONFIG_FILE_PATH = The path to the SSH config file

File.join( SSH_DIRECTORY_PATH, "config" )

GITHUB_ACCESS_TOKEN = This access token allows us to talk to the Github API

"@github.access.token"

GIT_REPOSITORY_NAME_KEYNAME = Github repository keyname

"repository.name"

GIT_REPOSITORY_USER_KEYNAME = Github Username Keyname

"repository.user"

GIT_REPOSITORY_HOST_KEYNAME = Github Host Keyname

"repository.host"

REMOTE_LAST_PUSH_ON = Keyname for when the last backend push occured

"last.push.on"

REMOTE_LAST_PUSH_BY = Keyname for the user and hostname that evoked the last push

"last.push.by"

REMOTE_LAST_PUSH_ID = Keyname for the ID of the last push (Usually Git Commit Reference)

"last.push.id"

PRIVATE_KEY_DEFAULT_KEY_NAME = Private Key Default Key Name

"private.key"

PUBLIC_KEY_DEFAULT_KEY_NAME = Public Key Default Key Name

"public.key"

CONFIGURE_BACKEND_KEY_NAME = The parameter key name to configure the backend coordinates

"backend"

REMOTE_DATABASE_GIT_PULL_URL = The name of the remote database git pull url key

"git.pull.url"

REMOTE_DATABASE_GIT_PUSH_URL = The name of the remote database git push url key

"git.push.url"

CONTENT_ID_LENGTH = The desired length of a content identifier

CONTENT_IDENTIFIER = Content identifiers act to name chapter and/or index database files.

"content.id"

CONTENT_RANDOM_IV = The AES symmetric encryption initialization vector

"content.iv"

COMMIT_IDENTIFIER = The commit identifiers of the master and branch are compared to ascertain eligibility for commits

"commit.identifier"

BOOTUP_IDENTIFIER = The bootup id is set on machine boot and lasts until the reboot or shutdown.

"bootup.identifier"

CRYPT_CIPHER_TEXT = The key ciphertext that sits against the trio of either master, branch or chapter

"crypt.cipher"

BRANCH_DATA = This is the global section header of the branch book index file

"branch.data"

BRANCH_INITIAL_LOGIN_TIME = The time of the first book login within this shell

"branch.initial.login.time"

BRANCH_LAST_ACCESSED_TIME = The most recent time that any book of this branch was accessed

"branch.last.accessed.time"

CURRENT_BRANCH_BOOK_ID = The ID of the book being currently used by this branch

"current.branch.book.id"

BOOK_BRANCH_LOGIN_TIME = The time this book was first logged into during this branch

"book.branch.login.time"

BOOK_LAST_ACCESSED_TIME = The time this book was last accessed during this branch

"book.last.accessed.time"

CONTENT_BLOCK_START_STRING = The start of the content block laid out in a crypt file

"0123456789abcdef0123456789abcdef0123456789abcdef0123456789ab\n"

CONTENT_BLOCK_END_STRING = The end of the content block laid out in a crypt file

"ba9876543210fedcba9876543210fedcba9876543210fedcba9876543210\n"

CONTENT_BLOCK_DELIMITER = The delimeter used to separate headers from ciphertext in a crypt file

"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n"

TOKEN_VARIABLE_NAME = The name of the safe tty token environment variable

"SAFE_TTY_TOKEN"

TOKEN_VARIABLE_SIZE = The expected length of the tty token environment variable

SECRET_MASK_STRING = Character (randomly) repeated to mask credentials Asterices, hyphens, plus and equal signs are common alternatives.

"*" * rand( 18 .. 30 )

SAFE_BOOK_INITIALIZE_TIME = The birthday (initialization time) of this safe book.

"book.init.time"

SAFE_BOOK_NAME = The name of this safe book.

"book.name"

SAFE_BOOK_INIT_VERSION = The application version that oversaw this book’s initialization.

"book.init.version"

SAFE_BOOK_CURRENT_VERSION = The application version that oversaw this book’s initialization.

"book.current.version"

SAFE_BOOK_CHAPTER_KEYS = The handle to the chapter keys inside the book index.

"book.chapter.keys"

OPENED_CHAPTER_NAME = The opened chapter id/name in the current book

"book.open.chapter"

OPENED_VERSE_NAME = The opened verse id/name in the current book

"book.open.verse"

SAFE_PRE_VERSION_STRING = The application version that oversaw this book’s initialization.

"safedb-v"

INGESTED_FILE_LINE_NAME_KEY = Handle to the key name of the ingested file in the submap verse

"safedb.file::"

INGESTED_FILE_CONTENT64_KEY = Handle to the file base64 content within the submap verse

"file.content"

INGESTED_FILE_BASE_NAME_KEY = Handle to the simple name of the ingested file in the submap verse

"file.name"

FILE_CHMOD_PERMISSIONS_KEY = The permission setting (chmod) key name

"file.access"

PRIVATE_KEY_PREFIX = The keypair name prefix for private keys.

"private.key"

PUBLIC_KEY_PREFIX = The keypair name prefix for public keys.

"public.key"

ELLIPTIC_CURVE_KEY_TYPE = Elliptic Curve SSL Key Type

"secp384r1"

NOTHING_TO_OBLITERATE = ##################################### ### Strings printed to the user interface ### ##################################### ###

"There is nothing to obliterate."