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

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

(trunk) #1538 "Make Web UI URL configurable" -- added to trunk. Patch by wereHamster

  • Property svn:keywords set to Date Rev Author Id
File size: 29.0 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 11524 2010-12-12 18:22:11Z 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    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                              const 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_DATA( body );
163    size_t inlen = EVBUFFER_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_DATA( json ),
280                                          EVBUFFER_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,
331              struct tr_rpc_server *  server,
332              struct evbuffer *       out,
333              const void *            content,
334              size_t                  content_len )
335{
336#ifndef HAVE_ZLIB
337    evbuffer_add( out, content, content_len );
338#else
339    const char * key = "Accept-Encoding";
340    const char * encoding = evhttp_find_header( req->input_headers, key );
341    const int do_compress = encoding && strstr( encoding, "gzip" );
342
343    if( !do_compress )
344    {
345        evbuffer_add( out, content, content_len );
346    }
347    else
348    {
349        int state;
350
351        /* FIXME(libevent2): this won't compile under libevent2.
352           but we can use evbuffer_reserve_space() + evbuffer_commit_space() instead */
353
354        if( !server->isStreamInitialized )
355        {
356            int compressionLevel;
357
358            server->isStreamInitialized = TRUE;
359            server->stream.zalloc = (alloc_func) Z_NULL;
360            server->stream.zfree = (free_func) Z_NULL;
361            server->stream.opaque = (voidpf) Z_NULL;
362
363            /* zlib's manual says: "Add 16 to windowBits to write a simple gzip header
364             * and trailer around the compressed data instead of a zlib wrapper." */
365#ifdef TR_EMBEDDED
366            compressionLevel = Z_DEFAULT_COMPRESSION;
367#else
368            compressionLevel = Z_BEST_COMPRESSION;
369#endif
370            deflateInit2( &server->stream, compressionLevel, Z_DEFLATED, 15+16, 8, Z_DEFAULT_STRATEGY );
371        }
372
373        server->stream.next_in = (Bytef*) content;
374        server->stream.avail_in = content_len;
375
376        /* allocate space for the raw data and call deflate() just once --
377         * we won't use the deflated data if it's longer than the raw data,
378         * so it's okay to let deflate() run out of output buffer space */
379        evbuffer_expand( out, content_len );
380        server->stream.next_out = EVBUFFER_DATA( out );
381        server->stream.avail_out = content_len;
382
383        state = deflate( &server->stream, Z_FINISH );
384
385        if( state == Z_STREAM_END )
386        {
387            EVBUFFER_LENGTH( out ) = content_len - server->stream.avail_out;
388
389#if 0
390            fprintf( stderr, "compressed response is %.2f of original (raw==%zu bytes; compressed==%zu)\n",
391                             (double)EVBUFFER_LENGTH(out)/content_len,
392                             content_len, EVBUFFER_LENGTH(out) );
393#endif
394            evhttp_add_header( req->output_headers,
395                               "Content-Encoding", "gzip" );
396        }
397        else
398        {
399            evbuffer_drain( out, EVBUFFER_LENGTH( out ) );
400            evbuffer_add( out, content, content_len );
401        }
402
403        deflateReset( &server->stream );
404    }
405#endif
406}
407
408static void
409add_time_header( struct evkeyvalq * headers, const char * key, time_t value )
410{
411    /* According to RFC 2616 this must follow RFC 1123's date format,
412       so use gmtime instead of localtime... */
413    char buf[128];
414    struct tm tm = *gmtime( &value );
415    strftime( buf, sizeof( buf ), "%a, %d %b %Y %H:%M:%S GMT", &tm );
416    evhttp_add_header( headers, key, buf );
417}
418
419static void
420serve_file( struct evhttp_request * req,
421            struct tr_rpc_server *  server,
422            const char *            filename )
423{
424    if( req->type != EVHTTP_REQ_GET )
425    {
426        evhttp_add_header( req->output_headers, "Allow", "GET" );
427        send_simple_response( req, 405, NULL );
428    }
429    else
430    {
431        size_t content_len;
432        uint8_t * content;
433        const int error = errno;
434
435        errno = 0;
436        content_len = 0;
437        content = tr_loadFile( filename, &content_len );
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, content_len );
456            evhttp_send_reply( req, HTTP_OK, "OK", out );
457
458            evbuffer_free( out );
459            tr_free( content );
460        }
461    }
462}
463
464static void
465handle_web_client( struct evhttp_request * req,
466                   struct tr_rpc_server *  server )
467{
468    const char * webClientDir = tr_getWebClientDir( server->session );
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 + strlen( server->url ) + 4 );
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( strncmp( req->uri, server->url, strlen( server->url ) ) )
629        {
630            const char * protocol = "http";
631            const char * host = evhttp_find_header( req->input_headers, "Host" );
632            char * location = tr_strdup_printf( "%s://%s%sweb/", protocol, host, server->url );
633            evhttp_add_header( req->output_headers, "Location", location );
634            send_simple_response( req, HTTP_MOVEPERM, NULL );
635            tr_free( location );
636        }
637        else if( !strncmp( req->uri + strlen( server->url ), "web/", 4 ) )
638        {
639            handle_web_client( req, server );
640        }
641#ifdef REQUIRE_SESSION_ID
642        else if( !test_session_id( server, req ) )
643        {
644            const char * sessionId = get_current_session_id( server );
645            char * tmp = tr_strdup_printf(
646                "<p>Your request had an invalid session-id header.</p>"
647                "<p>To fix this, follow these steps:"
648                "<ol><li> When reading a response, get its X-Transmission-Session-Id header and remember it"
649                "<li> Add the updated header to your outgoing requests"
650                "<li> When you get this 409 error message, resend your request with the updated header"
651                "</ol></p>"
652                "<p>This requirement has been added to help prevent "
653                "<a href=\"http://en.wikipedia.org/wiki/Cross-site_request_forgery\">CSRF</a> "
654                "attacks.</p>"
655                "<p><code>%s: %s</code></p>",
656                TR_RPC_SESSION_ID_HEADER, sessionId );
657            evhttp_add_header( req->output_headers, TR_RPC_SESSION_ID_HEADER, sessionId );
658            send_simple_response( req, 409, tmp );
659            tr_free( tmp );
660        }
661#endif
662        else if( !strncmp( req->uri + strlen( server->url ), "rpc", 3 ) )
663        {
664            handle_rpc( req, server );
665        }
666        else if( !strncmp( req->uri + strlen( server->url ), "upload", 6 ) )
667        {
668            handle_upload( req, server );
669        }
670        else
671        {
672            send_simple_response( req, HTTP_NOTFOUND, req->uri );
673        }
674
675        tr_free( user );
676    }
677}
678
679static void
680startServer( void * vserver )
681{
682    tr_rpc_server * server  = vserver;
683    tr_address addr;
684
685    if( !server->httpd )
686    {
687        addr.type = TR_AF_INET;
688        addr.addr.addr4 = server->bindAddress;
689        server->httpd = evhttp_new( tr_eventGetBase( server->session ) );
690        evhttp_bind_socket( server->httpd, tr_ntop_non_ts( &addr ),
691                            server->port );
692        evhttp_set_gencb( server->httpd, handle_request, server );
693
694    }
695}
696
697static void
698stopServer( tr_rpc_server * server )
699{
700    if( server->httpd )
701    {
702        evhttp_free( server->httpd );
703        server->httpd = NULL;
704    }
705}
706
707static void
708onEnabledChanged( void * vserver )
709{
710    tr_rpc_server * server = vserver;
711
712    if( !server->isEnabled )
713        stopServer( server );
714    else
715        startServer( server );
716}
717
718void
719tr_rpcSetEnabled( tr_rpc_server * server,
720                  tr_bool         isEnabled )
721{
722    server->isEnabled = isEnabled;
723
724    tr_runInEventThread( server->session, onEnabledChanged, server );
725}
726
727tr_bool
728tr_rpcIsEnabled( const tr_rpc_server * server )
729{
730    return server->isEnabled;
731}
732
733static void
734restartServer( void * vserver )
735{
736    tr_rpc_server * server = vserver;
737
738    if( server->isEnabled )
739    {
740        stopServer( server );
741        startServer( server );
742    }
743}
744
745void
746tr_rpcSetPort( tr_rpc_server * server,
747               tr_port         port )
748{
749    assert( server != NULL );
750
751    if( server->port != port )
752    {
753        server->port = port;
754
755        if( server->isEnabled )
756            tr_runInEventThread( server->session, restartServer, server );
757    }
758}
759
760tr_port
761tr_rpcGetPort( const tr_rpc_server * server )
762{
763    return server->port;
764}
765
766void
767tr_rpcSetUrl( tr_rpc_server * server, const char * url )
768{
769    char * tmp = server->url;
770    server->url = tr_strdup( url );
771    dbgmsg( "setting our URL to [%s]", server->url );
772    tr_free( tmp );
773}
774
775const char*
776tr_rpcGetUrl( const tr_rpc_server * server )
777{
778    return server->url ? server->url : "";
779}
780
781void
782tr_rpcSetWhitelist( tr_rpc_server * server, const char * whitelistStr )
783{
784    void * tmp;
785    const char * walk;
786
787    /* keep the string */
788    tmp = server->whitelistStr;
789    server->whitelistStr = tr_strdup( whitelistStr );
790    tr_free( tmp );
791
792    /* clear out the old whitelist entries */
793    while(( tmp = tr_list_pop_front( &server->whitelist )))
794        tr_free( tmp );
795
796    /* build the new whitelist entries */
797    for( walk=whitelistStr; walk && *walk; ) {
798        const char * delimiters = " ,;";
799        const size_t len = strcspn( walk, delimiters );
800        char * token = tr_strndup( walk, len );
801        tr_list_append( &server->whitelist, token );
802        if( strcspn( token, "+-" ) < len )
803            tr_ninf( MY_NAME, "Adding address to whitelist: %s (And it has a '+' or '-'!  Are you using an old ACL by mistake?)", token );
804        else
805            tr_ninf( MY_NAME, "Adding address to whitelist: %s", token );
806
807        if( walk[len]=='\0' )
808            break;
809        walk += len + 1;
810    }
811}
812
813const char*
814tr_rpcGetWhitelist( const tr_rpc_server * server )
815{
816    return server->whitelistStr ? server->whitelistStr : "";
817}
818
819void
820tr_rpcSetWhitelistEnabled( tr_rpc_server  * server,
821                           tr_bool          isEnabled )
822{
823    server->isWhitelistEnabled = isEnabled != 0;
824}
825
826tr_bool
827tr_rpcGetWhitelistEnabled( const tr_rpc_server * server )
828{
829    return server->isWhitelistEnabled;
830}
831
832/****
833*****  PASSWORD
834****/
835
836void
837tr_rpcSetUsername( tr_rpc_server * server, const char * username )
838{
839    char * tmp = server->username;
840    server->username = tr_strdup( username );
841    dbgmsg( "setting our Username to [%s]", server->username );
842    tr_free( tmp );
843}
844
845const char*
846tr_rpcGetUsername( const tr_rpc_server * server )
847{
848    return server->username ? server->username : "";
849}
850
851void
852tr_rpcSetPassword( tr_rpc_server * server,
853                   const char *    password )
854{
855    tr_free( server->password );
856    if( *password != '{' )
857        server->password = tr_ssha1( password );
858    else
859        server->password = strdup( password );
860    dbgmsg( "setting our Password to [%s]", server->password );
861}
862
863const char*
864tr_rpcGetPassword( const tr_rpc_server * server )
865{
866    return server->password ? server->password : "" ;
867}
868
869void
870tr_rpcSetPasswordEnabled( tr_rpc_server * server,
871                          tr_bool          isEnabled )
872{
873    server->isPasswordEnabled = isEnabled;
874    dbgmsg( "setting 'password enabled' to %d", (int)isEnabled );
875}
876
877tr_bool
878tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
879{
880    return server->isPasswordEnabled;
881}
882
883const char *
884tr_rpcGetBindAddress( const tr_rpc_server * server )
885{
886    tr_address addr;
887    addr.type = TR_AF_INET;
888    addr.addr.addr4 = server->bindAddress;
889    return tr_ntop_non_ts( &addr );
890}
891
892/****
893*****  LIFE CYCLE
894****/
895
896static void
897closeServer( void * vserver )
898{
899    void * tmp;
900    tr_rpc_server * s = vserver;
901
902    stopServer( s );
903    while(( tmp = tr_list_pop_front( &s->whitelist )))
904        tr_free( tmp );
905#ifdef HAVE_ZLIB
906    if( s->isStreamInitialized )
907        deflateEnd( &s->stream );
908#endif
909    tr_free( s->url );
910    tr_free( s->sessionId );
911    tr_free( s->whitelistStr );
912    tr_free( s->username );
913    tr_free( s->password );
914    tr_free( s );
915}
916
917void
918tr_rpcClose( tr_rpc_server ** ps )
919{
920    tr_runInEventThread( ( *ps )->session, closeServer, *ps );
921    *ps = NULL;
922}
923
924tr_rpc_server *
925tr_rpcInit( tr_session  * session, tr_benc * settings )
926{
927    tr_rpc_server * s;
928    tr_bool found;
929    tr_bool boolVal;
930    int64_t i;
931    const char *str;
932    tr_address address;
933
934    s = tr_new0( tr_rpc_server, 1 );
935    s->session = session;
936
937    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_ENABLED, &boolVal );
938    assert( found );
939    s->isEnabled = boolVal;
940
941    found = tr_bencDictFindInt( settings, TR_PREFS_KEY_RPC_PORT, &i );
942    assert( found );
943    s->port = i;
944
945    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_URL, &str );
946    assert( found );
947    s->url = tr_strdup( str );
948
949    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, &boolVal );
950    assert( found );
951    tr_rpcSetWhitelistEnabled( s, boolVal );
952
953    found = tr_bencDictFindBool( settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, &boolVal );
954    assert( found );
955    tr_rpcSetPasswordEnabled( s, boolVal );
956
957    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_WHITELIST, &str );
958    assert( found );
959    tr_rpcSetWhitelist( s, str ? str : "127.0.0.1" );
960
961    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_USERNAME, &str );
962    assert( found );
963    tr_rpcSetUsername( s, str );
964
965    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_PASSWORD, &str );
966    assert( found );
967    tr_rpcSetPassword( s, str );
968
969    found = tr_bencDictFindStr( settings, TR_PREFS_KEY_RPC_BIND_ADDRESS, &str );
970    assert( found );
971    if( tr_pton( str, &address ) == NULL ) {
972        tr_err( _( "%s is not a valid address" ), str );
973        address = tr_inaddr_any;
974    } else if( address.type != TR_AF_INET ) {
975        tr_err( _( "%s is not an IPv4 address. RPC listeners must be IPv4" ),
976                   str );
977        address = tr_inaddr_any;
978    }
979    s->bindAddress = address.addr.addr4;
980
981    if( s->isEnabled )
982    {
983        tr_ninf( MY_NAME, _( "Serving RPC and Web requests on port 127.0.0.1:%d%s" ), (int) s->port, s->url );
984        tr_runInEventThread( session, startServer, s );
985
986        if( s->isWhitelistEnabled )
987            tr_ninf( MY_NAME, "%s", _( "Whitelist enabled" ) );
988
989        if( s->isPasswordEnabled )
990            tr_ninf( MY_NAME, "%s", _( "Password required" ) );
991    }
992
993    return s;
994}
Note: See TracBrowser for help on using the repository browser.