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

Last change on this file since 6253 was 6253, checked in by charles, 14 years ago

(rpc) fix crash when quickly toggling rpc on/off reported by John_Clay

  • Property svn:keywords set to Date Rev Author Id
File size: 13.0 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: rpc-server.c 6253 2008-06-25 11:34:35Z charles $
11 */
12
13#include <assert.h>
14#include <ctype.h> /* isdigit */
15#include <errno.h>
16#include <stdlib.h> /* strtol */
17#include <string.h>
18
19#include <unistd.h> /* unlink */
20
21#include <libevent/event.h>
22#include <shttpd/defs.h> /* edit_passwords */
23#include <shttpd/shttpd.h>
24
25#include "transmission.h"
26#include "rpc.h"
27#include "rpc-server.h"
28#include "utils.h"
29
30#define MY_NAME "RPC Server"
31#define MY_REALM "Transmission RPC Server"
32
33#define BUSY_INTERVAL_MSEC 30
34#define IDLE_INTERVAL_MSEC 66
35#define UNUSED_INTERVAL_MSEC 100
36
37struct tr_rpc_server
38{
39    int port;
40    time_t lastRequestTime;
41    struct shttpd_ctx * ctx;
42    tr_handle * session;
43    struct evbuffer * in;
44    struct evbuffer * out;
45    struct event timer;
46    int isPasswordEnabled;
47    char * username;
48    char * password;
49    char * acl;
50};
51
52#define dbgmsg(fmt...) tr_deepLog(__FILE__, __LINE__, MY_NAME, ##fmt )
53
54static void
55handle_rpc( struct shttpd_arg * arg )
56{
57    struct tr_rpc_server * s = arg->user_data;
58    s->lastRequestTime = time( NULL );
59
60    if( !EVBUFFER_LENGTH( s->out ) )
61    {
62        int len = 0;
63        char * response = NULL;
64        const char * request_method = shttpd_get_env( arg, "REQUEST_METHOD" );
65        const char * query_string = shttpd_get_env( arg, "QUERY_STRING" );
66
67        if( query_string && *query_string )
68            response = tr_rpc_request_exec_uri( s->session,
69                                                query_string,
70                                                strlen( query_string ),
71                                                &len );
72        else if( !strcmp( request_method, "POST" ) )
73        {
74            evbuffer_add( s->in, arg->in.buf, arg->in.len );
75            arg->in.num_bytes = arg->in.len;
76            if( arg->flags & SHTTPD_MORE_POST_DATA )
77                return;
78            response = tr_rpc_request_exec_json( s->session,
79                                                 EVBUFFER_DATA( s->in ),
80                                                 EVBUFFER_LENGTH( s->in ),
81                                                 &len );
82            evbuffer_drain( s->in, EVBUFFER_LENGTH( s->in ) );
83        }
84
85        evbuffer_add_printf( s->out, "HTTP/1.1 200 OK\r\n"
86                                     "Content-Type: application/json\r\n"
87                                     "Content-Length: %d\r\n"
88                                     "\r\n"
89                                     "%*.*s\r\n", len, len, len, response );
90        tr_free( response );
91    }
92
93    if( EVBUFFER_LENGTH( s->out ) )
94    {
95        const int n = MIN( ( int )EVBUFFER_LENGTH( s->out ), arg->out.len );
96        memcpy( arg->out.buf, EVBUFFER_DATA( s->out ), n );
97        evbuffer_drain( s->out, n );
98        arg->out.num_bytes = n;
99    }
100
101    if( !EVBUFFER_LENGTH( s->out ) )
102        arg->flags |= SHTTPD_END_OF_OUTPUT;
103}
104
105static void
106rpcPulse( int socket UNUSED, short action UNUSED, void * vserver )
107{
108    int interval;
109    struct timeval tv;
110    tr_rpc_server * server = vserver;
111    const time_t now = time( NULL );
112
113    assert( server );
114
115    if( server->ctx )
116        shttpd_poll( server->ctx, 1 );
117
118    /* set a timer for the next pulse */
119    if( EVBUFFER_LENGTH( server->in ) || EVBUFFER_LENGTH( server->out ) )
120        interval = BUSY_INTERVAL_MSEC;
121    else if( now - server->lastRequestTime < 300 )
122        interval = IDLE_INTERVAL_MSEC;
123    else
124        interval = UNUSED_INTERVAL_MSEC;
125    tv = tr_timevalMsec( interval );
126    evtimer_add( &server->timer, &tv );
127}
128
129static void
130getPasswordFile( tr_rpc_server * server, char * buf, int buflen )
131{
132    tr_buildPath( buf, buflen, tr_sessionGetConfigDir( server->session ),
133                               "htpasswd",
134                               NULL );
135}
136
137static void
138startServer( tr_rpc_server * server )
139{
140    dbgmsg( "in startServer; current context is %p", server->ctx );
141
142    if( !server->ctx )
143    {
144        char ports[128];
145        char passwd[MAX_PATH_LENGTH];
146        char clutchDir[MAX_PATH_LENGTH];
147        char * clutchAlias;
148        struct timeval tv = tr_timevalMsec( UNUSED_INTERVAL_MSEC );
149
150        tr_buildPath( clutchDir, sizeof( clutchDir ), tr_sessionGetConfigDir( server->session ), "clutch", NULL );
151        clutchAlias = tr_strdup_printf( "%s=%s", "/transmission/clutch", clutchDir );
152
153        getPasswordFile( server, passwd, sizeof( passwd ) );
154        if( !server->isPasswordEnabled )
155            unlink( passwd );
156        else
157            edit_passwords( passwd, MY_REALM, server->username, server->password );
158
159        server->ctx = shttpd_init( );
160        snprintf( ports, sizeof( ports ), "%d", server->port );
161        shttpd_register_uri( server->ctx, "/transmission/rpc", handle_rpc, server );
162        shttpd_set_option(server->ctx, "aliases", clutchAlias );
163        shttpd_set_option( server->ctx, "ports", ports );
164        shttpd_set_option( server->ctx, "dir_list", "0" );
165        //shttpd_set_option( server->ctx, "root", "/dev/null" );
166        shttpd_set_option( server->ctx, "auth_realm", MY_REALM );
167        if( server->acl ) {
168            dbgmsg( "setting acl [%s]", server->acl );
169            shttpd_set_option( server->ctx, "acl", server->acl );
170        }
171        if( server->isPasswordEnabled ) {
172            char * buf = tr_strdup_printf( "/transmission/rpc=%s", passwd );
173            shttpd_set_option( server->ctx, "protect", buf );
174            tr_free( buf );
175        }
176
177        evtimer_set( &server->timer, rpcPulse, server );
178        evtimer_add( &server->timer, &tv );
179
180        tr_free( clutchAlias );
181    }
182}
183
184static void
185stopServer( tr_rpc_server * server )
186{
187    if( server->ctx )
188    {
189        char passwd[MAX_PATH_LENGTH];
190        getPasswordFile( server, passwd, sizeof( passwd ) );
191        unlink( passwd );
192
193        evtimer_del( &server->timer );
194        shttpd_fini( server->ctx );
195        server->ctx = NULL;
196    }
197}
198
199void
200tr_rpcSetEnabled( tr_rpc_server * server, int isEnabled )
201{
202    if( !isEnabled && server->ctx )
203        stopServer( server );
204
205    if( isEnabled && !server->ctx )
206        startServer( server );
207}
208
209int
210tr_rpcIsEnabled( const tr_rpc_server * server )
211{
212    return server->ctx != NULL;
213}
214
215void
216tr_rpcSetPort( tr_rpc_server * server, int port )
217{
218    if( server->port != port )
219    {
220        server->port = port;
221
222        if( server->ctx )
223        {
224            stopServer( server );
225            startServer( server );
226        }
227    }
228}
229
230int
231tr_rpcGetPort( const tr_rpc_server * server )
232{
233    return server->port;
234}
235
236/****
237*****  ACL
238****/
239
240/*
241 * DELIM_CHARS, FOR_EACH_WORD_IN_LIST, isbyte, and testACL are from, or modified from,
242 * shttpd, written by Sergey Lyubka under this license:
243 * "THE BEER-WARE LICENSE" (Revision 42):
244 * Sergey Lyubka wrote this file.  As long as you retain this notice you
245 * can do whatever you want with this stuff. If we meet some day, and you think
246 * this stuff is worth it, you can buy me a beer in return.
247 */
248
249#define  DELIM_CHARS "," /* Separators for lists */
250
251#define FOR_EACH_WORD_IN_LIST(s,len)                                    \
252        for (; s != NULL && (len = strcspn(s, DELIM_CHARS)) != 0;       \
253                        s += len, s+= strspn(s, DELIM_CHARS))
254
255static int isbyte(int n) { return (n >= 0 && n <= 255); }
256
257static char*
258testACL( const char * s )
259{
260    int len;
261
262    FOR_EACH_WORD_IN_LIST(s, len)
263    {
264
265        char flag;
266        int  a, b, c, d, n, mask;
267
268        if( sscanf(s, "%c%d.%d.%d.%d%n",&flag,&a,&b,&c,&d,&n) != 5 )
269            return tr_strdup_printf( _( "[%s]: subnet must be [+|-]x.x.x.x[/x]" ), s );
270        if( flag != '+' && flag != '-')
271            return tr_strdup_printf( _( "[%s]: flag must be + or -" ), s );
272        if( !isbyte(a) || !isbyte(b) || !isbyte(c) || !isbyte(d) )
273            return tr_strdup_printf( _( "[%s]: bad ip address" ), s );
274        if( sscanf(s + n, "/%d", &mask) == 1 && ( mask<0 || mask>32 ) )
275            return tr_strdup_printf( _( "[%s]: bad subnet mask %d" ), s, n );
276    }
277
278    return NULL;
279}
280
281/* 192.*.*.* --> 192.0.0.0/8
282   192.64.*.* --> 192.64.0.0/16
283   192.64.1.* --> 192.64.1.0/24
284   192.64.1.2 --> 192.64.1.2/32 */
285static void
286cidrizeOne( const char * in, int len, struct evbuffer * out )
287{
288    int stars = 0;
289    const char * pch;
290    const char * end;
291    char zero = '0';
292    char huh = '?';
293
294    for( pch=in, end=pch+len; pch!=end; ++pch ) {
295        if( stars && isdigit(*pch) )
296            evbuffer_add( out, &huh, 1 ); 
297        else if( *pch!='*' )
298            evbuffer_add( out, pch, 1 );
299        else {
300            evbuffer_add( out, &zero, 1 );
301            ++stars;
302        }
303    }
304
305    evbuffer_add_printf( out, "/%d", (32-(stars*8)));
306}
307
308char*
309cidrize( const char * acl )
310{
311    int len;
312    const char * walk = acl;
313    char * ret;
314    struct evbuffer * out = evbuffer_new( );
315
316    FOR_EACH_WORD_IN_LIST( walk, len )
317    {
318        cidrizeOne( walk, len, out );
319        evbuffer_add_printf( out, "," );
320    }
321
322    /* the -1 is to eat the final ", " */
323    ret = tr_strndup( (char*) EVBUFFER_DATA(out), EVBUFFER_LENGTH(out)-1 );
324    evbuffer_free( out );
325    return ret;
326}
327
328int
329tr_rpcTestACL( const tr_rpc_server  * server UNUSED,
330               const char           * acl,
331               char                ** setme_errmsg )
332{
333    int err = 0;
334    char * cidr = cidrize( acl );
335    char * errmsg = testACL( cidr );
336    if( errmsg )
337    {
338        if( setme_errmsg )
339            *setme_errmsg = errmsg;
340        else
341            tr_free( errmsg );
342        err = -1;
343    }
344    tr_free( cidr );
345    return err;
346}
347
348int
349tr_rpcSetACL( tr_rpc_server   * server,
350              const char      * acl,
351              char           ** setme_errmsg )
352{
353    char * cidr = cidrize( acl );
354    const int err = tr_rpcTestACL( server, cidr, setme_errmsg );
355
356    if( !err )
357    {
358        const int isRunning = server->ctx != NULL;
359
360        if( isRunning )
361            stopServer( server );
362
363        tr_free( server->acl );
364        server->acl = tr_strdup( cidr );
365        dbgmsg( "setting our ACL to [%s]", server->acl );
366
367        if( isRunning )
368            startServer( server );
369    }
370    tr_free( cidr );
371
372    return err;
373}
374
375char*
376tr_rpcGetACL( const tr_rpc_server * server )
377{
378    return tr_strdup( server->acl ? server->acl : "" );
379}
380
381/****
382*****  PASSWORD
383****/
384
385void
386tr_rpcSetUsername( tr_rpc_server        * server,
387                   const char           * username )
388{
389    const int isRunning = server->ctx != NULL;
390
391    if( isRunning )
392        stopServer( server );
393
394    tr_free( server->username );
395    server->username = tr_strdup( username );
396    dbgmsg( "setting our Username to [%s]", server->username );
397
398    if( isRunning )
399        startServer( server );
400}
401
402char*
403tr_rpcGetUsername( const tr_rpc_server  * server )
404{
405    return tr_strdup( server->username ? server->username : "" );
406}
407
408void
409tr_rpcSetPassword( tr_rpc_server        * server,
410                   const char           * password )
411{
412    const int isRunning = server->ctx != NULL;
413
414    if( isRunning )
415        stopServer( server );
416
417    tr_free( server->password );
418    server->password = tr_strdup( password );
419    dbgmsg( "setting our Password to [%s]", server->password );
420
421    if( isRunning )
422        startServer( server );
423}
424
425char*
426tr_rpcGetPassword( const tr_rpc_server  * server )
427{
428    return tr_strdup( server->password ? server->password : "" );
429}
430
431void
432tr_rpcSetPasswordEnabled( tr_rpc_server  * server,
433                          int              isEnabled )
434{
435    const int isRunning = server->ctx != NULL;
436
437    if( isRunning )
438        stopServer( server );
439
440    server->isPasswordEnabled = isEnabled;
441    dbgmsg( "setting 'password enabled' to %d", isEnabled );
442
443    if( isRunning )
444        startServer( server );
445}
446
447int
448tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
449{
450    return server->isPasswordEnabled;
451}
452
453/****
454*****  LIFE CYCLE
455****/
456
457void
458tr_rpcClose( tr_rpc_server ** ps )
459{
460    tr_rpc_server * s = *ps;
461    *ps = NULL;
462
463    stopServer( s );
464    evbuffer_free( s->in );
465    evbuffer_free( s->out );
466    tr_free( s->acl );
467    tr_free( s );
468}
469
470tr_rpc_server *
471tr_rpcInit( tr_handle   * session,
472            int           isEnabled,
473            int           port,
474            const char  * acl,
475            int           isPasswordEnabled,
476            const char  * username,
477            const char  * password )
478{
479    char * errmsg;
480    tr_rpc_server * s;
481
482    if(( errmsg = testACL ( acl )))
483    {
484        tr_nerr( MY_NAME, errmsg );
485        tr_free( errmsg );
486        acl = TR_DEFAULT_RPC_ACL;
487        tr_nerr( MY_NAME, "using fallback ACL \"%s\"", acl );
488    }
489
490    s = tr_new0( tr_rpc_server, 1 );
491    s->session = session;
492    s->port = port;
493    s->in = evbuffer_new( );
494    s->out = evbuffer_new( );
495    s->acl = tr_strdup( acl );
496    s->username = tr_strdup( username );
497    s->password = tr_strdup( password );
498    s->isPasswordEnabled = isPasswordEnabled;
499   
500    if( isEnabled )
501        startServer( s );
502    return s;   
503}
Note: See TracBrowser for help on using the repository browser.