cake_wallet/lib/core/backup_service.dart

505 lines
20 KiB
Dart
Raw Normal View History

2021-01-13 16:43:34 +00:00
import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';
import 'package:cw_core/root_dir.dart';
2022-02-03 18:04:16 +00:00
import 'package:cw_core/wallet_type.dart';
2021-01-13 16:43:34 +00:00
import 'package:flutter/foundation.dart';
import 'package:hive/hive.dart';
import 'package:cake_wallet/core/secure_storage.dart';
2021-01-13 16:43:34 +00:00
import 'package:path_provider/path_provider.dart';
import 'package:cryptography/cryptography.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:archive/archive_io.dart';
import 'package:cake_wallet/core/key_service.dart';
import 'package:cake_wallet/entities/encrypt.dart';
import 'package:cake_wallet/entities/preferences_key.dart';
import 'package:cake_wallet/entities/secret_store_key.dart';
2021-12-24 12:37:24 +00:00
import 'package:cw_core/wallet_info.dart';
2021-01-15 17:41:30 +00:00
import 'package:cake_wallet/.secrets.g.dart' as secrets;
2022-02-02 12:40:40 +00:00
import 'package:cake_wallet/wallet_types.g.dart';
import 'package:cake_backup/backup.dart' as cake_backup;
2021-01-13 16:43:34 +00:00
class BackupService {
2021-01-15 17:41:30 +00:00
BackupService(this._flutterSecureStorage, this._walletInfoSource,
this._keyService, this._sharedPreferences)
2022-10-12 17:09:57 +00:00
: _cipher = Cryptography.instance.chacha20Poly1305Aead(),
_correctWallets = <WalletInfo>[];
2021-01-13 16:43:34 +00:00
static const currentVersion = _v2;
2021-01-15 17:41:30 +00:00
static const _v1 = 1;
static const _v2 = 2;
2021-01-15 17:41:30 +00:00
2021-01-13 16:43:34 +00:00
final Cipher _cipher;
final SecureStorage _flutterSecureStorage;
2021-01-13 16:43:34 +00:00
final SharedPreferences _sharedPreferences;
final Box<WalletInfo> _walletInfoSource;
final KeyService _keyService;
2022-02-02 12:40:40 +00:00
List<WalletInfo> _correctWallets;
2021-01-13 16:43:34 +00:00
Future<void> importBackup(Uint8List data, String password,
2021-01-15 17:41:30 +00:00
{String nonce = secrets.backupSalt}) async {
final version = getVersion(data);
switch (version) {
case _v1:
final backupBytes = data.toList()..removeAt(0);
final backupData = Uint8List.fromList(backupBytes);
2021-01-15 17:41:30 +00:00
await _importBackupV1(backupData, password, nonce: nonce);
break;
case _v2:
await _importBackupV2(data, password);
break;
2021-01-15 17:41:30 +00:00
default:
break;
}
}
Future<Uint8List> exportBackup(String password,
{String nonce = secrets.backupSalt, int version = currentVersion}) async {
switch (version) {
case _v1:
return await _exportBackupV1(password, nonce: nonce);
case _v2:
return await _exportBackupV2(password);
2021-01-15 17:41:30 +00:00
default:
2022-10-12 17:09:57 +00:00
throw Exception('Incorrect version: $version for exportBackup');
2021-01-15 17:41:30 +00:00
}
}
@Deprecated('Use v2 instead')
2021-01-15 17:41:30 +00:00
Future<Uint8List> _exportBackupV1(String password,
{String nonce = secrets.backupSalt}) async
=> throw Exception('Deprecated. Export for backups v1 is deprecated. Please use export v2.');
Future<Uint8List> _exportBackupV2(String password) async {
2021-01-15 17:41:30 +00:00
final zipEncoder = ZipFileEncoder();
final appDir = await getAppDir();
2021-01-15 17:41:30 +00:00
final now = DateTime.now();
final tmpDir = Directory('${appDir.path}/~_BACKUP_TMP');
final archivePath = '${tmpDir.path}/backup_${now.toString()}.zip';
final fileEntities = appDir.listSync(recursive: false);
final keychainDump = await _exportKeychainDumpV2(password);
2021-01-15 17:41:30 +00:00
final preferencesDump = await _exportPreferencesJSON();
final preferencesDumpFile = File('${tmpDir.path}/~_preferences_dump_TMP');
final keychainDumpFile = File('${tmpDir.path}/~_keychain_dump_TMP');
if (tmpDir.existsSync()) {
tmpDir.deleteSync(recursive: true);
}
tmpDir.createSync();
zipEncoder.create(archivePath);
fileEntities.forEach((entity) {
if (entity.path == archivePath || entity.path == tmpDir.path) {
return;
}
if (entity.statSync().type == FileSystemEntityType.directory) {
zipEncoder.addDirectory(Directory(entity.path));
} else {
zipEncoder.addFile(File(entity.path));
}
});
await keychainDumpFile.writeAsBytes(keychainDump.toList());
await preferencesDumpFile.writeAsString(preferencesDump);
2022-10-12 17:09:57 +00:00
await zipEncoder.addFile(preferencesDumpFile, '~_preferences_dump');
await zipEncoder.addFile(keychainDumpFile, '~_keychain_dump');
2021-01-15 17:41:30 +00:00
zipEncoder.close();
final content = File(archivePath).readAsBytesSync();
tmpDir.deleteSync(recursive: true);
return await _encryptV2(content, password);
2021-01-15 17:41:30 +00:00
}
Future<void> _importBackupV1(Uint8List data, String password,
2022-10-12 17:09:57 +00:00
{required String nonce}) async {
final appDir = await getAppDir();
final decryptedData = await _decryptV1(data, password, nonce);
2021-01-13 16:43:34 +00:00
final zip = ZipDecoder().decodeBytes(decryptedData);
zip.files.forEach((file) {
final filename = file.name;
if (file.isFile) {
2021-01-15 17:41:30 +00:00
final content = file.content as List<int>;
2021-01-13 16:43:34 +00:00
File('${appDir.path}/' + filename)
..createSync(recursive: true)
2021-01-15 17:41:30 +00:00
..writeAsBytesSync(content);
2021-01-13 16:43:34 +00:00
} else {
Directory('${appDir.path}/' + filename)..create(recursive: true);
}
});
2022-02-02 12:40:40 +00:00
await _verifyWallets();
await _importKeychainDumpV1(password, nonce: nonce);
await _importPreferencesDump();
}
Future<void> _importBackupV2(Uint8List data, String password) async {
final appDir = await getAppDir();
final decryptedData = await _decryptV2(data, password);
final zip = ZipDecoder().decodeBytes(decryptedData);
zip.files.forEach((file) {
final filename = file.name;
if (file.isFile) {
final content = file.content as List<int>;
File('${appDir.path}/' + filename)
..createSync(recursive: true)
..writeAsBytesSync(content);
} else {
Directory('${appDir.path}/' + filename)..create(recursive: true);
}
});
await _verifyWallets();
await _importKeychainDumpV2(password);
2021-01-15 17:41:30 +00:00
await _importPreferencesDump();
2021-01-13 16:43:34 +00:00
}
2022-02-02 12:40:40 +00:00
Future<void> _verifyWallets() async {
final walletInfoSource = await _reloadHiveWalletInfoBox();
_correctWallets = walletInfoSource
.values
.where((info) => availableWalletTypes.contains(info.type))
.toList();
if (_correctWallets.isEmpty) {
throw Exception('Correct wallets not detected');
}
}
Future<Box<WalletInfo>> _reloadHiveWalletInfoBox() async {
final appDir = await getAppDir();
2022-02-02 12:40:40 +00:00
await Hive.close();
Hive.init(appDir.path);
if (!Hive.isAdapterRegistered(WalletInfo.typeId)) {
Hive.registerAdapter(WalletInfoAdapter());
}
return await Hive.openBox<WalletInfo>(WalletInfo.boxName);
}
2021-01-15 17:41:30 +00:00
Future<void> _importPreferencesDump() async {
final appDir = await getAppDir();
2021-01-13 16:43:34 +00:00
final preferencesFile = File('${appDir.path}/~_preferences_dump');
if (!preferencesFile.existsSync()) {
return;
}
final data =
2022-10-18 15:38:54 +00:00
json.decode(preferencesFile.readAsStringSync()) as Map<String, dynamic>;
2022-02-02 12:40:40 +00:00
String currentWalletName = data[PreferencesKey.currentWalletName] as String;
int currentWalletType = data[PreferencesKey.currentWalletType] as int;
final isCorrentCurrentWallet = _correctWallets
.any((info) => info.name == currentWalletName &&
info.type.index == currentWalletType);
if (!isCorrentCurrentWallet) {
currentWalletName = _correctWallets.first.name;
2022-02-03 18:04:16 +00:00
currentWalletType = serializeToInt(_correctWallets.first.type);
2022-02-02 12:40:40 +00:00
}
2021-01-13 16:43:34 +00:00
2022-10-18 15:38:54 +00:00
final currentNodeId = data[PreferencesKey.currentNodeIdKey] as int?;
final currentBalanceDisplayMode = data[PreferencesKey.currentBalanceDisplayModeKey] as int?;
final currentFiatCurrency = data[PreferencesKey.currentFiatCurrencyKey] as String?;
final shouldSaveRecipientAddress = data[PreferencesKey.shouldSaveRecipientAddressKey] as bool?;
final isAppSecure = data[PreferencesKey.isAppSecureKey] as bool?;
final disableBuy = data[PreferencesKey.disableBuyKey] as bool?;
final disableSell = data[PreferencesKey.disableSellKey] as bool?;
2022-10-18 15:38:54 +00:00
final currentTransactionPriorityKeyLegacy = data[PreferencesKey.currentTransactionPriorityKeyLegacy] as int?;
final allowBiometricalAuthentication = data[PreferencesKey.allowBiometricalAuthenticationKey] as bool?;
final currentBitcoinElectrumSererId = data[PreferencesKey.currentBitcoinElectrumSererIdKey] as int?;
final currentLanguageCode = data[PreferencesKey.currentLanguageCode] as String?;
final displayActionListMode = data[PreferencesKey.displayActionListModeKey] as int?;
final fiatApiMode = data[PreferencesKey.currentFiatApiModeKey] as int?;
2022-10-18 15:38:54 +00:00
final currentPinLength = data[PreferencesKey.currentPinLength] as int?;
final currentTheme = data[PreferencesKey.currentTheme] as int?;
2023-03-02 15:43:42 +00:00
final exchangeStatus = data[PreferencesKey.exchangeStatusKey] as int?;
2022-10-18 15:38:54 +00:00
final currentDefaultSettingsMigrationVersion = data[PreferencesKey.currentDefaultSettingsMigrationVersion] as int?;
final moneroTransactionPriority = data[PreferencesKey.moneroTransactionPriority] as int?;
final bitcoinTransactionPriority = data[PreferencesKey.bitcoinTransactionPriority] as int?;
2021-01-13 16:43:34 +00:00
await _sharedPreferences.setString(PreferencesKey.currentWalletName,
2022-02-02 12:40:40 +00:00
currentWalletName);
2022-10-18 15:38:54 +00:00
if (currentNodeId != null)
await _sharedPreferences.setInt(PreferencesKey.currentNodeIdKey,
currentNodeId);
if (currentBalanceDisplayMode != null)
await _sharedPreferences.setInt(PreferencesKey.currentBalanceDisplayModeKey,
currentBalanceDisplayMode);
2021-01-13 16:43:34 +00:00
await _sharedPreferences.setInt(PreferencesKey.currentWalletType,
2022-02-02 12:40:40 +00:00
currentWalletType);
2022-10-18 15:38:54 +00:00
if (currentFiatCurrency != null)
await _sharedPreferences.setString(PreferencesKey.currentFiatCurrencyKey,
currentFiatCurrency);
if (shouldSaveRecipientAddress != null)
await _sharedPreferences.setBool(
2021-01-13 16:43:34 +00:00
PreferencesKey.shouldSaveRecipientAddressKey,
2022-10-18 15:38:54 +00:00
shouldSaveRecipientAddress);
if (isAppSecure != null)
await _sharedPreferences.setBool(
PreferencesKey.isAppSecureKey,
isAppSecure);
if (disableBuy != null)
await _sharedPreferences.setBool(
PreferencesKey.disableBuyKey,
disableBuy);
if (disableSell != null)
await _sharedPreferences.setBool(
PreferencesKey.disableSellKey,
disableSell);
2022-10-18 15:38:54 +00:00
if (currentTransactionPriorityKeyLegacy != null)
await _sharedPreferences.setInt(
2021-01-27 13:51:51 +00:00
PreferencesKey.currentTransactionPriorityKeyLegacy,
2022-10-18 15:38:54 +00:00
currentTransactionPriorityKeyLegacy);
if (allowBiometricalAuthentication != null)
await _sharedPreferences.setBool(
2021-01-13 16:43:34 +00:00
PreferencesKey.allowBiometricalAuthenticationKey,
2022-10-18 15:38:54 +00:00
allowBiometricalAuthentication);
if (currentBitcoinElectrumSererId != null)
await _sharedPreferences.setInt(
2021-01-13 16:43:34 +00:00
PreferencesKey.currentBitcoinElectrumSererIdKey,
2022-10-18 15:38:54 +00:00
currentBitcoinElectrumSererId);
if (currentLanguageCode != null)
await _sharedPreferences.setString(PreferencesKey.currentLanguageCode,
currentLanguageCode);
if (displayActionListMode != null)
await _sharedPreferences.setInt(PreferencesKey.displayActionListModeKey,
displayActionListMode);
if (fiatApiMode != null)
await _sharedPreferences.setInt(PreferencesKey.currentFiatApiModeKey,
fiatApiMode);
2022-10-18 15:38:54 +00:00
if (currentPinLength != null)
await _sharedPreferences.setInt(PreferencesKey.currentPinLength,
currentPinLength);
if (currentTheme != null)
await _sharedPreferences.setInt(
PreferencesKey.currentTheme, currentTheme);
2023-03-02 15:13:25 +00:00
if (exchangeStatus != null)
2023-03-02 15:43:42 +00:00
await _sharedPreferences.setInt(
2023-03-02 15:13:25 +00:00
PreferencesKey.exchangeStatusKey, exchangeStatus);
2022-10-18 15:38:54 +00:00
if (currentDefaultSettingsMigrationVersion != null)
await _sharedPreferences.setInt(
PreferencesKey.currentDefaultSettingsMigrationVersion,
2022-10-18 15:38:54 +00:00
currentDefaultSettingsMigrationVersion);
if (moneroTransactionPriority != null)
await _sharedPreferences.setInt(PreferencesKey.moneroTransactionPriority,
moneroTransactionPriority);
if (bitcoinTransactionPriority != null)
await _sharedPreferences.setInt(PreferencesKey.bitcoinTransactionPriority,
bitcoinTransactionPriority);
2021-01-13 16:43:34 +00:00
await preferencesFile.delete();
}
Future<void> _importKeychainDumpV1(String password,
2022-10-12 17:09:57 +00:00
{required String nonce,
2021-01-15 17:41:30 +00:00
String keychainSalt = secrets.backupKeychainSalt}) async {
final appDir = await getAppDir();
2021-01-13 16:43:34 +00:00
final keychainDumpFile = File('${appDir.path}/~_keychain_dump');
final decryptedKeychainDumpFileData = await _decryptV1(
2021-01-15 17:41:30 +00:00
keychainDumpFile.readAsBytesSync(), '$keychainSalt$password', nonce);
2021-01-13 16:43:34 +00:00
final keychainJSON = json.decode(utf8.decode(decryptedKeychainDumpFileData))
as Map<String, dynamic>;
final keychainWalletsInfo = keychainJSON['wallets'] as List;
final decodedPin = keychainJSON['pin'] as String;
final pinCodeKey = generateStoreKeyFor(key: SecretStoreKey.pinCodePassword);
2021-01-15 17:41:30 +00:00
final backupPasswordKey =
generateStoreKeyFor(key: SecretStoreKey.backupPassword);
final backupPassword = keychainJSON[backupPasswordKey] as String;
await _flutterSecureStorage.write(
key: backupPasswordKey, value: backupPassword);
2021-01-13 16:43:34 +00:00
keychainWalletsInfo.forEach((dynamic rawInfo) async {
final info = rawInfo as Map<String, dynamic>;
await importWalletKeychainInfo(info);
});
await _flutterSecureStorage.write(
key: pinCodeKey, value: encodedPinCode(pin: decodedPin));
keychainDumpFile.deleteSync();
}
Future<void> _importKeychainDumpV2(String password,
{String keychainSalt = secrets.backupKeychainSalt}) async {
final appDir = await getAppDir();
final keychainDumpFile = File('${appDir.path}/~_keychain_dump');
final decryptedKeychainDumpFileData = await _decryptV2(
keychainDumpFile.readAsBytesSync(), '$keychainSalt$password');
final keychainJSON = json.decode(utf8.decode(decryptedKeychainDumpFileData))
as Map<String, dynamic>;
final keychainWalletsInfo = keychainJSON['wallets'] as List;
final decodedPin = keychainJSON['pin'] as String;
final pinCodeKey = generateStoreKeyFor(key: SecretStoreKey.pinCodePassword);
final backupPasswordKey =
generateStoreKeyFor(key: SecretStoreKey.backupPassword);
final backupPassword = keychainJSON[backupPasswordKey] as String;
await _flutterSecureStorage.write(
key: backupPasswordKey, value: backupPassword);
keychainWalletsInfo.forEach((dynamic rawInfo) async {
final info = rawInfo as Map<String, dynamic>;
await importWalletKeychainInfo(info);
});
await _flutterSecureStorage.write(
key: pinCodeKey, value: encodedPinCode(pin: decodedPin));
keychainDumpFile.deleteSync();
}
2021-01-13 16:43:34 +00:00
Future<void> importWalletKeychainInfo(Map<String, dynamic> info) async {
final name = info['name'] as String;
final password = info['password'] as String;
await _keyService.saveWalletPassword(walletName: name, password: password);
}
@Deprecated('Use v2 instead')
Future<Uint8List> _exportKeychainDumpV1(String password,
2022-10-12 17:09:57 +00:00
{required String nonce,
String keychainSalt = secrets.backupKeychainSalt}) async
=> throw Exception('Deprecated');
Future<Uint8List> _exportKeychainDumpV2(String password,
{String keychainSalt = secrets.backupKeychainSalt}) async {
2021-01-13 16:43:34 +00:00
final key = generateStoreKeyFor(key: SecretStoreKey.pinCodePassword);
final encodedPin = await _flutterSecureStorage.read(key: key);
2022-10-12 17:09:57 +00:00
final decodedPin = decodedPinCode(pin: encodedPin!);
2021-01-13 16:43:34 +00:00
final wallets =
await Future.wait(_walletInfoSource.values.map((walletInfo) async {
return {
'name': walletInfo.name,
'type': walletInfo.type.toString(),
'password':
await _keyService.getWalletPassword(walletName: walletInfo.name)
};
}));
2021-01-15 17:41:30 +00:00
final backupPasswordKey =
generateStoreKeyFor(key: SecretStoreKey.backupPassword);
final backupPassword =
await _flutterSecureStorage.read(key: backupPasswordKey);
final data = utf8.encode(json.encode({
'pin': decodedPin,
'wallets': wallets,
backupPasswordKey: backupPassword
}));
final encrypted = await _encryptV2(
Uint8List.fromList(data), '$keychainSalt$password');
2021-01-13 16:43:34 +00:00
return encrypted;
}
2021-01-15 17:41:30 +00:00
Future<String> _exportPreferencesJSON() async {
2022-10-18 15:38:54 +00:00
final preferences = <String, dynamic>{
2021-01-13 16:43:34 +00:00
PreferencesKey.currentWalletName:
_sharedPreferences.getString(PreferencesKey.currentWalletName),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentNodeIdKey:
_sharedPreferences.getInt(PreferencesKey.currentNodeIdKey),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentBalanceDisplayModeKey: _sharedPreferences
.getInt(PreferencesKey.currentBalanceDisplayModeKey),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentWalletType:
_sharedPreferences.getInt(PreferencesKey.currentWalletType),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentFiatCurrencyKey:
_sharedPreferences.getString(PreferencesKey.currentFiatCurrencyKey),
2021-01-13 16:43:34 +00:00
PreferencesKey.shouldSaveRecipientAddressKey: _sharedPreferences
.getBool(PreferencesKey.shouldSaveRecipientAddressKey),
PreferencesKey.disableBuyKey: _sharedPreferences
.getBool(PreferencesKey.disableBuyKey),
PreferencesKey.disableSellKey: _sharedPreferences
.getBool(PreferencesKey.disableSellKey),
2021-01-13 17:18:28 +00:00
PreferencesKey.isDarkThemeLegacy:
_sharedPreferences.getBool(PreferencesKey.isDarkThemeLegacy),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentPinLength:
_sharedPreferences.getInt(PreferencesKey.currentPinLength),
2021-01-27 13:51:51 +00:00
PreferencesKey.currentTransactionPriorityKeyLegacy: _sharedPreferences
.getInt(PreferencesKey.currentTransactionPriorityKeyLegacy),
2021-01-13 16:43:34 +00:00
PreferencesKey.allowBiometricalAuthenticationKey: _sharedPreferences
.getBool(PreferencesKey.allowBiometricalAuthenticationKey),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentBitcoinElectrumSererIdKey: _sharedPreferences
.getInt(PreferencesKey.currentBitcoinElectrumSererIdKey),
2021-01-13 16:43:34 +00:00
PreferencesKey.currentLanguageCode:
_sharedPreferences.getString(PreferencesKey.currentLanguageCode),
2021-01-13 16:43:34 +00:00
PreferencesKey.displayActionListModeKey:
_sharedPreferences.getInt(PreferencesKey.displayActionListModeKey),
2021-01-15 17:41:30 +00:00
PreferencesKey.currentTheme:
_sharedPreferences.getInt(PreferencesKey.currentTheme),
2023-03-02 15:13:25 +00:00
PreferencesKey.exchangeStatusKey:
2023-03-02 15:43:42 +00:00
_sharedPreferences.getInt(PreferencesKey.exchangeStatusKey),
PreferencesKey.currentDefaultSettingsMigrationVersion: _sharedPreferences
.getInt(PreferencesKey.currentDefaultSettingsMigrationVersion),
PreferencesKey.bitcoinTransactionPriority:
_sharedPreferences.getInt(PreferencesKey.bitcoinTransactionPriority),
PreferencesKey.moneroTransactionPriority:
_sharedPreferences.getInt(PreferencesKey.moneroTransactionPriority),
PreferencesKey.currentFiatApiModeKey:
_sharedPreferences.getInt(PreferencesKey.currentFiatApiModeKey),
2021-01-13 16:43:34 +00:00
};
return json.encode(preferences);
}
2021-01-15 17:41:30 +00:00
int getVersion(Uint8List data) => data.toList().first;
Uint8List setVersion(Uint8List data, int version) {
final bytes = data.toList()..insert(0, version);
return Uint8List.fromList(bytes);
}
@Deprecated('Use v2 instead')
Future<Uint8List> _encryptV1(
Uint8List data, String secretKeySource, String nonceBase64) async
=> throw Exception('Deprecated');
2021-01-13 16:43:34 +00:00
Future<Uint8List> _decryptV1(
2022-10-18 15:38:54 +00:00
Uint8List data, String secretKeySource, String nonceBase64, {int macLength = 16}) async {
final secretKeyHash = await Cryptography.instance.sha256().hash(utf8.encode(secretKeySource));
final secretKey = SecretKey(secretKeyHash.bytes);
final nonce = base64.decode(nonceBase64).toList();
final box = SecretBox(
Uint8List.sublistView(data, 0, data.lengthInBytes - macLength).toList(),
nonce: nonce,
mac: Mac(Uint8List.sublistView(data, data.lengthInBytes - macLength)));
final plainData = await _cipher.decrypt(box, secretKey: secretKey);
return Uint8List.fromList(plainData);
2021-01-13 16:43:34 +00:00
}
Future<Uint8List> _encryptV2(
Uint8List data, String passphrase) async
=> cake_backup.encrypt(passphrase, data, version: _v2);
Future<Uint8List> _decryptV2(
Uint8List data, String passphrase) async
=> cake_backup.decrypt(passphrase, data);
2021-01-13 16:43:34 +00:00
}