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

Commit fd37abe9 authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

Make PreferenceActivity/Fragment encryption ready. 

Developers using these classes can getPreferenceManager() and
explicitly set the storage location for any SharedPreferences values
persisted through it.

Bug: 26747519
Change-Id: I133045df6a69aa99f33b6b6c447f52605468b927
parent b92b05bb

api/current.txt

+2 −0
Original line number Diff line number Diff line
@@ -29207,6 +29207,8 @@ package android.preference { 
    method public static void setDefaultValues(android.content.Context, java.lang.String, int, int, boolean);

    method public void setSharedPreferencesMode(int);

    method public void setSharedPreferencesName(java.lang.String);

    method public void setStorageDefault();

    method public void setStorageDeviceEncrypted();

    field public static final java.lang.String KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values";

    field public static final java.lang.String METADATA_KEY_PREFERENCES = "android.preference";

  }

api/system-current.txt

+3 −0
Original line number Diff line number Diff line
@@ -31300,6 +31300,9 @@ package android.preference { 
    method public static void setDefaultValues(android.content.Context, java.lang.String, int, int, boolean);

    method public void setSharedPreferencesMode(int);

    method public void setSharedPreferencesName(java.lang.String);

    method public void setStorageCredentialEncrypted();

    method public void setStorageDefault();

    method public void setStorageDeviceEncrypted();

    field public static final java.lang.String KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values";

    field public static final java.lang.String METADATA_KEY_PREFERENCES = "android.preference";

  }

api/test-current.txt

+2 −0
Original line number Diff line number Diff line
@@ -29216,6 +29216,8 @@ package android.preference { 
    method public static void setDefaultValues(android.content.Context, java.lang.String, int, int, boolean);

    method public void setSharedPreferencesMode(int);

    method public void setSharedPreferencesName(java.lang.String);

    method public void setStorageDefault();

    method public void setStorageDeviceEncrypted();

    field public static final java.lang.String KEY_HAS_SET_DEFAULT_VALUES = "_has_set_default_values";

    field public static final java.lang.String METADATA_KEY_PREFERENCES = "android.preference";

  }

core/java/android/preference/PreferenceManager.java

+63 −3
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ 


package android.preference;



import android.annotation.SystemApi;

import android.annotation.XmlRes;

import android.app.Activity;

import android.content.Context;
@@ -24,8 +25,8 @@ import android.content.Intent; 
import android.content.SharedPreferences;

import android.content.pm.ActivityInfo;

import android.content.pm.PackageManager;

import android.content.pm.ResolveInfo;

import android.content.pm.PackageManager.NameNotFoundException;

import android.content.pm.ResolveInfo;

import android.content.res.XmlResourceParser;

import android.os.Bundle;

import android.util.Log;
@@ -111,6 +112,12 @@ public class PreferenceManager { 
     */

    private int mSharedPreferencesMode;



    private static final int STORAGE_DEFAULT = 0;

    private static final int STORAGE_DEVICE_ENCRYPTED = 1;

    private static final int STORAGE_CREDENTIAL_ENCRYPTED = 2;



    private int mStorage = STORAGE_DEFAULT;



    /**

     * The {@link PreferenceScreen} at the root of the preference hierarchy.

     */
@@ -342,6 +349,46 @@ public class PreferenceManager { 
        mSharedPreferences = null;

    }



    /**

     * Sets the storage location used internally by this class to be the default

     * provided by the hosting {@link Context}.

     */

    public void setStorageDefault() {

        mStorage = STORAGE_DEFAULT;

        mSharedPreferences = null;

    }



    /**

     * Explicitly set the storage location used internally by this class to be

     * device-encrypted storage.

     * <p>

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

     * tied to the physical device, and it can be accessed when the device has

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

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

     * Because device-encrypted data is available before user authentication,

     * you should carefully consider what data you store using this mode.

     *

     * @see Context#createDeviceEncryptedStorageContext()

     */

    public void setStorageDeviceEncrypted() {

        mStorage = STORAGE_DEVICE_ENCRYPTED;

        mSharedPreferences = null;

    }



    /**

     * Explicitly set the storage location used internally by this class to be

     * credential-encrypted storage.

     *

     * @see Context#createCredentialEncryptedStorageContext()

     * @hide

     */

    @SystemApi

    public void setStorageCredentialEncrypted() {

        mStorage = STORAGE_CREDENTIAL_ENCRYPTED;

        mSharedPreferences = null;

    }



    /**

     * Gets a SharedPreferences instance that preferences managed by this will

     * use.
@@ -351,7 +398,20 @@ public class PreferenceManager { 
     */

    public SharedPreferences getSharedPreferences() {

        if (mSharedPreferences == null) {

            mSharedPreferences = mContext.getSharedPreferences(mSharedPreferencesName,

            final Context storageContext;

            switch (mStorage) {

                case STORAGE_DEVICE_ENCRYPTED:

                    storageContext = mContext.createDeviceEncryptedStorageContext();

                    break;

                case STORAGE_CREDENTIAL_ENCRYPTED:

                    storageContext = mContext.createCredentialEncryptedStorageContext();

                    break;

                default:

                    storageContext = mContext;

                    break;

            }



            mSharedPreferences = storageContext.getSharedPreferences(mSharedPreferencesName,

                    mSharedPreferencesMode);

        }