source: protocols/jabber/jabber.h @ f138bd2

Last change on this file since f138bd2 was e1c926f, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-07-31T15:44:37Z

Facebook authentication. This isn't really OAuth in the end: FB doesn't
really support desktop app OAuth in a way that would work with BitlBee.
Plus, it's only OAuth-compliant by, err, name?

  • Property mode set to 100644
File size: 14.6 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Main file                                                *
5*                                                                           *
6*  Copyright 2006 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{
37        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
38                                           and want to do auth. */
39        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
40        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
41                                           SASL or TLS). */
42        JFLAG_WANT_SESSION = 8,         /* Set if the server wants a <session/> tag
43                                           before we continue. */
44        JFLAG_WANT_BIND = 16,           /* ... for <bind> tag. */
45        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
46                                           activates all XEP-85 related code. */
47        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
48        JFLAG_STARTTLS_DONE = 128,      /* If a plaintext session was converted to TLS. */
49       
50        JFLAG_SASL_FB = 0x10000,        /* Trying Facebook authentication. */
51} jabber_flags_t;
52
53typedef enum
54{
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{
70        char *jid;
71        char *host;
72        char port[6];
73} jabber_streamhost_t;
74
75typedef enum
76{
77        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
78                                           we can detect echoes/backlogs. */
79} jabber_chat_flags_t;
80
81struct jabber_data
82{
83        struct im_connection *ic;
84       
85        int fd;
86        void *ssl;
87        char *txq;
88        int tx_len;
89        int r_inpa, w_inpa;
90       
91        struct xt_parser *xt;
92        jabber_flags_t flags;
93       
94        char *username;         /* USERNAME@server */
95        char *server;           /* username@SERVER -=> server/domain, not hostname */
96       
97        char *oauth2_access_token;
98       
99        /* After changing one of these two (or the priority setting), call
100           presence_send_update() to inform the server about the changes. */
101        const struct jabber_away_state *away_state;
102        char *away_message;
103       
104        md5_state_t cached_id_prefix;
105        GHashTable *node_cache;
106        GHashTable *buddies;
107
108        GSList *filetransfers;
109        GSList *streamhosts;
110        int have_streamhosts;
111};
112
113struct jabber_away_state
114{
115        char code[5];
116        char *full_name;
117};
118
119typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
120
121struct jabber_cache_entry
122{
123        time_t saved_at;
124        struct xt_node *node;
125        jabber_cache_event func;
126};
127
128/* Somewhat messy data structure: We have a hash table with the bare JID as
129   the key and the head of a struct jabber_buddy list as the value. The head
130   is always a bare JID. If the JID has other resources (often the case,
131   except for some transports that don't support multiple resources), those
132   follow. In that case, the bare JID at the beginning doesn't actually
133   refer to a real session and should only be used for operations that
134   support incomplete JIDs. */
135struct jabber_buddy
136{
137        char *bare_jid;
138        char *full_jid;
139        char *resource;
140       
141        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
142                       /* otherwise something similar to the conference JID. */
143       
144        int priority;
145        struct jabber_away_state *away_state;
146        char *away_message;
147        GSList *features;
148       
149        time_t last_msg;
150        jabber_buddy_flags_t flags;
151       
152        struct jabber_buddy *next;
153};
154
155struct jabber_chat
156{
157        int flags;
158        char *name;
159        char *my_full_jid; /* Separate copy because of case sensitivity. */
160        struct jabber_buddy *me;
161};
162
163struct jabber_transfer
164{
165        /* bitlbee's handle for this transfer */
166        file_transfer_t *ft;
167
168        /* the stream's private handle */
169        gpointer streamhandle;
170
171        /* timeout for discover queries */
172        gint disco_timeout;
173        gint disco_timeout_fired;
174
175        struct im_connection *ic;
176
177        struct jabber_buddy *bud;
178
179        int watch_in;
180        int watch_out;
181
182        char *ini_jid;
183        char *tgt_jid;
184        char *iq_id;
185        char *sid;
186        int accepted;
187
188        size_t bytesread, byteswritten;
189        int fd;
190        struct sockaddr_storage saddr;
191};
192
193#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
194
195/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
196   first one should be used, but when storing a packet in the cache, a
197   "special" kind of ID is assigned to make it easier later to figure out
198   if we have to do call an event handler for the response packet. Also
199   we'll append a hash to make sure we won't trigger on cached packets from
200   other BitlBee users. :-) */
201#define JABBER_PACKET_ID "BeeP"
202#define JABBER_CACHED_ID "BeeC"
203
204/* The number of seconds to keep cached packets before garbage collecting
205   them. This gc is done on every keepalive (every minute). */
206#define JABBER_CACHE_MAX_AGE 600
207
208/* RFC 392[01] stuff */
209#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
210#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
211#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
212#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
213#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
214#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
215#define XMLNS_ROSTER       "jabber:iq:roster"
216
217/* Some supported extensions/legacy stuff */
218#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
219#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
220#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
221#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
222#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
223#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
224#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
225#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
226#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
227#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
228#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
229#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
230#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
231#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
232#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
233#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
234#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
235#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
236#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
237
238/* jabber.c */
239void jabber_connect( struct im_connection *ic );
240
241/* iq.c */
242xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
243int jabber_init_iq_auth( struct im_connection *ic );
244xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
245int jabber_get_roster( struct im_connection *ic );
246int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
247int jabber_add_to_roster( struct im_connection *ic, const char *handle, const char *name, const char *group );
248int jabber_remove_from_roster( struct im_connection *ic, char *handle );
249xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
250xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
251void jabber_iq_version_send( struct im_connection *ic, struct jabber_buddy *bud, void *data );
252
253/* si.c */
254int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
255void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
256void jabber_si_free_transfer( file_transfer_t *ft);
257
258/* s5bytestream.c */
259int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
260gboolean jabber_bs_send_start( struct jabber_transfer *tf );
261gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
262
263/* message.c */
264xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
265
266/* presence.c */
267xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
268int presence_send_update( struct im_connection *ic );
269int presence_send_request( struct im_connection *ic, char *handle, char *request );
270
271/* jabber_util.c */
272char *set_eval_priority( set_t *set, char *value );
273char *set_eval_tls( set_t *set, char *value );
274struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
275struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
276void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
277struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
278void jabber_cache_entry_free( gpointer entry );
279void jabber_cache_clean( struct im_connection *ic );
280xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
281const struct jabber_away_state *jabber_away_state_by_code( char *code );
282const struct jabber_away_state *jabber_away_state_by_name( char *name );
283void jabber_buddy_ask( struct im_connection *ic, char *handle );
284char *jabber_normalize( const char *orig );
285
286typedef enum
287{
288        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
289        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
290        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
291        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
292        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
293} get_buddy_flags_t;
294
295struct jabber_error
296{
297        char *code, *text, *type;
298};
299
300struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
301struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
302struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
303int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
304int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
305void jabber_buddy_remove_all( struct im_connection *ic );
306time_t jabber_get_timestamp( struct xt_node *xt );
307struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
308void jabber_error_free( struct jabber_error *err );
309
310extern const struct jabber_away_state jabber_away_state_list[];
311
312/* io.c */
313int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
314int jabber_write( struct im_connection *ic, char *buf, int len );
315gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
316gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
317gboolean jabber_start_stream( struct im_connection *ic );
318void jabber_end_stream( struct im_connection *ic );
319
320/* sasl.c */
321xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
322xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
323xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
324gboolean sasl_supported( struct im_connection *ic );
325void sasl_oauth2_init( struct im_connection *ic );
326int sasl_oauth2_get_refresh_token( struct im_connection *ic, const char *msg );
327int sasl_oauth2_refresh( struct im_connection *ic, const char *refresh_token );
328
329/* conference.c */
330struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
331struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
332void jabber_chat_free( struct groupchat *c );
333int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
334int jabber_chat_topic( struct groupchat *c, char *topic );
335int jabber_chat_leave( struct groupchat *c, const char *reason );
336void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
337void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
338void jabber_chat_invite( struct groupchat *c, char *who, char *message );
339
340#endif
Note: See TracBrowser for help on using the repository browser.