source: protocols/jabber/jabber.h @ a9a7287

Last change on this file since a9a7287 was 89d736a, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-06-22T19:21:06Z

From the department of over-engineering, now cached packet IDs are full
MD5 hashes instead of a known MD5 hash with a number. Just to make it
harder to confuse BitlBee by sending it faked responses to packets.
  • Property mode set to 100644
File size: 10.9 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 "xmltree.h"
30#include "bitlbee.h"
31
32extern GSList *jabber_connections;
33
34typedef enum
35{
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_WAIT_SESSION = 8,         /* Set if we sent a <session> tag and need a reply
42                                           before we continue. */
43        JFLAG_WAIT_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} jabber_flags_t;
48
49typedef enum
50{
51        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
52                                           sure it gets sent only once. */
53        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
54                                           XEP85 (typing notification shite). */
55        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
56                                           groupchat state info too. */
57        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
58                                           have a real JID. */
59} jabber_buddy_flags_t;
60
61typedef enum
62{
63        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
64                                           we can detect echoes/backlogs. */
65} jabber_chat_flags_t;
66
67struct jabber_data
68{
69        struct im_connection *ic;
70       
71        int fd;
72        void *ssl;
73        char *txq;
74        int tx_len;
75        int r_inpa, w_inpa;
76       
77        struct xt_parser *xt;
78        jabber_flags_t flags;
79       
80        char *username;         /* USERNAME@server */
81        char *server;           /* username@SERVER -=> server/domain, not hostname */
82       
83        /* After changing one of these two (or the priority setting), call
84           presence_send_update() to inform the server about the changes. */
85        struct jabber_away_state *away_state;
86        char *away_message;
87       
88        md5_state_t cached_id_prefix;
89        GHashTable *node_cache;
90        GHashTable *buddies;
91};
92
93struct jabber_away_state
94{
95        char code[5];
96        char *full_name;
97};
98
99typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
100
101struct jabber_cache_entry
102{
103        time_t saved_at;
104        struct xt_node *node;
105        jabber_cache_event func;
106};
107
108struct jabber_buddy
109{
110        char *bare_jid;
111        char *full_jid;
112        char *resource;
113       
114        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
115                       /* otherwise something similar to the conference JID. */
116       
117        int priority;
118        struct jabber_away_state *away_state;
119        char *away_message;
120       
121        time_t last_act;
122        jabber_buddy_flags_t flags;
123       
124        struct jabber_buddy *next;
125};
126
127struct jabber_chat
128{
129        int flags;
130        char *name;
131        char *my_full_jid; /* Separate copy because of case sensitivity. */
132        struct jabber_buddy *me;
133};
134
135#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
136
137/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
138   first one should be used, but when storing a packet in the cache, a
139   "special" kind of ID is assigned to make it easier later to figure out
140   if we have to do call an event handler for the response packet. Also
141   we'll append a hash to make sure we won't trigger on cached packets from
142   other BitlBee users. :-) */
143#define JABBER_PACKET_ID "BeeP"
144#define JABBER_CACHED_ID "BeeC"
145
146/* The number of seconds to keep cached packets before garbage collecting
147   them. This gc is done on every keepalive (every minute). */
148#define JABBER_CACHE_MAX_AGE 600
149
150/* RFC 392[01] stuff */
151#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
152#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
153#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
154#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
155#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
156#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
157#define XMLNS_ROSTER       "jabber:iq:roster"
158
159/* Some supported extensions/legacy stuff */
160#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
161#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
162#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
163#define XMLNS_PING         "urn:xmpp:ping"                      /* XEP-0199 */
164#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
165#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
166#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
167#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
168#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
169#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
170#define XMLNS_CAPS         "http://jabber.org/protocol/caps"    /* XEP-0115 */
171
172/* iq.c */
173xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
174int jabber_init_iq_auth( struct im_connection *ic );
175xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
176int jabber_get_roster( struct im_connection *ic );
177int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
178int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
179int jabber_remove_from_roster( struct im_connection *ic, char *handle );
180
181/* message.c */
182xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
183
184/* presence.c */
185xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
186int presence_send_update( struct im_connection *ic );
187int presence_send_request( struct im_connection *ic, char *handle, char *request );
188
189/* jabber_util.c */
190char *set_eval_priority( set_t *set, char *value );
191char *set_eval_tls( set_t *set, char *value );
192struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
193struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
194void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
195struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
196void jabber_cache_entry_free( gpointer entry );
197void jabber_cache_clean( struct im_connection *ic );
198xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
199const struct jabber_away_state *jabber_away_state_by_code( char *code );
200const struct jabber_away_state *jabber_away_state_by_name( char *name );
201void jabber_buddy_ask( struct im_connection *ic, char *handle );
202char *jabber_normalize( const char *orig );
203
204typedef enum
205{
206        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
207        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
208        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
209} get_buddy_flags_t;
210
211struct jabber_error
212{
213        char *code, *text, *type;
214};
215
216struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
217struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
218struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
219int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
220int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
221time_t jabber_get_timestamp( struct xt_node *xt );
222struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
223void jabber_error_free( struct jabber_error *err );
224
225extern const struct jabber_away_state jabber_away_state_list[];
226
227/* io.c */
228int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
229int jabber_write( struct im_connection *ic, char *buf, int len );
230gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
231gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
232gboolean jabber_start_stream( struct im_connection *ic );
233void jabber_end_stream( struct im_connection *ic );
234
235/* sasl.c */
236xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
237xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
238xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
239gboolean sasl_supported( struct im_connection *ic );
240
241/* conference.c */
242struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
243struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
244void jabber_chat_free( struct groupchat *c );
245int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
246int jabber_chat_topic( struct groupchat *c, char *topic );
247int jabber_chat_leave( struct groupchat *c, const char *reason );
248void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
249void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
250void jabber_chat_invite( struct groupchat *c, char *who, char *message );
251
252#endif
Note: See TracBrowser for help on using the repository browser.