source: protocols/jabber/jabber.h @ 200e151

Last change on this file since 200e151 was 792a93b, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-12-23T12:44:08Z

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