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

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

(rpc) better fix for #1330

  • Property svn:keywords set to Date Rev Author Id
File size: 18.6 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 6867 2008-10-08 13:33:19Z 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        evbuffer_expand( out, content_len );
243        stream.next_out = EVBUFFER_DATA( out );
244        stream.avail_out = content_len;
245
246        state = deflate( &stream, Z_FINISH );
247        if( state != Z_STREAM_END )
248            evbuffer_add( out, content, content_len );
249        else {
250            EVBUFFER_LENGTH( out ) = content_len - stream.avail_out;
251            tr_ninf( MY_NAME, _( "Deflated response from %zu bytes to %zu" ),
252                              content_len,
253                              EVBUFFER_LENGTH( out ) );
254            evhttp_add_header( req->output_headers,
255                               "Content-Encoding", "deflate" );
256        }
257
258        deflateEnd( &stream );
259    }
260#endif
261}
262
263static void
264serve_file( struct evhttp_request * req,
265            const char *            filename )
266{
267    if( req->type != EVHTTP_REQ_GET )
268    {
269        evhttp_add_header( req->output_headers, "Allow", "GET" );
270        send_simple_response( req, 405, NULL );
271    }
272    else
273    {
274        size_t content_len;
275        uint8_t * content;
276        const int error = errno;
277
278        errno = 0;
279        content_len = 0;
280        content = tr_loadFile( filename, &content_len );
281
282        if( errno )
283        {
284            send_simple_response( req, HTTP_NOTFOUND, NULL );
285        }
286        else
287        {
288            struct evbuffer * out;
289
290            errno = error;
291            out = evbuffer_new( );
292            evhttp_add_header( req->output_headers, "Content-Type",
293                               mimetype_guess( filename ) );
294            add_response( req, out, content, content_len );
295            evhttp_send_reply( req, HTTP_OK, "OK", out );
296
297            evbuffer_free( out );
298            tr_free( content );
299        }
300    }
301}
302
303static void
304handle_clutch( struct evhttp_request * req,
305               struct tr_rpc_server *  server )
306{
307    const char * clutchDir = tr_getClutchDir( server->session );
308
309    assert( !strncmp( req->uri, "/transmission/web/", 18 ) );
310
311    if( !clutchDir || !*clutchDir )
312    {
313        send_simple_response( req, HTTP_NOTFOUND,
314            "<p>Couldn't find Transmission's web interface files!</p>"
315            "<p>Users: to tell Transmission where to look, "
316            "set the TRANSMISSION_WEB_HOME environmental "
317            "variable to the folder where the web interface's "
318            "index.html is located.</p>"
319            "<p>Package Builders: to set a custom default at compile time, "
320            "#define PACKAGE_DATA_DIR in libtransmission/platform.c "
321            "or tweak tr_getClutchDir() by hand.</p>" );
322    }
323    else
324    {
325        char * pch;
326        char * subpath;
327        char * filename;
328
329        subpath = tr_strdup( req->uri + 18 );
330        if(( pch = strchr( subpath, '?' )))
331            *pch = '\0';
332
333        filename = tr_strdup_printf( "%s%s%s",
334                       clutchDir,
335                       TR_PATH_DELIMITER_STR,
336                       subpath && *subpath ? subpath : ":index.html" );
337
338        serve_file( req, filename );
339
340        tr_free( filename );
341        tr_free( subpath );
342    }
343}
344
345static void
346handle_rpc( struct evhttp_request * req,
347            struct tr_rpc_server *  server )
348{
349    int               len = 0;
350    char *            out = NULL;
351    struct evbuffer * buf;
352
353    if( req->type == EVHTTP_REQ_GET )
354    {
355        const char * q;
356        if( ( q = strchr( req->uri, '?' ) ) )
357            out = tr_rpc_request_exec_uri( server->session,
358                                           q + 1,
359                                           strlen( q + 1 ),
360                                           &len );
361    }
362    else if( req->type == EVHTTP_REQ_POST )
363    {
364        out = tr_rpc_request_exec_json( server->session,
365                                        EVBUFFER_DATA( req->input_buffer ),
366                                        EVBUFFER_LENGTH( req->input_buffer ),
367                                        &len );
368    }
369
370    buf = evbuffer_new( );
371    add_response( req, buf, out, len );
372    evhttp_add_header( req->output_headers, "Content-Type",
373                       "application/json; charset=UTF-8" );
374    evhttp_send_reply( req, HTTP_OK, "OK", buf );
375
376    /* cleanup */
377    evbuffer_free( buf );
378    tr_free( out );
379}
380
381static int
382isAddressAllowed( const tr_rpc_server * server,
383                  const char *          address )
384{
385    const char * str;
386
387    if( !server->isWhitelistEnabled )
388        return 1;
389
390    for( str = server->whitelist; str && *str; )
391    {
392        const char * delimiter = strchr( str, ',' );
393        const int    len = delimiter ? delimiter - str : (int)strlen( str );
394        char *       token = tr_strndup( str, len );
395        const int    match = tr_wildmat( address, token );
396        tr_free( token );
397        if( match )
398            return 1;
399        if( !delimiter )
400            break;
401        str = delimiter + 1;
402    }
403
404    return 0;
405}
406
407static void
408handle_request( struct evhttp_request * req,
409                void *                  arg )
410{
411    struct tr_rpc_server * server = arg;
412
413    if( req && req->evcon )
414    {
415        const char * auth;
416        char *       user = NULL;
417        char *       pass = NULL;
418
419        evhttp_add_header( req->output_headers, "Server", MY_REALM );
420
421        auth = evhttp_find_header( req->input_headers, "Authorization" );
422
423        if( auth && !strncasecmp( auth, "basic ", 6 ) )
424        {
425            int    plen;
426            char * p = tr_base64_decode( auth + 6, 0, &plen );
427            if( p && plen && ( ( pass = strchr( p, ':' ) ) ) )
428            {
429                user = p;
430                *pass++ = '\0';
431            }
432        }
433
434        if( !isAddressAllowed( server, req->remote_host ) )
435        {
436            send_simple_response( req, 401, "Unauthorized IP Address" );
437        }
438        else if( server->isPasswordEnabled
439                 && ( !pass || !user || strcmp( server->username, user )
440                                     || strcmp( server->password, pass ) ) )
441        {
442            evhttp_add_header( req->output_headers,
443                               "WWW-Authenticate",
444                               "Basic realm=\"" MY_REALM "\"" );
445            send_simple_response( req, 401, "Unauthorized User" );
446        }
447        else if( !strcmp( req->uri, "/transmission/web" )
448               || !strcmp( req->uri, "/transmission/clutch" )
449               || !strcmp( req->uri, "/" ) )
450        {
451            evhttp_add_header( req->output_headers, "Location",
452                               "/transmission/web/" );
453            send_simple_response( req, HTTP_MOVEPERM, NULL );
454        }
455        else if( !strncmp( req->uri, "/transmission/web/", 18 ) )
456        {
457            handle_clutch( req, server );
458        }
459        else if( !strncmp( req->uri, "/transmission/rpc", 17 ) )
460        {
461            handle_rpc( req, server );
462        }
463        else if( !strncmp( req->uri, "/transmission/upload", 20 ) )
464        {
465            handle_upload( req, server );
466        }
467        else
468        {
469            send_simple_response( req, HTTP_NOTFOUND, NULL );
470        }
471
472        tr_free( user );
473    }
474}
475
476static void
477startServer( void * vserver )
478{
479    tr_rpc_server * server  = vserver;
480
481    if( !server->httpd )
482    {
483        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
484        evhttp_bind_socket( server->httpd, "0.0.0.0", server->port );
485        evhttp_set_gencb( server->httpd, handle_request, server );
486    }
487}
488
489static void
490stopServer( tr_rpc_server * server )
491{
492    if( server->httpd )
493    {
494        evhttp_free( server->httpd );
495        server->httpd = NULL;
496    }
497}
498
499static void
500onEnabledChanged( void * vserver )
501{
502    tr_rpc_server * server = vserver;
503
504    if( !server->isEnabled )
505        stopServer( server );
506    else
507        startServer( server );
508}
509
510void
511tr_rpcSetEnabled( tr_rpc_server * server,
512                  int             isEnabled )
513{
514    server->isEnabled = isEnabled != 0;
515
516    tr_runInEventThread( server->session, onEnabledChanged, server );
517}
518
519int
520tr_rpcIsEnabled( const tr_rpc_server * server )
521{
522    return server->isEnabled;
523}
524
525static void
526restartServer( void * vserver )
527{
528    tr_rpc_server * server = vserver;
529
530    if( server->isEnabled )
531    {
532        stopServer( server );
533        startServer( server );
534    }
535}
536
537void
538tr_rpcSetPort( tr_rpc_server * server,
539               uint16_t        port )
540{
541    if( server->port != port )
542    {
543        server->port = port;
544
545        if( server->isEnabled )
546            tr_runInEventThread( server->session, restartServer, server );
547    }
548}
549
550uint16_t
551tr_rpcGetPort( const tr_rpc_server * server )
552{
553    return server->port;
554}
555
556void
557tr_rpcSetWhitelist( tr_rpc_server * server,
558                    const char *    whitelist )
559{
560    tr_free( server->whitelist );
561    server->whitelist = tr_strdup( whitelist );
562}
563
564char*
565tr_rpcGetWhitelist( const tr_rpc_server * server )
566{
567    return tr_strdup( server->whitelist ? server->whitelist : "" );
568}
569
570void
571tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
572                           int              isEnabled )
573{
574    server->isWhitelistEnabled = isEnabled != 0;
575}
576
577int
578tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
579{
580    return server->isWhitelistEnabled;
581}
582
583/****
584*****  PASSWORD
585****/
586
587void
588tr_rpcSetUsername( tr_rpc_server * server,
589                   const char *    username )
590{
591    tr_free( server->username );
592    server->username = tr_strdup( username );
593    dbgmsg( "setting our Username to [%s]", server->username );
594}
595
596char*
597tr_rpcGetUsername( const tr_rpc_server * server )
598{
599    return tr_strdup( server->username ? server->username : "" );
600}
601
602void
603tr_rpcSetPassword( tr_rpc_server * server,
604                   const char *    password )
605{
606    tr_free( server->password );
607    server->password = tr_strdup( password );
608    dbgmsg( "setting our Password to [%s]", server->password );
609}
610
611char*
612tr_rpcGetPassword( const tr_rpc_server * server )
613{
614    return tr_strdup( server->password ? server->password : "" );
615}
616
617void
618tr_rpcSetPasswordEnabled( tr_rpc_server * server,
619                          int             isEnabled )
620{
621    server->isPasswordEnabled = isEnabled != 0;
622    dbgmsg( "setting 'password enabled' to %d", isEnabled );
623}
624
625int
626tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
627{
628    return server->isPasswordEnabled;
629}
630
631/****
632*****  LIFE CYCLE
633****/
634
635static void
636closeServer( void * vserver )
637{
638    tr_rpc_server * s = vserver;
639
640    stopServer( s );
641    tr_free( s->whitelist );
642    tr_free( s->username );
643    tr_free( s->password );
644    tr_free( s );
645}
646
647void
648tr_rpcClose( tr_rpc_server ** ps )
649{
650    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
651    *ps = NULL;
652}
653
654tr_rpc_server *
655tr_rpcInit( tr_handle *  session,
656            int          isEnabled,
657            uint16_t     port,
658            int          isWhitelistEnabled,
659            const char * whitelist,
660            int          isPasswordEnabled,
661            const char * username,
662            const char * password )
663{
664    tr_rpc_server * s;
665
666    s = tr_new0( tr_rpc_server, 1 );
667    s->session = session;
668    s->port = port;
669    s->whitelist = tr_strdup( whitelist && *whitelist
670                              ? whitelist
671                              : TR_DEFAULT_RPC_WHITELIST );
672    s->username = tr_strdup( username );
673    s->password = tr_strdup( password );
674    s->isWhitelistEnabled = isWhitelistEnabled != 0;
675    s->isPasswordEnabled = isPasswordEnabled != 0;
676    s->isEnabled = isEnabled != 0;
677    if( isEnabled )
678        tr_runInEventThread( session, startServer, s );
679    return s;
680}
Note: See TracBrowser for help on using the repository browser.