Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7a30a30e authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

Shift around encryption public APIs. 

There are far too many Context APIs with special directory paths
to replicate device-encryption versions of them all.  Instead, add
methods to clone a Context that explicitly stores its data in either
credential- or device-encrypted storage.

Methods to test the behavior of a given Context.

Bug: 22358539
Change-Id: I6a6290a9b282605ce9a1f82742fc2c4c50536754
parent 6a6cdafa

api/current.txt

+14 −3
Original line number Diff line number Diff line
@@ -7779,6 +7779,8 @@ package android.content { 
    method public abstract int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public abstract deprecated void clearWallpaper() throws java.io.IOException;

    method public abstract android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public abstract android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDisplayContext(android.view.Display);

    method public abstract android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public abstract java.lang.String[] databaseList();
@@ -7802,7 +7804,6 @@ package android.content { 
    method public final android.content.res.ColorStateList getColorStateList(int);

    method public abstract android.content.ContentResolver getContentResolver();

    method public abstract java.io.File getDatabasePath(java.lang.String);

    method public abstract java.io.File getDeviceEncryptedFilesDir();

    method public abstract java.io.File getDir(java.lang.String, int);

    method public final android.graphics.drawable.Drawable getDrawable(int);

    method public abstract java.io.File getExternalCacheDir();
@@ -7835,6 +7836,8 @@ package android.content { 
    method public abstract deprecated int getWallpaperDesiredMinimumHeight();

    method public abstract deprecated int getWallpaperDesiredMinimumWidth();

    method public abstract void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public abstract boolean isCredentialEncrypted();

    method public abstract boolean isDeviceEncrypted();

    method public boolean isRestricted();

    method public final android.content.res.TypedArray obtainStyledAttributes(int[]);

    method public final android.content.res.TypedArray obtainStyledAttributes(int, int[]) throws android.content.res.Resources.NotFoundException;
@@ -7966,6 +7969,8 @@ package android.content { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public deprecated void clearWallpaper() throws java.io.IOException;

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -7988,7 +7993,6 @@ package android.content { 
    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -8016,6 +8020,8 @@ package android.content { 
    method public deprecated int getWallpaperDesiredMinimumHeight();

    method public deprecated int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);
@@ -9097,8 +9103,10 @@ package android.content.pm { 
    field public java.lang.String backupAgentName;

    field public java.lang.String className;

    field public int compatibleWidthLimitDp;

    field public java.lang.String credentialEncryptedDataDir;

    field public java.lang.String dataDir;

    field public int descriptionRes;

    field public java.lang.String deviceEncryptedDataDir;

    field public boolean enabled;

    field public int flags;

    field public int largestWidthLimitDp;
@@ -36234,6 +36242,8 @@ package android.test.mock { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public void clearWallpaper();

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -36255,7 +36265,6 @@ package android.test.mock { 
    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -36283,6 +36292,8 @@ package android.test.mock { 
    method public int getWallpaperDesiredMinimumHeight();

    method public int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);

api/system-current.txt

+14 −6
Original line number Diff line number Diff line
@@ -8023,6 +8023,8 @@ package android.content { 
    method public abstract int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public abstract deprecated void clearWallpaper() throws java.io.IOException;

    method public abstract android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public abstract android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDisplayContext(android.view.Display);

    method public abstract android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public abstract java.lang.String[] databaseList();
@@ -8045,9 +8047,7 @@ package android.content { 
    method public final int getColor(int);

    method public final android.content.res.ColorStateList getColorStateList(int);

    method public abstract android.content.ContentResolver getContentResolver();

    method public abstract java.io.File getCredentialEncryptedFilesDir();

    method public abstract java.io.File getDatabasePath(java.lang.String);

    method public abstract java.io.File getDeviceEncryptedFilesDir();

    method public abstract java.io.File getDir(java.lang.String, int);

    method public final android.graphics.drawable.Drawable getDrawable(int);

    method public abstract java.io.File getExternalCacheDir();
@@ -8080,6 +8080,8 @@ package android.content { 
    method public abstract deprecated int getWallpaperDesiredMinimumHeight();

    method public abstract deprecated int getWallpaperDesiredMinimumWidth();

    method public abstract void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public abstract boolean isCredentialEncrypted();

    method public abstract boolean isDeviceEncrypted();

    method public boolean isRestricted();

    method public final android.content.res.TypedArray obtainStyledAttributes(int[]);

    method public final android.content.res.TypedArray obtainStyledAttributes(int, int[]) throws android.content.res.Resources.NotFoundException;
@@ -8219,6 +8221,8 @@ package android.content { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public deprecated void clearWallpaper() throws java.io.IOException;

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -8240,9 +8244,7 @@ package android.content { 
    method public java.lang.ClassLoader getClassLoader();

    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getCredentialEncryptedFilesDir();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -8270,6 +8272,8 @@ package android.content { 
    method public deprecated int getWallpaperDesiredMinimumHeight();

    method public deprecated int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);
@@ -9361,8 +9365,10 @@ package android.content.pm { 
    field public java.lang.String backupAgentName;

    field public java.lang.String className;

    field public int compatibleWidthLimitDp;

    field public java.lang.String credentialEncryptedDataDir;

    field public java.lang.String dataDir;

    field public int descriptionRes;

    field public java.lang.String deviceEncryptedDataDir;

    field public boolean enabled;

    field public int flags;

    field public int largestWidthLimitDp;
@@ -38560,6 +38566,8 @@ package android.test.mock { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public void clearWallpaper();

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -38580,9 +38588,7 @@ package android.test.mock { 
    method public java.lang.ClassLoader getClassLoader();

    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getCredentialEncryptedFilesDir();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -38610,6 +38616,8 @@ package android.test.mock { 
    method public int getWallpaperDesiredMinimumHeight();

    method public int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);

api/test-current.txt

+14 −3
Original line number Diff line number Diff line
@@ -7779,6 +7779,8 @@ package android.content { 
    method public abstract int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public abstract deprecated void clearWallpaper() throws java.io.IOException;

    method public abstract android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public abstract android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public abstract android.content.Context createDisplayContext(android.view.Display);

    method public abstract android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public abstract java.lang.String[] databaseList();
@@ -7802,7 +7804,6 @@ package android.content { 
    method public final android.content.res.ColorStateList getColorStateList(int);

    method public abstract android.content.ContentResolver getContentResolver();

    method public abstract java.io.File getDatabasePath(java.lang.String);

    method public abstract java.io.File getDeviceEncryptedFilesDir();

    method public abstract java.io.File getDir(java.lang.String, int);

    method public final android.graphics.drawable.Drawable getDrawable(int);

    method public abstract java.io.File getExternalCacheDir();
@@ -7835,6 +7836,8 @@ package android.content { 
    method public abstract deprecated int getWallpaperDesiredMinimumHeight();

    method public abstract deprecated int getWallpaperDesiredMinimumWidth();

    method public abstract void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public abstract boolean isCredentialEncrypted();

    method public abstract boolean isDeviceEncrypted();

    method public boolean isRestricted();

    method public final android.content.res.TypedArray obtainStyledAttributes(int[]);

    method public final android.content.res.TypedArray obtainStyledAttributes(int, int[]) throws android.content.res.Resources.NotFoundException;
@@ -7966,6 +7969,8 @@ package android.content { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public deprecated void clearWallpaper() throws java.io.IOException;

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -7988,7 +7993,6 @@ package android.content { 
    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -8016,6 +8020,8 @@ package android.content { 
    method public deprecated int getWallpaperDesiredMinimumHeight();

    method public deprecated int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);
@@ -9097,8 +9103,10 @@ package android.content.pm { 
    field public java.lang.String backupAgentName;

    field public java.lang.String className;

    field public int compatibleWidthLimitDp;

    field public java.lang.String credentialEncryptedDataDir;

    field public java.lang.String dataDir;

    field public int descriptionRes;

    field public java.lang.String deviceEncryptedDataDir;

    field public boolean enabled;

    field public int flags;

    field public int largestWidthLimitDp;
@@ -36236,6 +36244,8 @@ package android.test.mock { 
    method public int checkUriPermission(android.net.Uri, java.lang.String, java.lang.String, int, int, int);

    method public void clearWallpaper();

    method public android.content.Context createConfigurationContext(android.content.res.Configuration);

    method public android.content.Context createCredentialEncryptedContext(android.content.Context);

    method public android.content.Context createDeviceEncryptedContext(android.content.Context);

    method public android.content.Context createDisplayContext(android.view.Display);

    method public android.content.Context createPackageContext(java.lang.String, int) throws android.content.pm.PackageManager.NameNotFoundException;

    method public java.lang.String[] databaseList();
@@ -36257,7 +36267,6 @@ package android.test.mock { 
    method public java.io.File getCodeCacheDir();

    method public android.content.ContentResolver getContentResolver();

    method public java.io.File getDatabasePath(java.lang.String);

    method public java.io.File getDeviceEncryptedFilesDir();

    method public java.io.File getDir(java.lang.String, int);

    method public java.io.File getExternalCacheDir();

    method public java.io.File[] getExternalCacheDirs();
@@ -36285,6 +36294,8 @@ package android.test.mock { 
    method public int getWallpaperDesiredMinimumHeight();

    method public int getWallpaperDesiredMinimumWidth();

    method public void grantUriPermission(java.lang.String, android.net.Uri, int);

    method public boolean isCredentialEncrypted();

    method public boolean isDeviceEncrypted();

    method public java.io.FileInputStream openFileInput(java.lang.String) throws java.io.FileNotFoundException;

    method public java.io.FileOutputStream openFileOutput(java.lang.String, int) throws java.io.FileNotFoundException;

    method public android.database.sqlite.SQLiteDatabase openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory);

core/java/android/app/ContextImpl.java

+61 −31

File changed.

Preview size limit exceeded, changes collapsed.

core/java/android/content/Context.java

+72 −21
Original line number Diff line number Diff line
@@ -770,27 +770,6 @@ public abstract class Context { 
     */

    public abstract File getFilesDir();



    /**

     * Return the filesystem directory for storing device-encrypted private app

     * data. Files stored in this location are typically encrypted with a key

     * tied to the physical device, and they can be accessed whenever the device

     * has booted successfully, both <em>before and after</em> the user has

     * entered their credentials (such as a lock pattern or PIN).

     */

    public abstract File getDeviceEncryptedFilesDir();



    /**

     * Return the filesystem directory for storing credential-encrypted private

     * app data. Files stored in this location are typically encrypted with a

     * key tied to user credentials, and they can be accessed

     * <em>only after</em> the user has entered their credentials (such as a

     * lock pattern or PIN).

     *

     * @hide

     */

    @SystemApi

    public abstract File getCredentialEncryptedFilesDir();



    /**

     * Returns the absolute path to the directory on the filesystem similar to

     * {@link #getFilesDir()}. The difference is that files placed under this
@@ -3885,6 +3864,26 @@ public abstract class Context { 
     */

    public static final int CONTEXT_RESTRICTED = 0x00000004;



    /**

     * Flag for use with {@link #createPackageContext}: point all file APIs at

     * device-encrypted storage.

     *

     * @hide

     */

    public static final int CONTEXT_STORAGE_DEVICE_ENCRYPTED = 0x00000008;



    /**

     * Flag for use with {@link #createPackageContext}: point all file APIs at

     * credential-encrypted storage.

     *

     * @hide

     */

    public static final int CONTEXT_STORAGE_CREDENTIAL_ENCRYPTED = 0x00000010;



    /** {@hide} */

    public static final int CONTEXT_STORAGE_MASK = CONTEXT_STORAGE_DEVICE_ENCRYPTED

            | CONTEXT_STORAGE_CREDENTIAL_ENCRYPTED;



    /**

     * @hide Used to indicate we should tell the activity manager about the process

     * loading this code.
@@ -3984,6 +3983,42 @@ public abstract class Context { 
     */

    public abstract Context createDisplayContext(@NonNull Display display);



    /**

     * Return a new Context object for the current Context but whose storage

     * APIs are backed by device-encrypted storage.

     * <p>

     * Data stored in device-encrypted storage is typically encrypted with a

     * key tied to the physical device, and they can be accessed whenever the

     * device has booted successfully, both <em>before and after</em> the user

     * has entered their credentials (such as a lock pattern or PIN).

     * <p>

     * Each call to this method returns a new instance of a Context object;

     * Context objects are not shared, however common state (ClassLoader, other

     * Resources for the same configuration) may be so the Context itself can be

     * fairly lightweight.

     *

     * @see #isDeviceEncrypted()

     */

    public abstract Context createDeviceEncryptedContext(Context context);



    /**

     * Return a new Context object for the current Context but whose storage

     * APIs are backed by credential-encrypted storage.

     * <p>

     * Data stored in credential-encrypted storage is typically encrypted with a

     * key tied to user credentials, and they can be accessed

     * <em>only after</em> the user has entered their credentials (such as a

     * lock pattern or PIN).

     * <p>

     * Each call to this method returns a new instance of a Context object;

     * Context objects are not shared, however common state (ClassLoader, other

     * Resources for the same configuration) may be so the Context itself can be

     * fairly lightweight.

     *

     * @see #isCredentialEncrypted()

     */

    public abstract Context createCredentialEncryptedContext(Context context);



    /**

     * Gets the display adjustments holder for this context.  This information

     * is provided on a per-application or activity basis and is used to simulate lower density
@@ -4005,4 +4040,20 @@ public abstract class Context { 
    public boolean isRestricted() {

        return false;

    }



    /**

     * Indicates if the storage APIs of this Context are backed by

     * device-encrypted storage.

     *

     * @see #createDeviceEncryptedContext(Context)

     */

    public abstract boolean isDeviceEncrypted();



    /**

     * Indicates if the storage APIs of this Context are backed by

     * credential-encrypted storage.

     *

     * @see #createCredentialEncryptedContext(Context)

     */

    public abstract boolean isCredentialEncrypted();

}