SecureBlackbox 2020 PHP Edition

Questions / Feedback?

PasswordVault Class

Properties   Methods   Events   Configuration Settings   Errors  

The PasswordVault class implements a vault for keeping passwords and other sensitive properties.

Class Name

SecureBlackbox_PasswordVault

Procedural Interface

 secureblackbox_passwordvault_open();
 secureblackbox_passwordvault_close($res);
 secureblackbox_passwordvault_register_callback($res, $id, $function);
 secureblackbox_passwordvault_get_last_error($res);
 secureblackbox_passwordvault_get_last_error_code($res);
 secureblackbox_passwordvault_set($res, $id, $index, $value);
 secureblackbox_passwordvault_get($res, $id, $index);
 secureblackbox_passwordvault_do_addentry($res, $entryname);
 secureblackbox_passwordvault_do_changeentrykey($res, $entryname, $newkey);
 secureblackbox_passwordvault_do_changeentrypassword($res, $entryname, $newpassword);
 secureblackbox_passwordvault_do_close($res);
 secureblackbox_passwordvault_do_config($res, $configurationstring);
 secureblackbox_passwordvault_do_getentryvalue($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_getentryvaluestr($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_listentries($res);
 secureblackbox_passwordvault_do_listfields($res, $entryname, $includeencrypted);
 secureblackbox_passwordvault_do_openbytes($res, $vaultbytes);
 secureblackbox_passwordvault_do_openfile($res, $filename);
 secureblackbox_passwordvault_do_removeallentries($res);
 secureblackbox_passwordvault_do_removeentry($res, $entryname);
 secureblackbox_passwordvault_do_removefield($res, $entryname, $fieldname);
 secureblackbox_passwordvault_do_savebytes($res);
 secureblackbox_passwordvault_do_savefile($res, $filename);
 secureblackbox_passwordvault_do_setentryvalue($res, $entryname, $fieldname, $fieldvalue, $encrypted);
 secureblackbox_passwordvault_do_setentryvaluestr($res, $entryname, $fieldname, $fieldvaluestr, $encrypted);

Remarks

Use this component to keep passwords and other settings in secure manner.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

DescriptionThe description of the vault.
EntryKeyProvides an encryption key for the current entry.
EntryPasswordProvides an encryption password for the current entry.
KeyProvides an encryption key for the vault.
PasswordProvides an encryption password for the vault file.
PlatformProtectionEnables platform-based protection of the master key.
TitleThe title of the vault.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddEntryAdds an entry to the vault.
ChangeEntryKeyChanges the entry's encryption key.
ChangeEntryPasswordChanges the entry's encryption password.
CloseCloses the vault file.
ConfigSets or retrieves a configuration setting.
GetEntryValueReturns the content stored in one of the entry fields as a byte array.
GetEntryValueStrReturns the content stored in a field of the entry as a string.
ListEntriesReturns a list of entries stored in the vault.
ListFieldsReturns a list of fields contained in the entry.
OpenBytesLoads vault content from a byte array.
OpenFileOpens a vault file.
RemoveAllEntriesRemoves all entries from a vault.
RemoveEntryRemoves an entry from the vault.
RemoveFieldRemoves an entry field.
SaveBytesSaves the vault contents to a byte array.
SaveFileSaves the vault contents to a file.
SetEntryValueAssigns a value to an entry field.
SetEntryValueStrAssigns a value to an entry field.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

EntryKeyNeededThis event is fired to request an entry encryption/decryption key from the application.
ErrorInforms about errors during cryptographic operations.
KeyNeededThis event is fired to request a vault encryption/decryption key from the application.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 PHP Edition - Version 20.0 [Build 8154]