Android EncryptedSharedPreferences

🔥 Android EncryptedSharedPreferences 에 대해 알아보고, 사용 방법을 살펴보자.

🎈 EncryptedSharedPreferences 란?

EncryptedSharedPreferences는 Android Jetpack 라이브러리 중 security 에서 제공하는 클래스이다.
기존에 존재하는 SharedPreferences를 암호화하여 데이터 보안을 강화하는 데 사용된다.
Jetpack security 라이브러리는 Android Keystore 시스템을 사용하여 암호화 키를 앱 내부가 아닌 시스템만이 접근가능한 곳에 저장하도록 한다.

EncryptedSharedPreferences는 기본적으로 SharedPreferences 와 비슷하지만, 값을 저장 및 검색할 때 암호화 및 복호화를 수행하여 데이터 누출을 방지한다. 이를 통해 앱에서 사용하는 중요한 데이터(예: API 키, 사용자 정보 등)를 안전하게 저장할 수 있다. 여기서 사용되는 키 값은 Android Keystore 시스템을 사용하여 관리한다.
EncryptedSharedPreferences를 사용하면, 기본적으로 AES256-GCM 암호화와 같은 안전한 알고리즘을 사용하여 SharedPreferences를 보호할 수 있다. 아래 예제에서 AES256 알고리즘을 사용한 EncryptedSharedPreferences 사용 방법을 살펴보자.

공식 문서

https://developer.android.com/topic/security/data?hl=ko
https://developer.android.com/jetpack/androidx/releases/security?hl=ko

🔥 사용 방법

✓ build.gradle

implementation "androidx.security:security-crypto:1.1.0-alpha06"

✓ MainActivity.java

// 상수
private static final String PREFS_NAME = "my_api_key_prefs";
private static final String PREFS_KEY = "api_key";


// MasterKey 생성
MasterKey masterKey = new MasterKey.Builder(context)
		.setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
        .build();

// EncryptedSharedPreferences 생성
SharedPreferences sharedPreferences = EncryptedSharedPreferences.create(
        this,
		PREFS_NAME,
		masterKey,
		EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
		EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
);

// data 저장
SharedPreferences.Editor editor = sharedPreferences.edit();
editor.putString(PREFS_KEY, "저장할 데이터");
editor.apply();

// data 가져오기
String data = sharedPreferences.getString(PREFS_KEY, null);