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

Last change on this file since 11116 was 11116, checked in by charles, 11 years ago

(trunk libT) #3486 "add gzip compression support to RPC server" -- fixed.

  • Property svn:keywords set to Date Rev Author Id
File size: 27.5 KB
Line 
1/*
2 * This file Copyright (C) 2008-2010 Mnemosyne LLC
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 11116 2010-08-04 20:57:08Z 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_ZLIB
24 #include <zlib.h>
25#endif
26
27#include <event.h>
28#include <evhttp.h>
29
30#include "transmission.h"
31#include "bencode.h"
32#include "crypto.h"
33#include "list.h"
34#include "net.h"
35#include "platform.h"
36#include "ptrarray.h"
37#include "rpcimpl.h"
38#include "rpc-server.h"
39#include "trevent.h"
40#include "utils.h"
41#include "web.h"
42
43/* session-id is used to make cross-site request forgery attacks difficult.
44 * Don't disable this feature unless you really know what you're doing!
45 * http://en.wikipedia.org/wiki/Cross-site_request_forgery
46 * http://shiflett.org/articles/cross-site-request-forgeries
47 * http://www.webappsec.org/lists/websecurity/archive/2008-04/msg00037.html */
48#define REQUIRE_SESSION_ID
49
50#define MY_NAME "RPC Server"
51#define MY_REALM "Transmission"
52#define TR_N_ELEMENTS( ary ) ( sizeof( ary ) / sizeof( *ary ) )
53
54#ifdef WIN32
55#define strncasecmp _strnicmp
56#endif
57
58struct tr_rpc_server
59{
60    tr_bool            isEnabled;
61    tr_bool            isPasswordEnabled;
62    tr_bool            isWhitelistEnabled;
63    tr_port            port;
64    struct in_addr     bindAddress;
65    struct evhttp *    httpd;
66    tr_session *       session;
67    char *             username;
68    char *             password;
69    char *             whitelistStr;
70    tr_list *          whitelist;
71
72    char *             sessionId;
73    time_t             sessionIdExpiresAt;
74
75#ifdef HAVE_ZLIB
76    tr_bool            isStreamInitialized;
77    z_stream           stream;
78#endif
79};
80
81#define dbgmsg( ... ) \
82    do { \
83        if( tr_deepLoggingIsActive( ) ) \
84            tr_deepLog( __FILE__, __LINE__, MY_NAME, __VA_ARGS__ ); \
85    } while( 0 )
86
87
88/***
89****
90***/
91
92static char*
93get_current_session_id( struct tr_rpc_server * server )
94{
95    const time_t now = tr_time( );
96
97    if( !server->sessionId || ( now >= server->sessionIdExpiresAt ) )
98    {
99        int i;
100        const int n = 48;
101        const char * pool = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
102        const size_t pool_size = strlen( pool );
103        char * buf = tr_new( char, n+1 );
104
105        for( i=0; i<n; ++i )
106            buf[i] = pool[ tr_cryptoRandInt( pool_size ) ];
107        buf[n] = '\0';
108
109        tr_free( server->sessionId );
110        server->sessionId = buf;
111        server->sessionIdExpiresAt = now + (60*60); /* expire in an hour */
112    }
113
114    return server->sessionId;
115}
116
117
118/**
119***
120**/
121
122static void
123send_simple_response( struct evhttp_request * req,
124                      int                     code,
125                      const char *            text )
126{
127    const char *      code_text = tr_webGetResponseStr( code );
128    struct evbuffer * body = evbuffer_new( );
129
130    evbuffer_add_printf( body, "<h1>%d: %s</h1>", code, code_text );
131    if( text )
132        evbuffer_add_printf( body, "%s", text );
133    evhttp_send_reply( req, code, code_text, body );
134
135    evbuffer_free( body );
136}
137
138struct tr_mimepart
139{
140    char * headers;
141    int headers_len;
142    char * body;
143    int body_len;
144};
145
146static void
147tr_mimepart_free( struct tr_mimepart * p )
148{
149    tr_free( p->body );
150    tr_free( p->headers );
151    tr_free( p );
152}
153
154static void
155extract_parts_from_multipart( const struct evkeyvalq * headers,
156                              const struct evbuffer * body,
157                              tr_ptrArray * setme_parts )
158{
159    const char * content_type = evhttp_find_header( headers, "Content-Type" );
160    const char * in = (const char*) EVBUFFER_DATA( body );
161    size_t inlen = EVBUFFER_LENGTH( body );
162
163    const char * boundary_key = "boundary=";
164    const char * boundary_key_begin = strstr( content_type, boundary_key );
165    const char * boundary_val = boundary_key_begin ? boundary_key_begin + strlen( boundary_key ) : "arglebargle";
166    char * boundary = tr_strdup_printf( "--%s", boundary_val );
167    const size_t boundary_len = strlen( boundary );
168
169    const char * delim = tr_memmem( in, inlen, boundary, boundary_len );
170    while( delim )
171    {
172        size_t part_len;
173        const char * part = delim + boundary_len;
174
175        inlen -= ( part - in );
176        in = part;
177
178        delim = tr_memmem( in, inlen, boundary, boundary_len );
179        part_len = delim ? (size_t)( delim - part ) : inlen;
180
181        if( part_len )
182        {
183            const char * rnrn = tr_memmem( part, part_len, "\r\n\r\n", 4 );
184            if( rnrn )
185            {
186                struct tr_mimepart * p = tr_new( struct tr_mimepart, 1 );
187                p->headers_len = rnrn - part;
188                p->headers = tr_strndup( part, p->headers_len );
189                p->body_len = (part+part_len) - (rnrn + 4);
190                p->body = tr_strndup( rnrn+4, p->body_len );
191                tr_ptrArrayAppend( setme_parts, p );
192            }
193        }
194    }
195
196    tr_free( boundary );
197}
198
199static void
200handle_upload( struct evhttp_request * req,
201               struct tr_rpc_server *  server )
202{
203    if( req->type != EVHTTP_REQ_POST )
204    {
205        send_simple_response( req, 405, NULL );
206    }
207    else
208    {
209        int i;
210        int n;
211        tr_bool hasSessionId = FALSE;
212        tr_ptrArray parts = TR_PTR_ARRAY_INIT;
213
214        const char * query = strchr( req->uri, '?' );
215        const tr_bool paused = query && strstr( query + 1, "paused=true" );
216
217        extract_parts_from_multipart( req->input_headers, req->input_buffer, &parts );
218        n = tr_ptrArraySize( &parts );
219
220        /* first look for the session id */
221        for( i=0; i<n; ++i ) {
222            struct tr_mimepart * p = tr_ptrArrayNth( &parts, i );
223            if( tr_memmem( p->headers, p->headers_len, TR_RPC_SESSION_ID_HEADER, strlen( TR_RPC_SESSION_ID_HEADER ) ) )
224                break;
225        }
226        if( i<n ) {
227            const struct tr_mimepart * p = tr_ptrArrayNth( &parts, i );
228            const char * ours = get_current_session_id( server );
229            const int ourlen = strlen( ours );
230            hasSessionId = ourlen<=p->body_len && !memcmp( p->body, ours, ourlen );
231        }
232
233        if( !hasSessionId )
234        {
235            send_simple_response( req, 409, NULL );
236        }
237        else for( i=0; i<n; ++i )
238        {
239            struct tr_mimepart * p = tr_ptrArrayNth( &parts, i );
240            if( strstr( p->headers, "filename=\"" ) )
241            {
242                char * b64;
243                int body_len = p->body_len;
244                tr_benc top, *args;
245                const char * body = p->body;
246                struct evbuffer * json = evbuffer_new( );
247
248                if( body_len >= 2 && !memcmp( &body[body_len - 2], "\r\n", 2 ) )
249                    body_len -= 2;
250
251                tr_bencInitDict( &top, 2 );
252                args = tr_bencDictAddDict( &top, "arguments", 2 );
253                tr_bencDictAddStr( &top, "method", "torrent-add" );
254                b64 = tr_base64_encode( body, body_len, NULL );
255                tr_bencDictAddStr( args, "metainfo", b64 );
256                tr_bencDictAddBool( args, "paused", paused );
257                tr_bencToBuf( &top, TR_FMT_JSON_LEAN, json );
258                tr_rpc_request_exec_json( server->session,
259                                          EVBUFFER_DATA( json ),
260                                          EVBUFFER_LENGTH( json ),
261                                          NULL, NULL );
262
263                evbuffer_free( json );
264                tr_free( b64 );
265                tr_bencFree( &top );
266            }
267        }
268
269        tr_ptrArrayDestruct( &parts, (PtrArrayForeachFunc)tr_mimepart_free );
270
271        /* use xml here because json responses to file uploads is trouble.
272         * see http://www.malsup.com/jquery/form/#sample7 for details */
273        evhttp_add_header( req->output_headers, "Content-Type",
274                           "text/xml; charset=UTF-8" );
275        send_simple_response( req, HTTP_OK, NULL );
276    }
277}
278
279static const char*
280mimetype_guess( const char * path )
281{
282    unsigned int i;
283
284    const struct
285    {
286        const char *    suffix;
287        const char *    mime_type;
288    } types[] = {
289        /* these are the ones we need for serving the web client's files... */
290        { "css",  "text/css"                  },
291        { "gif",  "image/gif"                 },
292        { "html", "text/html"                 },
293        { "ico",  "image/vnd.microsoft.icon"  },
294        { "js",   "application/javascript"    },
295        { "png",  "image/png"                 }
296    };
297    const char * dot = strrchr( path, '.' );
298
299    for( i = 0; dot && i < TR_N_ELEMENTS( types ); ++i )
300        if( !strcmp( dot + 1, types[i].suffix ) )
301            return types[i].mime_type;
302
303    return "application/octet-stream";
304}
305
306static void
307add_response( struct evhttp_request * req,
308              struct tr_rpc_server *  server,
309              struct evbuffer *       out,
310              const void *            content,
311              size_t                  content_len )
312{
313#ifndef HAVE_ZLIB
314    evbuffer_add( out, content, content_len );
315#else
316    const char * key = "Accept-Encoding";
317    const char * encoding = evhttp_find_header( req->input_headers, key );
318    const int do_compress = encoding && strstr( encoding, "gzip" );
319
320    if( !do_compress )
321    {
322        evbuffer_add( out, content, content_len );
323    }
324    else
325    {
326        int state;
327
328        /* FIXME(libevent2): this won't compile under libevent2.
329           but we can use evbuffer_reserve_space() + evbuffer_commit_space() instead */
330
331        if( !server->isStreamInitialized )
332        {
333            server->isStreamInitialized = TRUE;
334            server->stream.zalloc = (alloc_func) Z_NULL;
335            server->stream.zfree = (free_func) Z_NULL;
336            server->stream.opaque = (voidpf) Z_NULL;
337            server->stream.data_type = Z_ASCII;
338
339            /* zlib's manual says: "Add 16 to windowBits to write a simple gzip header
340             * and trailer around the compressed data instead of a zlib wrapper." */
341            deflateInit2( &server->stream, Z_BEST_COMPRESSION, Z_DEFLATED, 15+16, 9, Z_DEFAULT_STRATEGY );
342        }
343
344        server->stream.next_in = (Bytef*) content;
345        server->stream.avail_in = content_len;
346
347        /* allocate space for the raw data and call deflate() just once --
348         * we won't use the deflated data if it's longer than the raw data,
349         * so it's okay to let deflate() run out of output buffer space */
350        evbuffer_expand( out, content_len );
351        server->stream.next_out = EVBUFFER_DATA( out );
352        server->stream.avail_out = content_len;
353
354        state = deflate( &server->stream, Z_FINISH );
355
356        if( state == Z_STREAM_END )
357        {
358            EVBUFFER_LENGTH( out ) = content_len - server->stream.avail_out;
359
360#if 0
361            fprintf( stderr, "compressed response is %.2f of original (raw==%zu bytes; compressed==%zu)\n",
362                             (double)EVBUFFER_LENGTH(out)/content_len,
363                             content_len, EVBUFFER_LENGTH(out) );
364#endif
365            evhttp_add_header( req->output_headers,
366                               "Content-Encoding", "gzip" );
367        }
368        else
369        {
370            evbuffer_drain( out, EVBUFFER_LENGTH( out ) );
371            evbuffer_add( out, content, content_len );
372        }
373
374        deflateReset( &server->stream );
375    }
376#endif
377}
378
379static void
380add_time_header( struct evkeyvalq * headers, const char * key, time_t value )
381{
382    /* According to RFC 2616 this must follow RFC 1123's date format,
383       so use gmtime instead of localtime... */
384    char buf[128];
385    struct tm tm = *gmtime( &value );
386    strftime( buf, sizeof( buf ), "%a, %d %b %Y %H:%M:%S GMT", &tm );
387    evhttp_add_header( headers, key, buf );
388}
389
390static void
391serve_file( struct evhttp_request * req,
392            struct tr_rpc_server *  server,
393            const char *            filename )
394{
395    if( req->type != EVHTTP_REQ_GET )
396    {
397        evhttp_add_header( req->output_headers, "Allow", "GET" );
398        send_simple_response( req, 405, NULL );
399    }
400    else
401    {
402        size_t content_len;
403        uint8_t * content;
404        const int error = errno;
405
406        errno = 0;
407        content_len = 0;
408        content = tr_loadFile( filename, &content_len );
409
410        if( errno )
411        {
412            char * tmp = tr_strdup_printf( "%s (%s)", filename, tr_strerror( errno ) );
413            send_simple_response( req, HTTP_NOTFOUND, tmp );
414            tr_free( tmp );
415        }
416        else
417        {
418            struct evbuffer * out;
419            const time_t now = tr_time( );
420
421            errno = error;
422            out = evbuffer_new( );
423            evhttp_add_header( req->output_headers, "Content-Type", mimetype_guess( filename ) );
424            add_time_header( req->output_headers, "Date", now );
425            add_time_header( req->output_headers, "Expires", now+(24*60*60) );
426            add_response( req, server, out, content, content_len );
427            evhttp_send_reply( req, HTTP_OK, "OK", out );
428
429            evbuffer_free( out );
430            tr_free( content );
431        }
432    }
433}
434
435static void
436handle_web_client( struct evhttp_request * req,
437                   struct tr_rpc_server *  server )
438{
439    const char * webClientDir = tr_getWebClientDir( server->session );
440
441    assert( !strncmp( req->uri, "/transmission/web/", 18 ) );
442
443    if( !webClientDir || !*webClientDir )
444    {
445        send_simple_response( req, HTTP_NOTFOUND,
446            "<p>Couldn't find Transmission's web interface files!</p>"
447            "<p>Users: to tell Transmission where to look, "
448            "set the TRANSMISSION_WEB_HOME environment "
449            "variable to the folder where the web interface's "
450            "index.html is located.</p>"
451            "<p>Package Builders: to set a custom default at compile time, "
452            "#define PACKAGE_DATA_DIR in libtransmission/platform.c "
453            "or tweak tr_getClutchDir() by hand.</p>" );
454    }
455    else
456    {
457        char * pch;
458        char * subpath;
459
460        subpath = tr_strdup( req->uri + 18 );
461        if(( pch = strchr( subpath, '?' )))
462            *pch = '\0';
463
464        if( strstr( subpath, ".." ) )
465        {
466            send_simple_response( req, HTTP_NOTFOUND, "<p>Tsk, tsk.</p>" );
467        }
468        else
469        {
470            char * filename = tr_strdup_printf( "%s%s%s",
471                                 webClientDir,
472                                 TR_PATH_DELIMITER_STR,
473                                 subpath && *subpath ? subpath : "index.html" );
474            serve_file( req, server, filename );
475            tr_free( filename );
476        }
477
478        tr_free( subpath );
479    }
480}
481
482struct rpc_response_data
483{
484    struct evhttp_request * req;
485    struct tr_rpc_server  * server;
486};
487
488/* FIXME(libevent2): make "response" an evbuffer and remove response_len */
489static void
490rpc_response_func( tr_session      * session UNUSED,
491                   const char      * response,
492                   size_t            response_len,
493                   void            * user_data )
494{
495    struct rpc_response_data * data = user_data;
496    struct evbuffer * buf = evbuffer_new( );
497
498    add_response( data->req, data->server, buf, response, response_len );
499    evhttp_add_header( data->req->output_headers,
500                           "Content-Type", "application/json; charset=UTF-8" );
501    evhttp_send_reply( data->req, HTTP_OK, "OK", buf );
502
503    evbuffer_free( buf );
504    tr_free( data );
505}
506
507
508static void
509handle_rpc( struct evhttp_request * req,
510            struct tr_rpc_server  * server )
511{
512    struct rpc_response_data * data = tr_new0( struct rpc_response_data, 1 );
513
514    data->req = req;
515    data->server = server;
516
517    if( req->type == EVHTTP_REQ_GET )
518    {
519        const char * q;
520        if( ( q = strchr( req->uri, '?' ) ) )
521            tr_rpc_request_exec_uri( server->session, q+1, -1, rpc_response_func, data );
522    }
523    else if( req->type == EVHTTP_REQ_POST )
524    {
525        tr_rpc_request_exec_json( server->session,
526                                  EVBUFFER_DATA( req->input_buffer ),
527                                  EVBUFFER_LENGTH( req->input_buffer ),
528                                  rpc_response_func, data );
529    }
530
531}
532
533static tr_bool
534isAddressAllowed( const tr_rpc_server * server,
535                  const char *          address )
536{
537    tr_list * l;
538
539    if( !server->isWhitelistEnabled )
540        return TRUE;
541
542    for( l=server->whitelist; l!=NULL; l=l->next )
543        if( tr_wildmat( address, l->data ) )
544            return TRUE;
545
546    return FALSE;
547}
548
549static tr_bool
550test_session_id( struct tr_rpc_server * server, struct evhttp_request * req )
551{
552    const char * ours = get_current_session_id( server );
553    const char * theirs = evhttp_find_header( req->input_headers, TR_RPC_SESSION_ID_HEADER );
554    const tr_bool success =  theirs && !strcmp( theirs, ours );
555    return success;
556}
557
558static void
559handle_request( struct evhttp_request * req, void * arg )
560{
561    struct tr_rpc_server * server = arg;
562
563    if( req && req->evcon )
564    {
565        const char * auth;
566        char * user = NULL;
567        char * pass = NULL;
568
569        evhttp_add_header( req->output_headers, "Server", MY_REALM );
570
571        auth = evhttp_find_header( req->input_headers, "Authorization" );
572        if( auth && !strncasecmp( auth, "basic ", 6 ) )
573        {
574            int    plen;
575            char * p = tr_base64_decode( auth + 6, 0, &plen );
576            if( p && plen && ( ( pass = strchr( p, ':' ) ) ) )
577            {
578                user = p;
579                *pass++ = '\0';
580            }
581        }
582
583        if( !isAddressAllowed( server, req->remote_host ) )
584        {
585            send_simple_response( req, 403,
586                "<p>Unauthorized IP Address.</p>"
587                "<p>Either disable the IP address whitelist or add your address to it.</p>"
588                "<p>If you're editing settings.json, see the 'rpc-whitelist' and 'rpc-whitelist-enabled' entries.</p>"
589                "<p>If you're still using ACLs, use a whitelist instead.  See the transmission-daemon manpage for details.</p>" );
590        }
591        else if( server->isPasswordEnabled
592                 && ( !pass || !user || strcmp( server->username, user )
593                                     || !tr_ssha1_matches( server->password,
594                                                           pass ) ) )
595        {
596            evhttp_add_header( req->output_headers,
597                               "WWW-Authenticate",
598                               "Basic realm=\"" MY_REALM "\"" );
599            send_simple_response( req, 401, "Unauthorized User" );
600        }
601        else if( !strcmp( req->uri, "/transmission/web" )
602               || !strcmp( req->uri, "/transmission/clutch" )
603               || !strcmp( req->uri, "/" ) )
604        {
605            evhttp_add_header( req->output_headers, "Location", "/transmission/web/" );
606            send_simple_response( req, HTTP_MOVEPERM, NULL );
607        }
608        else if( !strncmp( req->uri, "/transmission/web/", 18 ) )
609        {
610            handle_web_client( req, server );
611        }
612        else if( !strncmp( req->uri, "/transmission/upload", 20 ) )
613        {
614            handle_upload( req, server );
615        }
616#ifdef REQUIRE_SESSION_ID
617        else if( !test_session_id( server, req ) )
618        {
619            const char * sessionId = get_current_session_id( server );
620            char * tmp = tr_strdup_printf(
621                "<p>Your request had an invalid session-id header.</p>"
622                "<p>To fix this, follow these steps:"
623                "<ol><li> When reading a response, get its X-Transmission-Session-Id header and remember it"
624                "<li> Add the updated header to your outgoing requests"
625                "<li> When you get this 409 error message, resend your request with the updated header"
626                "</ol></p>"
627                "<p>This requirement has been added to help prevent "
628                "<a href=\"http://en.wikipedia.org/wiki/Cross-site_request_forgery\">CSRF</a> "
629                "attacks.</p>"
630                "<p><code>%s: %s</code></p>",
631                TR_RPC_SESSION_ID_HEADER, sessionId );
632            evhttp_add_header( req->output_headers, TR_RPC_SESSION_ID_HEADER, sessionId );
633            send_simple_response( req, 409, tmp );
634            tr_free( tmp );
635        }
636#endif
637        else if( !strncmp( req->uri, "/transmission/rpc", 17 ) )
638        {
639            handle_rpc( req, server );
640        }
641        else
642        {
643            send_simple_response( req, HTTP_NOTFOUND, req->uri );
644        }
645
646        tr_free( user );
647    }
648}
649
650static void
651startServer( void * vserver )
652{
653    tr_rpc_server * server  = vserver;
654    tr_address addr;
655
656    if( !server->httpd )
657    {
658        addr.type = TR_AF_INET;
659        addr.addr.addr4 = server->bindAddress;
660        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
661        evhttp_bind_socket( server->httpd, tr_ntop_non_ts( &addr ),
662                            server->port );
663        evhttp_set_gencb( server->httpd, handle_request, server );
664
665    }
666}
667
668static void
669stopServer( tr_rpc_server * server )
670{
671    if( server->httpd )
672    {
673        evhttp_free( server->httpd );
674        server->httpd = NULL;
675    }
676}
677
678static void
679onEnabledChanged( void * vserver )
680{
681    tr_rpc_server * server = vserver;
682
683    if( !server->isEnabled )
684        stopServer( server );
685    else
686        startServer( server );
687}
688
689void
690tr_rpcSetEnabled( tr_rpc_server * server,
691                  tr_bool         isEnabled )
692{
693    server->isEnabled = isEnabled;
694
695    tr_runInEventThread( server->session, onEnabledChanged, server );
696}
697
698tr_bool
699tr_rpcIsEnabled( const tr_rpc_server * server )
700{
701    return server->isEnabled;
702}
703
704static void
705restartServer( void * vserver )
706{
707    tr_rpc_server * server = vserver;
708
709    if( server->isEnabled )
710    {
711        stopServer( server );
712        startServer( server );
713    }
714}
715
716void
717tr_rpcSetPort( tr_rpc_server * server,
718               tr_port         port )
719{
720    assert( server != NULL );
721
722    if( server->port != port )
723    {
724        server->port = port;
725
726        if( server->isEnabled )
727            tr_runInEventThread( server->session, restartServer, server );
728    }
729}
730
731tr_port
732tr_rpcGetPort( const tr_rpc_server * server )
733{
734    return server->port;
735}
736
737void
738tr_rpcSetWhitelist( tr_rpc_server * server,
739                    const char    * whitelistStr )
740{
741    void * tmp;
742    const char * walk;
743
744    /* keep the string */
745    tr_free( server->whitelistStr );
746    server->whitelistStr = tr_strdup( whitelistStr );
747
748    /* clear out the old whitelist entries */
749    while(( tmp = tr_list_pop_front( &server->whitelist )))
750        tr_free( tmp );
751
752    /* build the new whitelist entries */
753    for( walk=whitelistStr; walk && *walk; ) {
754        const char * delimiters = " ,;";
755        const size_t len = strcspn( walk, delimiters );
756        char * token = tr_strndup( walk, len );
757        tr_list_append( &server->whitelist, token );
758        if( strcspn( token, "+-" ) < len )
759            tr_ninf( MY_NAME, "Adding address to whitelist: %s (And it has a '+' or '-'!  Are you using an old ACL by mistake?)", token );
760        else
761            tr_ninf( MY_NAME, "Adding address to whitelist: %s", token );
762
763        if( walk[len]=='\0' )
764            break;
765        walk += len + 1;
766    }
767}
768
769const char*
770tr_rpcGetWhitelist( const tr_rpc_server * server )
771{
772    return server->whitelistStr ? server->whitelistStr : "";
773}
774
775void
776tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
777                           tr_bool          isEnabled )
778{
779    server->isWhitelistEnabled = isEnabled != 0;
780}
781
782tr_bool
783tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
784{
785    return server->isWhitelistEnabled;
786}
787
788/****
789*****  PASSWORD
790****/
791
792void
793tr_rpcSetUsername( tr_rpc_server * server,
794                   const char *    username )
795{
796    tr_free( server->username );
797    server->username = tr_strdup( username );
798    dbgmsg( "setting our Username to [%s]", server->username );
799}
800
801const char*
802tr_rpcGetUsername( const tr_rpc_server * server )
803{
804    return server->username ? server->username : "";
805}
806
807void
808tr_rpcSetPassword( tr_rpc_server * server,
809                   const char *    password )
810{
811    tr_free( server->password );
812    if( *password != '{' )
813        server->password = tr_ssha1( password );
814    else
815        server->password = strdup( password );
816    dbgmsg( "setting our Password to [%s]", server->password );
817}
818
819const char*
820tr_rpcGetPassword( const tr_rpc_server * server )
821{
822    return server->password ? server->password : "" ;
823}
824
825void
826tr_rpcSetPasswordEnabled( tr_rpc_server * server,
827                          tr_bool          isEnabled )
828{
829    server->isPasswordEnabled = isEnabled;
830    dbgmsg( "setting 'password enabled' to %d", (int)isEnabled );
831}
832
833tr_bool
834tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
835{
836    return server->isPasswordEnabled;
837}
838
839const char *
840tr_rpcGetBindAddress( const tr_rpc_server * server )
841{
842    tr_address addr;
843    addr.type = TR_AF_INET;
844    addr.addr.addr4 = server->bindAddress;
845    return tr_ntop_non_ts( &addr );
846}
847
848/****
849*****  LIFE CYCLE
850****/
851
852static void
853closeServer( void * vserver )
854{
855    void * tmp;
856    tr_rpc_server * s = vserver;
857
858    stopServer( s );
859    while(( tmp = tr_list_pop_front( &s->whitelist )))
860        tr_free( tmp );
861#ifdef HAVE_ZLIB
862    if( s->isStreamInitialized )
863        deflateEnd( &s->stream );
864#endif
865    tr_free( s->sessionId );
866    tr_free( s->whitelistStr );
867    tr_free( s->username );
868    tr_free( s->password );
869    tr_free( s );
870}
871
872void
873tr_rpcClose( tr_rpc_server ** ps )
874{
875    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
876    *ps = NULL;
877}
878
879tr_rpc_server *
880tr_rpcInit( tr_session  * session, tr_benc * settings )
881{
882    tr_rpc_server * s;
883    tr_bool found;
884    tr_bool boolVal;
885    int64_t i;
886    const char *str;
887    tr_address address;
888
889    s = tr_new0( tr_rpc_server, 1 );
890    s->session = session;
891
892    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_ENABLED, &boolVal );
893    assert( found );
894    s->isEnabled = boolVal;
895
896    found = tr_bencDictFindInt( settings, TR_PREFS_KEY_RPC_PORT, &i );
897    assert( found );
898    s->port = i;
899
900    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, &boolVal );
901    assert( found );
902    tr_rpcSetWhitelistEnabled( s, boolVal );
903
904    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, &boolVal );
905    assert( found );
906    tr_rpcSetPasswordEnabled( s, boolVal );
907
908    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_WHITELIST, &str );
909    assert( found );
910    tr_rpcSetWhitelist( s, str ? str : "127.0.0.1" );
911
912    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_USERNAME, &str );
913    assert( found );
914    tr_rpcSetUsername( s, str );
915
916    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_PASSWORD, &str );
917    assert( found );
918    tr_rpcSetPassword( s, str );
919
920    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_BIND_ADDRESS, &str );
921    assert( found );
922    if( tr_pton( str, &address ) == NULL ) {
923        tr_err( _( "%s is not a valid address" ), str );
924        address = tr_inaddr_any;
925    } else if( address.type != TR_AF_INET ) {
926        tr_err( _( "%s is not an IPv4 address. RPC listeners must be IPv4" ),
927                   str );
928        address = tr_inaddr_any;
929    }
930    s->bindAddress = address.addr.addr4;
931
932    if( s->isEnabled )
933    {
934        tr_ninf( MY_NAME, _( "Serving RPC and Web requests on port %d" ), (int) s->port );
935        tr_runInEventThread( session, startServer, s );
936
937        if( s->isWhitelistEnabled )
938            tr_ninf( MY_NAME, "%s", _( "Whitelist enabled" ) );
939
940        if( s->isPasswordEnabled )
941            tr_ninf( MY_NAME, "%s", _( "Password required" ) );
942    }
943
944    return s;
945}
Note: See TracBrowser for help on using the repository browser.