source: protocols/jabber/jabber.h @ 19f5c94

Last change on this file since 19f5c94 was a42169b, checked in by / <>, at 2021-03-12T11:37:53Z

xmpp xep-0191/blocklist
  • Property mode set to 100644
File size: 17.0 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Main file                                                *
5*                                                                           *
6*  Copyright 2006-2013 Wilmer van der Gaast <wilmer@gaast.net>              *
7*                                                                           *
8*  This program is free software; you can redistribute it and/or modify     *
9*  it under the terms of the GNU General Public License as published by     *
10*  the Free Software Foundation; either version 2 of the License, or        *
11*  (at your option) any later version.                                      *
12*                                                                           *
13*  This program is distributed in the hope that it will be useful,          *
14*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
15*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
16*  GNU General Public License for more details.                             *
17*                                                                           *
18*  You should have received a copy of the GNU General Public License along  *
19*  with this program; if not, write to the Free Software Foundation, Inc.,  *
20*  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.              *
21*                                                                           *
22\***************************************************************************/
23
24#ifndef _JABBER_H
25#define _JABBER_H
26
27#include <glib.h>
28
29#include "bitlbee.h"
30#include "md5.h"
31#include "xmltree.h"
32
33extern GSList *jabber_connections;
34
35typedef enum {
36        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
37                                           and want to do auth. */
38        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
39        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
40                                           SASL or TLS). */
41        JFLAG_WANT_SESSION = 8,         /* Set if the server wants a <session/> tag
42                                           before we continue. */
43        JFLAG_WANT_BIND = 16,           /* ... for <bind> tag. */
44        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
45                                           activates all XEP-85 related code. */
46        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
47        JFLAG_STARTTLS_DONE = 128,      /* If a plaintext session was converted to TLS. */
48        JFLAG_GMAILNOTIFY = 256,        /* If gmail notification is enabled */
49
50        JFLAG_GTALK =  0x100000,        /* Is Google Talk, as confirmed by iq discovery */
51        JFLAG_HIPCHAT = 0x200000,       /* Is hipchat, because prpl->name says so */
52} jabber_flags_t;
53
54typedef enum {
55        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
56                                           sure it gets sent only once. */
57        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
58                                           XEP85 (typing notification shite). */
59        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
60                                           groupchat state info too. */
61        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
62                                           have a real JID. */
63        JBFLAG_HIDE_SUBJECT = 16,       /* Hide the subject field since we probably
64                                           showed it already. */
65} jabber_buddy_flags_t;
66
67/* Stores a streamhost's (a.k.a. proxy) data */
68typedef struct {
69        char *jid;
70        char *host;
71        char port[6];
72} jabber_streamhost_t;
73
74typedef enum {
75        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
76                                           we can detect echoes/backlogs. */
77        JCFLAG_ALWAYS_USE_NICKS = 2,
78} jabber_chat_flags_t;
79
80struct jabber_data {
81        struct im_connection *ic;
82
83        int fd;
84        void *ssl;
85        char *txq;
86        int tx_len;
87        int r_inpa, w_inpa;
88
89        struct xt_parser *xt;
90        jabber_flags_t flags;
91
92        char *username;         /* USERNAME@server */
93        char *server;           /* username@SERVER -=> server/domain, not hostname */
94        char *me;               /* bare jid */
95        char *internal_jid;
96
97        const struct oauth2_service *oauth2_service;
98        char *oauth2_access_token;
99
100        /* After changing one of these two (or the priority setting), call
101           presence_send_update() to inform the server about the changes. */
102        const struct jabber_away_state *away_state;
103        char *away_message;
104        guint64 gmail_time;
105        char *gmail_tid;
106
107        md5_state_t cached_id_prefix;
108        GHashTable *node_cache;
109        GHashTable *buddies;
110
111        GSList *features;
112        GSList *filetransfers;
113        GSList *streamhosts;
114        int have_streamhosts;
115
116        char *muc_host;
117};
118
119struct jabber_away_state {
120        char code[5];
121        char *full_name;
122};
123
124typedef xt_status (*jabber_cache_event) (struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
125
126struct jabber_cache_entry {
127        time_t saved_at;
128        struct xt_node *node;
129        jabber_cache_event func;
130};
131
132/* Somewhat messy data structure: We have a hash table with the bare JID as
133   the key and the head of a struct jabber_buddy list as the value. The head
134   is always a bare JID. If the JID has other resources (often the case,
135   except for some transports that don't support multiple resources), those
136   follow. In that case, the bare JID at the beginning doesn't actually
137   refer to a real session and should only be used for operations that
138   support incomplete JIDs. */
139struct jabber_buddy {
140        char *bare_jid;
141        char *full_jid;
142        char *resource;
143
144        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
145                       /* otherwise something similar to the conference JID. */
146
147        int priority;
148        struct jabber_away_state *away_state;
149        char *away_message;
150        GSList *features;
151
152        time_t last_msg;
153        jabber_buddy_flags_t flags;
154
155        struct jabber_buddy *next;
156};
157
158struct jabber_chat {
159        int flags;
160        char *name;
161        char *my_full_jid; /* Separate copy because of case sensitivity. */
162        struct jabber_buddy *me;
163        char *invite;
164        char *last_sent_message;
165};
166
167struct jabber_transfer {
168        /* bitlbee's handle for this transfer */
169        file_transfer_t *ft;
170
171        /* the stream's private handle */
172        gpointer streamhandle;
173
174        /* timeout for discover queries */
175        gint disco_timeout;
176        gint disco_timeout_fired;
177
178        struct im_connection *ic;
179
180        struct jabber_buddy *bud;
181
182        int watch_in;
183        int watch_out;
184
185        char *ini_jid;
186        char *tgt_jid;
187        char *iq_id;
188        char *sid;
189        int accepted;
190
191        size_t bytesread, byteswritten;
192        int fd;
193        struct sockaddr_storage saddr;
194};
195
196#define JABBER_XMLCONSOLE_HANDLE "_xmlconsole"
197#define JABBER_OAUTH_HANDLE "jabber_oauth"
198
199/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
200   first one should be used, but when storing a packet in the cache, a
201   "special" kind of ID is assigned to make it easier later to figure out
202   if we have to do call an event handler for the response packet. Also
203   we'll append a hash to make sure we won't trigger on cached packets from
204   other BitlBee users. :-) */
205#define JABBER_PACKET_ID "BeeP"
206#define JABBER_CACHED_ID "BeeC"
207
208/* The number of seconds to keep cached packets before garbage collecting
209   them. This gc is done on every keepalive (every minute). */
210#define JABBER_CACHE_MAX_AGE 600
211
212/* RFC 392[01] stuff */
213#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
214#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
215#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
216#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
217#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
218#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
219#define XMLNS_ROSTER       "jabber:iq:roster"
220
221/* Some supported extensions/legacy stuff */
222#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
223#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
224#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
225#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
226#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
227#define XMLNS_RECEIPTS     "urn:xmpp:receipts"                                   /* XEP-0184 */
228#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
229#define XMLNS_DELAY_OLD    "jabber:x:delay"                                      /* XEP-0091 */
230#define XMLNS_DELAY        "urn:xmpp:delay"                                      /* XEP-0203 */
231#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
232#define XMLNS_GMAILNOTIFY  "google:mail:notify"                                  /* Not a XEP */
233#define XMLNS_CARBONS      "urn:xmpp:carbons:2"                                  /* XEP-0280 */
234#define XMLNS_FORWARDING   "urn:xmpp:forward:0"                                  /* XEP-0297 */
235#define XMLNS_HINTS        "urn:xmpp:hints"                                      /* XEP-0334 */
236#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
237#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
238#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
239#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
240#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
241#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
242#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
243#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
244#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
245#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
246#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
247#define XMLNS_BLOCK        "urn:xmpp:blocking"                                   /* XEP-0191 */
248
249/* Hipchat protocol extensions*/
250#define XMLNS_HIPCHAT         "http://hipchat.com"
251#define XMLNS_HIPCHAT_PROFILE "http://hipchat.com/protocol/profile"
252
253/* jabber.c */
254void jabber_connect(struct im_connection *ic);
255
256/* iq.c */
257xt_status jabber_pkt_iq(struct xt_node *node, gpointer data);
258int jabber_init_iq_auth(struct im_connection *ic);
259xt_status jabber_pkt_bind_sess(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
260int jabber_get_roster(struct im_connection *ic);
261int jabber_get_vcard(struct im_connection *ic, char *bare_jid);
262int jabber_add_to_roster(struct im_connection *ic, const char *handle, const char *name, const char *group);
263int jabber_remove_from_roster(struct im_connection *ic, char *handle);
264xt_status jabber_iq_query_features(struct im_connection *ic, char *bare_jid);
265xt_status jabber_iq_query_server(struct im_connection *ic, char *jid, char *xmlns);
266void jabber_iq_version_send(struct im_connection *ic, struct jabber_buddy *bud, void *data);
267int jabber_iq_disco_server(struct im_connection *ic);
268int jabber_iq_disco_muc(struct im_connection *ic, const char *muc_server);
269
270/* si.c */
271int jabber_si_handle_request(struct im_connection *ic, struct xt_node *node, struct xt_node *sinode);
272void jabber_si_transfer_request(struct im_connection *ic, file_transfer_t *ft, char *who);
273void jabber_si_free_transfer(file_transfer_t *ft);
274
275/* s5bytestream.c */
276int jabber_bs_recv_request(struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
277gboolean jabber_bs_send_start(struct jabber_transfer *tf);
278gboolean jabber_bs_send_write(file_transfer_t *ft, char *buffer, unsigned int len);
279
280/* message.c */
281xt_status jabber_pkt_message(struct xt_node *node, gpointer data);
282
283/* presence.c */
284xt_status jabber_pkt_presence(struct xt_node *node, gpointer data);
285int presence_send_update(struct im_connection *ic);
286int presence_send_request(struct im_connection *ic, char *handle, char *request);
287
288/* block.c */
289void jabber_buddy_block(struct im_connection *ic, char *who);
290void jabber_buddy_unblock(struct im_connection *ic, char *who);
291void jabber_buddy_permit(struct im_connection *ic, char *who);
292void jabber_buddy_unpermit(struct im_connection *ic, char *who);
293int jabber_block_feature(struct im_connection *ic);
294
295/* jabber_util.c */
296char *set_eval_priority(set_t *set, char *value);
297char *set_eval_tls(set_t *set, char *value);
298struct xt_node *jabber_make_packet(char *name, char *type, char *to, struct xt_node *children);
299struct xt_node *jabber_make_error_packet(struct xt_node *orig, char *err_cond, char *err_type, char *err_code);
300void jabber_cache_add(struct im_connection *ic, struct xt_node *node, jabber_cache_event func);
301struct xt_node *jabber_cache_get(struct im_connection *ic, char *id);
302void jabber_cache_entry_free(gpointer entry);
303void jabber_cache_clean(struct im_connection *ic);
304xt_status jabber_cache_handle_packet(struct im_connection *ic, struct xt_node *node);
305const struct jabber_away_state *jabber_away_state_by_code(char *code);
306const struct jabber_away_state *jabber_away_state_by_name(char *name);
307void jabber_buddy_ask(struct im_connection *ic, char *handle);
308int jabber_compare_jid(const char *jid1, const char *jid2);
309char *jabber_normalize(const char *orig);
310
311typedef enum {
312        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
313        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
314        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
315        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
316        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
317} get_buddy_flags_t;
318
319struct jabber_error {
320        char *code, *text, *type;
321};
322
323struct jabber_buddy *jabber_buddy_add(struct im_connection *ic, char *full_jid);
324struct jabber_buddy *jabber_buddy_by_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
325struct jabber_buddy *jabber_buddy_by_ext_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
326int jabber_buddy_remove(struct im_connection *ic, char *full_jid);
327int jabber_buddy_remove_bare(struct im_connection *ic, char *bare_jid);
328void jabber_buddy_remove_all(struct im_connection *ic);
329time_t jabber_get_timestamp(struct xt_node *xt);
330struct jabber_error *jabber_error_parse(struct xt_node *node, char *xmlns);
331void jabber_error_free(struct jabber_error *err);
332gboolean jabber_set_me(struct im_connection *ic, const char *me);
333char *jabber_get_bare_jid(char *jid);
334
335extern const struct jabber_away_state jabber_away_state_list[];
336
337/* io.c */
338int jabber_write_packet(struct im_connection *ic, struct xt_node *node);
339int jabber_write(struct im_connection *ic, char *buf, int len);
340gboolean jabber_connected_plain(gpointer data, gint source, b_input_condition cond);
341gboolean jabber_connected_ssl(gpointer data, int returncode, void *source, b_input_condition cond);
342gboolean jabber_start_stream(struct im_connection *ic);
343void jabber_end_stream(struct im_connection *ic);
344
345/* sasl.c */
346xt_status sasl_pkt_mechanisms(struct xt_node *node, gpointer data);
347xt_status sasl_pkt_challenge(struct xt_node *node, gpointer data);
348xt_status sasl_pkt_result(struct xt_node *node, gpointer data);
349gboolean sasl_supported(struct im_connection *ic);
350void sasl_oauth2_init(struct im_connection *ic);
351int sasl_oauth2_get_refresh_token(struct im_connection *ic, const char *msg);
352int sasl_oauth2_refresh(struct im_connection *ic, const char *refresh_token);
353void sasl_oauth2_got_token(gpointer data, const char *access_token, const char *refresh_token, const char *error);
354
355extern const struct oauth2_service oauth2_service_google;
356
357/* conference.c */
358struct groupchat *jabber_chat_join(struct im_connection *ic, const char *room, const char *nick, const char *password,
359                                   gboolean always_use_nicks);
360struct groupchat *jabber_chat_with(struct im_connection *ic, char *who);
361struct groupchat *jabber_chat_by_jid(struct im_connection *ic, const char *name);
362void jabber_chat_free(struct groupchat *c);
363int jabber_chat_msg(struct groupchat *ic, char *message, int flags);
364int jabber_chat_topic(struct groupchat *c, char *topic);
365int jabber_chat_leave(struct groupchat *c, const char *reason);
366void jabber_chat_pkt_presence(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
367void jabber_chat_pkt_message(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
368void jabber_chat_invite(struct groupchat *c, char *who, char *message);
369
370/* hipchat.c */
371int jabber_get_hipchat_profile(struct im_connection *ic);
372xt_status jabber_parse_hipchat_profile(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
373xt_status hipchat_handle_success(struct im_connection *ic, struct xt_node *node);
374char *hipchat_make_channel_slug(const char *name);
375char *hipchat_guess_channel_name(struct im_connection *ic, const char *name);
376
377#endif
Note: See TracBrowser for help on using the repository browser.