Add libnice-based ICE-UDP implementation as plugin

This commit is contained in:
Marvin W 2021-03-21 12:41:27 +01:00
parent f328bf93fb
commit d703b7c09d
7 changed files with 387 additions and 17 deletions

View file

@ -10,6 +10,9 @@ find_packages(ICE_PACKAGES REQUIRED
vala_precompile(ICE_VALA_C
SOURCES
src/plugin.vala
src/module.vala
src/transport_parameters.vala
src/util.vala
src/register_plugin.vala
CUSTOM_VAPIS
${CMAKE_BINARY_DIR}/exports/xmpp-vala.vapi
@ -21,7 +24,7 @@ OPTIONS
--vapidir=${CMAKE_CURRENT_SOURCE_DIR}/vapi
)
add_definitions(${VALA_CFLAGS})
add_definitions(${VALA_CFLAGS} -DG_LOG_DOMAIN="ice")
add_library(ice SHARED ${ICE_VALA_C})
target_link_libraries(ice libdino ${ICE_PACKAGES})
set_target_properties(ice PROPERTIES PREFIX "")

View file

@ -0,0 +1,42 @@
using Gee;
using Xmpp;
using Xmpp.Xep;
public class Dino.Plugins.Ice.Module : JingleIceUdp.Module {
public string? stun_ip = null;
public uint stun_port = 0;
public string? turn_ip = null;
public Xep.ExternalServiceDiscovery.Service? turn_service = null;
private weak Nice.Agent? agent;
private Nice.Agent get_agent() {
Nice.Agent? agent = this.agent;
if (agent == null) {
agent = new Nice.Agent(MainContext.@default(), Nice.Compatibility.RFC5245);
if (stun_ip != null) {
agent.stun_server = stun_ip;
agent.stun_server_port = stun_port;
}
agent.ice_tcp = false;
agent.set_software("Dino");
agent.weak_ref(agent_unweak);
this.agent = agent;
debug("STUN server for libnice %s %u", agent.stun_server, agent.stun_server_port);
}
return agent;
}
public override Jingle.TransportParameters create_transport_parameters(XmppStream stream, uint8 components, Jid local_full_jid, Jid peer_full_jid) {
return new TransportParameters(get_agent(), turn_service, turn_ip, components, local_full_jid, peer_full_jid);
}
public override Jingle.TransportParameters parse_transport_parameters(XmppStream stream, uint8 components, Jid local_full_jid, Jid peer_full_jid, StanzaNode transport) throws Jingle.IqError {
return new TransportParameters(get_agent(), turn_service, turn_ip, components, local_full_jid, peer_full_jid, transport);
}
private void agent_unweak() {
this.agent = null;
}
}

View file

@ -1,30 +1,71 @@
using Gee;
using Nice;
using Dino.Entities;
using Xmpp;
using Xmpp.Xep;
namespace Dino.Plugins.Ice {
private extern const size_t NICE_ADDRESS_STRING_LEN;
public class Plugin : RootInterface, Object {
public class Dino.Plugins.Ice.Plugin : RootInterface, Object {
public Dino.Application app;
public void registered(Dino.Application app) {
Nice.debug_enable(true);
this.app = app;
app.stream_interactor.stream_attached_modules.connect((account, stream) => {
stream.get_module(Xmpp.Xep.Socks5Bytestreams.Module.IDENTITY).set_local_ip_address_handler(get_local_ip_addresses);
app.stream_interactor.module_manager.initialize_account_modules.connect((account, list) => {
list.add(new Module());
});
app.stream_interactor.stream_attached_modules.connect((account, stream) => {
stream.get_module(Socks5Bytestreams.Module.IDENTITY).set_local_ip_address_handler(get_local_ip_addresses);
});
app.stream_interactor.stream_negotiated.connect(on_stream_negotiated);
}
private Gee.List<string> get_local_ip_addresses() {
Gee.List<string> result = new ArrayList<string>();
foreach (string ip_address in Nice.interfaces_get_local_ips(false)) {
result.add(ip_address);
private async void on_stream_negotiated(Account account, XmppStream stream) {
Module? ice_udp_module = stream.get_module(JingleIceUdp.Module.IDENTITY) as Module;
if (ice_udp_module == null) return;
Gee.List<Xep.ExternalServiceDiscovery.Service> services = yield ExternalServiceDiscovery.request_services(stream);
foreach (Xep.ExternalServiceDiscovery.Service service in services) {
if (service.transport == "udp" && (service.ty == "stun" || service.ty == "turn")) {
InetAddress ip = yield lookup_ipv4_addess(service.host);
if (ip == null) continue;
if (service.ty == "stun") {
debug("Server offers STUN server: %s:%u, resolved to %s", service.host, service.port, ip.to_string());
ice_udp_module.stun_ip = ip.to_string();
ice_udp_module.stun_port = service.port;
} else if (service.ty == "turn") {
debug("Server offers TURN server: %s:%u, resolved to %s", service.host, service.port, ip.to_string());
ice_udp_module.turn_ip = ip.to_string();
ice_udp_module.turn_service = service;
}
}
}
if (ice_udp_module.stun_ip == null) {
InetAddress ip = yield lookup_ipv4_addess("stun.l.google.com");
if (ip == null) return;
debug("Using fallback STUN server: stun.l.google.com:19302, resolved to %s", ip.to_string());
ice_udp_module.stun_ip = ip.to_string();
ice_udp_module.stun_port = 19302;
}
return result;
}
public void shutdown() {
// Nothing to do
}
}
private async InetAddress? lookup_ipv4_addess(string host) {
try {
Resolver resolver = Resolver.get_default();
GLib.List<GLib.InetAddress>? ips = yield resolver.lookup_by_name_async(host);
foreach (GLib.InetAddress ina in ips) {
if (ina.get_family() != SocketFamily.IPV4) continue;
return ina;
}
} catch (Error e) {
warning("Failed looking up IP address of %s", host);
}
return null;
}
}

View file

@ -0,0 +1,261 @@
using Gee;
using Xmpp;
using Xmpp.Xep;
public class Dino.Plugins.Ice.TransportParameters : JingleIceUdp.IceUdpTransportParameters {
private Nice.Agent agent;
private uint stream_id;
private bool we_want_connection;
private bool remote_credentials_set;
private Map<uint8, DatagramConnection> connections = new HashMap<uint8, DatagramConnection>();
private class DatagramConnection : Jingle.DatagramConnection {
private Nice.Agent agent;
private uint stream_id;
private string? error;
private ulong sent;
private ulong sent_reported;
private ulong recv;
private ulong recv_reported;
private ulong datagram_received_id;
public DatagramConnection(Nice.Agent agent, uint stream_id, uint8 component_id) {
this.agent = agent;
this.stream_id = stream_id;
this.component_id = component_id;
this.datagram_received_id = this.datagram_received.connect((datagram) => {
recv += datagram.length;
if (recv > recv_reported + 100000) {
debug("Received %lu bytes via stream %u component %u", recv, stream_id, component_id);
recv_reported = recv;
}
});
}
public override async void terminate(bool we_terminated, string? reason_string = null, string? reason_text = null) {
yield base.terminate(we_terminated, reason_string, reason_text);
this.disconnect(datagram_received_id);
agent = null;
}
public override void send_datagram(Bytes datagram) {
if (this.agent != null && is_component_ready(agent, stream_id, component_id)) {
agent.send(stream_id, component_id, datagram.get_data());
sent += datagram.length;
if (sent > sent_reported + 100000) {
debug("Sent %lu bytes via stream %u component %u", sent, stream_id, component_id);
sent_reported = sent;
}
}
}
}
public TransportParameters(Nice.Agent agent, Xep.ExternalServiceDiscovery.Service? turn_service, string? turn_ip, uint8 components, Jid local_full_jid, Jid peer_full_jid, StanzaNode? node = null) {
base(components, local_full_jid, peer_full_jid, node);
this.we_want_connection = (node == null);
this.agent = agent;
agent.candidate_gathering_done.connect(on_candidate_gathering_done);
agent.initial_binding_request_received.connect(on_initial_binding_request_received);
agent.component_state_changed.connect(on_component_state_changed);
agent.new_selected_pair_full.connect(on_new_selected_pair_full);
agent.new_candidate_full.connect(on_new_candidate);
agent.controlling_mode = !incoming;
stream_id = agent.add_stream(components);
if (turn_ip != null) {
for (uint8 component_id = 1; component_id <= components; component_id++) {
agent.set_relay_info(stream_id, component_id, turn_ip, turn_service.port, turn_service.username, turn_service.password, Nice.RelayType.UDP);
debug("TURN info (component %i) %s:%u", component_id, turn_ip, turn_service.port);
}
}
string ufrag;
string pwd;
agent.get_local_credentials(stream_id, out ufrag, out pwd);
init(ufrag, pwd);
for (uint8 component_id = 1; component_id <= components; component_id++) {
// We don't properly get local candidates before this call
agent.attach_recv(stream_id, component_id, MainContext.@default(), on_recv);
}
agent.gather_candidates(stream_id);
}
private void on_candidate_gathering_done(uint stream_id) {
if (stream_id != this.stream_id) return;
debug("on_candidate_gathering_done in %u", stream_id);
for (uint8 i = 1; i <= components; i++) {
foreach (unowned Nice.Candidate nc in agent.get_local_candidates(stream_id, i)) {
if (nc.transport == Nice.CandidateTransport.UDP) {
JingleIceUdp.Candidate? candidate = candidate_to_jingle(nc);
if (candidate == null) continue;
debug("Local candidate summary: %s", agent.generate_local_candidate_sdp(nc));
}
}
}
}
private void on_new_candidate(Nice.Candidate nc) {
if (nc.stream_id != stream_id) return;
JingleIceUdp.Candidate? candidate = candidate_to_jingle(nc);
if (candidate == null) return;
if (nc.transport == Nice.CandidateTransport.UDP) {
// Execution was in the agent thread before
add_local_candidate_threadsafe(candidate);
}
}
public override void handle_transport_accept(StanzaNode transport) throws Jingle.IqError {
debug("on_transport_accept from %s", peer_full_jid.to_string());
base.handle_transport_accept(transport);
}
public override void handle_transport_info(StanzaNode transport) throws Jingle.IqError {
debug("on_transport_info from %s", peer_full_jid.to_string());
base.handle_transport_info(transport);
if (!we_want_connection) return;
if (remote_ufrag != null && remote_pwd != null && !remote_credentials_set) {
agent.set_remote_credentials(stream_id, remote_ufrag, remote_pwd);
remote_credentials_set = true;
}
for (uint8 i = 1; i <= components; i++) {
SList<Nice.Candidate> candidates = new SList<Nice.Candidate>();
foreach (JingleIceUdp.Candidate candidate in remote_candidates) {
if (candidate.component == i) {
Nice.Candidate nc = candidate_to_nice(candidate);
candidates.append(nc);
}
}
int new_candidates = agent.set_remote_candidates(stream_id, i, candidates);
debug("Updated to %i remote candidates for candidate %u via transport info", new_candidates, i);
}
}
public override void create_transport_connection(XmppStream stream, Jingle.Content content) {
debug("create_transport_connection: %s", content.session.sid);
debug("local_credentials: %s %s", local_ufrag, local_pwd);
debug("remote_credentials: %s %s", remote_ufrag, remote_pwd);
debug("expected incoming credentials: %s %s", local_ufrag + ":" + remote_ufrag, local_pwd);
debug("expected outgoing credentials: %s %s", remote_ufrag + ":" + local_ufrag, remote_pwd);
we_want_connection = true;
if (remote_ufrag != null && remote_pwd != null && !remote_credentials_set) {
agent.set_remote_credentials(stream_id, remote_ufrag, remote_pwd);
remote_credentials_set = true;
}
for (uint8 i = 1; i <= components; i++) {
SList<Nice.Candidate> candidates = new SList<Nice.Candidate>();
foreach (JingleIceUdp.Candidate candidate in remote_candidates) {
if (candidate.ip.has_prefix("fe80::")) continue;
if (candidate.component == i) {
Nice.Candidate nc = candidate_to_nice(candidate);
candidates.append(nc);
debug("remote candidate: %s", agent.generate_local_candidate_sdp(nc));
}
}
int new_candidates = agent.set_remote_candidates(stream_id, i, candidates);
debug("Initiated component %u with %i remote candidates", i, new_candidates);
connections[i] = new DatagramConnection(agent, stream_id, i);
content.set_transport_connection(connections[i], i);
}
base.create_transport_connection(stream, content);
}
private void on_component_state_changed(uint stream_id, uint component_id, uint state) {
if (stream_id != this.stream_id) return;
debug("stream %u component %u state changed to %s", stream_id, component_id, agent.get_component_state(stream_id, component_id).to_string());
if (is_component_ready(agent, stream_id, component_id) && connections.has_key((uint8) component_id) && !connections[(uint8)component_id].ready) {
connections[(uint8)component_id].ready = true;
}
}
private void on_initial_binding_request_received(uint stream_id) {
if (stream_id != this.stream_id) return;
debug("initial_binding_request_received");
}
private void on_new_selected_pair_full(uint stream_id, uint component_id, Nice.Candidate p1, Nice.Candidate p2) {
if (stream_id != this.stream_id) return;
debug("new_selected_pair_full %u [%s, %s]", component_id, agent.generate_local_candidate_sdp(p1), agent.generate_local_candidate_sdp(p2));
}
private void on_recv(Nice.Agent agent, uint stream_id, uint component_id, uint8[] data) {
if (stream_id != this.stream_id) return;
if (is_component_ready(agent, stream_id, component_id) && connections.has_key((uint8) component_id)) {
connections[(uint8) component_id].datagram_received(new Bytes(data));
} else {
debug("on_recv stream %u component %u length %u", stream_id, component_id, data.length);
}
}
private static Nice.Candidate candidate_to_nice(JingleIceUdp.Candidate c) {
Nice.CandidateType type;
switch (c.type_) {
case JingleIceUdp.Candidate.Type.HOST: type = Nice.CandidateType.HOST; break;
case JingleIceUdp.Candidate.Type.PRFLX: type = Nice.CandidateType.PEER_REFLEXIVE; break;
case JingleIceUdp.Candidate.Type.RELAY: type = Nice.CandidateType.RELAYED; break;
case JingleIceUdp.Candidate.Type.SRFLX: type = Nice.CandidateType.SERVER_REFLEXIVE; break;
default: assert_not_reached();
}
Nice.Candidate candidate = new Nice.Candidate(type);
candidate.component_id = c.component;
char[] foundation = new char[Nice.CANDIDATE_MAX_FOUNDATION];
string foundation_str = c.foundation.to_string();
Memory.copy(foundation, foundation_str.data, foundation_str.length);
candidate.foundation = foundation;
candidate.addr = Nice.Address();
candidate.addr.init();
candidate.addr.set_from_string(c.ip);
candidate.addr.set_port(c.port);
candidate.priority = c.priority;
if (c.rel_addr != null) {
candidate.base_addr = Nice.Address();
candidate.base_addr.init();
candidate.base_addr.set_from_string(c.rel_addr);
candidate.base_addr.set_port(c.rel_port);
}
candidate.transport = Nice.CandidateTransport.UDP;
return candidate;
}
private static JingleIceUdp.Candidate? candidate_to_jingle(Nice.Candidate nc) {
JingleIceUdp.Candidate candidate = new JingleIceUdp.Candidate();
switch (nc.type) {
case Nice.CandidateType.HOST: candidate.type_ = JingleIceUdp.Candidate.Type.HOST; break;
case Nice.CandidateType.PEER_REFLEXIVE: candidate.type_ = JingleIceUdp.Candidate.Type.PRFLX; break;
case Nice.CandidateType.RELAYED: candidate.type_ = JingleIceUdp.Candidate.Type.RELAY; break;
case Nice.CandidateType.SERVER_REFLEXIVE: candidate.type_ = JingleIceUdp.Candidate.Type.SRFLX; break;
default: assert_not_reached();
}
candidate.component = (uint8) nc.component_id;
candidate.foundation = (uint8) int.parse((string)nc.foundation);
candidate.generation = 0;
candidate.id = Random.next_int().to_string("%08x"); // TODO
char[] res = new char[NICE_ADDRESS_STRING_LEN];
nc.addr.to_string(res);
candidate.ip = (string) res;
candidate.network = 0; // TODO
candidate.port = (uint16) nc.addr.get_port();
candidate.priority = nc.priority;
candidate.protocol = "udp";
if (nc.base_addr.is_valid() && !nc.base_addr.equal(nc.addr)) {
res = new char[NICE_ADDRESS_STRING_LEN];
nc.base_addr.to_string(res);
candidate.rel_addr = (string) res;
candidate.rel_port = (uint16) nc.base_addr.get_port();
}
if (candidate.ip.has_prefix("fe80::")) return null;
return candidate;
}
}

18
plugins/ice/src/util.vala Normal file
View file

@ -0,0 +1,18 @@
using Gee;
namespace Dino.Plugins.Ice {
internal static bool is_component_ready(Nice.Agent agent, uint stream_id, uint component_id) {
var state = agent.get_component_state(stream_id, component_id);
return state == Nice.ComponentState.CONNECTED || state == Nice.ComponentState.READY;
}
internal Gee.List<string> get_local_ip_addresses() {
Gee.List<string> result = new ArrayList<string>();
foreach (string ip_address in Nice.interfaces_get_local_ips(false)) {
result.add(ip_address);
}
return result;
}
}

View file

@ -1,4 +1,8 @@
Nice cheader_filename="nice.h"
Address.to_string.dst type="char[]"
Agent.new_reliable#constructor name="create_reliable"
Agent.attach_recv skip=false
Agent.send.buf type="uint8[]" array_length_idx=2
AgentRecvFunc.buf type="uint8[]" array_length_idx=3
PseudoTcpCallbacks#record skip
PseudoTcpSocket#class skip

View file

@ -8,6 +8,7 @@ namespace Nice {
public Agent (GLib.MainContext ctx, Nice.Compatibility compat);
public bool add_local_address (Nice.Address addr);
public uint add_stream (uint n_components);
public bool attach_recv (uint stream_id, uint component_id, GLib.MainContext ctx, Nice.AgentRecvFunc func);
[Version (since = "0.1.16")]
public async void close_async ();
[CCode (cname = "nice_agent_new_reliable", has_construct_function = false)]
@ -58,7 +59,7 @@ namespace Nice {
public bool restart ();
[Version (since = "0.1.6")]
public bool restart_stream (uint stream_id);
public int send (uint stream_id, uint component_id, uint len, string buf);
public int send (uint stream_id, uint component_id, [CCode (array_length_cname = "len", array_length_pos = 2.5, array_length_type = "guint", type = "const gchar*")] uint8[] buf);
[Version (since = "0.1.5")]
public int send_messages_nonblocking (uint stream_id, uint component_id, [CCode (array_length_cname = "n_messages", array_length_pos = 3.5, array_length_type = "guint")] Nice.OutputMessage[] messages, GLib.Cancellable? cancellable = null) throws GLib.Error;
public bool set_local_credentials (uint stream_id, string ufrag, string pwd);
@ -209,7 +210,7 @@ namespace Nice {
public void set_ipv4 (uint32 addr_ipv4);
public void set_ipv6 (uint8 addr_ipv6);
public void set_port (uint port);
public void to_string (string dst);
public void to_string ([CCode (array_length = false, type = "gchar*")] char[] dst);
}
[CCode (cheader_filename = "nice.h", has_type_id = false)]
[Version (since = "0.1.5")]
@ -343,8 +344,8 @@ namespace Nice {
TCP,
TLS
}
[CCode (cheader_filename = "nice.h", instance_pos = 5.9)]
public delegate void AgentRecvFunc (Nice.Agent agent, uint stream_id, uint component_id, uint len, string buf);
[CCode (cheader_filename = "nice.h", instance_pos = 4.9)]
public delegate void AgentRecvFunc (Nice.Agent agent, uint stream_id, uint component_id, [CCode (array_length_cname = "len", array_length_pos = 3.5, array_length_type = "guint", type = "gchar*")] uint8[] buf);
[CCode (cheader_filename = "nice.h", cname = "NICE_AGENT_MAX_REMOTE_CANDIDATES")]
public const int AGENT_MAX_REMOTE_CANDIDATES;
[CCode (cheader_filename = "nice.h", cname = "NICE_CANDIDATE_DIRECTION_MS_PREF_ACTIVE")]