Interface KeyCrypter

  • All Known Implementing Classes:

    public interface KeyCrypter

    A KeyCrypter can be used to encrypt and decrypt a message. The sequence of events to encrypt and then decrypt a message are as follows:

    (1) Ask the user for a password. deriveKey() is then called to create an KeyParameter. This contains the AES key that will be used for encryption.

    (2) Encrypt the message using encrypt(), providing the message bytes and the KeyParameter from (1). This returns an EncryptedData which contains the encryptedPrivateKey bytes and an initialisation vector.

    (3) To decrypt an EncryptedData, repeat step (1) to get a KeyParameter, then call decrypt().

    There can be different algorithms used for encryption/ decryption so the getUnderstoodEncryptionType is used to determine whether any given KeyCrypter can understand the type of encrypted data you have.

    • Method Detail

      • getUnderstoodEncryptionType

        Protos.Wallet.EncryptionType getUnderstoodEncryptionType()
        Return the EncryptionType enum value which denotes the type of encryption/ decryption that this KeyCrypter can understand.
      • deriveKey

        AesKey deriveKey​(java.lang.CharSequence password)
                  throws KeyCrypterException
        Create an AESKey (which typically contains an AES key)
        password -
        AESKey which typically contains the AES key to use for encrypting and decrypting
      • encrypt

        EncryptedData encrypt​(byte[] plainBytes,
                              AesKey aesKey)
                       throws KeyCrypterException
        Encrypt the supplied bytes, converting them into ciphertext.
        encryptedPrivateKey An encryptedPrivateKey containing the encrypted bytes and an initialisation vector.
        KeyCrypterException - if encryption was unsuccessful