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

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

(rpc) fix small bug introduced in the last commit.

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