Data Face
\nData Service
\nKeys Face
\nKey Service
\nBase Face with neutral common registration functionality\nNot official API.
\nBase Service with common registration logic
\nAES plugin
\nHKDF plugin
\nHMAC plugin
\nPassword plugin
\nAllows passwords from 4 to 255 unicode characters in length.\nSupports custom characters set through options.chars.
\nSupports secure password verification.
\nPBKDF2 plugin
\nRSA plugin
\nBase for SecVault plugins
\nStorage wapper with advanced caching & invalidation
\nDatabase Encrypted secret storage
\nEncrypted secret storage base
\nAssume there is
\nSealed key info
\nSQL secret storage
\nSecret storage base
\nBaseFace](#BaseFace) \n\n\n### BaseFace.PING\\_VERSION\nLatest supported FTN4 version\n\n**Kind**: static property of [BaseFace](#BaseFace) \n\n\n### BaseFace.register(as, ccm, name, endpoint, [credentials], [options])\nCCM registration helper\n\n**Kind**: static method of [BaseFace](#BaseFace) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| as | AsyncSteps | | steps interface |\n| ccm | AdvancedCCM | | CCM instance |\n| name | string | | CCM registration name |\n| endpoint | any | | see AdvancedCCM#register |\n| [credentials] | any | object | | interface options |\n| [options.version] | string | | interface version to use |\n\n\n\n## BaseService\nBase Service with common registration logic\n\n**Kind**: global class \n\n* [BaseService](#BaseService)\n * [new BaseService(storage, options)](#new_BaseService_new)\n * [.register(as, executor, storage, options)](#BaseService.register) ⇒ LimitsService\n\n\n\n### new BaseService(storage, options)\nC-tor\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| storage | [Storage](#Storage) | low-level storage instance |\n| options | object | passed to superclass c-tor |\n| [options.failure_limit] | number | limit crypt key decrypt failures, integer |\n\n\n\n### BaseService.register(as, executor, storage, options) ⇒ LimitsService\nRegister futoin.xfers.limits interface with Executor\n\n**Kind**: static method of [BaseService](#BaseService) \n**Returns**: LimitsService - instance \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | steps interface |\n| executor | Executor | executor instance |\n| storage | [Storage](#Storage) | low-level storage instance |\n| options | object | implementation defined options |\n\n\n\n## AESPlugin\nAES plugin\n\n**Kind**: global class \n\n\n### AESPlugin.register()\nRegister this plugin\n\n**Kind**: static method of [AESPlugin](#AESPlugin) \n\n\n## HKDFPlugin\nHKDF plugin\n\n**Kind**: global class \n\n\n### HKDFPlugin.register()\nRegister this plugin\n\n**Kind**: static method of [HKDFPlugin](#HKDFPlugin) \n\n\n## HMACPlugin\nHMAC plugin\n\n**Kind**: global class \n\n\n### HMACPlugin.register()\nRegister this plugin\n\n**Kind**: static method of [HMACPlugin](#HMACPlugin) \n\n\n## PasswordPlugin\nPassword plugin\n\nAllows passwords from 4 to 255 unicode characters in length.\nSupports custom characters set through options.chars.\n\nSupports secure password verification.\n\n**Kind**: global class \n\n\n### PasswordPlugin.register()\nRegister this plugin\n\n**Kind**: static method of [PasswordPlugin](#PasswordPlugin) \n\n\n## PBKDF2Plugin\nPBKDF2 plugin\n\n**Kind**: global class \n\n\n### PBKDF2Plugin.register()\nRegister this plugin\n\n**Kind**: static method of [PBKDF2Plugin](#PBKDF2Plugin) \n\n\n## RSAPlugin\nRSA plugin\n\n**Kind**: global class \n\n\n### RSAPlugin.register()\nRegister this plugin\n\n**Kind**: static method of [RSAPlugin](#RSAPlugin) \n\n\n## VaultPlugin\nBase for SecVault plugins\n\n**Kind**: global class \n\n* [VaultPlugin](#VaultPlugin)\n * _instance_\n * [.defaultBits()](#VaultPlugin+defaultBits)\n * [.isAsymetric()](#VaultPlugin+isAsymetric) ⇒ boolean\n * [.generate(as, options)](#VaultPlugin+generate)\n * [.validateKey(as, key)](#VaultPlugin+validateKey)\n * [.derive(as, base, bits, hash, options)](#VaultPlugin+derive)\n * [.pubkey(as, key, options)](#VaultPlugin+pubkey)\n * [.encrypt(as, key, data, options)](#VaultPlugin+encrypt)\n * [.decrypt(as, key, edata, options)](#VaultPlugin+decrypt)\n * [.sign(as, key, data, options)](#VaultPlugin+sign)\n * [.verify(as, key, edata, sig, options)](#VaultPlugin+verify)\n * [.random(as, size)](#VaultPlugin+random)\n * _static_\n * [.registerPlugin(name, impl)](#VaultPlugin.registerPlugin)\n * [.getPlugin(name)](#VaultPlugin.getPlugin) ⇒ [VaultPlugin](#VaultPlugin)\n\n\n\n### vaultPlugin.defaultBits()\nDefault bits to use, if applicable\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n\n### vaultPlugin.isAsymetric() ⇒ boolean\nCheck if type conforms to asymmetric cryptography requirements\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n**Returns**: boolean - true, if assymetric \n\n\n### vaultPlugin.generate(as, options)\nGenerate new key\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| options | object | implementation-defined options |\n| options.bits | number | key length, if applicable Passes raw key buffer to the next step |\n\n\n\n### vaultPlugin.validateKey(as, key)\nValidate key data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | key data to validate |\n\n\n\n### vaultPlugin.derive(as, base, bits, hash, options)\nDerive new key\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| base | Buffer | base key as is |\n| bits | number | key length |\n| hash | string | hash name to use |\n| options | object | implementation-defined options |\n| [options.salt] | string | salt, if any |\n| [options.info] | string | info, if any |\n| [options.rounds] | number | rounds, if any Passes raw key buffer to the next step |\n\n\n\n### vaultPlugin.pubkey(as, key, options)\nGet public key from private key\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | raw private key |\n| options | object | implementation-defined options Passes raw key buffer to the next step |\n\n\n\n### vaultPlugin.encrypt(as, key, data, options)\nEncrypt arbitrary data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | raw key |\n| data | Buffer | raw data |\n| options | object | implementation-defined options |\n| [options.iv] | Buffer | custom IV, if needed |\n| [options.aad] | Buffer | additional data, if supported Passes Buffer { edata | iv | authtag } to the next step |\n\n\n\n### vaultPlugin.decrypt(as, key, edata, options)\nDecrypt arbitrary data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | raw key |\n| edata | object | encrypted data as generated by encrypt |\n| options | object | implementation-defined options |\n| options.aad | string | additional authentication data, if applicable Passes Buffer of raw data to the next step |\n\n\n\n### vaultPlugin.sign(as, key, data, options)\nEncrypt arbitrary data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | raw key |\n| data | Buffer | raw data |\n| options | object | implementation-defined options |\n| options.hash | string | hash name, if applicable Passes Buffer { sig } to the next step |\n\n\n\n### vaultPlugin.verify(as, key, edata, sig, options)\nDecrypt arbitrary data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| key | Buffer | raw key |\n| edata | object | encrypted data as generated by encrypt |\n| sig | Buffer | signature to verify |\n| options | object | implementation-defined options |\n| options.hash | string | hash name, if applicable Passes Buffer of raw data to the next step |\n\n\n\n### vaultPlugin.random(as, size)\nCommon API to generate random data\n\n**Kind**: instance method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| size | number | how many bytes to generate Passes Buffer of random data to the next step |\n\n\n\n### VaultPlugin.registerPlugin(name, impl)\nRegister plugin\n\n**Kind**: static method of [VaultPlugin](#VaultPlugin) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | string | plugin identifier |\n| impl | [VaultPlugin](#VaultPlugin) | plugin implementation |\n\n\n\n### VaultPlugin.getPlugin(name) ⇒ [VaultPlugin](#VaultPlugin)\nGet plugin by name\n\n**Kind**: static method of [VaultPlugin](#VaultPlugin) \n**Returns**: [VaultPlugin](#VaultPlugin) - plugin instance \n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | string | plugin identifier |\n\n\n\n## CachedStorageWrapper\nStorage wapper with advanced caching & invalidation\n\n**Kind**: global class \n\n\n### new CachedStorageWrapper(ccm, target, options)\nC-tor\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| ccm | AdvancedCCM | CCM instance |\n| target | [Storage](#Storage) | target slow storage |\n| options | object | extra options for fine tune |\n| options.evtpushExecutor | object | executor instace with PushService |\n| [options.cacheSize] | number | max cache entries |\n| [options.ttlMs] | number | Cache Time-To-Live in ms |\n| [options.syncDelayMs] | number | Cache Sync delay in ms |\n| [options.syncThreads] | number | Cache Sync parallelism |\n\n\n\n## DBStorage\nDatabase Encrypted secret storage\n\n**Kind**: global class \n\n\n## EncryptedStorage\nEncrypted secret storage base\n\nAssume there is\n\n**Kind**: global class \n\n* [EncryptedStorage](#EncryptedStorage)\n * [.setStorageSecret(as, secret, [cipher_opts], [kdf_opts])](#EncryptedStorage+setStorageSecret)\n * [.isLocked()](#EncryptedStorage+isLocked) ⇒ boolean\n\n\n\n### encryptedStorage.setStorageSecret(as, secret, [cipher_opts], [kdf_opts])\nConfigure common storage secret which is used to encrypt keys\n\n**Kind**: instance method of [EncryptedStorage](#EncryptedStorage) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| as | AsyncSteps | AsyncSteps interface |\n| secret | Buffer | some arbitrary secret |\n| [cipher_opts] | object | options for encryption/decryption |\n| [cipher_opts.type] | string | cipher type |\n| [cipher_opts.bits] | number | key length for KDF |\n| [cipher_opts.mode] | string | cipher block mode |\n| [cipher_opts.aad] | string | additional auth data |\n| [kdf_opts] | object \\| null | KDF options, null to disable |\n| [kdf_opts.type] | string | KDF type |\n| [kdf_opts.salt] | string | KDF salt |\n| [kdf_opts.info] | string | info parameter for HKDF |\n| [kdf_opts.rounds] | string | rounds for PBKDF2 |\n\n\n\n### encryptedStorage.isLocked() ⇒ boolean\nCheck if storage is locked\n\n**Kind**: instance method of [EncryptedStorage](#EncryptedStorage) \n**Returns**: boolean - true, if locked \n\n\n## KeyInfo\nSealed key info\n\n**Kind**: global class \n\n\n### new KeyInfo([info])\nC-tor\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| [info] | object | optional default values |\n\n\n\n## SQLStorage\nSQL secret storage\n\n**Kind**: global class \n\n\n### new SQLStorage(ccm, options)\nC-tor\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| ccm | AdvancedCCM | CCM instance with registered 'secvault' DB |\n| options | object | options |\n| [options.key_table] | string | name of encrypted key table |\n\n\n\n## Storage\nSecret storage base\n\n**Kind**: global class \n\n","readmeFilename":"README.md"}