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

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

fix ACL parsing error introduced by the shttpd auth code change.

  • Property svn:keywords set to Date Rev Author Id
File size: 12.6 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 6139 2008-06-11 15:17:59Z 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 100
35#define UNUSED_INTERVAL_MSEC 1000
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    shttpd_poll( server->ctx, 1 );
116
117    /* set a timer for the next pulse */
118    if( EVBUFFER_LENGTH( server->in ) || EVBUFFER_LENGTH( server->out ) )
119        interval = BUSY_INTERVAL_MSEC;
120    else if( now - server->lastRequestTime < 300 )
121        interval = IDLE_INTERVAL_MSEC;
122    else
123        interval = UNUSED_INTERVAL_MSEC;
124    tv = tr_timevalMsec( interval );
125    evtimer_add( &server->timer, &tv );
126}
127
128static void
129getPasswordFile( tr_rpc_server * server, char * buf, int buflen )
130{
131    tr_buildPath( buf, buflen, tr_sessionGetConfigDir( server->session ),
132                               "htpasswd",
133                               NULL );
134}
135
136static void
137startServer( tr_rpc_server * server )
138{
139    dbgmsg( "in startServer; current context is %p", server->ctx );
140
141    if( !server->ctx )
142    {
143        char ports[128];
144        char passwd[MAX_PATH_LENGTH];
145        struct timeval tv = tr_timevalMsec( UNUSED_INTERVAL_MSEC );
146
147        getPasswordFile( server, passwd, sizeof( passwd ) );
148        if( !server->isPasswordEnabled )
149            unlink( passwd );
150        else
151            edit_passwords( passwd, MY_REALM, server->username, server->password );
152
153        server->ctx = shttpd_init( );
154        snprintf( ports, sizeof( ports ), "%d", server->port );
155        shttpd_register_uri( server->ctx, "/transmission", handle_rpc, server );
156        shttpd_set_option( server->ctx, "ports", ports );
157        shttpd_set_option( server->ctx, "dir_list", "0" );
158        shttpd_set_option( server->ctx, "root", "/dev/null" );
159        shttpd_set_option( server->ctx, "auth_realm", MY_REALM );
160        if( server->acl ) {
161            dbgmsg( "setting acl [%s]", server->acl );
162            shttpd_set_option( server->ctx, "acl", server->acl );
163        }
164        if( server->isPasswordEnabled ) {
165            char * buf = tr_strdup_printf( "/transmission=%s", passwd );
166            shttpd_set_option( server->ctx, "protect", buf );
167            tr_free( buf );
168        }
169
170        evtimer_set( &server->timer, rpcPulse, server );
171        evtimer_add( &server->timer, &tv );
172    }
173}
174
175static void
176stopServer( tr_rpc_server * server )
177{
178    if( server->ctx )
179    {
180        char passwd[MAX_PATH_LENGTH];
181        getPasswordFile( server, passwd, sizeof( passwd ) );
182        unlink( passwd );
183
184        evtimer_del( &server->timer );
185        shttpd_fini( server->ctx );
186        server->ctx = NULL;
187    }
188}
189
190void
191tr_rpcSetEnabled( tr_rpc_server * server, int isEnabled )
192{
193    if( !isEnabled && server->ctx )
194        stopServer( server );
195
196    if( isEnabled && !server->ctx )
197        startServer( server );
198}
199
200int
201tr_rpcIsEnabled( const tr_rpc_server * server )
202{
203    return server->ctx != NULL;
204}
205
206void
207tr_rpcSetPort( tr_rpc_server * server, int port )
208{
209    if( server->port != port )
210    {
211        server->port = port;
212
213        if( server->ctx )
214        {
215            stopServer( server );
216            startServer( server );
217        }
218    }
219}
220
221int
222tr_rpcGetPort( const tr_rpc_server * server )
223{
224    return server->port;
225}
226
227/****
228*****  ACL
229****/
230
231/*
232 * DELIM_CHARS, FOR_EACH_WORD_IN_LIST, isbyte, and testACL are from, or modified from,
233 * shttpd, written by Sergey Lyubka under this license:
234 * "THE BEER-WARE LICENSE" (Revision 42):
235 * Sergey Lyubka wrote this file.  As long as you retain this notice you
236 * can do whatever you want with this stuff. If we meet some day, and you think
237 * this stuff is worth it, you can buy me a beer in return.
238 */
239
240#define  DELIM_CHARS "," /* Separators for lists */
241
242#define FOR_EACH_WORD_IN_LIST(s,len)                                    \
243        for (; s != NULL && (len = strcspn(s, DELIM_CHARS)) != 0;       \
244                        s += len, s+= strspn(s, DELIM_CHARS))
245
246static int isbyte(int n) { return (n >= 0 && n <= 255); }
247
248static char*
249testACL( const char * s )
250{
251    int len;
252
253    FOR_EACH_WORD_IN_LIST(s, len)
254    {
255
256        char flag;
257        int  a, b, c, d, n, mask;
258
259        if( sscanf(s, "%c%d.%d.%d.%d%n",&flag,&a,&b,&c,&d,&n) != 5 )
260            return tr_strdup_printf( _( "[%s]: subnet must be [+|-]x.x.x.x[/x]" ), s );
261        if( flag != '+' && flag != '-')
262            return tr_strdup_printf( _( "[%s]: flag must be + or -" ), s );
263        if( !isbyte(a) || !isbyte(b) || !isbyte(c) || !isbyte(d) )
264            return tr_strdup_printf( _( "[%s]: bad ip address" ), s );
265        if( sscanf(s + n, "/%d", &mask) == 1 && ( mask<0 || mask>32 ) )
266            return tr_strdup_printf( _( "[%s]: bad subnet mask %d" ), s, n );
267    }
268
269    return NULL;
270}
271
272/* 192.*.*.* --> 192.0.0.0/8
273   192.64.*.* --> 192.64.0.0/16
274   192.64.1.* --> 192.64.1.0/24
275   192.64.1.2 --> 192.64.1.2/32 */
276static void
277cidrizeOne( const char * in, int len, struct evbuffer * out )
278{
279    int stars = 0;
280    const char * pch;
281    const char * end;
282    char zero = '0';
283    char huh = '?';
284
285    for( pch=in, end=pch+len; pch!=end; ++pch ) {
286        if( stars && isdigit(*pch) )
287            evbuffer_add( out, &huh, 1 ); 
288        else if( *pch!='*' )
289            evbuffer_add( out, pch, 1 );
290        else {
291            evbuffer_add( out, &zero, 1 );
292            ++stars;
293        }
294    }
295
296    evbuffer_add_printf( out, "/%d", (32-(stars*8)));
297}
298
299char*
300cidrize( const char * acl )
301{
302    int len;
303    const char * walk = acl;
304    char * ret;
305    struct evbuffer * out = evbuffer_new( );
306
307    FOR_EACH_WORD_IN_LIST( walk, len )
308    {
309        cidrizeOne( walk, len, out );
310        evbuffer_add_printf( out, "," );
311    }
312
313    /* the -1 is to eat the final ", " */
314    ret = tr_strndup( (char*) EVBUFFER_DATA(out), EVBUFFER_LENGTH(out)-1 );
315    evbuffer_free( out );
316    return ret;
317}
318
319int
320tr_rpcTestACL( const tr_rpc_server  * server UNUSED,
321               const char           * acl,
322               char                ** setme_errmsg )
323{
324    int err = 0;
325    char * cidr = cidrize( acl );
326    char * errmsg = testACL( cidr );
327    if( errmsg )
328    {
329        if( setme_errmsg )
330            *setme_errmsg = errmsg;
331        else
332            tr_free( errmsg );
333        err = -1;
334    }
335    tr_free( cidr );
336    return err;
337}
338
339int
340tr_rpcSetACL( tr_rpc_server   * server,
341              const char      * acl,
342              char           ** setme_errmsg )
343{
344    char * cidr = cidrize( acl );
345    const int err = tr_rpcTestACL( server, cidr, setme_errmsg );
346
347    if( !err )
348    {
349        const int isRunning = server->ctx != NULL;
350
351        if( isRunning )
352            stopServer( server );
353
354        tr_free( server->acl );
355        server->acl = tr_strdup( cidr );
356        dbgmsg( "setting our ACL to [%s]", server->acl );
357
358        if( isRunning )
359            startServer( server );
360    }
361    tr_free( cidr );
362
363    return err;
364}
365
366char*
367tr_rpcGetACL( const tr_rpc_server * server )
368{
369    return tr_strdup( server->acl ? server->acl : "" );
370}
371
372/****
373*****  PASSWORD
374****/
375
376void
377tr_rpcSetUsername( tr_rpc_server        * server,
378                   const char           * username )
379{
380    const int isRunning = server->ctx != NULL;
381
382    if( isRunning )
383        stopServer( server );
384
385    tr_free( server->username );
386    server->username = tr_strdup( username );
387    dbgmsg( "setting our Username to [%s]", server->username );
388
389    if( isRunning )
390        startServer( server );
391}
392
393char*
394tr_rpcGetUsername( const tr_rpc_server  * server )
395{
396    return tr_strdup( server->username ? server->username : "" );
397}
398
399void
400tr_rpcSetPassword( tr_rpc_server        * server,
401                   const char           * password )
402{
403    const int isRunning = server->ctx != NULL;
404
405    if( isRunning )
406        stopServer( server );
407
408    tr_free( server->password );
409    server->password = tr_strdup( password );
410    dbgmsg( "setting our Password to [%s]", server->password );
411
412    if( isRunning )
413        startServer( server );
414}
415
416char*
417tr_rpcGetPassword( const tr_rpc_server  * server )
418{
419    return tr_strdup( server->password ? server->password : "" );
420}
421
422void
423tr_rpcSetPasswordEnabled( tr_rpc_server  * server,
424                          int              isEnabled )
425{
426    const int isRunning = server->ctx != NULL;
427
428    if( isRunning )
429        stopServer( server );
430
431    server->isPasswordEnabled = isEnabled;
432    dbgmsg( "setting 'password enabled' to %d", isEnabled );
433
434    if( isRunning )
435        startServer( server );
436}
437
438int
439tr_rpcIsPasswordEnabled( const tr_rpc_server * server )
440{
441    return server->isPasswordEnabled;
442}
443
444/****
445*****  LIFE CYCLE
446****/
447
448void
449tr_rpcClose( tr_rpc_server ** ps )
450{
451    tr_rpc_server * s = *ps;
452    *ps = NULL;
453
454    stopServer( s );
455    evbuffer_free( s->in );
456    evbuffer_free( s->out );
457    tr_free( s->acl );
458    tr_free( s );
459}
460
461tr_rpc_server *
462tr_rpcInit( tr_handle   * session,
463            int           isEnabled,
464            int           port,
465            const char  * acl,
466            int           isPasswordEnabled,
467            const char  * username,
468            const char  * password )
469{
470    char * errmsg;
471    tr_rpc_server * s;
472
473    if(( errmsg = testACL ( acl )))
474    {
475        tr_nerr( MY_NAME, errmsg );
476        tr_free( errmsg );
477        acl = TR_DEFAULT_RPC_ACL;
478        tr_nerr( MY_NAME, "using fallback ACL \"%s\"", acl );
479    }
480
481    s = tr_new0( tr_rpc_server, 1 );
482    s->session = session;
483    s->port = port;
484    s->in = evbuffer_new( );
485    s->out = evbuffer_new( );
486    s->acl = tr_strdup( acl );
487    s->username = tr_strdup( username );
488    s->password = tr_strdup( password );
489    s->isPasswordEnabled = isPasswordEnabled;
490   
491    if( isEnabled )
492        startServer( s );
493    return s;   
494}
Note: See TracBrowser for help on using the repository browser.