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

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

(trunk libT) handle URLs, as well as filenames, via the rpc server's /transmission/upload mechanism

  • Property svn:keywords set to Date Rev Author Id
File size: 28.3 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 11183 2010-08-21 12:50:13Z 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            int code = 409;
236            const char * codetext = tr_webGetResponseStr( code );
237            struct evbuffer * body = evbuffer_new( );
238            evbuffer_add_printf( body, "%s", "{ \"success\": false, \"msg\": \"Bad Session-Id\" }" );;
239            evhttp_send_reply( req, code, codetext, body );
240            evbuffer_free( body );
241        }
242        else for( i=0; i<n; ++i )
243        {
244            struct tr_mimepart * p = tr_ptrArrayNth( &parts, i );
245            int body_len = p->body_len;
246            tr_benc top, *args;
247            tr_benc test;
248            tr_bool have_source = FALSE;
249            char * body = p->body;
250
251            if( body_len >= 2 && !memcmp( &body[body_len - 2], "\r\n", 2 ) )
252                body_len -= 2;
253
254            tr_bencInitDict( &top, 2 );
255            tr_bencDictAddStr( &top, "method", "torrent-add" );
256            args = tr_bencDictAddDict( &top, "arguments", 2 );
257            tr_bencDictAddBool( args, "paused", paused );
258
259            if( tr_urlIsValid( body, body_len ) )
260            {
261                tr_bencDictAddRaw( args, "filename", body, body_len );
262                have_source = TRUE;
263            }
264            else if( !tr_bencLoad( body, body_len, &test, NULL ) )
265            {
266                char * b64 = tr_base64_encode( body, body_len, NULL );
267                tr_bencDictAddStr( args, "metainfo", b64 );
268                tr_free( b64 );
269                have_source = TRUE;
270            }
271
272            if( have_source )
273            {
274                struct evbuffer * json = evbuffer_new( );
275                tr_bencToBuf( &top, TR_FMT_JSON, json );
276                tr_rpc_request_exec_json( server->session,
277                                          EVBUFFER_DATA( json ),
278                                          EVBUFFER_LENGTH( json ),
279                                          NULL, NULL );
280                evbuffer_free( json );
281            }
282
283            tr_bencFree( &top );
284        }
285
286        tr_ptrArrayDestruct( &parts, (PtrArrayForeachFunc)tr_mimepart_free );
287
288        /* send "success" response */
289        {
290            int code = HTTP_OK;
291            const char * codetext = tr_webGetResponseStr( code );
292            struct evbuffer * body = evbuffer_new( );
293            evbuffer_add_printf( body, "%s", "{ \"success\": true, \"msg\": \"Torrent Added\" }" );;
294            evhttp_send_reply( req, code, codetext, body );
295            evbuffer_free( body );
296        }
297    }
298}
299
300static const char*
301mimetype_guess( const char * path )
302{
303    unsigned int i;
304
305    const struct
306    {
307        const char *    suffix;
308        const char *    mime_type;
309    } types[] = {
310        /* these are the ones we need for serving the web client's files... */
311        { "css",  "text/css"                  },
312        { "gif",  "image/gif"                 },
313        { "html", "text/html"                 },
314        { "ico",  "image/vnd.microsoft.icon"  },
315        { "js",   "application/javascript"    },
316        { "png",  "image/png"                 }
317    };
318    const char * dot = strrchr( path, '.' );
319
320    for( i = 0; dot && i < TR_N_ELEMENTS( types ); ++i )
321        if( !strcmp( dot + 1, types[i].suffix ) )
322            return types[i].mime_type;
323
324    return "application/octet-stream";
325}
326
327static void
328add_response( struct evhttp_request * req,
329              struct tr_rpc_server *  server,
330              struct evbuffer *       out,
331              const void *            content,
332              size_t                  content_len )
333{
334#ifndef HAVE_ZLIB
335    evbuffer_add( out, content, content_len );
336#else
337    const char * key = "Accept-Encoding";
338    const char * encoding = evhttp_find_header( req->input_headers, key );
339    const int do_compress = encoding && strstr( encoding, "gzip" );
340
341    if( !do_compress )
342    {
343        evbuffer_add( out, content, content_len );
344    }
345    else
346    {
347        int state;
348
349        /* FIXME(libevent2): this won't compile under libevent2.
350           but we can use evbuffer_reserve_space() + evbuffer_commit_space() instead */
351
352        if( !server->isStreamInitialized )
353        {
354            int compressionLevel;
355
356            server->isStreamInitialized = TRUE;
357            server->stream.zalloc = (alloc_func) Z_NULL;
358            server->stream.zfree = (free_func) Z_NULL;
359            server->stream.opaque = (voidpf) Z_NULL;
360
361            /* zlib's manual says: "Add 16 to windowBits to write a simple gzip header
362             * and trailer around the compressed data instead of a zlib wrapper." */
363#ifdef TR_EMBEDDED
364            compressionLevel = Z_DEFAULT_COMPRESSION;
365#else
366            compressionLevel = Z_BEST_COMPRESSION;
367#endif
368            deflateInit2( &server->stream, compressionLevel, Z_DEFLATED, 15+16, 8, Z_DEFAULT_STRATEGY );
369        }
370
371        server->stream.next_in = (Bytef*) content;
372        server->stream.avail_in = content_len;
373
374        /* allocate space for the raw data and call deflate() just once --
375         * we won't use the deflated data if it's longer than the raw data,
376         * so it's okay to let deflate() run out of output buffer space */
377        evbuffer_expand( out, content_len );
378        server->stream.next_out = EVBUFFER_DATA( out );
379        server->stream.avail_out = content_len;
380
381        state = deflate( &server->stream, Z_FINISH );
382
383        if( state == Z_STREAM_END )
384        {
385            EVBUFFER_LENGTH( out ) = content_len - server->stream.avail_out;
386
387#if 0
388            fprintf( stderr, "compressed response is %.2f of original (raw==%zu bytes; compressed==%zu)\n",
389                             (double)EVBUFFER_LENGTH(out)/content_len,
390                             content_len, EVBUFFER_LENGTH(out) );
391#endif
392            evhttp_add_header( req->output_headers,
393                               "Content-Encoding", "gzip" );
394        }
395        else
396        {
397            evbuffer_drain( out, EVBUFFER_LENGTH( out ) );
398            evbuffer_add( out, content, content_len );
399        }
400
401        deflateReset( &server->stream );
402    }
403#endif
404}
405
406static void
407add_time_header( struct evkeyvalq * headers, const char * key, time_t value )
408{
409    /* According to RFC 2616 this must follow RFC 1123's date format,
410       so use gmtime instead of localtime... */
411    char buf[128];
412    struct tm tm = *gmtime( &value );
413    strftime( buf, sizeof( buf ), "%a, %d %b %Y %H:%M:%S GMT", &tm );
414    evhttp_add_header( headers, key, buf );
415}
416
417static void
418serve_file( struct evhttp_request * req,
419            struct tr_rpc_server *  server,
420            const char *            filename )
421{
422    if( req->type != EVHTTP_REQ_GET )
423    {
424        evhttp_add_header( req->output_headers, "Allow", "GET" );
425        send_simple_response( req, 405, NULL );
426    }
427    else
428    {
429        size_t content_len;
430        uint8_t * content;
431        const int error = errno;
432
433        errno = 0;
434        content_len = 0;
435        content = tr_loadFile( filename, &content_len );
436
437        if( errno )
438        {
439            char * tmp = tr_strdup_printf( "%s (%s)", filename, tr_strerror( errno ) );
440            send_simple_response( req, HTTP_NOTFOUND, tmp );
441            tr_free( tmp );
442        }
443        else
444        {
445            struct evbuffer * out;
446            const time_t now = tr_time( );
447
448            errno = error;
449            out = evbuffer_new( );
450            evhttp_add_header( req->output_headers, "Content-Type", mimetype_guess( filename ) );
451            add_time_header( req->output_headers, "Date", now );
452            add_time_header( req->output_headers, "Expires", now+(24*60*60) );
453            add_response( req, server, out, content, content_len );
454            evhttp_send_reply( req, HTTP_OK, "OK", out );
455
456            evbuffer_free( out );
457            tr_free( content );
458        }
459    }
460}
461
462static void
463handle_web_client( struct evhttp_request * req,
464                   struct tr_rpc_server *  server )
465{
466    const char * webClientDir = tr_getWebClientDir( server->session );
467
468    assert( !strncmp( req->uri, "/transmission/web/", 18 ) );
469
470    if( !webClientDir || !*webClientDir )
471    {
472        send_simple_response( req, HTTP_NOTFOUND,
473            "<p>Couldn't find Transmission's web interface files!</p>"
474            "<p>Users: to tell Transmission where to look, "
475            "set the TRANSMISSION_WEB_HOME environment "
476            "variable to the folder where the web interface's "
477            "index.html is located.</p>"
478            "<p>Package Builders: to set a custom default at compile time, "
479            "#define PACKAGE_DATA_DIR in libtransmission/platform.c "
480            "or tweak tr_getClutchDir() by hand.</p>" );
481    }
482    else
483    {
484        char * pch;
485        char * subpath;
486
487        subpath = tr_strdup( req->uri + 18 );
488        if(( pch = strchr( subpath, '?' )))
489            *pch = '\0';
490
491        if( strstr( subpath, ".." ) )
492        {
493            send_simple_response( req, HTTP_NOTFOUND, "<p>Tsk, tsk.</p>" );
494        }
495        else
496        {
497            char * filename = tr_strdup_printf( "%s%s%s",
498                                 webClientDir,
499                                 TR_PATH_DELIMITER_STR,
500                                 subpath && *subpath ? subpath : "index.html" );
501            serve_file( req, server, filename );
502            tr_free( filename );
503        }
504
505        tr_free( subpath );
506    }
507}
508
509struct rpc_response_data
510{
511    struct evhttp_request * req;
512    struct tr_rpc_server  * server;
513};
514
515/* FIXME(libevent2): make "response" an evbuffer and remove response_len */
516static void
517rpc_response_func( tr_session      * session UNUSED,
518                   const char      * response,
519                   size_t            response_len,
520                   void            * user_data )
521{
522    struct rpc_response_data * data = user_data;
523    struct evbuffer * buf = evbuffer_new( );
524
525    add_response( data->req, data->server, buf, response, response_len );
526    evhttp_add_header( data->req->output_headers,
527                           "Content-Type", "application/json; charset=UTF-8" );
528    evhttp_send_reply( data->req, HTTP_OK, "OK", buf );
529
530    evbuffer_free( buf );
531    tr_free( data );
532}
533
534
535static void
536handle_rpc( struct evhttp_request * req,
537            struct tr_rpc_server  * server )
538{
539    struct rpc_response_data * data = tr_new0( struct rpc_response_data, 1 );
540
541    data->req = req;
542    data->server = server;
543
544    if( req->type == EVHTTP_REQ_GET )
545    {
546        const char * q;
547        if( ( q = strchr( req->uri, '?' ) ) )
548            tr_rpc_request_exec_uri( server->session, q+1, -1, rpc_response_func, data );
549    }
550    else if( req->type == EVHTTP_REQ_POST )
551    {
552        tr_rpc_request_exec_json( server->session,
553                                  EVBUFFER_DATA( req->input_buffer ),
554                                  EVBUFFER_LENGTH( req->input_buffer ),
555                                  rpc_response_func, data );
556    }
557
558}
559
560static tr_bool
561isAddressAllowed( const tr_rpc_server * server,
562                  const char *          address )
563{
564    tr_list * l;
565
566    if( !server->isWhitelistEnabled )
567        return TRUE;
568
569    for( l=server->whitelist; l!=NULL; l=l->next )
570        if( tr_wildmat( address, l->data ) )
571            return TRUE;
572
573    return FALSE;
574}
575
576static tr_bool
577test_session_id( struct tr_rpc_server * server, struct evhttp_request * req )
578{
579    const char * ours = get_current_session_id( server );
580    const char * theirs = evhttp_find_header( req->input_headers, TR_RPC_SESSION_ID_HEADER );
581    const tr_bool success =  theirs && !strcmp( theirs, ours );
582    return success;
583}
584
585static void
586handle_request( struct evhttp_request * req, void * arg )
587{
588    struct tr_rpc_server * server = arg;
589
590    if( req && req->evcon )
591    {
592        const char * auth;
593        char * user = NULL;
594        char * pass = NULL;
595
596        evhttp_add_header( req->output_headers, "Server", MY_REALM );
597
598        auth = evhttp_find_header( req->input_headers, "Authorization" );
599        if( auth && !strncasecmp( auth, "basic ", 6 ) )
600        {
601            int    plen;
602            char * p = tr_base64_decode( auth + 6, 0, &plen );
603            if( p && plen && ( ( pass = strchr( p, ':' ) ) ) )
604            {
605                user = p;
606                *pass++ = '\0';
607            }
608        }
609
610        if( !isAddressAllowed( server, req->remote_host ) )
611        {
612            send_simple_response( req, 403,
613                "<p>Unauthorized IP Address.</p>"
614                "<p>Either disable the IP address whitelist or add your address to it.</p>"
615                "<p>If you're editing settings.json, see the 'rpc-whitelist' and 'rpc-whitelist-enabled' entries.</p>"
616                "<p>If you're still using ACLs, use a whitelist instead.  See the transmission-daemon manpage for details.</p>" );
617        }
618        else if( server->isPasswordEnabled
619                 && ( !pass || !user || strcmp( server->username, user )
620                                     || !tr_ssha1_matches( server->password,
621                                                           pass ) ) )
622        {
623            evhttp_add_header( req->output_headers,
624                               "WWW-Authenticate",
625                               "Basic realm=\"" MY_REALM "\"" );
626            send_simple_response( req, 401, "Unauthorized User" );
627        }
628        else if( !strcmp( req->uri, "/transmission/web" )
629               || !strcmp( req->uri, "/transmission/clutch" )
630               || !strcmp( req->uri, "/" ) )
631        {
632            evhttp_add_header( req->output_headers, "Location", "/transmission/web/" );
633            send_simple_response( req, HTTP_MOVEPERM, NULL );
634        }
635        else if( !strncmp( req->uri, "/transmission/web/", 18 ) )
636        {
637            handle_web_client( req, server );
638        }
639        else if( !strncmp( req->uri, "/transmission/upload", 20 ) )
640        {
641            handle_upload( req, server );
642        }
643#ifdef REQUIRE_SESSION_ID
644        else if( !test_session_id( server, req ) )
645        {
646            const char * sessionId = get_current_session_id( server );
647            char * tmp = tr_strdup_printf(
648                "<p>Your request had an invalid session-id header.</p>"
649                "<p>To fix this, follow these steps:"
650                "<ol><li> When reading a response, get its X-Transmission-Session-Id header and remember it"
651                "<li> Add the updated header to your outgoing requests"
652                "<li> When you get this 409 error message, resend your request with the updated header"
653                "</ol></p>"
654                "<p>This requirement has been added to help prevent "
655                "<a href=\"http://en.wikipedia.org/wiki/Cross-site_request_forgery\">CSRF</a> "
656                "attacks.</p>"
657                "<p><code>%s: %s</code></p>",
658                TR_RPC_SESSION_ID_HEADER, sessionId );
659            evhttp_add_header( req->output_headers, TR_RPC_SESSION_ID_HEADER, sessionId );
660            send_simple_response( req, 409, tmp );
661            tr_free( tmp );
662        }
663#endif
664        else if( !strncmp( req->uri, "/transmission/rpc", 17 ) )
665        {
666            handle_rpc( req, server );
667        }
668        else
669        {
670            send_simple_response( req, HTTP_NOTFOUND, req->uri );
671        }
672
673        tr_free( user );
674    }
675}
676
677static void
678startServer( void * vserver )
679{
680    tr_rpc_server * server  = vserver;
681    tr_address addr;
682
683    if( !server->httpd )
684    {
685        addr.type = TR_AF_INET;
686        addr.addr.addr4 = server->bindAddress;
687        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
688        evhttp_bind_socket( server->httpd, tr_ntop_non_ts( &addr ),
689                            server->port );
690        evhttp_set_gencb( server->httpd, handle_request, server );
691
692    }
693}
694
695static void
696stopServer( tr_rpc_server * server )
697{
698    if( server->httpd )
699    {
700        evhttp_free( server->httpd );
701        server->httpd = NULL;
702    }
703}
704
705static void
706onEnabledChanged( void * vserver )
707{
708    tr_rpc_server * server = vserver;
709
710    if( !server->isEnabled )
711        stopServer( server );
712    else
713        startServer( server );
714}
715
716void
717tr_rpcSetEnabled( tr_rpc_server * server,
718                  tr_bool         isEnabled )
719{
720    server->isEnabled = isEnabled;
721
722    tr_runInEventThread( server->session, onEnabledChanged, server );
723}
724
725tr_bool
726tr_rpcIsEnabled( const tr_rpc_server * server )
727{
728    return server->isEnabled;
729}
730
731static void
732restartServer( void * vserver )
733{
734    tr_rpc_server * server = vserver;
735
736    if( server->isEnabled )
737    {
738        stopServer( server );
739        startServer( server );
740    }
741}
742
743void
744tr_rpcSetPort( tr_rpc_server * server,
745               tr_port         port )
746{
747    assert( server != NULL );
748
749    if( server->port != port )
750    {
751        server->port = port;
752
753        if( server->isEnabled )
754            tr_runInEventThread( server->session, restartServer, server );
755    }
756}
757
758tr_port
759tr_rpcGetPort( const tr_rpc_server * server )
760{
761    return server->port;
762}
763
764void
765tr_rpcSetWhitelist( tr_rpc_server * server,
766                    const char    * whitelistStr )
767{
768    void * tmp;
769    const char * walk;
770
771    /* keep the string */
772    tr_free( server->whitelistStr );
773    server->whitelistStr = tr_strdup( whitelistStr );
774
775    /* clear out the old whitelist entries */
776    while(( tmp = tr_list_pop_front( &server->whitelist )))
777        tr_free( tmp );
778
779    /* build the new whitelist entries */
780    for( walk=whitelistStr; walk && *walk; ) {
781        const char * delimiters = " ,;";
782        const size_t len = strcspn( walk, delimiters );
783        char * token = tr_strndup( walk, len );
784        tr_list_append( &server->whitelist, token );
785        if( strcspn( token, "+-" ) < len )
786            tr_ninf( MY_NAME, "Adding address to whitelist: %s (And it has a '+' or '-'!  Are you using an old ACL by mistake?)", token );
787        else
788            tr_ninf( MY_NAME, "Adding address to whitelist: %s", token );
789
790        if( walk[len]=='\0' )
791            break;
792        walk += len + 1;
793    }
794}
795
796const char*
797tr_rpcGetWhitelist( const tr_rpc_server * server )
798{
799    return server->whitelistStr ? server->whitelistStr : "";
800}
801
802void
803tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
804                           tr_bool          isEnabled )
805{
806    server->isWhitelistEnabled = isEnabled != 0;
807}
808
809tr_bool
810tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
811{
812    return server->isWhitelistEnabled;
813}
814
815/****
816*****  PASSWORD
817****/
818
819void
820tr_rpcSetUsername( tr_rpc_server * server,
821                   const char *    username )
822{
823    tr_free( server->username );
824    server->username = tr_strdup( username );
825    dbgmsg( "setting our Username to [%s]", server->username );
826}
827
828const char*
829tr_rpcGetUsername( const tr_rpc_server * server )
830{
831    return server->username ? server->username : "";
832}
833
834void
835tr_rpcSetPassword( tr_rpc_server * server,
836                   const char *    password )
837{
838    tr_free( server->password );
839    if( *password != '{' )
840        server->password = tr_ssha1( password );
841    else
842        server->password = strdup( password );
843    dbgmsg( "setting our Password to [%s]", server->password );
844}
845
846const char*
847tr_rpcGetPassword( const tr_rpc_server * server )
848{
849    return server->password ? server->password : "" ;
850}
851
852void
853tr_rpcSetPasswordEnabled( tr_rpc_server * server,
854                          tr_bool          isEnabled )
855{
856    server->isPasswordEnabled = isEnabled;
857    dbgmsg( "setting 'password enabled' to %d", (int)isEnabled );
858}
859
860tr_bool
861tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
862{
863    return server->isPasswordEnabled;
864}
865
866const char *
867tr_rpcGetBindAddress( const tr_rpc_server * server )
868{
869    tr_address addr;
870    addr.type = TR_AF_INET;
871    addr.addr.addr4 = server->bindAddress;
872    return tr_ntop_non_ts( &addr );
873}
874
875/****
876*****  LIFE CYCLE
877****/
878
879static void
880closeServer( void * vserver )
881{
882    void * tmp;
883    tr_rpc_server * s = vserver;
884
885    stopServer( s );
886    while(( tmp = tr_list_pop_front( &s->whitelist )))
887        tr_free( tmp );
888#ifdef HAVE_ZLIB
889    if( s->isStreamInitialized )
890        deflateEnd( &s->stream );
891#endif
892    tr_free( s->sessionId );
893    tr_free( s->whitelistStr );
894    tr_free( s->username );
895    tr_free( s->password );
896    tr_free( s );
897}
898
899void
900tr_rpcClose( tr_rpc_server ** ps )
901{
902    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
903    *ps = NULL;
904}
905
906tr_rpc_server *
907tr_rpcInit( tr_session  * session, tr_benc * settings )
908{
909    tr_rpc_server * s;
910    tr_bool found;
911    tr_bool boolVal;
912    int64_t i;
913    const char *str;
914    tr_address address;
915
916    s = tr_new0( tr_rpc_server, 1 );
917    s->session = session;
918
919    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_ENABLED, &boolVal );
920    assert( found );
921    s->isEnabled = boolVal;
922
923    found = tr_bencDictFindInt( settings, TR_PREFS_KEY_RPC_PORT, &i );
924    assert( found );
925    s->port = i;
926
927    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, &boolVal );
928    assert( found );
929    tr_rpcSetWhitelistEnabled( s, boolVal );
930
931    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, &boolVal );
932    assert( found );
933    tr_rpcSetPasswordEnabled( s, boolVal );
934
935    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_WHITELIST, &str );
936    assert( found );
937    tr_rpcSetWhitelist( s, str ? str : "127.0.0.1" );
938
939    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_USERNAME, &str );
940    assert( found );
941    tr_rpcSetUsername( s, str );
942
943    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_PASSWORD, &str );
944    assert( found );
945    tr_rpcSetPassword( s, str );
946
947    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_BIND_ADDRESS, &str );
948    assert( found );
949    if( tr_pton( str, &address ) == NULL ) {
950        tr_err( _( "%s is not a valid address" ), str );
951        address = tr_inaddr_any;
952    } else if( address.type != TR_AF_INET ) {
953        tr_err( _( "%s is not an IPv4 address. RPC listeners must be IPv4" ),
954                   str );
955        address = tr_inaddr_any;
956    }
957    s->bindAddress = address.addr.addr4;
958
959    if( s->isEnabled )
960    {
961        tr_ninf( MY_NAME, _( "Serving RPC and Web requests on port %d" ), (int) s->port );
962        tr_runInEventThread( session, startServer, s );
963
964        if( s->isWhitelistEnabled )
965            tr_ninf( MY_NAME, "%s", _( "Whitelist enabled" ) );
966
967        if( s->isPasswordEnabled )
968            tr_ninf( MY_NAME, "%s", _( "Password required" ) );
969    }
970
971    return s;
972}
Note: See TracBrowser for help on using the repository browser.