Instance of CardManager. Used to create cards with user public keys.
Unique identifier of current user. Received from JWT token.
Instance of IKeyEntryStorage implementation. Used for storing private keys.
Instance of implementation of ICrypto interface.
Decrypts and verifies integrity of File or Blob for recipient public key. If there is no recipient and the message is encrypted for the current user, omit the public key parameter. You can define chunk size and a callback, that will be invoked on each chunk.
The file will be read twice during this method execution:
Signs and encrypts File or Blob. If there is no recipient and the message is encrypted for the current user, omit the public key parameter. You can define chunk size and a callback, that will be invoked on each chunk.
Uploads current user private key to Virgil Keyknox Storage.
User password for access to Virgil Keyknox Storage
Is a name that would be used to store backup in the cloud.
Changes password for access to current user private key backup.
users old password
users new password
Deletes local private key from key storage. Make sure backupPrivateKey method was called first.
Decrypts and verifies the data encrypted by the current user for the current user.
Message to decrypt
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Decrypts and verifies the data encrypted by the user identified by senderCard
for the
current user.
Message to decrypt
Virgil Card of the user who encrypted and signed the message.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Decrypts and verifies the data encrypted by the user identified by senderCard
for the
current user. If the sender had ever rotated their keys (e.g. by using the
EThree.rotatePrivateKey method), then the encryptedAt
date is used to find the
public key that was current at the time of encryption.
Message to decrypt
Virgil Card of the user who encrypted and signed the message.
The date the message was encrypted on.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Decrypts and verifies the data encrypted by the user identified by senderPublicKey
for the
current user.
Message to decrypt
Public key of the user who encrypted and signed the message.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Decrypts File or Blob with fileKey
and verifies integrity with senderCardOrPublicKey
. If there is no recipient
and the message is encrypted for the current user, omit the senderCardOrPublicKey
parameter. You can define
chunk size and a callback, that will be invoked on each chunk.
Encrypts and signs the message for the current user.
Message to sign and encrypt.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise
Encrypts and signs the message for the current user and a single recipient user.
Message to sign and encrypt.
Virgil Card of the encrypted message recipient.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Encrypts and signs the message for the current user and multiple recipient users.
Message to sign and encrypt.
Result of the {@link AbstractEThree.findUsers} method. Specifies multiple recipients.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Encrypts and signs the message for the current user and a single recipient user.
Use the overload that accepts ICard
object instead.
Message to sign and encrypt.
Public key of the encrypted message recipient.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Encrypts and signs the message for the current user and multiple recipient users.
Message to sign and encrypt.
Promise that is that resolves to a string if message
was a string and Buffer
otherwise.
Encrypts file with fileKey
which can be shared among other users.
You can define chunk size and a callback, that will be invoked on each chunk.
Finds Virgil Card for user identity registered on Virgil Cloud.
Finds Virgil Cards for user identities registered on Virgil Cloud.
Checks if current user has private key saved locally.
Finds public key for user identity registered on Virgil Cloud.
Finds public keys for user identities registered on Virgil Cloud.
Registers current user in Virgil Cloud. Saves private key locally and uploads public key to the cloud.
Delete private key saved in Virgil Keyknox Storage.
Delete private key saved in Virgil Keyknox Storage.
User password for access to Virgil Keyknox Storage.
Delete private key saved in Virgil Keyknox Storage.
Downloads private key from Virgil Cloud. Use backupPrivateKey to upload the key first.
User password for access to Virgil Keyknox Storage.
Is a name for the key backup in the cloud.
Generates a new private key and saves locally. Replaces old public key with new one in Cloud. Used in case if old private key is lost.
Unregister current user. Revokes public key in Virgil Cloud and deletes local private key.
Initialize a new instance of EThree which tied to specific user.
Function that receive JWT.
Generated using TypeDoc
Instance of IAccessTokenProvider implementation. Using [[getToken]] to receive JWT.