java 是否有办法将EncryptedSharedPreference与PreferenceScreen集成在一起?

qv7cva1a  于 2023-01-07  发布在  Java
关注(0)|答案(4)|浏览(96)

我是Android开发新手。目前,我想加密名为"共享首选项"的自定义项并与PreferenceScreen集成,但未能成功。我正在使用依赖项:

  1. androidx.security:security-crypto:1.0.0-alpha02 [EncryptedSharedPreference]
  2. androidx.首选项:首选项:1.1.0 [首选项屏幕]
    我曾试图研究这两个功能集成的相关信息,但没有找到相关信息。
    根据我的测试,我有一个现有的加密共享首选项,并测试了以下API:
getPreferenceManager().setSharedPreferencesName("MyShared"); //MyShared Is custom named preference.

但它最终以朴素的价值拯救了偏好。
我的问题:
1.在现阶段是否有可能将这两个特性集成在一起?

  1. PreferenceScreen是否提供我不知道的加密功能?
    1.如果我坚持使用EncryptedSharedPreference,我创建一个自定义活动外观像首选项屏幕会更好吗?
vwoqyblh

vwoqyblh1#

A1:是的,有可能。
答3:您可以通过以下方式利用系统提供的设置。
由于Kotlin是首选的一等公民,现在我将在Kotlin中显示它,@Rikka在另一个答案中有一个Java版本。对于Kotlin,诀窍是仍然设置preferencesDataSource,它是这样的:

class SettingsFragment : PreferenceFragmentCompat() {
    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
        preferenceManager.preferenceDataStore =
            EncryptedPreferenceDataStore.getInstance(requireContext())

        // Load the preferences from an XML resource
        setPreferencesFromResource(R.xml.preferences, rootKey)
    }

Kotlin版本的EncryptedPreferenceDataStore:我使用also关键字作为单例,类似于Singleton with parameter in Kotlin中与Google源代码相关的Room示例

class EncryptedPreferenceDataStore private constructor(context: Context) : PreferenceDataStore() {
    companion object {
        private const val SHARED_PREFERENCES_NAME = "secret_shared_preferences"

        @Volatile private var INSTANCE: EncryptedPreferenceDataStore? = null

        fun getInstance(context: Context): EncryptedPreferenceDataStore =
            INSTANCE ?: synchronized(this) {
                INSTANCE ?: EncryptedPreferenceDataStore(context).also { INSTANCE = it }
            }
    }

    private var mSharedPreferences: SharedPreferences
    private lateinit var mContext: Context

    init {
        try {
            mContext = context
            val masterKey = MasterKey.Builder(context, MasterKey.DEFAULT_MASTER_KEY_ALIAS)
                .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
                .build()

            mSharedPreferences = EncryptedSharedPreferences.create(
                context,
                SHARED_PREFERENCES_NAME,
                masterKey,
                EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
                EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
            )
        } catch (e: Exception) {
            // Fallback, default mode is Context.MODE_PRIVATE!
            mSharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)
        }
    }

    override fun putString(key: String, value: String?) {
        mSharedPreferences.edit().putString(key, value).apply()
    }

    override fun putStringSet(key: String, values: Set<String>?) {
        mSharedPreferences.edit().putStringSet(key, values).apply()
    }

    override fun putInt(key: String, value: Int) {
        mSharedPreferences.edit().putInt(key, value).apply()
    }

    override fun putLong(key: String, value: Long) {
        mSharedPreferences.edit().putLong(key, value).apply()
    }

    override fun putFloat(key: String, value: Float) {
        mSharedPreferences.edit().putFloat(key, value).apply()
    }

    override fun putBoolean(key: String, value: Boolean) {
        mSharedPreferences.edit().putBoolean(key, value).apply()
    }

    override fun getString(key: String, defValue: String?): String? {
        return mSharedPreferences.getString(key, defValue)
    }

    override fun getStringSet(key: String, defValues: Set<String>?): Set<String>? {
        return mSharedPreferences.getStringSet(key, defValues)
    }

    override fun getInt(key: String, defValue: Int): Int {
        return mSharedPreferences.getInt(key, defValue)
    }

    override fun getLong(key: String, defValue: Long): Long {
        return mSharedPreferences.getLong(key, defValue)
    }

    override fun getFloat(key: String, defValue: Float): Float {
        return mSharedPreferences.getFloat(key, defValue)
    }

    override fun getBoolean(key: String, defValue: Boolean): Boolean {
        return mSharedPreferences.getBoolean(key, defValue)
    }
}

也许通过双重同步检查,它可以更安全地运行线程?

bgibtngc

bgibtngc2#

使用getPreferenceManager().setPreferenceDataStore(PreferenceDataStore)PreferenceDataStore提供了更改首选项加载/保存方式的功能。
PreferenceDataStore的简单实现:

public class SharedPreferenceDataStore extends PreferenceDataStore {

    private final SharedPreferences mSharedPreferences;

    public SharedPreferenceDataStore(@NonNull SharedPreferences sharedPreferences) {
        mSharedPreferences = sharedPreferences;
    }

    @NonNull
    public SharedPreferences getSharedPreferences() {
        return mSharedPreferences;
    }

    @Override
    public void putString(String key, @Nullable String value) {
        mSharedPreferences.edit().putString(key, value).apply();
    }

    @Override
    public void putStringSet(String key, @Nullable Set<String> values) {
        mSharedPreferences.edit().putStringSet(key, values).apply();
    }

    @Override
    public void putInt(String key, int value) {
        mSharedPreferences.edit().putInt(key, value).apply();
    }

    @Override
    public void putLong(String key, long value) {
        mSharedPreferences.edit().putLong(key, value).apply();
    }

    @Override
    public void putFloat(String key, float value) {
        mSharedPreferences.edit().putFloat(key, value).apply();
    }

    @Override
    public void putBoolean(String key, boolean value) {
        mSharedPreferences.edit().putBoolean(key, value).apply();
    }

    @Nullable
    @Override
    public String getString(String key, @Nullable String defValue) {
        return mSharedPreferences.getString(key, defValue);
    }

    @Nullable
    @Override
    public Set<String> getStringSet(String key, @Nullable Set<String> defValues) {
        return mSharedPreferences.getStringSet(key, defValues);
    }

    @Override
    public int getInt(String key, int defValue) {
        return mSharedPreferences.getInt(key, defValue);
    }

    @Override
    public long getLong(String key, long defValue) {
        return mSharedPreferences.getLong(key, defValue);
    }

    @Override
    public float getFloat(String key, float defValue) {
        return mSharedPreferences.getFloat(key, defValue);
    }

    @Override
    public boolean getBoolean(String key, boolean defValue) {
        return mSharedPreferences.getBoolean(key, defValue);
    }
}
getPreferenceManager().setPreferenceDataStore(new SharedPreferenceDataStore(EncryptedSharedPreferences.create()));
qcbq4gxm

qcbq4gxm3#

我在将EncryptedSharePreferences与AndroidX首选项GUI集成时遇到了一些问题。

  • PreferenceManager无法全局设置默认首选项数据存储,因为它只能检索默认共享首选项(未加密的变体并绑定到应用程序包名称),而不能将默认共享首选项设置为加密的变体。PreferenceManager.getDefaultSharedPreferences(context);没有对应的set方法。
  • PreferenceManager只能由具有相同库组的包创建。

我创建的解决方案是不依赖于SharedPreferences,而是利用PreferenceFragmentCompat写入EncryptedPreferenceDataStore,但是,这仍然会带来一个问题,即默认值在用户进入Preference屏幕之前不会初始化。

依赖项

dependencies {
    implementation 'androidx.preference:preference:1.1.1'
    implementation 'androidx.security:security-crypto:1.0.0-rc01'
}

首选项片段

import android.app.Activity;
import android.app.ActivityManager;
import android.os.Bundle;

import androidx.preference.Preference;
import androidx.preference.PreferenceFragmentCompat;
import androidx.preference.PreferenceManager;

public class PreferencesFragment extends PreferenceFragmentCompat {

    @Override
    public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
        PreferenceManager preferenceManager = getPreferenceManager();
        preferenceManager.setPreferenceDataStore(EncryptedPreferenceDataStore.getInstance(getContext()));

        // Load the preferences from an XML resource
        setPreferencesFromResource(R.xml.preferences, rootKey);
    }

加密首选项数据存储

import android.content.Context;
import android.content.SharedPreferences;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.preference.PreferenceDataStore;
import androidx.security.crypto.EncryptedSharedPreferences;

import java.util.Set;

public class EncryptedPreferenceDataStore extends PreferenceDataStore {

    private static final String CONFIG_FILE_NAME = "FileName";
    private static final String CONFIG_MASTER_KEY_ALIAS = "KeyAlias";
    private static EncryptedPreferenceDataStore mInstance;
    private SharedPreferences mSharedPreferences;
    private Context mContext;

    private EncryptedPreferenceDataStore(Context context) {
        try {
            mContext = context;
            mSharedPreferences = EncryptedSharedPreferences.create(
                    CONFIG_FILE_NAME,
                    CONFIG_MASTER_KEY_ALIAS,
                    context,
                    EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV, //for encrypting Keys
                    EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM ////for encrypting Values
            );
        } catch (Exception e) {
            // Fallback
            mSharedPreferences = context.getSharedPreferences(CONFIG_FILE_NAME, Context.MODE_PRIVATE);
        }
    }

    @Override
    public void putString(String key, @Nullable String value) {
        mSharedPreferences.edit().putString(key, value).apply();
    }

    @Override
    public void putStringSet(String key, @Nullable Set<String> values) {
        mSharedPreferences.edit().putStringSet(key, values).apply();
    }

    @Override
    public void putInt(String key, int value) {
        mSharedPreferences.edit().putInt(key, value).apply();
    }

    @Override
    public void putLong(String key, long value) {
        mSharedPreferences.edit().putLong(key, value).apply();
    }

    @Override
    public void putFloat(String key, float value) {
        mSharedPreferences.edit().putFloat(key, value).apply();
    }

    @Override
    public void putBoolean(String key, boolean value) {
        mSharedPreferences.edit().putBoolean(key, value).apply();
    }

    @Nullable
    @Override
    public String getString(String key, @Nullable String defValue) {
        return mSharedPreferences.getString(key, defValue);
    }

    @Nullable
    @Override
    public Set<String> getStringSet(String key, @Nullable Set<String> defValues) {
        return mSharedPreferences.getStringSet(key, defValues);
    }

    @Override
    public int getInt(String key, int defValue) {
        return mSharedPreferences.getInt(key, defValue);
    }

    @Override
    public long getLong(String key, long defValue) {
        return mSharedPreferences.getLong(key, defValue);
    }

    @Override
    public float getFloat(String key, float defValue) {
        return mSharedPreferences.getFloat(key, defValue);
    }

    @Override
    public boolean getBoolean(String key, boolean defValue) {
        return mSharedPreferences.getBoolean(key, defValue);
    }
}

用法

EncryptedPreferenceDataStore prefs = EncryptedPreferenceDataStore.getInstance(getContext());
    boolean bIsXXX = prefs.getBoolean(getString(R.string.pref_access_xxx), true);
yquaqz18

yquaqz184#

我在这里找到了答案,添加了一点Kotlin糖使它更短,避免使用未发布的库版本,下面是结果:

依赖项:

dependencies {
    implementation "androidx.security:security-crypto:1.0.0"
    implementation 'androidx.preference:preference-ktx:1.2.0'
}

数据存储:

lateinit var dataStore: PreferenceDataStore
lateinit var globalPreferences: SharedPreferences

private const val SHARED_PREFERENCES_NAME = "secret_shared_preferences"

fun prepareDataStore(context: Context) {

    val masterKey = MasterKeys.getOrCreate(MasterKeys.AES256_GCM_SPEC)

    globalPreferences = EncryptedSharedPreferences.create(
        SHARED_PREFERENCES_NAME,
        masterKey,
        context,
        EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
        EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
    )

    dataStore = object :
        PreferenceDataStore(), SharedPreferences by globalPreferences {

        private val editor by lazy { globalPreferences.edit() }

        override fun putString(key: String, value: String?) =
            editor.putString(key, value).apply()

        override fun putStringSet(key: String, values: Set<String>?) =
            editor.putStringSet(key, values).apply()

        override fun putInt(key: String, value: Int) =
            editor.putInt(key, value).apply()

        override fun putLong(key: String, value: Long) =
            editor.putLong(key, value).apply()

        override fun putFloat(key: String, value: Float) =
            editor.putFloat(key, value).apply()

        override fun putBoolean(key: String, value: Boolean) =
            editor.putBoolean(key, value).apply()

    }
}

首选项片段:

class PreferencesFragment: PreferenceFragmentCompat() {

        override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
            preferenceManager.preferenceDataStore = dataStore
            setPreferencesFromResource(R.xml.root_preferences, rootKey)

用法:

boolean bIsXXX = globalPreferences.getBoolean(getString(R.string.pref_access_xxx), true);

备注:

  1. get ...函数的技巧不能用于继承SharedPreferences.Editor的put ...函数,因为put ...函数的返回值与PreferenceDataStore不同,并且还需要调用apply()
    1.不使用单例是我对单例的品味,单例依赖于参数,并在下次调用时忽略参数。但这是另一个主题。我建议从class MyApplication : Application()调用prepareDataStore,并将其Context参数改为Application,以明确这一点。

相关问题