Add support for SASL2 user-agent

Author: singpolyma

src/auth.c

@@ -686,7 +686,7 @@ static xmpp_stanza_t *_make_sasl_auth(xmpp_conn_t *conn,
                                       const char *mechanism,
                                       const char *initial_data)
 {
-    xmpp_stanza_t *auth, *init;
+    xmpp_stanza_t *auth, *init, *user_agent;
     xmpp_stanza_t *inittxt = NULL;
 
     /* build auth stanza */
@@ -712,6 +712,61 @@ static xmpp_stanza_t *_make_sasl_auth(xmpp_conn_t *conn,
                 xmpp_stanza_add_child_ex(init, inittxt, 0);
                 xmpp_stanza_add_child_ex(auth, init, 0);
             }
+            if (conn->user_agent_id || conn->user_agent_software ||
+                conn->user_agent_device) {
+                user_agent = xmpp_stanza_new(conn->ctx);
+                if (!user_agent) {
+                    xmpp_stanza_release(auth);
+                    return NULL;
+                }
+                xmpp_stanza_set_name(user_agent, "user-agent");
+                xmpp_stanza_set_ns(user_agent, XMPP_NS_SASL2);
+                if (conn->user_agent_id) {
+                    xmpp_stanza_set_attribute(user_agent, "id",
+                                              conn->user_agent_id);
+                }
+                if (conn->user_agent_software) {
+                    xmpp_stanza_t *software = xmpp_stanza_new(conn->ctx);
+                    if (!software) {
+                        xmpp_stanza_release(user_agent);
+                        xmpp_stanza_release(auth);
+                        return NULL;
+                    }
+                    xmpp_stanza_set_name(software, "software");
+                    xmpp_stanza_set_ns(software, XMPP_NS_SASL2);
+                    xmpp_stanza_t *txt = xmpp_stanza_new(conn->ctx);
+                    if (!txt) {
+                        xmpp_stanza_release(software);
+                        xmpp_stanza_release(user_agent);
+                        xmpp_stanza_release(auth);
+                        return NULL;
+                    }
+                    xmpp_stanza_set_text(txt, conn->user_agent_software);
+                    xmpp_stanza_add_child_ex(software, txt, 0);
+                    xmpp_stanza_add_child_ex(user_agent, software, 0);
+                }
+                if (conn->user_agent_device) {
+                    xmpp_stanza_t *device = xmpp_stanza_new(conn->ctx);
+                    if (!device) {
+                        xmpp_stanza_release(user_agent);
+                        xmpp_stanza_release(auth);
+                        return NULL;
+                    }
+                    xmpp_stanza_set_name(device, "device");
+                    xmpp_stanza_set_ns(device, XMPP_NS_SASL2);
+                    xmpp_stanza_t *txt = xmpp_stanza_new(conn->ctx);
+                    if (!txt) {
+                        xmpp_stanza_release(device);
+                        xmpp_stanza_release(user_agent);
+                        xmpp_stanza_release(auth);
+                        return NULL;
+                    }
+                    xmpp_stanza_set_text(txt, conn->user_agent_device);
+                    xmpp_stanza_add_child_ex(device, txt, 0);
+                    xmpp_stanza_add_child_ex(user_agent, device, 0);
+                }
+                xmpp_stanza_add_child_ex(auth, user_agent, 0);
+            }
         } else {
             xmpp_stanza_set_name(auth, "auth");
             xmpp_stanza_set_ns(auth, XMPP_NS_SASL);

src/common.h

@@ -293,6 +293,9 @@ struct _xmpp_conn_t {
     char *domain;
     char *jid;
     char *pass;
+    char *user_agent_id;
+    char *user_agent_software;
+    char *user_agent_device;
     char *bound_jid;
     char *stream_id;
 

src/conn.c

@@ -624,6 +624,99 @@ void xmpp_conn_set_pass(xmpp_conn_t *conn, const char *pass)
     conn->pass = pass ? strophe_strdup(conn->ctx, pass) : NULL;
 }
 
+/** Get the user-agent id used for authentication of a connection.
+ *
+ *  @param conn a Strophe connection object
+ *
+ *  @return a string containing the id or NULL if it has not been set
+ *
+ *  @ingroup Connections
+ */
+const char *xmpp_conn_get_user_agent_id(const xmpp_conn_t *conn)
+{
+    return conn->user_agent_id;
+}
+
+/** Set the user-agent id used to authenticate the connection.
+ *  If any id was previously set, it will be discarded.  The function
+ *  will make a copy of the string.
+ *
+ *  @param conn a Strophe connection object
+ *  @param user_agent_id the id
+ *
+ *  @ingroup Connections
+ */
+void xmpp_conn_set_user_agent_id(xmpp_conn_t *conn, const char *user_agent_id)
+{
+    if (conn->user_agent_id)
+        strophe_free(conn->ctx, conn->user_agent_id);
+    conn->user_agent_id =
+        user_agent_id ? strophe_strdup(conn->ctx, user_agent_id) : NULL;
+}
+
+/** Get the software name used for authentication of a connection.
+ *
+ *  @param conn a Strophe connection object
+ *
+ *  @return a string containing the name or NULL if it has not been set
+ *
+ *  @ingroup Connections
+ */
+const char *xmpp_conn_get_user_agent_software(const xmpp_conn_t *conn)
+{
+    return conn->user_agent_software;
+}
+
+/** Set the user-agent software name used to authenticate the connection.
+ *  If any name was previously set, it will be discarded.  The function
+ *  will make a copy of the string.
+ *
+ *  @param conn a Strophe connection object
+ *  @param user_agent_software the name
+ *
+ *  @ingroup Connections
+ */
+void xmpp_conn_set_user_agent_software(xmpp_conn_t *conn,
+                                       const char *user_agent_software)
+{
+    if (conn->user_agent_software)
+        strophe_free(conn->ctx, conn->user_agent_software);
+    conn->user_agent_software =
+        user_agent_software ? strophe_strdup(conn->ctx, user_agent_software)
+                            : NULL;
+}
+
+/** Get the device name used for authentication of a connection.
+ *
+ *  @param conn a Strophe connection object
+ *
+ *  @return a string containing the name or NULL if it has not been set
+ *
+ *  @ingroup Connections
+ */
+const char *xmpp_conn_get_user_agent_device(const xmpp_conn_t *conn)
+{
+    return conn->user_agent_device;
+}
+
+/** Set the user-agent device name used to authenticate the connection.
+ *  If any name was previously set, it will be discarded.  The function
+ *  will make a copy of the string.
+ *
+ *  @param conn a Strophe connection object
+ *  @param user_agent_device the name
+ *
+ *  @ingroup Connections
+ */
+void xmpp_conn_set_user_agent_device(xmpp_conn_t *conn,
+                                     const char *user_agent_device)
+{
+    if (conn->user_agent_device)
+        strophe_free(conn->ctx, conn->user_agent_device);
+    conn->user_agent_device =
+        user_agent_device ? strophe_strdup(conn->ctx, user_agent_device) : NULL;
+}
+
 /** Get the strophe context that the connection is associated with.
  *  @param conn a Strophe connection object
  *

strophe.h

@@ -403,6 +403,14 @@ unsigned int xmpp_conn_cert_xmppaddr_num(xmpp_conn_t *conn);
 char *xmpp_conn_cert_xmppaddr(xmpp_conn_t *conn, unsigned int n);
 const char *xmpp_conn_get_pass(const xmpp_conn_t *conn);
 void xmpp_conn_set_pass(xmpp_conn_t *conn, const char *pass);
+const char *xmpp_conn_get_user_agent_id(const xmpp_conn_t *conn);
+void xmpp_conn_set_user_agent_id(xmpp_conn_t *conn, const char *user_agent_id);
+const char *xmpp_conn_get_user_agent_software(const xmpp_conn_t *conn);
+void xmpp_conn_set_user_agent_software(xmpp_conn_t *conn,
+                                       const char *user_agent_software);
+const char *xmpp_conn_get_user_agent_device(const xmpp_conn_t *conn);
+void xmpp_conn_set_user_agent_device(xmpp_conn_t *conn,
+                                     const char *user_agent_device);
 xmpp_ctx_t *xmpp_conn_get_context(xmpp_conn_t *conn);
 int xmpp_conn_is_secured(xmpp_conn_t *conn);
 void xmpp_conn_set_sockopt_callback(xmpp_conn_t *conn,