source: storage_xml.c @ 23d6165

Last change on this file since 23d6165 was e135cd09, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-24T15:58:27Z

Use the account tag in a few places and store it in the XML file as an
attribute, not as a setting (since all accounts have it anyway).

  • Property mode set to 100644
File size: 17.5 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2006 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* Storage backend that uses an XMLish format for all data. */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#define BITLBEE_CORE
27#include "bitlbee.h"
28#include "base64.h"
29#include "arc.h"
30#include "md5.h"
31
32#if GLIB_CHECK_VERSION(2,8,0)
33#include <glib/gstdio.h>
34#else
35/* GLib < 2.8.0 doesn't have g_access, so just use the system access(). */
36#include <unistd.h>
37#define g_access access
38#endif
39
40typedef enum
41{
42        XML_PASS_CHECK_ONLY = -1,
43        XML_PASS_UNKNOWN = 0,
44        XML_PASS_WRONG,
45        XML_PASS_OK
46} xml_pass_st;
47
48/* To make it easier later when extending the format: */
49#define XML_FORMAT_VERSION 1
50
51struct xml_parsedata
52{
53        irc_t *irc;
54        char *current_setting;
55        account_t *current_account;
56        irc_channel_t *current_channel;
57        set_t **current_set_head;
58        char *given_nick;
59        char *given_pass;
60        xml_pass_st pass_st;
61        int unknown_tag;
62};
63
64static char *xml_attr( const gchar **attr_names, const gchar **attr_values, const gchar *key )
65{
66        int i;
67       
68        for( i = 0; attr_names[i]; i ++ )
69                if( g_strcasecmp( attr_names[i], key ) == 0 )
70                        return (char*) attr_values[i];
71       
72        return NULL;
73}
74
75static void xml_destroy_xd( gpointer data )
76{
77        struct xml_parsedata *xd = data;
78       
79        g_free( xd->given_nick );
80        g_free( xd->given_pass );
81        g_free( xd );
82}
83
84static void xml_start_element( GMarkupParseContext *ctx, const gchar *element_name, const gchar **attr_names, const gchar **attr_values, gpointer data, GError **error )
85{
86        struct xml_parsedata *xd = data;
87        irc_t *irc = xd->irc;
88       
89        if( xd->unknown_tag > 0 )
90        {
91                xd->unknown_tag ++;
92        }
93        else if( g_strcasecmp( element_name, "user" ) == 0 )
94        {
95                char *nick = xml_attr( attr_names, attr_values, "nick" );
96                char *pass = xml_attr( attr_names, attr_values, "password" );
97                int st;
98               
99                if( !nick || !pass )
100                {
101                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
102                                     "Missing attributes for %s element", element_name );
103                }
104                else if( ( st = md5_verify_password( xd->given_pass, pass ) ) == -1 )
105                {
106                        xd->pass_st = XML_PASS_WRONG;
107                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
108                                     "Error while decoding password attribute" );
109                }
110                else if( st == 0 )
111                {
112                        if( xd->pass_st != XML_PASS_CHECK_ONLY )
113                                xd->pass_st = XML_PASS_OK;
114                }
115                else
116                {
117                        xd->pass_st = XML_PASS_WRONG;
118                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
119                                     "Password mismatch" );
120                }
121        }
122        else if( xd->pass_st < XML_PASS_OK )
123        {
124                /* Let's not parse anything else if we only have to check
125                   the password. */
126        }
127        else if( g_strcasecmp( element_name, "account" ) == 0 )
128        {
129                char *protocol, *handle, *server, *password = NULL, *autoconnect, *tag;
130                char *pass_b64 = NULL;
131                unsigned char *pass_cr = NULL;
132                int pass_len;
133                struct prpl *prpl = NULL;
134               
135                handle = xml_attr( attr_names, attr_values, "handle" );
136                pass_b64 = xml_attr( attr_names, attr_values, "password" );
137                server = xml_attr( attr_names, attr_values, "server" );
138                autoconnect = xml_attr( attr_names, attr_values, "autoconnect" );
139                tag = xml_attr( attr_names, attr_values, "tag" );
140               
141                protocol = xml_attr( attr_names, attr_values, "protocol" );
142                if( protocol )
143                        prpl = find_protocol( protocol );
144               
145                if( !handle || !pass_b64 || !protocol )
146                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
147                                     "Missing attributes for %s element", element_name );
148                else if( !prpl )
149                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
150                                     "Unknown protocol: %s", protocol );
151                else if( ( pass_len = base64_decode( pass_b64, (unsigned char**) &pass_cr ) ) &&
152                                         arc_decode( pass_cr, pass_len, &password, xd->given_pass ) )
153                {
154                        xd->current_account = account_add( irc->b, prpl, handle, password );
155                        if( server )
156                                set_setstr( &xd->current_account->set, "server", server );
157                        if( autoconnect )
158                                set_setstr( &xd->current_account->set, "auto_connect", autoconnect );
159                        if( tag )
160                                set_setstr( &xd->current_account->set, "tag", tag );
161                }
162                else
163                {
164                        /* Actually the _decode functions don't even return error codes,
165                           but maybe they will later... */
166                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
167                                     "Error while decrypting account password" );
168                }
169               
170                g_free( pass_cr );
171                g_free( password );
172        }
173        else if( g_strcasecmp( element_name, "setting" ) == 0 )
174        {
175                char *setting;
176               
177                if( xd->current_setting )
178                {
179                        g_free( xd->current_setting );
180                        xd->current_setting = NULL;
181                }
182               
183                if( ( setting = xml_attr( attr_names, attr_values, "name" ) ) )
184                {
185                        if( xd->current_channel != NULL )
186                                xd->current_set_head = &xd->current_channel->set;
187                        else if( xd->current_account != NULL )
188                                xd->current_set_head = &xd->current_account->set;
189                        else
190                                xd->current_set_head = &xd->irc->b->set;
191                       
192                        xd->current_setting = g_strdup( setting );
193                }
194                else
195                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
196                                     "Missing attributes for %s element", element_name );
197        }
198        else if( g_strcasecmp( element_name, "buddy" ) == 0 )
199        {
200                char *handle, *nick;
201               
202                handle = xml_attr( attr_names, attr_values, "handle" );
203                nick = xml_attr( attr_names, attr_values, "nick" );
204               
205                if( xd->current_account && handle && nick )
206                {
207                        nick_set_raw( xd->current_account, handle, nick );
208                }
209                else
210                {
211                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
212                                     "Missing attributes for %s element", element_name );
213                }
214        }
215        else if( g_strcasecmp( element_name, "channel" ) == 0 )
216        {
217                char *name, *type;
218               
219                name = xml_attr( attr_names, attr_values, "name" );
220                type = xml_attr( attr_names, attr_values, "type" );
221               
222                if( !name || !type )
223                {
224                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
225                                     "Missing attributes for %s element", element_name );
226                        return;
227                }
228               
229                /* The channel may exist already, for example if it's &bitlbee.
230                   Also, it's possible that the user just reconnected and the
231                   IRC client already rejoined all channels it was in. They
232                   should still get the right settings. */
233                if( ( xd->current_channel = irc_channel_by_name( irc, name ) ) ||
234                    ( xd->current_channel = irc_channel_new( irc, name ) ) )
235                        set_setstr( &xd->current_channel->set, "type", type );
236        }
237        /* Backward compatibility: Keep this around for a while for people
238           switching from BitlBee 1.2.4+. */
239        else if( g_strcasecmp( element_name, "chat" ) == 0 )
240        {
241                char *handle, *channel;
242               
243                handle = xml_attr( attr_names, attr_values, "handle" );
244                channel = xml_attr( attr_names, attr_values, "channel" );
245               
246                if( xd->current_account && handle && channel )
247                {
248                        irc_channel_t *ic;
249                       
250                        if( ( ic = irc_channel_new( irc, channel ) ) &&
251                            set_setstr( &ic->set, "type", "chat" ) &&
252                            set_setstr( &ic->set, "chat_type", "room" ) &&
253                            set_setstr( &ic->set, "account", xd->current_account->tag ) &&
254                            set_setstr( &ic->set, "room", handle ) )
255                        {
256                                /* Try to pick up some settings where possible. */
257                                xd->current_channel = ic;
258                        }
259                        else if( ic )
260                                irc_channel_free( ic );
261                }
262                else
263                {
264                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
265                                     "Missing attributes for %s element", element_name );
266                }
267        }
268        else
269        {
270                xd->unknown_tag ++;
271                irc_usermsg( irc, "Warning: Unknown XML tag found in configuration file (%s). "
272                                  "This may happen when downgrading BitlBee versions. "
273                                  "This tag will be skipped and the information will be lost "
274                                  "once you save your settings.", element_name );
275                /*
276                g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
277                             "Unkown element: %s", element_name );
278                */
279        }
280}
281
282static void xml_end_element( GMarkupParseContext *ctx, const gchar *element_name, gpointer data, GError **error )
283{
284        struct xml_parsedata *xd = data;
285       
286        if( xd->unknown_tag > 0 )
287        {
288                xd->unknown_tag --;
289        }
290        else if( g_strcasecmp( element_name, "setting" ) == 0 && xd->current_setting )
291        {
292                g_free( xd->current_setting );
293                xd->current_setting = NULL;
294        }
295        else if( g_strcasecmp( element_name, "account" ) == 0 )
296        {
297                xd->current_account = NULL;
298        }
299        else if( g_strcasecmp( element_name, "channel" ) == 0 ||
300                 g_strcasecmp( element_name, "chat" ) == 0 )
301        {
302                xd->current_channel = NULL;
303        }
304}
305
306static void xml_text( GMarkupParseContext *ctx, const gchar *text_orig, gsize text_len, gpointer data, GError **error )
307{
308        char text[text_len+1];
309        struct xml_parsedata *xd = data;
310       
311        strncpy( text, text_orig, text_len );
312        text[text_len] = 0;
313       
314        if( xd->pass_st < XML_PASS_OK )
315        {
316                /* Let's not parse anything else if we only have to check
317                   the password, or if we didn't get the chance to check it
318                   yet. */
319        }
320        else if( g_strcasecmp( g_markup_parse_context_get_element( ctx ), "setting" ) == 0 && xd->current_setting )
321        {
322                set_setstr( xd->current_set_head, xd->current_setting, (char*) text );
323                g_free( xd->current_setting );
324                xd->current_setting = NULL;
325        }
326}
327
328GMarkupParser xml_parser =
329{
330        xml_start_element,
331        xml_end_element,
332        xml_text,
333        NULL,
334        NULL
335};
336
337static void xml_init( void )
338{
339        if( g_access( global.conf->configdir, F_OK ) != 0 )
340                log_message( LOGLVL_WARNING, "The configuration directory `%s' does not exist. Configuration won't be saved.", global.conf->configdir );
341        else if( g_access( global.conf->configdir, F_OK ) != 0 || 
342                 g_access( global.conf->configdir, W_OK ) != 0 )
343                log_message( LOGLVL_WARNING, "Permission problem: Can't read/write from/to `%s'.", global.conf->configdir );
344}
345
346static storage_status_t xml_load_real( irc_t *irc, const char *my_nick, const char *password, xml_pass_st action )
347{
348        GMarkupParseContext *ctx;
349        struct xml_parsedata *xd;
350        char *fn, buf[512];
351        GError *gerr = NULL;
352        int fd, st;
353       
354        xd = g_new0( struct xml_parsedata, 1 );
355        xd->irc = irc;
356        xd->given_nick = g_strdup( my_nick );
357        xd->given_pass = g_strdup( password );
358        xd->pass_st = action;
359        nick_lc( xd->given_nick );
360       
361        fn = g_strdup_printf( "%s%s%s", global.conf->configdir, xd->given_nick, ".xml" );
362        if( ( fd = open( fn, O_RDONLY ) ) < 0 )
363        {
364                xml_destroy_xd( xd );
365                g_free( fn );
366                return STORAGE_NO_SUCH_USER;
367        }
368        g_free( fn );
369       
370        ctx = g_markup_parse_context_new( &xml_parser, 0, xd, xml_destroy_xd );
371       
372        while( ( st = read( fd, buf, sizeof( buf ) ) ) > 0 )
373        {
374                if( !g_markup_parse_context_parse( ctx, buf, st, &gerr ) || gerr )
375                {
376                        xml_pass_st pass_st = xd->pass_st;
377                       
378                        g_markup_parse_context_free( ctx );
379                        close( fd );
380                       
381                        if( pass_st == XML_PASS_WRONG )
382                        {
383                                g_clear_error( &gerr );
384                                return STORAGE_INVALID_PASSWORD;
385                        }
386                        else
387                        {
388                                if( gerr && irc )
389                                        irc_usermsg( irc, "Error from XML-parser: %s", gerr->message );
390                               
391                                g_clear_error( &gerr );
392                                return STORAGE_OTHER_ERROR;
393                        }
394                }
395        }
396        /* Just to be sure... */
397        g_clear_error( &gerr );
398       
399        g_markup_parse_context_free( ctx );
400        close( fd );
401       
402        if( action == XML_PASS_CHECK_ONLY )
403                return STORAGE_OK;
404       
405        return STORAGE_OK;
406}
407
408static storage_status_t xml_load( irc_t *irc, const char *password )
409{
410        return xml_load_real( irc, irc->user->nick, password, XML_PASS_UNKNOWN );
411}
412
413static storage_status_t xml_check_pass( const char *my_nick, const char *password )
414{
415        /* This is a little bit risky because we have to pass NULL for the
416           irc_t argument. This *should* be fine, if I didn't miss anything... */
417        return xml_load_real( NULL, my_nick, password, XML_PASS_CHECK_ONLY );
418}
419
420static int xml_printf( int fd, int indent, char *fmt, ... )
421{
422        va_list params;
423        char *out;
424        char tabs[9] = "\t\t\t\t\t\t\t\t";
425        int len;
426       
427        /* Maybe not very clean, but who needs more than 8 levels of indentation anyway? */
428        if( write( fd, tabs, indent <= 8 ? indent : 8 ) != indent )
429                return 0;
430       
431        va_start( params, fmt );
432        out = g_markup_vprintf_escaped( fmt, params );
433        va_end( params );
434       
435        len = strlen( out );
436        len -= write( fd, out, len );
437        g_free( out );
438       
439        return len == 0;
440}
441
442static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data );
443
444static storage_status_t xml_save( irc_t *irc, int overwrite )
445{
446        char path[512], *path2, *pass_buf = NULL;
447        set_t *set;
448        account_t *acc;
449        int fd;
450        md5_byte_t pass_md5[21];
451        md5_state_t md5_state;
452        GSList *l;
453       
454        path2 = g_strdup( irc->user->nick );
455        nick_lc( path2 );
456        g_snprintf( path, sizeof( path ) - 2, "%s%s%s", global.conf->configdir, path2, ".xml" );
457        g_free( path2 );
458       
459        if( !overwrite && g_access( path, F_OK ) == 0 )
460                return STORAGE_ALREADY_EXISTS;
461       
462        strcat( path, ".XXXXXX" );
463        if( ( fd = mkstemp( path ) ) < 0 )
464        {
465                irc_usermsg( irc, "Error while opening configuration file." );
466                return STORAGE_OTHER_ERROR;
467        }
468       
469        /* Generate a salted md5sum of the password. Use 5 bytes for the salt
470           (to prevent dictionary lookups of passwords) to end up with a 21-
471           byte password hash, more convenient for base64 encoding. */
472        random_bytes( pass_md5 + 16, 5 );
473        md5_init( &md5_state );
474        md5_append( &md5_state, (md5_byte_t*) irc->password, strlen( irc->password ) );
475        md5_append( &md5_state, pass_md5 + 16, 5 ); /* Add the salt. */
476        md5_finish( &md5_state, pass_md5 );
477        /* Save the hash in base64-encoded form. */
478        pass_buf = base64_encode( pass_md5, 21 );
479       
480        if( !xml_printf( fd, 0, "<user nick=\"%s\" password=\"%s\" version=\"%d\">\n", irc->user->nick, pass_buf, XML_FORMAT_VERSION ) )
481                goto write_error;
482       
483        g_free( pass_buf );
484       
485        for( set = irc->b->set; set; set = set->next )
486                if( set->value )
487                        if( !xml_printf( fd, 1, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
488                                goto write_error;
489       
490        for( acc = irc->b->accounts; acc; acc = acc->next )
491        {
492                unsigned char *pass_cr;
493                char *pass_b64;
494                int pass_len;
495               
496                pass_len = arc_encode( acc->pass, strlen( acc->pass ), (unsigned char**) &pass_cr, irc->password, 12 );
497                pass_b64 = base64_encode( pass_cr, pass_len );
498                g_free( pass_cr );
499               
500                if( !xml_printf( fd, 1, "<account protocol=\"%s\" handle=\"%s\" password=\"%s\" "
501                                        "autoconnect=\"%d\" tag=\"%s\"", acc->prpl->name, acc->user,
502                                        pass_b64, acc->auto_connect, acc->tag ) )
503                {
504                        g_free( pass_b64 );
505                        goto write_error;
506                }
507                g_free( pass_b64 );
508               
509                if( acc->server && acc->server[0] && !xml_printf( fd, 0, " server=\"%s\"", acc->server ) )
510                        goto write_error;
511                if( !xml_printf( fd, 0, ">\n" ) )
512                        goto write_error;
513               
514                for( set = acc->set; set; set = set->next )
515                        if( set->value && !( set->flags & ACC_SET_NOSAVE ) )
516                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
517                                        goto write_error;
518               
519                /* This probably looks pretty strange. g_hash_table_foreach
520                   is quite a PITA already (but it can't get much better in
521                   C without using #define, I'm afraid), and since it
522                   doesn't seem to be possible to abort the foreach on write
523                   errors, so instead let's use the _find function and
524                   return TRUE on write errors. Which means, if we found
525                   something, there was an error. :-) */
526                if( g_hash_table_find( acc->nicks, xml_save_nick, & fd ) )
527                        goto write_error;
528               
529                if( !xml_printf( fd, 1, "</account>\n" ) )
530                        goto write_error;
531        }
532       
533        for( l = irc->channels; l; l = l->next )
534        {
535                irc_channel_t *ic = l->data;
536               
537                if( ic->flags & IRC_CHANNEL_TEMP )
538                        continue;
539               
540                if( !xml_printf( fd, 1, "<channel name=\"%s\" type=\"%s\">\n",
541                                 ic->name, set_getstr( &ic->set, "type" ) ) )
542                        goto write_error;
543               
544                for( set = ic->set; set; set = set->next )
545                        if( set->value && strcmp( set->key, "type" ) != 0 )
546                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
547                                        goto write_error;
548               
549                if( !xml_printf( fd, 1, "</channel>\n" ) )
550                        goto write_error;
551        }
552       
553        if( !xml_printf( fd, 0, "</user>\n" ) )
554                goto write_error;
555       
556        fsync( fd );
557        close( fd );
558       
559        path2 = g_strndup( path, strlen( path ) - 7 );
560        if( rename( path, path2 ) != 0 )
561        {
562                irc_usermsg( irc, "Error while renaming temporary configuration file." );
563               
564                g_free( path2 );
565                unlink( path );
566               
567                return STORAGE_OTHER_ERROR;
568        }
569       
570        g_free( path2 );
571       
572        return STORAGE_OK;
573
574write_error:
575        g_free( pass_buf );
576       
577        irc_usermsg( irc, "Write error. Disk full?" );
578        close( fd );
579       
580        return STORAGE_OTHER_ERROR;
581}
582
583static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data )
584{
585        return !xml_printf( *( (int*) data ), 2, "<buddy handle=\"%s\" nick=\"%s\" />\n", key, value );
586}
587
588static storage_status_t xml_remove( const char *nick, const char *password )
589{
590        char s[512], *lc;
591        storage_status_t status;
592
593        status = xml_check_pass( nick, password );
594        if( status != STORAGE_OK )
595                return status;
596
597        lc = g_strdup( nick );
598        nick_lc( lc );
599        g_snprintf( s, 511, "%s%s%s", global.conf->configdir, lc, ".xml" );
600        g_free( lc );
601       
602        if( unlink( s ) == -1 )
603                return STORAGE_OTHER_ERROR;
604       
605        return STORAGE_OK;
606}
607
608storage_t storage_xml = {
609        .name = "xml",
610        .init = xml_init,
611        .check_pass = xml_check_pass,
612        .remove = xml_remove,
613        .load = xml_load,
614        .save = xml_save
615};
Note: See TracBrowser for help on using the repository browser.