aboutsummaryrefslogtreecommitdiff
path: root/xmpp-vala/src/module/xep/0166_jingle.vala
diff options
context:
space:
mode:
authorhrxi <hrrrxi@gmail.com>2019-06-23 14:51:33 +0200
committerhrxi <hrrrxi@gmail.com>2019-07-09 11:21:40 +0200
commit82e7cf4447d72c24af04c64c05eed35338455f35 (patch)
tree3766c40dc3e030aa6a2c092545af17e5c998aa9c /xmpp-vala/src/module/xep/0166_jingle.vala
parent877c46628fa2836f9226e24a3d0a84b9a3f821e6 (diff)
downloaddino-82e7cf4447d72c24af04c64c05eed35338455f35.tar.gz
dino-82e7cf4447d72c24af04c64c05eed35338455f35.zip
Add file receiving via Jingle
This currently follows the same rules as HTTP file download for accepting files.
Diffstat (limited to 'xmpp-vala/src/module/xep/0166_jingle.vala')
-rw-r--r--xmpp-vala/src/module/xep/0166_jingle.vala384
1 files changed, 275 insertions, 109 deletions
diff --git a/xmpp-vala/src/module/xep/0166_jingle.vala b/xmpp-vala/src/module/xep/0166_jingle.vala
index 5c086399..7413ff4f 100644
--- a/xmpp-vala/src/module/xep/0166_jingle.vala
+++ b/xmpp-vala/src/module/xep/0166_jingle.vala
@@ -7,9 +7,28 @@ namespace Xmpp.Xep.Jingle {
private const string NS_URI = "urn:xmpp:jingle:1";
private const string ERROR_NS_URI = "urn:xmpp:jingle:errors:1";
-public errordomain CreateConnectionError {
+public errordomain IqError {
BAD_REQUEST,
NOT_ACCEPTABLE,
+ NOT_IMPLEMENTED,
+ OUT_OF_ORDER,
+}
+
+void send_iq_error(IqError iq_error, XmppStream stream, Iq.Stanza iq) {
+ ErrorStanza error;
+ if (iq_error is IqError.BAD_REQUEST) {
+ error = new ErrorStanza.bad_request(iq_error.message);
+ } else if (iq_error is IqError.NOT_ACCEPTABLE) {
+ error = new ErrorStanza.not_acceptable(iq_error.message);
+ } else if (iq_error is IqError.NOT_IMPLEMENTED) {
+ error = new ErrorStanza.feature_not_implemented(iq_error.message);
+ } else if (iq_error is IqError.OUT_OF_ORDER) {
+ StanzaNode out_of_order = new StanzaNode.build("out-of-order", ERROR_NS_URI).add_self_xmlns();
+ error = new ErrorStanza.build(ErrorStanza.TYPE_MODIFY, ErrorStanza.CONDITION_UNEXPECTED_REQUEST, iq_error.message, out_of_order);
+ } else {
+ assert_not_reached();
+ }
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.error(iq, error));
}
public errordomain Error {
@@ -21,9 +40,28 @@ public errordomain Error {
TRANSPORT_ERROR,
}
+StanzaNode get_single_node_anyns(StanzaNode parent, string node_name) throws IqError {
+ StanzaNode? result = null;
+ foreach (StanzaNode child in parent.get_all_subnodes()) {
+ if (child.name == node_name) {
+ if (result != null) {
+ throw new IqError.BAD_REQUEST(@"multiple $(node_name) nodes");
+ }
+ result = child;
+ }
+ }
+ if (result == null) {
+ throw new IqError.BAD_REQUEST(@"missing $(node_name) node");
+ }
+ return result;
+}
+
public class Module : XmppStreamModule, Iq.Handler {
public static Xmpp.ModuleIdentity<Module> IDENTITY = new Xmpp.ModuleIdentity<Module>(NS_URI, "0166_jingle");
+ private HashMap<string, ContentType> content_types = new HashMap<string, ContentType>();
+ private HashMap<string, Transport> transports = new HashMap<string, Transport>();
+
public override void attach(XmppStream stream) {
stream.add_flag(new Flag());
stream.get_module(ServiceDiscovery.Module.IDENTITY).add_feature(stream, NS_URI);
@@ -31,11 +69,35 @@ public class Module : XmppStreamModule, Iq.Handler {
}
public override void detach(XmppStream stream) { }
- public void add_transport(XmppStream stream, Transport transport) {
- stream.get_flag(Flag.IDENTITY).add_transport(transport);
+ public void register_content_type(ContentType content_type) {
+ content_types[content_type.content_type_ns_uri()] = content_type;
+ }
+ public ContentType? get_content_type(string ns_uri) {
+ if (!content_types.has_key(ns_uri)) {
+ return null;
+ }
+ return content_types[ns_uri];
+ }
+ public void register_transport(Transport transport) {
+ transports[transport.transport_ns_uri()] = transport;
+ }
+ public Transport? get_transport(string ns_uri) {
+ if (!transports.has_key(ns_uri)) {
+ return null;
+ }
+ return transports[ns_uri];
}
public Transport? select_transport(XmppStream stream, TransportType type, Jid receiver_full_jid) {
- return stream.get_flag(Flag.IDENTITY).select_transport(stream, type, receiver_full_jid);
+ foreach (Transport transport in transports.values) {
+ if (transport.transport_type() != type) {
+ continue;
+ }
+ // TODO(hrxi): prioritization
+ if (transport.is_transport_available(stream, receiver_full_jid)) {
+ return transport;
+ }
+ }
+ return null;
}
private bool is_jingle_available(XmppStream stream, Jid full_jid) {
@@ -59,13 +121,14 @@ public class Module : XmppStreamModule, Iq.Handler {
if (my_jid == null) {
throw new Error.GENERAL("Couldn't determine own JID");
}
- Session session = new Session(random_uuid(), type, receiver_full_jid);
+ TransportParameters transport_params = transport.create_transport_parameters();
+ Session session = new Session.initiate_sent(random_uuid(), type, transport_params, receiver_full_jid, content_name);
StanzaNode content = new StanzaNode.build("content", NS_URI)
.put_attribute("creator", "initiator")
.put_attribute("name", content_name)
.put_attribute("senders", senders.to_string())
.put_node(description)
- .put_node(transport.to_transport_stanza_node());
+ .put_node(transport_params.to_transport_stanza_node());
StanzaNode jingle = new StanzaNode.build("jingle", NS_URI)
.add_self_xmlns()
.put_attribute("action", "session-initiate")
@@ -75,21 +138,84 @@ public class Module : XmppStreamModule, Iq.Handler {
Iq.Stanza iq = new Iq.Stanza.set(jingle) { to=receiver_full_jid };
stream.get_module(Iq.Module.IDENTITY).send_iq(stream, iq, (stream, iq) => {
+ // TODO(hrxi): handle errors
stream.get_flag(Flag.IDENTITY).add_session(session);
});
return session;
}
+ public void handle_session_initiate(XmppStream stream, string sid, StanzaNode jingle, Iq.Stanza iq) throws IqError {
+ Gee.List<StanzaNode> contents = jingle.get_subnodes("content");
+ if (contents.size == 0) {
+ throw new IqError.BAD_REQUEST("missing content node");
+ }
+ if (contents.size > 1) {
+ throw new IqError.NOT_IMPLEMENTED("can't process multiple content nodes");
+ }
+ StanzaNode content = contents[0];
+ string? name = content.get_attribute("name");
+ StanzaNode description = get_single_node_anyns(content, "description");
+ StanzaNode transport_node = get_single_node_anyns(content, "transport");
+ if (name == null) {
+ throw new IqError.BAD_REQUEST("missing name");
+ }
+
+ Transport? transport = get_transport(transport_node.ns_uri);
+ TransportParameters? transport_params = null;
+ if (transport != null) {
+ transport_params = transport.parse_transport_parameters(transport_node);
+ } else {
+ // terminate the session below
+ }
+
+ ContentType? content_type = get_content_type(description.ns_uri);
+ if (content_type == null) {
+ // TODO(hrxi): how do we signal an unknown content type?
+ throw new IqError.NOT_IMPLEMENTED("unknown content type");
+ }
+ ContentParameters content_params = content_type.parse_content_parameters(description);
+
+ TransportType type = content_type.content_type_transport_type();
+ Session session = new Session.initiate_received(sid, type, transport_params, iq.from, name);
+ stream.get_flag(Flag.IDENTITY).add_session(session);
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.result(iq));
+
+ if (transport == null || transport.transport_type() != type) {
+ StanzaNode reason = new StanzaNode.build("reason", NS_URI)
+ .put_node(new StanzaNode.build("unsupported-transports", NS_URI));
+ session.terminate(stream, reason);
+ return;
+ }
+
+ content_params.on_session_initiate(stream, session);
+ }
+
public void on_iq_set(XmppStream stream, Iq.Stanza iq) {
+ try {
+ handle_iq_set(stream, iq);
+ } catch (IqError e) {
+ send_iq_error(e, stream, iq);
+ }
+ }
+
+ public void handle_iq_set(XmppStream stream, Iq.Stanza iq) throws IqError {
StanzaNode? jingle = iq.stanza.get_subnode("jingle", NS_URI);
string? sid = jingle != null ? jingle.get_attribute("sid") : null;
string? action = jingle != null ? jingle.get_attribute("action") : null;
if (jingle == null || sid == null || action == null) {
- stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.error(iq, new ErrorStanza.bad_request("missing jingle node, sid or action")));
- return;
+ throw new IqError.BAD_REQUEST("missing jingle node, sid or action");
}
Session? session = stream.get_flag(Flag.IDENTITY).get_session(sid);
+ if (action == "session-initiate") {
+ if (session != null) {
+ // TODO(hrxi): Info leak if other clients use predictable session IDs?
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.error(iq, new ErrorStanza.build(ErrorStanza.TYPE_MODIFY, ErrorStanza.CONDITION_CONFLICT, "session ID already in use", null)));
+ return;
+ }
+ handle_session_initiate(stream, sid, jingle, iq);
+ return;
+ }
if (session == null) {
StanzaNode unknown_session = new StanzaNode.build("unknown-session", ERROR_NS_URI).add_self_xmlns();
stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.error(iq, new ErrorStanza.item_not_found(unknown_session)));
@@ -125,62 +251,118 @@ public enum Senders {
}
public interface Transport : Object {
+ public abstract string transport_ns_uri();
public abstract bool is_transport_available(XmppStream stream, Jid full_jid);
public abstract TransportType transport_type();
+ public abstract TransportParameters create_transport_parameters();
+ public abstract TransportParameters parse_transport_parameters(StanzaNode transport) throws IqError;
+}
+
+public interface TransportParameters : Object {
+ public abstract string transport_ns_uri();
public abstract StanzaNode to_transport_stanza_node();
- public abstract Connection? create_transport_connection(XmppStream stream, Jid peer_full_jid, StanzaNode content) throws CreateConnectionError;
+ public abstract void update_transport(StanzaNode transport) throws IqError;
+ public abstract IOStream create_transport_connection(XmppStream stream, Jid peer_full_jid, Role role);
+}
+
+public enum Role {
+ INITIATOR,
+ RESPONDER;
+
+ public string to_string() {
+ switch (this) {
+ case INITIATOR: return "initiator";
+ case RESPONDER: return "responder";
+ }
+ assert_not_reached();
+ }
+}
+
+public interface ContentType : Object {
+ public abstract string content_type_ns_uri();
+ public abstract TransportType content_type_transport_type();
+ public abstract ContentParameters parse_content_parameters(StanzaNode description) throws IqError;
+}
+
+public interface ContentParameters : Object {
+ public abstract void on_session_initiate(XmppStream stream, Session session);
}
+
public class Session {
+ // INITIATE_SENT -> ACTIVE -> ENDED
+ // INITIATE_RECEIVED -> ACTIVE -> ENDED
public enum State {
- PENDING,
+ INITIATE_SENT,
+ INITIATE_RECEIVED,
ACTIVE,
ENDED,
}
public State state { get; private set; }
- Connection? conn;
public string sid { get; private set; }
public Type type_ { get; private set; }
public Jid peer_full_jid { get; private set; }
+ public string content_name { get; private set; }
- public Session(string sid, Type type, Jid peer_full_jid) {
- this.state = PENDING;
- this.conn = null;
+ // INITIATE_SENT | INITIATE_RECEIVED
+ TransportParameters? transport = null;
+
+ // ACTIVE
+ public IOStream? conn { get; private set; }
+
+ // Only interesting in INITIATE_SENT.
+ // Signals that the session has been accepted by the peer.
+ public signal void accepted(XmppStream stream);
+
+ public Session.initiate_sent(string sid, Type type, TransportParameters transport, Jid peer_full_jid, string content_name) {
+ this.state = INITIATE_SENT;
this.sid = sid;
this.type_ = type;
this.peer_full_jid = peer_full_jid;
+ this.content_name = content_name;
+ this.transport = transport;
+ this.conn = null;
}
- public signal void on_error(XmppStream stream, Error error);
- public signal void on_data(XmppStream stream, uint8[] data);
- // Signals that the stream is ready to send (more) data.
- public signal void on_ready(XmppStream stream);
-
- private void handle_error(XmppStream stream, Error error) {
- if (state == PENDING || state == ACTIVE) {
- StanzaNode reason = new StanzaNode.build("reason", NS_URI)
- .put_node(new StanzaNode.build("general-error", NS_URI)) // TODO(hrxi): Is this the right error?
- .put_node(new StanzaNode.build("text", NS_URI)
- .put_node(new StanzaNode.text(error.message))
- );
- terminate(stream, reason);
- }
+ public Session.initiate_received(string sid, Type type, TransportParameters? transport, Jid peer_full_jid, string content_name) {
+ this.state = INITIATE_RECEIVED;
+ this.sid = sid;
+ this.type_ = type;
+ this.peer_full_jid = peer_full_jid;
+ this.content_name = content_name;
+ this.transport = transport;
+ this.conn = null;
}
- delegate void SendIq(Iq.Stanza iq);
- public void handle_iq_set(XmppStream stream, string action, StanzaNode jingle, Iq.Stanza iq) {
- SendIq send_iq = (iq) => stream.get_module(Iq.Module.IDENTITY).send_iq(stream, iq);
- if (state != PENDING || action != "session-accept") {
- return;
- }
- StanzaNode? content = jingle.get_subnode("content");
- if (content == null) {
- // TODO(hrxi): here and below, should we terminate the session?
- send_iq(new Iq.Stanza.error(iq, new ErrorStanza.bad_request("no content element")));
- return;
+ public void handle_iq_set(XmppStream stream, string action, StanzaNode jingle, Iq.Stanza iq) throws IqError {
+ switch (action) {
+ case "session-accept":
+ if (state != INITIATE_SENT) {
+ throw new IqError.OUT_OF_ORDER("got session-accept while not waiting for one");
+ }
+ handle_session_accept(stream, jingle, iq);
+ break;
+ case "session-terminate":
+ handle_session_terminate(stream, jingle, iq);
+ break;
+ case "content-accept":
+ case "content-add":
+ case "content-modify":
+ case "content-reject":
+ case "content-remove":
+ case "security-info":
+ case "transport-accept":
+ case "transport-info":
+ case "transport-reject":
+ case "transport-replace":
+ throw new IqError.NOT_IMPLEMENTED(@"$(action) is not implemented");
+ default:
+ throw new IqError.BAD_REQUEST("invalid action");
}
+ }
+ void handle_session_accept(XmppStream stream, StanzaNode jingle, Iq.Stanza iq) throws IqError {
string? responder_str = jingle.get_attribute("responder");
Jid responder;
if (responder_str != null) {
@@ -190,38 +372,64 @@ public class Session {
// TODO(hrxi): more sanity checking, perhaps replace who we're talking to
}
if (!responder.is_full()) {
- send_iq(new Iq.Stanza.error(iq, new ErrorStanza.bad_request("invalid responder JID")));
- return;
+ throw new IqError.BAD_REQUEST("invalid responder JID");
}
- try {
- conn = stream.get_flag(Flag.IDENTITY).create_connection(stream, type_, peer_full_jid, content);
- } catch (CreateConnectionError e) {
- if (e is CreateConnectionError.BAD_REQUEST) {
- send_iq(new Iq.Stanza.error(iq, new ErrorStanza.bad_request(e.message)));
- } else if (e is CreateConnectionError.NOT_ACCEPTABLE) {
- send_iq(new Iq.Stanza.error(iq, new ErrorStanza.not_acceptable(e.message)));
- }
- return;
+ Gee.List<StanzaNode> contents = jingle.get_subnodes("content");
+ if (contents.size == 0) {
+ // TODO(hrxi): here and below, should we terminate the session?
+ throw new IqError.BAD_REQUEST("missing content node");
}
- send_iq(new Iq.Stanza.result(iq));
- if (conn == null) {
- terminate(stream, new StanzaNode.build("reason", NS_URI)
- .put_node(new StanzaNode.build("unsupported-transports", NS_URI)));
- return;
+ if (contents.size > 1) {
+ throw new IqError.NOT_IMPLEMENTED("can't process multiple content nodes");
+ }
+ StanzaNode content = contents[0];
+ StanzaNode description = get_single_node_anyns(content, "description");
+ StanzaNode transport_node = get_single_node_anyns(content, "transport");
+ if (transport_node.ns_uri != transport.transport_ns_uri()) {
+ throw new IqError.BAD_REQUEST("session-accept with unnegotiated transport method");
}
- conn.on_error.connect((stream, error) => on_error(stream, error));
- conn.on_data.connect((stream, data) => on_data(stream, data));
- conn.on_ready.connect((stream) => on_ready(stream));
- on_error.connect((stream, error) => handle_error(stream, error));
- conn.connect(stream);
+ transport.update_transport(transport_node);
+ conn = transport.create_transport_connection(stream, peer_full_jid, Role.INITIATOR);
+ transport = null;
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.result(iq));
state = ACTIVE;
+ accepted(stream);
+ }
+ void handle_session_terminate(XmppStream stream, StanzaNode jingle, Iq.Stanza iq) throws IqError {
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, new Iq.Stanza.result(iq));
+ // TODO(hrxi): also handle presence type=unavailable
}
- public void send(XmppStream stream, uint8[] data) {
- if (state != ACTIVE) {
+ public void accept(XmppStream stream, StanzaNode description) {
+ if (state != INITIATE_RECEIVED) {
+ return; // TODO(hrxi): what to do?
+ }
+ StanzaNode jingle = new StanzaNode.build("jingle", NS_URI)
+ .add_self_xmlns()
+ .put_attribute("action", "session-accept")
+ .put_attribute("sid", sid)
+ .put_node(new StanzaNode.build("content", NS_URI)
+ .put_attribute("creator", "initiator")
+ .put_attribute("name", content_name)
+ .put_node(description)
+ .put_node(transport.to_transport_stanza_node())
+ );
+ Iq.Stanza iq = new Iq.Stanza.set(jingle) { to=peer_full_jid };
+ stream.get_module(Iq.Module.IDENTITY).send_iq(stream, iq);
+
+ conn = transport.create_transport_connection(stream, peer_full_jid, Role.RESPONDER);
+ transport = null;
+
+ state = ACTIVE;
+ }
+
+ public void reject(XmppStream stream) {
+ if (state != INITIATE_RECEIVED) {
return; // TODO(hrxi): what to do?
}
- conn.send(stream, data);
+ StanzaNode reason = new StanzaNode.build("reason", NS_URI)
+ .put_node(new StanzaNode.build("decline", NS_URI));
+ terminate(stream, reason);
}
public void set_application_error(XmppStream stream, StanzaNode? application_reason = null) {
@@ -237,16 +445,16 @@ public class Session {
if (state != ACTIVE) {
return; // TODO(hrxi): what to do?
}
- conn.close(stream);
+ conn.close();
}
public void terminate(XmppStream stream, StanzaNode reason) {
- if (state != PENDING && state != ACTIVE) {
+ if (state != INITIATE_SENT && state != INITIATE_RECEIVED && state != ACTIVE) {
// TODO(hrxi): what to do?
return;
}
- if (conn != null) {
- conn.close(stream);
+ if (state == ACTIVE) {
+ conn.close();
}
StanzaNode jingle = new StanzaNode.build("jingle", NS_URI)
@@ -264,56 +472,14 @@ public class Session {
}
}
-public abstract class Connection {
- public Jid? peer_full_jid { get; private set; }
-
- public Connection(Jid peer_full_jid) {
- this.peer_full_jid = peer_full_jid;
- }
-
- public signal void on_error(XmppStream stream, Error error);
- public signal void on_data(XmppStream stream, uint8[] data);
- public signal void on_ready(XmppStream stream);
-
- public abstract void connect(XmppStream stream);
- public abstract void send(XmppStream stream, uint8[] data);
- public abstract void close(XmppStream stream);
-}
-
public class Flag : XmppStreamFlag {
public static FlagIdentity<Flag> IDENTITY = new FlagIdentity<Flag>(NS_URI, "jingle");
- private Gee.List<Transport> transports = new ArrayList<Transport>();
private HashMap<string, Session> sessions = new HashMap<string, Session>();
- public void add_transport(Transport transport) { transports.add(transport); }
- public Transport? select_transport(XmppStream stream, TransportType type, Jid receiver_full_jid) {
- foreach (Transport transport in transports) {
- if (transport.transport_type() != type) {
- continue;
- }
- // TODO(hrxi): prioritization
- if (transport.is_transport_available(stream, receiver_full_jid)) {
- return transport;
- }
- }
- return null;
- }
public void add_session(Session session) {
sessions[session.sid] = session;
}
- public Connection? create_connection(XmppStream stream, Type type, Jid peer_full_jid, StanzaNode content) throws CreateConnectionError {
- foreach (Transport transport in transports) {
- if (transport.transport_type() != type) {
- continue;
- }
- Connection? conn = transport.create_transport_connection(stream, peer_full_jid, content);
- if (conn != null) {
- return conn;
- }
- }
- return null;
- }
public Session? get_session(string sid) {
return sessions.has_key(sid) ? sessions[sid] : null;
}