Package com.google.crypto.tink.integration.android

Class AndroidKeystoreAesGcm

  • All Implemented Interfaces:
    Aead
    public final class AndroidKeystoreAesGcm
extends java.lang.Object
implements Aead
    An Aead that does AES-GCM encryption with a key stored in Android Keystore.

    We don't recommend using this class. Instead, directly use AndroidKeystore.getAead(java.lang.String) and implement retries yourself if you need them.

    This class requires Android M (API level 23) or newer.

    Since:
    1.0.0

    • Constructor Summary

      Constructors 
      Constructor Description
      AndroidKeystoreAesGcm​(java.lang.String keyId)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] decrypt​(byte[] ciphertext, byte[] associatedData)
      Decrypts ciphertext with associatedData as associated authenticated data.
      byte[] encrypt​(byte[] plaintext, byte[] associatedData)
      Encrypts plaintext with associatedData as associated authenticated data.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AndroidKeystoreAesGcm

        public AndroidKeystoreAesGcm​(java.lang.String keyId)
                      throws java.security.GeneralSecurityException,
                             java.io.IOException
        Throws:
        java.security.GeneralSecurityException
        java.io.IOException

    • Method Detail

      • encrypt

        public byte[] encrypt​(byte[] plaintext,
                      byte[] associatedData)
               throws java.security.GeneralSecurityException
        Description copied from interface: Aead
        Encrypts plaintext with associatedData as associated authenticated data. The resulting ciphertext allows for checking authenticity and integrity of associated data (associatedData), but does not guarantee its secrecy.
        Specified by:
        encrypt in interface Aead
        Parameters:
        plaintext - the plaintext to be encrypted. It must be non-null, but can also be an empty (zero-length) byte array
        associatedData - associated data to be authenticated, but not encrypted. Associated data is optional, so this parameter can be null. In this case the null value is equivalent to an empty (zero-length) byte array. For successful decryption the same associatedData must be provided along with the ciphertext.
        Returns:
        resulting ciphertext
        Throws:
        java.security.GeneralSecurityException

      • decrypt

        public byte[] decrypt​(byte[] ciphertext,
                      byte[] associatedData)
               throws java.security.GeneralSecurityException
        Description copied from interface: Aead
        Decrypts ciphertext with associatedData as associated authenticated data. The decryption verifies the authenticity and integrity of the associated data, but there are no guarantees wrt. secrecy of that data.
        Specified by:
        decrypt in interface Aead
        Parameters:
        ciphertext - the plaintext to be decrypted. It must be non-null.
        associatedData - associated data to be authenticated. For successful decryption it must be the same as associatedData used during encryption. Can be null, which is equivalent to an empty (zero-length) byte array.
        Returns:
        resulting plaintext
        Throws:
        java.security.GeneralSecurityException - if decryption fails. Decryption must fail if ciphertext is not correctly authenticated for the given associatedData.