anotherim-desktop/plugins/omemo/src/protocol/stream_module.vala
2023-02-05 18:49:32 +01:00

332 lines
15 KiB
Vala

using Gee;
using Xmpp;
using Xmpp.Xep;
using Signal;
namespace Dino.Plugins.Omemo {
internal const string NS_URI = "eu.siacs.conversations.axolotl";
private const string NODE_DEVICELIST = NS_URI + ".devicelist";
private const string NODE_BUNDLES = NS_URI + ".bundles";
private const string NODE_VERIFICATION = NS_URI + ".verification";
private const int NUM_KEYS_TO_PUBLISH = 100;
public class StreamModule : XmppStreamModule {
public static Xmpp.ModuleIdentity<StreamModule> IDENTITY = new Xmpp.ModuleIdentity<StreamModule>(NS_URI, "omemo_module");
private static TimeSpan IGNORE_TIME = TimeSpan.MINUTE;
public Store store { public get; private set; }
private ConcurrentSet<string> active_bundle_requests = new ConcurrentSet<string>();
private HashMap<Jid, Future<ArrayList<int32>>> active_devicelist_requests = new HashMap<Jid, Future<ArrayList<int32>>>(Jid.hash_func, Jid.equals_func);
private Map<string, DateTime> device_ignore_time = new HashMap<string, DateTime>();
public signal void device_list_loaded(Jid jid, ArrayList<int32> devices);
public signal void bundle_fetched(Jid jid, int device_id, Bundle bundle);
public signal void bundle_fetch_failed(Jid jid, int device_id);
public StreamModule(Store store) {
this.store = store;
}
public override void attach(XmppStream stream) {
stream.get_module(Pubsub.Module.IDENTITY).add_filtered_notification(stream, NODE_DEVICELIST, true,
(stream, jid, id, node) => parse_device_list(stream, jid, id, node), null);
}
public override void detach(XmppStream stream) {
stream.get_module(Pubsub.Module.IDENTITY).remove_filtered_notification(stream, NODE_DEVICELIST);
}
public async ArrayList<int32> request_user_devicelist(XmppStream stream, Jid jid) {
var future = active_devicelist_requests[jid];
if (future == null) {
var promise = new Promise<ArrayList<int32>?>();
future = promise.future;
active_devicelist_requests[jid] = future;
stream.get_module(Pubsub.Module.IDENTITY).request(stream, jid, NODE_DEVICELIST, (stream, jid, id, node) => {
ArrayList<int32> device_list = parse_device_list(stream, jid, id, node);
promise.set_value(device_list);
active_devicelist_requests.unset(jid);
});
}
try {
ArrayList<int32> device_list = yield future.wait_async();
return device_list;
} catch (FutureError error) {
warning("Future error when waiting for device list: %s", error.message);
return new ArrayList<int32>();
}
}
public ArrayList<int32> parse_device_list(XmppStream stream, Jid jid, string? id, StanzaNode? node_) {
ArrayList<int32> device_list = new ArrayList<int32>();
StanzaNode node = node_ ?? new StanzaNode.build("list", NS_URI).add_self_xmlns();
Jid? my_jid = stream.get_flag(Bind.Flag.IDENTITY).my_jid;
if (my_jid == null) return device_list;
if (jid.equals_bare(my_jid) && store.local_registration_id != 0) {
bool am_on_devicelist = false;
foreach (StanzaNode device_node in node.get_subnodes("device")) {
int device_id = device_node.get_attribute_int("id");
if (store.local_registration_id == device_id) {
am_on_devicelist = true;
}
}
if (!am_on_devicelist) {
debug("Not on device list, adding id");
node.put_node(new StanzaNode.build("device", NS_URI).put_attribute("id", store.local_registration_id.to_string()));
stream.get_module(Pubsub.Module.IDENTITY).publish.begin(stream, jid, NODE_DEVICELIST, id, node, null, true, () => {
try_make_node_public.begin(stream, NODE_DEVICELIST);
});
}
publish_bundles_if_needed(stream, jid);
}
foreach (StanzaNode device_node in node.get_subnodes("device")) {
device_list.add(device_node.get_attribute_int("id"));
}
device_list_loaded(jid, device_list);
return device_list;
}
public void fetch_bundles(XmppStream stream, Jid jid, Gee.List<int32> devices) {
Address address = new Address(jid.bare_jid.to_string(), 0);
foreach(int32 device_id in devices) {
if (!is_ignored_device(jid, device_id)) {
address.device_id = device_id;
try {
if (!store.contains_session(address)) {
fetch_bundle(stream, jid, device_id);
}
} catch (Error e) {
// Ignore
}
}
}
address.device_id = 0; // TODO: Hack to have address obj live longer
}
public void fetch_bundle(XmppStream stream, Jid jid, int device_id, bool ignore_if_non_present = true) {
if (active_bundle_requests.add(jid.bare_jid.to_string() + @":$device_id")) {
debug("Asking for bundle for %s/%d", jid.bare_jid.to_string(), device_id);
stream.get_module(Pubsub.Module.IDENTITY).request(stream, jid.bare_jid, @"$NODE_BUNDLES:$device_id", (stream, jid, id, node) => {
on_other_bundle_result(stream, jid, device_id, id, node, ignore_if_non_present);
});
}
}
public void ignore_device(Jid jid, int32 device_id) {
if (device_id <= 0) return;
lock (device_ignore_time) {
device_ignore_time[jid.bare_jid.to_string() + @":$device_id"] = new DateTime.now_utc();
}
}
public void unignore_device(Jid jid, int32 device_id) {
if (device_id <= 0) return;
lock (device_ignore_time) {
device_ignore_time.unset(jid.bare_jid.to_string() + @":$device_id");
}
}
public bool is_ignored_device(Jid jid, int32 device_id) {
if (device_id <= 0) return true;
lock (device_ignore_time) {
string id = jid.bare_jid.to_string() + @":$device_id";
if (device_ignore_time.has_key(id)) {
return new DateTime.now_utc().difference(device_ignore_time[id]) < IGNORE_TIME;
}
}
return false;
}
public void clear_device_list(XmppStream stream) {
stream.get_module(Pubsub.Module.IDENTITY).delete_node(stream, null, NODE_DEVICELIST);
}
private void on_other_bundle_result(XmppStream stream, Jid jid, int device_id, string? id, StanzaNode? node, bool ignore_if_non_present) {
if (node == null) {
// Device not registered, shouldn't exist
if (ignore_if_non_present) {
debug("Ignoring device %s/%d: No bundle", jid.bare_jid.to_string(), device_id);
stream.get_module(IDENTITY).ignore_device(jid, device_id);
}
bundle_fetch_failed(jid, device_id);
} else {
Bundle bundle = new Bundle(node);
stream.get_module(IDENTITY).unignore_device(jid, device_id);
debug("Received bundle for %s/%d: %s", jid.bare_jid.to_string(), device_id, Base64.encode(bundle.identity_key.serialize()));
bundle_fetched(jid, device_id, bundle);
}
stream.get_module(IDENTITY).active_bundle_requests.remove(jid.bare_jid.to_string() + @":$device_id");
}
public bool start_session(XmppStream stream, Jid jid, int32 device_id, Bundle bundle) {
bool fail = false;
int32 signed_pre_key_id = bundle.signed_pre_key_id;
ECPublicKey? signed_pre_key = bundle.signed_pre_key;
uint8[] signed_pre_key_signature = bundle.signed_pre_key_signature;
ECPublicKey? identity_key = bundle.identity_key;
ArrayList<Bundle.PreKey> pre_keys = bundle.pre_keys;
if (signed_pre_key_id < 0 || signed_pre_key == null || identity_key == null || pre_keys.size == 0) {
fail = true;
} else {
int pre_key_idx = Random.int_range(0, pre_keys.size);
int32 pre_key_id = pre_keys[pre_key_idx].key_id;
ECPublicKey? pre_key = pre_keys[pre_key_idx].key;
if (pre_key_id < 0 || pre_key == null) {
fail = true;
} else {
Address address = new Address(jid.bare_jid.to_string(), device_id);
try {
if (store.contains_session(address)) {
return false;
}
debug("Starting new session for encryption with %s/%d", jid.bare_jid.to_string(), device_id);
SessionBuilder builder = store.create_session_builder(address);
builder.process_pre_key_bundle(create_pre_key_bundle(device_id, device_id, pre_key_id, pre_key, signed_pre_key_id, signed_pre_key, signed_pre_key_signature, identity_key));
} catch (Error e) {
debug("Can't create session with %s/%d: %s", jid.bare_jid.to_string(), device_id, e.message);
fail = true;
}
address.device_id = 0; // TODO: Hack to have address obj live longer
}
}
if (fail) {
debug("Ignoring device %s/%d: Bad bundle: %s", jid.bare_jid.to_string(), device_id, bundle.node.to_string());
stream.get_module(IDENTITY).ignore_device(jid, device_id);
}
return true;
}
public void publish_bundles_if_needed(XmppStream stream, Jid jid) {
if (active_bundle_requests.add(jid.bare_jid.to_string() + @":$(store.local_registration_id)")) {
stream.get_module(Pubsub.Module.IDENTITY).request(stream, jid, @"$NODE_BUNDLES:$(store.local_registration_id)", on_self_bundle_result);
}
}
private void on_self_bundle_result(XmppStream stream, Jid jid, string? id, StanzaNode? node) {
if (!Plugin.ensure_context()) return;
Map<int, ECPublicKey> keys = new HashMap<int, ECPublicKey>();
ECPublicKey? identity_key = null;
int32 signed_pre_key_id = -1;
ECPublicKey? signed_pre_key = null;
SignedPreKeyRecord? signed_pre_key_record = null;
bool changed = false;
if (node == null) {
identity_key = store.identity_key_pair.public;
changed = true;
} else {
Bundle bundle = new Bundle(node);
foreach (Bundle.PreKey prekey in bundle.pre_keys) {
ECPublicKey? key = prekey.key;
if (key != null) {
keys[prekey.key_id] = (!)key;
}
}
identity_key = bundle.identity_key;
signed_pre_key_id = bundle.signed_pre_key_id;
signed_pre_key = bundle.signed_pre_key;
}
try {
// Validate IdentityKey
if (identity_key == null || store.identity_key_pair.public.compare((!)identity_key) != 0) {
changed = true;
}
IdentityKeyPair identity_key_pair = store.identity_key_pair;
// Validate signedPreKeyRecord + ID
if (signed_pre_key == null || signed_pre_key_id == -1 || !store.contains_signed_pre_key(signed_pre_key_id) || store.load_signed_pre_key(signed_pre_key_id).key_pair.public.compare((!)signed_pre_key) != 0) {
signed_pre_key_id = Random.int_range(1, int32.MAX); // TODO: No random, use ordered number
signed_pre_key_record = Plugin.get_context().generate_signed_pre_key(identity_key_pair, signed_pre_key_id);
store.store_signed_pre_key((!)signed_pre_key_record);
changed = true;
} else {
signed_pre_key_record = store.load_signed_pre_key(signed_pre_key_id);
}
// Validate PreKeys
Set<PreKeyRecord> pre_key_records = new HashSet<PreKeyRecord>();
foreach (var entry in keys.entries) {
if (store.contains_pre_key(entry.key)) {
PreKeyRecord record = store.load_pre_key(entry.key);
if (record.key_pair.public.compare(entry.value) == 0) {
pre_key_records.add(record);
}
}
}
int new_keys = NUM_KEYS_TO_PUBLISH - pre_key_records.size;
if (new_keys > 0) {
int32 next_id = Random.int_range(1, int32.MAX); // TODO: No random, use ordered number
Set<PreKeyRecord> new_records = Plugin.get_context().generate_pre_keys((uint)next_id, (uint)new_keys);
pre_key_records.add_all(new_records);
foreach (PreKeyRecord record in new_records) {
store.store_pre_key(record);
}
changed = true;
}
if (changed) {
publish_bundles.begin(stream, (!)signed_pre_key_record, identity_key_pair, pre_key_records, (int32) store.local_registration_id);
}
} catch (Error e) {
warning(@"Unexpected error while publishing bundle: $(e.message)\n");
}
stream.get_module(IDENTITY).active_bundle_requests.remove(jid.bare_jid.to_string() + @":$(store.local_registration_id)");
}
public async void publish_bundles(XmppStream stream, SignedPreKeyRecord signed_pre_key_record, IdentityKeyPair identity_key_pair, Set<PreKeyRecord> pre_key_records, int32 device_id) throws Error {
ECKeyPair tmp;
StanzaNode bundle = new StanzaNode.build("bundle", NS_URI)
.add_self_xmlns()
.put_node(new StanzaNode.build("signedPreKeyPublic", NS_URI)
.put_attribute("signedPreKeyId", signed_pre_key_record.id.to_string())
.put_node(new StanzaNode.text(Base64.encode((tmp = signed_pre_key_record.key_pair).public.serialize()))))
.put_node(new StanzaNode.build("signedPreKeySignature", NS_URI)
.put_node(new StanzaNode.text(Base64.encode(signed_pre_key_record.signature))))
.put_node(new StanzaNode.build("identityKey", NS_URI)
.put_node(new StanzaNode.text(Base64.encode(identity_key_pair.public.serialize()))));
StanzaNode prekeys = new StanzaNode.build("prekeys", NS_URI);
foreach (PreKeyRecord pre_key_record in pre_key_records) {
prekeys.put_node(new StanzaNode.build("preKeyPublic", NS_URI)
.put_attribute("preKeyId", pre_key_record.id.to_string())
.put_node(new StanzaNode.text(Base64.encode(pre_key_record.key_pair.public.serialize()))));
}
bundle.put_node(prekeys);
string node_id = @"$NODE_BUNDLES:$device_id";
yield stream.get_module(Pubsub.Module.IDENTITY).publish(stream, null, node_id, "1", bundle);
yield try_make_node_public(stream, node_id);
}
private async void try_make_node_public(XmppStream stream, string node_id) {
DataForms.DataForm? data_form = yield stream.get_module(Pubsub.Module.IDENTITY).request_node_config(stream, null, node_id);
if (data_form == null) return;
foreach (DataForms.DataForm.Field field in data_form.fields) {
if (field.var == "pubsub#access_model" && field.get_value_string() != Pubsub.ACCESS_MODEL_OPEN) {
field.set_value_string(Pubsub.ACCESS_MODEL_OPEN);
yield stream.get_module(Pubsub.Module.IDENTITY).submit_node_config(stream, data_form, node_id);
break;
}
}
}
public override string get_ns() {
return NS_URI;
}
public override string get_id() {
return IDENTITY.id;
}
}
}