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

Last change on this file since 12148 was 12148, checked in by jordan, 11 years ago

(trunk libT) use libevent's portability wrapper for strcasecmp()

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