Summary: Nested Classes | Methods | Inherited Methods

EncryptedFile

Kotlin |Java

public final class EncryptedFile
extends Object

java.lang.Object
↳	androidx.security.crypto.EncryptedFile

---

Class used to create and read encrypted files.

  String masterKeyAlias = MasterKeys.getOrCreate(MasterKeys.AES256_GCM_SPEC);

  File file = new File(context.getFilesDir(), "secret_data");
  EncryptedFile encryptedFile = EncryptedFile.Builder(
      file,
      context,
      masterKeyAlias,
      EncryptedFile.FileEncryptionScheme.AES256_GCM_HKDF_4KB
  ).build();

  // write to the encrypted file
  FileOutputStream encryptedOutputStream = encryptedFile.openFileOutput();

  // read the encrypted file
  FileInputStream encryptedInputStream = encryptedFile.openFileInput();
 

Summary

Nested classes
class	EncryptedFile.Builder Builder class to configure EncryptedFile
enum	EncryptedFile.FileEncryptionScheme The encryption scheme to encrypt files.

Public methods
FileInputStream	openFileInput() Opens a FileInputStream that reads encrypted files based on the previous settings.
FileOutputStream	openFileOutput() Opens a FileOutputStream for writing that automatically encrypts the data based on the provided settings.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public methods

openFileInput

public FileInputStream openFileInput ()

Opens a FileInputStream that reads encrypted files based on the previous settings. Please ensure that the same master key and keyset are used to decrypt or it will cause failures.

Returns
FileInputStream	The input stream to read previously encrypted data.

Throws
GeneralSecurityException	when a bad master key or keyset has been used
IOException	when the file was not found

openFileOutput

public FileOutputStream openFileOutput ()

Opens a FileOutputStream for writing that automatically encrypts the data based on the provided settings. Please ensure that the same master key and keyset are used to decrypt or it will cause failures.

Returns
FileOutputStream	The FileOutputStream that encrypts all data.

Throws
GeneralSecurityException	when a bad master key or keyset has been used
IOException	when the file already exists or is not available for writing

• Classes

  • EncryptedFile
  • EncryptedFile.Builder
  • EncryptedSharedPreferences
  • MasterKeys

• Enums

  • EncryptedFile.FileEncryptionScheme
  • EncryptedSharedPreferences.PrefKeyEncryptionScheme
  • EncryptedSharedPreferences.PrefValueEncryptionScheme