source: storage_xml.c @ 5b52a48

Last change on this file since 5b52a48 was 5b52a48, checked in by Wilmer van der Gaast <wilmer@…>, at 2006-07-03T21:22:45Z

Implemented per-account nick lists instead of per-protocol nick lists.
nick_t is dead, instead nicks are just saves in a per-account_t GLib
hash table. While doing this, the import_buddies command finally died
and text_save() disappeared, because the old file format can't handle
most of the new features in this branch anyway.

Still have to implement support for the new nick lists in text_load()!

  • Property mode set to 100644
File size: 14.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 "rc4.h"
30#include "md5.h"
31
32typedef enum
33{
34        XML_PASS_CHECK_ONLY = -1,
35        XML_PASS_UNKNOWN = 0,
36        XML_PASS_WRONG,
37        XML_PASS_OK
38} xml_pass_st;
39
40/* To make it easier later when extending the format: */
41#define XML_FORMAT_VERSION 1
42
43struct xml_parsedata
44{
45        irc_t *irc;
46        char *current_setting;
47        account_t *current_account;
48        char *given_nick;
49        char *given_pass;
50        xml_pass_st pass_st;
51};
52
53static char *xml_attr( const gchar **attr_names, const gchar **attr_values, const gchar *key )
54{
55        int i;
56       
57        for( i = 0; attr_names[i]; i ++ )
58                if( g_strcasecmp( attr_names[i], key ) == 0 )
59                        return (char*) attr_values[i];
60       
61        return NULL;
62}
63
64static void xml_destroy_xd( gpointer data )
65{
66        struct xml_parsedata *xd = data;
67       
68        g_free( xd->given_nick );
69        g_free( xd->given_pass );
70        g_free( xd );
71}
72
73static void xml_start_element( GMarkupParseContext *ctx, const gchar *element_name, const gchar **attr_names, const gchar **attr_values, gpointer data, GError **error )
74{
75        struct xml_parsedata *xd = data;
76        irc_t *irc = xd->irc;
77       
78        if( g_strcasecmp( element_name, "user" ) == 0 )
79        {
80                char *nick = xml_attr( attr_names, attr_values, "nick" );
81                char *pass = xml_attr( attr_names, attr_values, "password" );
82                md5_byte_t *pass_dec = NULL;
83               
84                if( !nick || !pass )
85                {
86                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
87                                     "Missing attributes for %s element", element_name );
88                }
89                else if( base64_decode( pass, &pass_dec ) != 21 )
90                {
91                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
92                                     "Error while decoding password attribute" );
93                }
94                else
95                {
96                        md5_byte_t pass_md5[16];
97                        md5_state_t md5_state;
98                        int i;
99                       
100                        md5_init( &md5_state );
101                        md5_append( &md5_state, (md5_byte_t*) xd->given_pass, strlen( xd->given_pass ) );
102                        md5_append( &md5_state, (md5_byte_t*) pass_dec + 16, 5 ); /* Hmmm, salt! */
103                        md5_finish( &md5_state, pass_md5 );
104                       
105                        for( i = 0; i < 16; i ++ )
106                        {
107                                if( pass_dec[i] != pass_md5[i] )
108                                {
109                                        xd->pass_st = XML_PASS_WRONG;
110                                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
111                                                     "Password mismatch" );
112                                        break;
113                                }
114                        }
115                       
116                        /* If we reached the end of the loop, it was a match! */
117                        if( i == 16 )
118                        {
119                                if( xd->pass_st != XML_PASS_CHECK_ONLY )
120                                        xd->pass_st = XML_PASS_OK;
121                        }
122                }
123               
124                g_free( pass_dec );
125        }
126        else if( xd->pass_st < XML_PASS_OK )
127        {
128                /* Let's not parse anything else if we only have to check
129                   the password. */
130        }
131        else if( g_strcasecmp( element_name, "account" ) == 0 )
132        {
133                char *protocol, *handle, *server, *password = NULL, *autoconnect;
134                char *pass_b64 = NULL, *pass_rc4 = NULL;
135                int pass_len;
136                struct prpl *prpl = NULL;
137               
138                handle = xml_attr( attr_names, attr_values, "handle" );
139                pass_b64 = xml_attr( attr_names, attr_values, "password" );
140                server = xml_attr( attr_names, attr_values, "server" );
141                autoconnect = xml_attr( attr_names, attr_values, "autoconnect" );
142               
143                protocol = xml_attr( attr_names, attr_values, "protocol" );
144                if( protocol )
145                        prpl = find_protocol( protocol );
146               
147                if( !handle || !pass_b64 || !protocol )
148                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
149                                     "Missing attributes for %s element", element_name );
150                else if( !prpl )
151                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
152                                     "Unknown protocol: %s", protocol );
153                else if( ( pass_len = base64_decode( pass_b64, (unsigned char**) &pass_rc4 ) ) &&
154                                rc4_decode( (unsigned char*) pass_rc4, pass_len,
155                                            (unsigned char**) &password, xd->given_pass ) )
156                {
157                        xd->current_account = account_add( irc, prpl, handle, password );
158                        if( server )
159                                set_setstr( &xd->current_account->set, "server", server );
160                        if( autoconnect )
161                                set_setstr( &xd->current_account->set, "auto_connect", autoconnect );
162                }
163                else
164                {
165                        /* Actually the _decode functions don't even return error codes,
166                           but maybe they will later... */
167                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
168                                     "Error while decrypting account password" );
169                }
170               
171                g_free( pass_rc4 );
172                g_free( password );
173        }
174        else if( g_strcasecmp( element_name, "setting" ) == 0 )
175        {
176                char *setting;
177               
178                if( xd->current_setting )
179                {
180                        g_free( xd->current_setting );
181                        xd->current_setting = NULL;
182                }
183               
184                if( ( setting = xml_attr( attr_names, attr_values, "name" ) ) )
185                        xd->current_setting = g_strdup( setting );
186                else
187                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
188                                     "Missing attributes for %s element", element_name );
189        }
190        else if( g_strcasecmp( element_name, "buddy" ) == 0 )
191        {
192                char *handle, *nick;
193               
194                handle = xml_attr( attr_names, attr_values, "handle" );
195                nick = xml_attr( attr_names, attr_values, "nick" );
196               
197                if( xd->current_account && handle && nick )
198                {
199                        nick_set( xd->current_account, handle, nick );
200                }
201                else
202                {
203                        g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
204                                     "Missing attributes for %s element", element_name );
205                }
206        }
207        else
208        {
209                g_set_error( error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
210                             "Unkown element: %s", element_name );
211        }
212}
213
214static void xml_end_element( GMarkupParseContext *ctx, const gchar *element_name, gpointer data, GError **error )
215{
216        struct xml_parsedata *xd = data;
217       
218        if( g_strcasecmp( element_name, "setting" ) == 0 && xd->current_setting )
219        {
220                g_free( xd->current_setting );
221                xd->current_setting = NULL;
222        }
223        else if( g_strcasecmp( element_name, "account" ) == 0 )
224        {
225                xd->current_account = NULL;
226        }
227}
228
229static void xml_text( GMarkupParseContext *ctx, const gchar *text, gsize text_len, gpointer data, GError **error )
230{
231        struct xml_parsedata *xd = data;
232        irc_t *irc = xd->irc;
233       
234        if( xd->pass_st < XML_PASS_OK )
235        {
236                /* Let's not parse anything else if we only have to check
237                   the password, or if we didn't get the chance to check it
238                   yet. */
239        }
240        else if( g_strcasecmp( g_markup_parse_context_get_element( ctx ), "setting" ) == 0 && xd->current_setting )
241        {
242                set_setstr( xd->current_account ? &xd->current_account->set : &irc->set,
243                            xd->current_setting, (char*) text );
244                g_free( xd->current_setting );
245                xd->current_setting = NULL;
246        }
247}
248
249GMarkupParser xml_parser =
250{
251        xml_start_element,
252        xml_end_element,
253        xml_text,
254        NULL,
255        NULL
256};
257
258static void xml_init( void )
259{
260        if( access( global.conf->configdir, F_OK ) != 0 )
261                log_message( LOGLVL_WARNING, "The configuration directory %s does not exist. Configuration won't be saved.", CONFIG );
262        else if( access( global.conf->configdir, R_OK ) != 0 || access( global.conf->configdir, W_OK ) != 0 )
263                log_message( LOGLVL_WARNING, "Permission problem: Can't read/write from/to %s.", global.conf->configdir );
264}
265
266static storage_status_t xml_load_real( const char *my_nick, const char *password, irc_t *irc, xml_pass_st action )
267{
268        GMarkupParseContext *ctx;
269        struct xml_parsedata *xd;
270        char *fn, buf[512];
271        GError *gerr = NULL;
272        int fd, st;
273       
274        if( irc && irc->status & USTATUS_IDENTIFIED )
275                return( 1 );
276       
277        xd = g_new0( struct xml_parsedata, 1 );
278        xd->irc = irc;
279        xd->given_nick = g_strdup( my_nick );
280        xd->given_pass = g_strdup( password );
281        xd->pass_st = action;
282        nick_lc( xd->given_nick );
283       
284        fn = g_strdup_printf( "%s%s%s", global.conf->configdir, xd->given_nick, ".xml" );
285        if( ( fd = open( fn, O_RDONLY ) ) < 0 )
286        {
287                xml_destroy_xd( xd );
288                g_free( fn );
289                return STORAGE_NO_SUCH_USER;
290        }
291        g_free( fn );
292       
293        ctx = g_markup_parse_context_new( &xml_parser, 0, xd, xml_destroy_xd );
294       
295        while( ( st = read( fd, buf, sizeof( buf ) ) ) > 0 )
296        {
297                if( !g_markup_parse_context_parse( ctx, buf, st, &gerr ) || gerr )
298                {
299                        xml_pass_st pass_st = xd->pass_st;
300                       
301                        g_markup_parse_context_free( ctx );
302                        close( fd );
303                       
304                        if( pass_st == XML_PASS_WRONG )
305                        {
306                                g_clear_error( &gerr );
307                                return STORAGE_INVALID_PASSWORD;
308                        }
309                        else
310                        {
311                                if( gerr && irc )
312                                        irc_usermsg( irc, "Error from XML-parser: %s", gerr->message );
313                               
314                                g_clear_error( &gerr );
315                                return STORAGE_OTHER_ERROR;
316                        }
317                }
318        }
319        /* Just to be sure... */
320        g_clear_error( &gerr );
321       
322        g_markup_parse_context_free( ctx );
323        close( fd );
324       
325        if( action == XML_PASS_CHECK_ONLY )
326                return STORAGE_OK;
327       
328        irc->status |= USTATUS_IDENTIFIED;
329       
330        return STORAGE_OK;
331}
332
333static storage_status_t xml_load( const char *my_nick, const char *password, irc_t *irc )
334{
335        return xml_load_real( my_nick, password, irc, XML_PASS_UNKNOWN );
336}
337
338static storage_status_t xml_check_pass( const char *my_nick, const char *password )
339{
340        /* This is a little bit risky because we have to pass NULL for the
341           irc_t argument. This *should* be fine, if I didn't miss anything... */
342        return xml_load_real( my_nick, password, NULL, XML_PASS_CHECK_ONLY );
343}
344
345static int xml_printf( int fd, int indent, char *fmt, ... )
346{
347        va_list params;
348        char *out;
349        char tabs[9] = "\t\t\t\t\t\t\t\t";
350        int len;
351       
352        /* Maybe not very clean, but who needs more than 8 levels of indentation anyway? */
353        if( write( fd, tabs, indent <= 8 ? indent : 8 ) != indent )
354                return 0;
355       
356        va_start( params, fmt );
357        out = g_markup_vprintf_escaped( fmt, params );
358        va_end( params );
359       
360        len = strlen( out );
361        len -= write( fd, out, len );
362        g_free( out );
363       
364        return len == 0;
365}
366
367static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data );
368
369static storage_status_t xml_save( irc_t *irc, int overwrite )
370{
371        char path[512], *path2, *pass_buf = NULL;
372        set_t *set;
373        account_t *acc;
374        int fd;
375        md5_byte_t pass_md5[21];
376        md5_state_t md5_state;
377       
378        if( irc->password == NULL )
379        {
380                irc_usermsg( irc, "Please register yourself if you want to save your settings." );
381                return STORAGE_OTHER_ERROR;
382        }
383       
384        g_snprintf( path, sizeof( path ) - 2, "%s%s%s", global.conf->configdir, irc->nick, ".xml" );
385       
386        if( !overwrite && access( path, F_OK ) != -1 )
387                return STORAGE_ALREADY_EXISTS;
388       
389        strcat( path, "~" );
390        if( ( fd = open( path, O_WRONLY | O_CREAT, 0600 ) ) < 0 )
391        {
392                irc_usermsg( irc, "Error while opening configuration file." );
393                return STORAGE_OTHER_ERROR;
394        }
395       
396        /* Generate a salted md5sum of the password. Use 5 bytes for the salt
397           (to prevent dictionary lookups of passwords) to end up with a 21-
398           byte password hash, more convenient for base64 encoding. */
399        random_bytes( pass_md5 + 16, 5 );
400        md5_init( &md5_state );
401        md5_append( &md5_state, (md5_byte_t*) irc->password, strlen( irc->password ) );
402        md5_append( &md5_state, pass_md5 + 16, 5 ); /* Add the salt. */
403        md5_finish( &md5_state, pass_md5 );
404        /* Save the hash in base64-encoded form. */
405        pass_buf = base64_encode( (char*) pass_md5, 21 );
406       
407        if( !xml_printf( fd, 0, "<user nick=\"%s\" password=\"%s\" version=\"%d\">\n", irc->nick, pass_buf, XML_FORMAT_VERSION ) )
408                goto write_error;
409       
410        g_free( pass_buf );
411       
412        for( set = irc->set; set; set = set->next )
413                if( set->value && set->def )
414                        if( !xml_printf( fd, 1, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
415                                goto write_error;
416       
417        for( acc = irc->accounts; acc; acc = acc->next )
418        {
419                char *pass_rc4, *pass_b64;
420                int pass_len;
421               
422                pass_len = rc4_encode( (unsigned char*) acc->pass, strlen( acc->pass ), (unsigned char**) &pass_rc4, irc->password );
423                pass_b64 = base64_encode( pass_rc4, pass_len );
424                g_free( pass_rc4 );
425               
426                if( !xml_printf( fd, 1, "<account protocol=\"%s\" handle=\"%s\" password=\"%s\" autoconnect=\"%d\"", acc->prpl->name, acc->user, pass_b64, acc->auto_connect ) )
427                {
428                        g_free( pass_b64 );
429                        goto write_error;
430                }
431                g_free( pass_b64 );
432               
433                if( acc->server && acc->server[0] && !xml_printf( fd, 0, " server=\"%s\"", acc->server ) )
434                        goto write_error;
435                if( !xml_printf( fd, 0, ">\n" ) )
436                        goto write_error;
437               
438                for( set = acc->set; set; set = set->next )
439                        if( set->value && set->def && !( set->flags & ACC_SET_NOSAVE ) )
440                                if( !xml_printf( fd, 2, "<setting name=\"%s\">%s</setting>\n", set->key, set->value ) )
441                                        goto write_error;
442               
443                /* This probably looks pretty strange. g_hash_table_foreach
444                   is quite a PITA already (but it can't get much better in
445                   C without using #define, I'm afraid), and since it
446                   doesn't seem to be possible to abort the foreach on write
447                   errors, so instead let's use the _find function and
448                   return TRUE on write errors. Which means, if we found
449                   something, there was an error. :-) */
450                if( g_hash_table_find( acc->nicks, xml_save_nick, (gpointer) fd ) )
451                        goto write_error;
452               
453                if( !xml_printf( fd, 1, "</account>\n" ) )
454                        goto write_error;
455        }
456       
457        if( !xml_printf( fd, 0, "</user>\n" ) )
458                goto write_error;
459       
460        close( fd );
461       
462        path2 = g_strndup( path, strlen( path ) - 1 );
463        if( rename( path, path2 ) != 0 )
464        {
465                irc_usermsg( irc, "Error while renaming temporary configuration file." );
466               
467                g_free( path2 );
468                unlink( path );
469               
470                return STORAGE_OTHER_ERROR;
471        }
472       
473        g_free( path2 );
474       
475        return STORAGE_OK;
476
477write_error:
478        g_free( pass_buf );
479       
480        irc_usermsg( irc, "Write error. Disk full?" );
481        close( fd );
482       
483        return STORAGE_OTHER_ERROR;
484}
485
486static gboolean xml_save_nick( gpointer key, gpointer value, gpointer data )
487{
488        return !xml_printf( (int) data, 2, "<buddy handle=\"%s\" nick=\"%s\" />\n", key, value );
489}
490
491static storage_status_t xml_remove( const char *nick, const char *password )
492{
493        char s[512];
494        storage_status_t status;
495
496        status = xml_check_pass( nick, password );
497        if( status != STORAGE_OK )
498                return status;
499
500        g_snprintf( s, 511, "%s%s%s", global.conf->configdir, nick, ".xml" );
501        if( unlink( s ) == -1 )
502                return STORAGE_OTHER_ERROR;
503       
504        return STORAGE_OK;
505}
506
507storage_t storage_xml = {
508        .name = "xml",
509        .init = xml_init,
510        .check_pass = xml_check_pass,
511        .remove = xml_remove,
512        .load = xml_load,
513        .save = xml_save
514};
Note: See TracBrowser for help on using the repository browser.