source: trunk/libtransmission/rpc-server.c @ 6825

Last change on this file since 6825 was 6825, checked in by charles, 13 years ago

add a separate flag for enabling/disabling the rpc address whitelist

  • Property svn:keywords set to Date Rev Author Id
File size: 18.4 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: rpc-server.c 6825 2008-10-01 22:59:29Z charles $
11 */
12
13#include <assert.h>
14#include <string.h> /* memcpy */
15#include <limits.h> /* INT_MAX */
16
17#include <sys/types.h> /* open */
18#include <sys/stat.h>  /* open */
19#include <fcntl.h>     /* open */
20#include <unistd.h>    /* close */
21
22#ifdef HAVE_LIBZ
23 #include <zlib.h>
24#endif
25
26#include <libevent/event.h>
27#include <libevent/evhttp.h>
28
29#include "transmission.h"
30#include "bencode.h"
31#include "list.h"
32#include "platform.h"
33#include "rpcimpl.h"
34#include "rpc-server.h"
35#include "trevent.h"
36#include "utils.h"
37#include "web.h"
38
39#define MY_NAME "RPC Server"
40#define MY_REALM "Transmission"
41#define TR_N_ELEMENTS( ary ) ( sizeof( ary ) / sizeof( *ary ) )
42
43struct tr_rpc_server
44{
45    unsigned int       isEnabled          : 1;
46    unsigned int       isPasswordEnabled  : 1;
47    unsigned int       isWhitelistEnabled : 1;
48    uint16_t           port;
49    struct evhttp *    httpd;
50    tr_handle *        session;
51    char *             username;
52    char *             password;
53    char *             whitelist;
54};
55
56#define dbgmsg( fmt ... ) tr_deepLog( __FILE__, __LINE__, MY_NAME, ## fmt )
57
58/**
59***
60**/
61
62static void
63send_simple_response( struct evhttp_request * req,
64                      int                     code,
65                      const char *            text )
66{
67    const char *      code_text = tr_webGetResponseStr( code );
68    struct evbuffer * body = evbuffer_new( );
69
70    evbuffer_add_printf( body, "<h1>%s</h1>", code_text );
71    if( text )
72        evbuffer_add_printf( body, "<h2>%s</h2>", text );
73    evhttp_send_reply( req, code, code_text, body );
74    evbuffer_free( body );
75}
76
77static const char*
78tr_memmem( const char * s1,
79           size_t       l1,
80           const char * s2,
81           size_t       l2 )
82{
83    if( !l2 ) return s1;
84    while( l1 >= l2 )
85    {
86        l1--;
87        if( !memcmp( s1, s2, l2 ) )
88            return s1;
89        s1++;
90    }
91
92    return NULL;
93}
94
95static void
96handle_upload( struct evhttp_request * req,
97               struct tr_rpc_server *  server )
98{
99    if( req->type != EVHTTP_REQ_POST )
100    {
101        send_simple_response( req, 405, NULL );
102    }
103    else
104    {
105        const char * content_type = evhttp_find_header( req->input_headers,
106                                                        "Content-Type" );
107
108        const char * query = strchr( req->uri, '?' );
109        const int    paused = query && strstr( query + 1, "paused=true" );
110
111        const char * in = (const char *) EVBUFFER_DATA( req->input_buffer );
112        size_t       inlen = EVBUFFER_LENGTH( req->input_buffer );
113
114        const char * boundary_key = "boundary=";
115        const char * boundary_key_begin = strstr( content_type,
116                                                  boundary_key );
117        const char * boundary_val =
118            boundary_key_begin ? boundary_key_begin +
119            strlen( boundary_key ) : "arglebargle";
120
121        char *       boundary = tr_strdup_printf( "--%s", boundary_val );
122        const size_t boundary_len = strlen( boundary );
123
124        const char * delim = tr_memmem( in, inlen, boundary, boundary_len );
125        while( delim )
126        {
127            size_t       part_len;
128            const char * part = delim + boundary_len;
129            inlen -= ( part - in );
130            in = part;
131            delim = tr_memmem( in, inlen, boundary, boundary_len );
132            part_len = delim ? (size_t)( delim - part ) : inlen;
133
134            if( part_len )
135            {
136                char * text = tr_strndup( part, part_len );
137                if( strstr( text, "filename=\"" ) )
138                {
139                    const char * body = strstr( text, "\r\n\r\n" );
140                    if( body )
141                    {
142                        char *  b64, *json, *freeme;
143                        int     json_len;
144                        size_t  body_len;
145                        tr_benc top, *args;
146
147                        body += 4;
148                        body_len = part_len - ( body - text );
149                        if( body_len >= 2
150                          && !memcmp( &body[body_len - 2], "\r\n", 2 ) )
151                            body_len -= 2;
152
153                        tr_bencInitDict( &top, 2 );
154                        args = tr_bencDictAddDict( &top, "arguments", 2 );
155                        tr_bencDictAddStr( &top, "method", "torrent-add" );
156                        b64 = tr_base64_encode( body, body_len, NULL );
157                        tr_bencDictAddStr( args, "metainfo", b64 );
158                        tr_bencDictAddInt( args, "paused", paused );
159                        json = tr_bencSaveAsJSON( &top, &json_len );
160                        freeme = tr_rpc_request_exec_json( server->session,
161                                                           json, json_len,
162                                                           NULL );
163
164                        tr_free( freeme );
165                        tr_free( json );
166                        tr_free( b64 );
167                        tr_bencFree( &top );
168                    }
169                }
170                tr_free( text );
171            }
172        }
173
174        tr_free( boundary );
175
176        /* use xml here because json responses to file uploads is trouble.
177         * see http://www.malsup.com/jquery/form/#sample7 for details */
178        evhttp_add_header( req->output_headers, "Content-Type",
179                           "text/xml; charset=UTF-8" );
180        send_simple_response( req, HTTP_OK, NULL );
181    }
182}
183
184static const char*
185mimetype_guess( const char * path )
186{
187    unsigned int i;
188
189    const struct
190    {
191        const char *    suffix;
192        const char *    mime_type;
193    } types[] = {
194        /* these are just the ones we need for serving clutch... */
195        { "css",  "text/css"                       },
196        { "gif",  "image/gif"                      },
197        { "html", "text/html"                      },
198        { "ico",  "image/vnd.microsoft.icon"       },
199        { "js",   "application/javascript"         },
200        { "png",  "image/png"                      }
201    };
202    const char * dot = strrchr( path, '.' );
203
204    for( i = 0; dot && i < TR_N_ELEMENTS( types ); ++i )
205        if( !strcmp( dot + 1, types[i].suffix ) )
206            return types[i].mime_type;
207
208    return "application/octet-stream";
209}
210
211#ifdef HAVE_LIBZ
212static void
213compress_evbuf( struct evbuffer * evbuf )
214{
215    static struct evbuffer * tmp;
216    static z_stream          stream;
217    static unsigned char     buffer[2048];
218
219    if( !tmp )
220    {
221        tmp = evbuffer_new( );
222        deflateInit( &stream, Z_BEST_COMPRESSION );
223    }
224
225    deflateReset( &stream );
226    stream.next_in = EVBUFFER_DATA( evbuf );
227    stream.avail_in = EVBUFFER_LENGTH( evbuf );
228
229    do
230    {
231        stream.next_out = buffer;
232        stream.avail_out = sizeof( buffer );
233        if( deflate( &stream, Z_FULL_FLUSH ) == Z_OK )
234            evbuffer_add( tmp, buffer, sizeof( buffer ) - stream.avail_out );
235        else
236            break;
237    }
238    while( stream.avail_out == 0 );
239
240/*fprintf( stderr, "deflated response from %zu to %zu bytes\n", EVBUFFER_LENGTH(
241  evbuf ), EVBUFFER_LENGTH( tmp ) );*/
242    evbuffer_drain( evbuf, EVBUFFER_LENGTH( evbuf ) );
243    evbuffer_add_buffer( evbuf, tmp );
244}
245
246#endif
247
248static void
249maybe_deflate_response( struct evhttp_request * req,
250                        struct evbuffer *       response )
251{
252#ifdef HAVE_LIBZ
253    const char * accept_encoding = evhttp_find_header( req->input_headers,
254                                                       "Accept-Encoding" );
255    const int    do_deflate = accept_encoding && strstr( accept_encoding,
256                                                         "deflate" );
257    if( do_deflate )
258    {
259        evhttp_add_header( req->output_headers, "Content-Encoding",
260                           "deflate" );
261        compress_evbuf( response );
262    }
263#endif
264}
265
266static void
267serve_file( struct evhttp_request * req,
268            const char *            path )
269{
270    if( req->type != EVHTTP_REQ_GET )
271    {
272        evhttp_add_header( req->output_headers, "Allow", "GET" );
273        send_simple_response( req, 405, NULL );
274    }
275    else
276    {
277        const int fd = open( path, O_RDONLY, 0 );
278        if( fd == -1 )
279        {
280            send_simple_response( req, HTTP_NOTFOUND, NULL );
281        }
282        else
283        {
284            struct evbuffer * buf = evbuffer_new( );
285            evbuffer_read( buf, fd, INT_MAX );
286            evhttp_add_header( req->output_headers, "Content-Type",
287                              mimetype_guess(
288                                  path ) );
289            maybe_deflate_response( req, buf );
290            evhttp_send_reply( req, HTTP_OK, "OK", buf );
291            evbuffer_free( buf );
292            close( fd );
293        }
294    }
295}
296
297static void
298handle_clutch( struct evhttp_request * req,
299               struct tr_rpc_server *  server )
300{
301    const char *      uri;
302    struct evbuffer * buf = evbuffer_new( );
303
304    assert( !strncmp( req->uri, "/transmission/web/", 18 ) );
305
306    evbuffer_add_printf( buf, "%s%s", tr_getClutchDir(
307                             server->session ), TR_PATH_DELIMITER_STR );
308    uri = req->uri + 18;
309    if( ( *uri == '?' ) || ( *uri == '\0' ) )
310        evbuffer_add_printf( buf, "index.html" );
311    else
312    {
313        const char * pch = strchr( uri, '?' );
314        if( pch )
315            evbuffer_add_printf( buf, "%*.*s", (int)( pch - uri ),
316                                 (int)( pch - uri ), uri );
317        else
318            evbuffer_add_printf( buf, "%s", uri );
319    }
320
321    if( strstr( (const char *)EVBUFFER_DATA( buf ), ".." ) )
322        send_simple_response( req, 401, NULL );
323    else
324        serve_file( req, (const char *)EVBUFFER_DATA( buf ) );
325
326    evbuffer_free( buf );
327}
328
329static void
330handle_rpc( struct evhttp_request * req,
331            struct tr_rpc_server *  server )
332{
333    int               len = 0;
334    char *            response = NULL;
335    struct evbuffer * buf;
336
337    if( req->type == EVHTTP_REQ_GET )
338    {
339        const char * q;
340        if( ( q = strchr( req->uri, '?' ) ) )
341            response = tr_rpc_request_exec_uri( server->session,
342                                                q + 1,
343                                                strlen( q + 1 ),
344                                                &len );
345    }
346    else if( req->type == EVHTTP_REQ_POST )
347    {
348        response = tr_rpc_request_exec_json( server->session,
349                                             EVBUFFER_DATA( req->
350                                                            input_buffer ),
351                                             EVBUFFER_LENGTH( req->
352                                                              input_buffer ),
353                                             &len );
354    }
355
356    buf = evbuffer_new( );
357    evbuffer_add( buf, response, len );
358    maybe_deflate_response( req, buf );
359    evhttp_add_header( req->output_headers, "Content-Type",
360                       "application/json; charset=UTF-8" );
361    evhttp_send_reply( req, HTTP_OK, "OK", buf );
362    evbuffer_free( buf );
363}
364
365static int
366isAddressAllowed( const tr_rpc_server * server,
367                  const char *          address )
368{
369    const char * str;
370
371    if( !server->isWhitelistEnabled )
372        return 1;
373
374    for( str = server->whitelist; str && *str; )
375    {
376        const char * delimiter = strchr( str, ',' );
377        const int    len = delimiter ? delimiter - str : (int)strlen( str );
378        char *       token = tr_strndup( str, len );
379        const int    match = tr_wildmat( address, token );
380        tr_free( token );
381        if( match )
382            return 1;
383        if( !delimiter )
384            break;
385        str = delimiter + 1;
386    }
387
388    return 0;
389}
390
391static void
392handle_request( struct evhttp_request * req,
393                void *                  arg )
394{
395    struct tr_rpc_server * server = arg;
396
397    if( req && req->evcon )
398    {
399        const char * auth;
400        char *       user = NULL;
401        char *       pass = NULL;
402
403        evhttp_add_header( req->output_headers, "Server", MY_REALM );
404
405        auth = evhttp_find_header( req->input_headers, "Authorization" );
406
407        if( auth && !strncasecmp( auth, "basic ", 6 ) )
408        {
409            int    plen;
410            char * p = tr_base64_decode( auth + 6, 0, &plen );
411            if( p && plen && ( ( pass = strchr( p, ':' ) ) ) )
412            {
413                user = p;
414                *pass++ = '\0';
415            }
416        }
417
418        if( !isAddressAllowed( server, req->remote_host ) )
419        {
420            send_simple_response( req, 401, "Unauthorized IP Address" );
421        }
422        else if( server->isPasswordEnabled && ( !pass
423                                              || !user
424                                              || strcmp( server->username,
425                                                         user )
426                                              || strcmp( server->password,
427                                                         pass ) ) )
428        {
429            evhttp_add_header( req->output_headers,
430                               "WWW-Authenticate",
431                               "Basic realm=\"" MY_REALM "\"" );
432            send_simple_response( req, 401, "Unauthorized User" );
433        }
434        else if( !strcmp( req->uri, "/transmission/web" )
435               || !strcmp( req->uri, "/transmission/clutch" )
436               || !strcmp( req->uri, "/" ) )
437        {
438            evhttp_add_header( req->output_headers, "Location",
439                               "/transmission/web/" );
440            send_simple_response( req, HTTP_MOVEPERM, NULL );
441        }
442        else if( !strncmp( req->uri, "/transmission/web/", 18 ) )
443        {
444            handle_clutch( req, server );
445        }
446        else if( !strncmp( req->uri, "/transmission/rpc", 17 ) )
447        {
448            handle_rpc( req, server );
449        }
450        else if( !strncmp( req->uri, "/transmission/upload", 20 ) )
451        {
452            handle_upload( req, server );
453        }
454        else
455        {
456            send_simple_response( req, HTTP_NOTFOUND, NULL );
457        }
458
459        tr_free( user );
460    }
461}
462
463static void
464startServer( void * vserver )
465{
466    tr_rpc_server * server  = vserver;
467
468    if( !server->httpd )
469    {
470        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
471        evhttp_bind_socket( server->httpd, "0.0.0.0", server->port );
472        evhttp_set_gencb( server->httpd, handle_request, server );
473    }
474}
475
476static void
477stopServer( tr_rpc_server * server )
478{
479    if( server->httpd )
480    {
481        evhttp_free( server->httpd );
482        server->httpd = NULL;
483    }
484}
485
486static void
487onEnabledChanged( void * vserver )
488{
489    tr_rpc_server * server = vserver;
490
491    if( !server->isEnabled )
492        stopServer( server );
493    else
494        startServer( server );
495}
496
497void
498tr_rpcSetEnabled( tr_rpc_server * server,
499                  int             isEnabled )
500{
501    server->isEnabled = isEnabled != 0;
502
503    tr_runInEventThread( server->session, onEnabledChanged, server );
504}
505
506int
507tr_rpcIsEnabled( const tr_rpc_server * server )
508{
509    return server->isEnabled;
510}
511
512static void
513restartServer( void * vserver )
514{
515    tr_rpc_server * server = vserver;
516
517    if( server->isEnabled )
518    {
519        stopServer( server );
520        startServer( server );
521    }
522}
523
524void
525tr_rpcSetPort( tr_rpc_server * server,
526               uint16_t        port )
527{
528    if( server->port != port )
529    {
530        server->port = port;
531
532        if( server->isEnabled )
533            tr_runInEventThread( server->session, restartServer, server );
534    }
535}
536
537uint16_t
538tr_rpcGetPort( const tr_rpc_server * server )
539{
540    return server->port;
541}
542
543void
544tr_rpcSetWhitelist( tr_rpc_server * server,
545                    const char *    whitelist )
546{
547    tr_free( server->whitelist );
548    server->whitelist = tr_strdup( whitelist );
549}
550
551char*
552tr_rpcGetWhitelist( const tr_rpc_server * server )
553{
554    return tr_strdup( server->whitelist ? server->whitelist : "" );
555}
556
557void
558tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
559                           int              isEnabled )
560{
561    server->isWhitelistEnabled = isEnabled != 0;
562}
563
564int
565tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
566{
567    return server->isWhitelistEnabled;
568}
569
570/****
571*****  PASSWORD
572****/
573
574void
575tr_rpcSetUsername( tr_rpc_server * server,
576                   const char *    username )
577{
578    tr_free( server->username );
579    server->username = tr_strdup( username );
580    dbgmsg( "setting our Username to [%s]", server->username );
581}
582
583char*
584tr_rpcGetUsername( const tr_rpc_server * server )
585{
586    return tr_strdup( server->username ? server->username : "" );
587}
588
589void
590tr_rpcSetPassword( tr_rpc_server * server,
591                   const char *    password )
592{
593    tr_free( server->password );
594    server->password = tr_strdup( password );
595    dbgmsg( "setting our Password to [%s]", server->password );
596}
597
598char*
599tr_rpcGetPassword( const tr_rpc_server * server )
600{
601    return tr_strdup( server->password ? server->password : "" );
602}
603
604void
605tr_rpcSetPasswordEnabled( tr_rpc_server * server,
606                          int             isEnabled )
607{
608    server->isPasswordEnabled = isEnabled != 0;
609    dbgmsg( "setting 'password enabled' to %d", isEnabled );
610}
611
612int
613tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
614{
615    return server->isPasswordEnabled;
616}
617
618/****
619*****  LIFE CYCLE
620****/
621
622static void
623closeServer( void * vserver )
624{
625    tr_rpc_server * s = vserver;
626
627    stopServer( s );
628    tr_free( s->whitelist );
629    tr_free( s->username );
630    tr_free( s->password );
631    tr_free( s );
632}
633
634void
635tr_rpcClose( tr_rpc_server ** ps )
636{
637    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
638    *ps = NULL;
639}
640
641tr_rpc_server *
642tr_rpcInit( tr_handle *  session,
643            int          isEnabled,
644            uint16_t     port,
645            int          isWhitelistEnabled,
646            const char * whitelist,
647            int          isPasswordEnabled,
648            const char * username,
649            const char * password )
650{
651    tr_rpc_server * s;
652
653    s = tr_new0( tr_rpc_server, 1 );
654    s->session = session;
655    s->port = port;
656    s->whitelist = tr_strdup( whitelist && *whitelist ? whitelist : TR_DEFAULT_RPC_WHITELIST );
657    s->username = tr_strdup( username );
658    s->password = tr_strdup( password );
659    s->isWhitelistEnabled = isWhitelistEnabled != 0;
660    s->isPasswordEnabled = isPasswordEnabled != 0;
661    s->isEnabled = isEnabled != 0;
662    if( isEnabled )
663        tr_runInEventThread( session, startServer, s );
664    return s;
665}
666
Note: See TracBrowser for help on using the repository browser.