famedlysdk/lib/encryption/ssss.dart

487 lines
16 KiB
Dart
Raw Normal View History

2020-06-05 20:03:28 +00:00
/*
* Famedly Matrix SDK
* Copyright (C) 2020 Famedly GmbH
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import 'dart:core';
2020-05-23 15:04:27 +00:00
import 'dart:convert';
import 'dart:typed_data';
2020-05-23 15:04:27 +00:00
2020-05-25 13:30:53 +00:00
import 'package:base58check/base58.dart';
import 'package:crypto/crypto.dart';
import 'package:encrypt/encrypt.dart';
2020-05-23 15:04:27 +00:00
import 'package:password_hash/password_hash.dart';
import '../famedlysdk.dart';
import '../matrix_api.dart';
import '../src/utils/logs.dart';
2020-06-05 20:03:28 +00:00
import 'encryption.dart';
2020-05-23 15:04:27 +00:00
const CACHE_TYPES = <String>[
'm.cross_signing.self_signing',
'm.cross_signing.user_signing',
'm.megolm_backup.v1'
];
const ZERO_STR =
'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00';
const BASE58_ALPHABET =
'123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
2020-05-25 13:30:53 +00:00
const base58 = Base58Codec(BASE58_ALPHABET);
2020-05-23 15:04:27 +00:00
const OLM_RECOVERY_KEY_PREFIX = [0x8B, 0x01];
const OLM_PRIVATE_KEY_LENGTH = 32; // TODO: fetch from dart-olm
class SSSS {
2020-06-05 20:03:28 +00:00
final Encryption encryption;
Client get client => encryption.client;
2020-05-23 15:04:27 +00:00
final pendingShareRequests = <String, _ShareRequest>{};
final _validators = <String, Future<bool> Function(String)>{};
2020-06-05 20:03:28 +00:00
SSSS(this.encryption);
2020-05-23 15:04:27 +00:00
static _DerivedKeys deriveKeys(Uint8List key, String name) {
final zerosalt = Uint8List(8);
final prk = Hmac(sha256, zerosalt).convert(key);
final b = Uint8List(1);
b[0] = 1;
final aesKey = Hmac(sha256, prk.bytes).convert(utf8.encode(name) + b);
b[0] = 2;
final hmacKey =
Hmac(sha256, prk.bytes).convert(aesKey.bytes + utf8.encode(name) + b);
return _DerivedKeys(aesKey: aesKey.bytes, hmacKey: hmacKey.bytes);
}
static _Encrypted encryptAes(String data, Uint8List key, String name,
[String ivStr]) {
Uint8List iv;
if (ivStr != null) {
iv = base64.decode(ivStr);
} else {
iv = Uint8List.fromList(SecureRandom(16).bytes);
}
// we need to clear bit 63 of the IV
iv[8] &= 0x7f;
final keys = deriveKeys(key, name);
final plain = Uint8List.fromList(utf8.encode(data));
final ciphertext = AES(Key(keys.aesKey), mode: AESMode.ctr, padding: null)
2020-05-23 15:05:55 +00:00
.encrypt(plain, iv: IV(iv))
.bytes;
2020-05-23 15:04:27 +00:00
final hmac = Hmac(sha256, keys.hmacKey).convert(ciphertext);
return _Encrypted(
iv: base64.encode(iv),
ciphertext: base64.encode(ciphertext),
mac: base64.encode(hmac.bytes));
}
static String decryptAes(_Encrypted data, Uint8List key, String name) {
final keys = deriveKeys(key, name);
2020-05-30 11:19:39 +00:00
final cipher = base64.decode(data.ciphertext);
2020-05-23 15:04:27 +00:00
final hmac = base64
2020-05-30 11:55:09 +00:00
.encode(Hmac(sha256, keys.hmacKey).convert(cipher).bytes)
2020-05-23 15:04:27 +00:00
.replaceAll(RegExp(r'=+$'), '');
if (hmac != data.mac.replaceAll(RegExp(r'=+$'), '')) {
throw 'Bad MAC';
}
2020-05-23 15:05:55 +00:00
final decipher = AES(Key(keys.aesKey), mode: AESMode.ctr, padding: null)
.decrypt(Encrypted(cipher), iv: IV(base64.decode(data.iv)));
2020-05-23 15:04:27 +00:00
return String.fromCharCodes(decipher);
}
static Uint8List decodeRecoveryKey(String recoveryKey) {
final result = base58.decode(recoveryKey.replaceAll(' ', ''));
var parity = 0;
for (final b in result) {
parity ^= b;
}
if (parity != 0) {
throw 'Incorrect parity';
}
for (var i = 0; i < OLM_RECOVERY_KEY_PREFIX.length; i++) {
if (result[i] != OLM_RECOVERY_KEY_PREFIX[i]) {
throw 'Incorrect prefix';
}
}
if (result.length !=
OLM_RECOVERY_KEY_PREFIX.length + OLM_PRIVATE_KEY_LENGTH + 1) {
throw 'Incorrect length';
}
return Uint8List.fromList(result.sublist(OLM_RECOVERY_KEY_PREFIX.length,
OLM_RECOVERY_KEY_PREFIX.length + OLM_PRIVATE_KEY_LENGTH));
}
2020-06-06 10:40:52 +00:00
static Uint8List keyFromPassphrase(String passphrase, _PassphraseInfo info) {
2020-05-23 15:04:27 +00:00
if (info.algorithm != 'm.pbkdf2') {
throw 'Unknown algorithm';
}
final generator = PBKDF2(hashAlgorithm: sha512);
2020-06-06 10:40:52 +00:00
return Uint8List.fromList(generator.generateKey(passphrase, info.salt,
info.iterations, info.bits != null ? (info.bits / 8).ceil() : 32));
2020-05-23 15:04:27 +00:00
}
void setValidator(String type, Future<bool> Function(String) validator) {
_validators[type] = validator;
}
2020-05-23 15:04:27 +00:00
String get defaultKeyId {
final keyData = client.accountData['m.secret_storage.default_key'];
if (keyData == null || !(keyData.content['key'] is String)) {
return null;
}
return keyData.content['key'];
}
2020-06-05 20:03:28 +00:00
BasicEvent getKey(String keyId) {
2020-05-23 15:04:27 +00:00
return client.accountData['m.secret_storage.key.${keyId}'];
}
2020-06-05 20:03:28 +00:00
bool checkKey(Uint8List key, BasicEvent keyData) {
2020-05-23 15:04:27 +00:00
final info = keyData.content;
if (info['algorithm'] == 'm.secret_storage.v1.aes-hmac-sha2') {
if ((info['mac'] is String) && (info['iv'] is String)) {
final encrypted = encryptAes(ZERO_STR, key, '', info['iv']);
return info['mac'].replaceAll(RegExp(r'=+$'), '') ==
encrypted.mac.replaceAll(RegExp(r'=+$'), '');
} else {
// no real information about the key, assume it is valid
return true;
}
} else {
throw 'Unknown Algorithm';
}
}
Future<String> getCached(String type) async {
if (client.database == null) {
return null;
}
final ret = await client.database.getSSSSCache(client.id, type);
if (ret == null) {
return null;
}
// check if it is still valid
final keys = keyIdsFromType(type);
2020-06-06 11:47:37 +00:00
if (keys.contains(ret.keyId) &&
client.accountData[type].content['encrypted'][ret.keyId]
['ciphertext'] ==
ret.ciphertext) {
2020-05-23 15:04:27 +00:00
return ret.content;
}
return null;
}
Future<String> getStored(String type, String keyId, Uint8List key) async {
final secretInfo = client.accountData[type];
if (secretInfo == null) {
throw 'Not found';
}
if (!(secretInfo.content['encrypted'] is Map)) {
throw 'Content is not encrypted';
}
if (!(secretInfo.content['encrypted'][keyId] is Map)) {
throw 'Wrong / unknown key';
}
final enc = secretInfo.content['encrypted'][keyId];
final encryptInfo = _Encrypted(
iv: enc['iv'], ciphertext: enc['ciphertext'], mac: enc['mac']);
final decrypted = decryptAes(encryptInfo, key, type);
if (CACHE_TYPES.contains(type) && client.database != null) {
// cache the thing
2020-06-06 11:47:37 +00:00
await client.database
.storeSSSSCache(client.id, type, keyId, enc['ciphertext'], decrypted);
2020-05-23 15:04:27 +00:00
}
return decrypted;
}
Future<void> store(
String type, String secret, String keyId, Uint8List key) async {
final encrypted = encryptAes(secret, key, type);
final content = <String, dynamic>{
'encrypted': <String, dynamic>{},
};
content['encrypted'][keyId] = <String, dynamic>{
'iv': encrypted.iv,
'ciphertext': encrypted.ciphertext,
'mac': encrypted.mac,
};
// store the thing in your account data
2020-08-11 16:11:51 +00:00
await client.setAccountData(client.userID, type, content);
2020-05-23 15:04:27 +00:00
if (CACHE_TYPES.contains(type) && client.database != null) {
// cache the thing
2020-06-06 11:47:37 +00:00
await client.database
.storeSSSSCache(client.id, type, keyId, encrypted.ciphertext, secret);
2020-05-23 15:04:27 +00:00
}
}
2020-05-25 13:30:53 +00:00
Future<void> maybeCacheAll(String keyId, Uint8List key) async {
for (final type in CACHE_TYPES) {
final secret = await getCached(type);
if (secret == null) {
try {
await getStored(type, keyId, key);
} catch (_) {
// the entry wasn't stored, just ignore it
}
2020-05-25 13:30:53 +00:00
}
}
}
2020-05-23 15:04:27 +00:00
Future<void> maybeRequestAll(List<DeviceKeys> devices) async {
for (final type in CACHE_TYPES) {
final secret = await getCached(type);
if (secret == null) {
await request(type, devices);
}
}
}
Future<void> request(String type, List<DeviceKeys> devices) async {
// only send to own, verified devices
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Requesting type ${type}...');
2020-05-23 15:04:27 +00:00
devices.removeWhere((DeviceKeys d) =>
d.userId != client.userID ||
!d.verified ||
d.blocked ||
d.deviceId == client.deviceID);
if (devices.isEmpty) {
2020-08-06 09:35:02 +00:00
Logs.warning('[SSSS] No devices');
2020-05-23 15:04:27 +00:00
return;
}
2020-05-29 07:06:36 +00:00
final requestId = client.generateUniqueTransactionId();
2020-05-23 15:04:27 +00:00
final request = _ShareRequest(
requestId: requestId,
type: type,
devices: devices,
);
pendingShareRequests[requestId] = request;
2020-08-11 16:11:51 +00:00
await client.sendToDeviceEncrypted(devices, 'm.secret.request', {
2020-05-23 15:04:27 +00:00
'action': 'request',
'requesting_device_id': client.deviceID,
'request_id': requestId,
'name': type,
});
}
Future<void> handleToDeviceEvent(ToDeviceEvent event) async {
if (event.type == 'm.secret.request') {
// got a request to share a secret
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Received sharing request...');
2020-05-23 15:04:27 +00:00
if (event.sender != client.userID ||
!client.userDeviceKeys.containsKey(client.userID)) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Not sent by us');
2020-05-23 15:04:27 +00:00
return; // we aren't asking for it ourselves, so ignore
}
if (event.content['action'] != 'request') {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] it is actually a cancelation');
2020-05-23 15:04:27 +00:00
return; // not actually requesting, so ignore
}
final device = client.userDeviceKeys[client.userID]
.deviceKeys[event.content['requesting_device_id']];
if (device == null || !device.verified || device.blocked) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Unknown / unverified devices, ignoring');
2020-05-23 15:04:27 +00:00
return; // nope....unknown or untrusted device
}
// alright, all seems fine...let's check if we actually have the secret they are asking for
final type = event.content['name'];
final secret = await getCached(type);
if (secret == null) {
2020-08-06 09:35:02 +00:00
Logs.info(
'[SSSS] We don\'t have the secret for ${type} ourself, ignoring');
2020-05-23 15:04:27 +00:00
return; // seems like we don't have this, either
}
// okay, all checks out...time to share this secret!
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Replying with secret for ${type}');
2020-08-11 16:11:51 +00:00
await client.sendToDeviceEncrypted(
2020-05-23 15:04:27 +00:00
[device],
'm.secret.send',
{
'request_id': event.content['request_id'],
'secret': secret,
});
} else if (event.type == 'm.secret.send') {
// receiving a secret we asked for
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Received shared secret...');
2020-05-23 15:04:27 +00:00
if (event.sender != client.userID ||
2020-05-29 07:06:36 +00:00
!pendingShareRequests.containsKey(event.content['request_id']) ||
event.encryptedContent == null) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Not by us or unknown request');
2020-05-23 15:04:27 +00:00
return; // we have no idea what we just received
}
final request = pendingShareRequests[event.content['request_id']];
2020-05-29 07:06:36 +00:00
// alright, as we received a known request id, let's check if the sender is valid
final device = request.devices.firstWhere(
(d) =>
d.userId == event.sender &&
d.curve25519Key == event.encryptedContent['sender_key'],
orElse: () => null);
if (device == null) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Someone else replied?');
2020-05-29 07:06:36 +00:00
return; // someone replied whom we didn't send the share request to
}
final secret = event.content['secret'];
2020-05-23 15:04:27 +00:00
if (!(event.content['secret'] is String)) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Secret wasn\'t a string');
2020-05-23 15:04:27 +00:00
return; // the secret wasn't a string....wut?
}
// let's validate if the secret is, well, valid
2020-05-30 11:55:09 +00:00
if (_validators.containsKey(request.type) &&
!(await _validators[request.type](secret))) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] The received secret was invalid');
return; // didn't pass the validator
}
pendingShareRequests.remove(request.requestId);
2020-05-23 15:04:27 +00:00
if (request.start.add(Duration(minutes: 15)).isBefore(DateTime.now())) {
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Request is too far in the past');
2020-05-23 15:04:27 +00:00
return; // our request is more than 15min in the past...better not trust it anymore
}
2020-08-06 09:35:02 +00:00
Logs.info('[SSSS] Secret for type ${request.type} is ok, storing it');
2020-05-23 15:04:27 +00:00
if (client.database != null) {
final keyId = keyIdFromType(request.type);
if (keyId != null) {
2020-06-06 11:47:37 +00:00
final ciphertext = client.accountData[request.type]
.content['encrypted'][keyId]['ciphertext'];
await client.database.storeSSSSCache(
client.id, request.type, keyId, ciphertext, secret);
2020-05-23 15:04:27 +00:00
}
}
}
}
Set<String> keyIdsFromType(String type) {
final data = client.accountData[type];
if (data == null) {
return null;
}
if (data.content['encrypted'] is Map) {
2020-05-25 13:30:53 +00:00
final Set keys = <String>{};
2020-05-23 15:04:27 +00:00
for (final key in data.content['encrypted'].keys) {
keys.add(key);
}
return keys;
}
return null;
}
String keyIdFromType(String type) {
final keys = keyIdsFromType(type);
if (keys == null || keys.isEmpty) {
return null;
}
if (keys.contains(defaultKeyId)) {
return defaultKeyId;
}
return keys.first;
}
OpenSSSS open([String identifier]) {
2020-05-25 13:30:53 +00:00
identifier ??= defaultKeyId;
2020-05-23 15:04:27 +00:00
if (identifier == null) {
throw 'Dont know what to open';
}
final keyToOpen = keyIdFromType(identifier) ?? identifier;
if (keyToOpen == null) {
throw 'No key found to open';
}
final key = getKey(keyToOpen);
if (key == null) {
throw 'Unknown key to open';
}
return OpenSSSS(ssss: this, keyId: keyToOpen, keyData: key);
}
}
class _ShareRequest {
final String requestId;
final String type;
final List<DeviceKeys> devices;
final DateTime start;
_ShareRequest({this.requestId, this.type, this.devices})
: start = DateTime.now();
}
class _Encrypted {
final String iv;
final String ciphertext;
final String mac;
_Encrypted({this.iv, this.ciphertext, this.mac});
}
class _DerivedKeys {
final Uint8List aesKey;
final Uint8List hmacKey;
_DerivedKeys({this.aesKey, this.hmacKey});
}
2020-06-06 10:40:52 +00:00
class _PassphraseInfo {
2020-05-23 15:04:27 +00:00
final String algorithm;
final String salt;
final int iterations;
final int bits;
2020-06-06 10:40:52 +00:00
_PassphraseInfo({this.algorithm, this.salt, this.iterations, this.bits});
2020-05-23 15:04:27 +00:00
}
class OpenSSSS {
final SSSS ssss;
final String keyId;
2020-06-05 20:03:28 +00:00
final BasicEvent keyData;
2020-05-23 15:04:27 +00:00
OpenSSSS({this.ssss, this.keyId, this.keyData});
Uint8List privateKey;
bool get isUnlocked => privateKey != null;
2020-06-06 10:40:52 +00:00
void unlock({String passphrase, String recoveryKey}) {
if (passphrase != null) {
privateKey = SSSS.keyFromPassphrase(
passphrase,
_PassphraseInfo(
2020-05-23 15:04:27 +00:00
algorithm: keyData.content['passphrase']['algorithm'],
salt: keyData.content['passphrase']['salt'],
iterations: keyData.content['passphrase']['iterations'],
bits: keyData.content['passphrase']['bits']));
} else if (recoveryKey != null) {
privateKey = SSSS.decodeRecoveryKey(recoveryKey);
} else {
throw 'Nothing specified';
}
// verify the validity of the key
if (!ssss.checkKey(privateKey, keyData)) {
privateKey = null;
throw 'Inalid key';
}
}
Future<String> getStored(String type) async {
return await ssss.getStored(type, keyId, privateKey);
}
2020-05-25 13:30:53 +00:00
2020-05-27 19:40:58 +00:00
Future<void> store(String type, String secret) async {
await ssss.store(type, secret, keyId, privateKey);
}
2020-05-25 13:30:53 +00:00
Future<void> maybeCacheAll() async {
await ssss.maybeCacheAll(keyId, privateKey);
}
2020-05-23 15:04:27 +00:00
}