source: lib/oauth.c @ f68fd5f

3.0.2
Last change on this file since f68fd5f was 93cc86f, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-03-08T06:24:34Z

Twitter: Warn the user if the OAuth username and the configured username
don't match. This is not a real problem but can be confusing if you don't
expect it.
  • Property mode set to 100644
File size: 12.0 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Simple OAuth client (consumer) implementation.                           *
5*                                                                           *
6*  Copyright 2010 Wilmer van der Gaast <wilmer@gaast.net>                   *
7*                                                                           *
8*  This library is free software; you can redistribute it and/or            *
9*  modify it under the terms of the GNU Lesser General Public               *
10*  License as published by the Free Software Foundation, version            *
11*  2.1.                                                                     *
12*                                                                           *
13*  This library is distributed in the hope that it will be useful,          *
14*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
15*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU        *
16*  Lesser General Public License for more details.                          *
17*                                                                           *
18*  You should have received a copy of the GNU Lesser General Public License *
19*  along with this library; if not, write to the Free Software Foundation,  *
20*  Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA           *
21*                                                                           *
22\***************************************************************************/
23
24#include <glib.h>
25#include <gmodule.h>
26#include <stdlib.h>
27#include <string.h>
28#include "http_client.h"
29#include "base64.h"
30#include "misc.h"
31#include "sha1.h"
32#include "url.h"
33#include "oauth.h"
34
35#define HMAC_BLOCK_SIZE 64
36
37static char *oauth_sign( const char *method, const char *url,
38                         const char *params, struct oauth_info *oi )
39{
40        sha1_state_t sha1;
41        uint8_t hash[sha1_hash_size];
42        uint8_t key[HMAC_BLOCK_SIZE+1];
43        char *s;
44        int i;
45       
46        /* Create K. If our current key is >64 chars we have to hash it,
47           otherwise just pad. */
48        memset( key, 0, HMAC_BLOCK_SIZE );
49        i = strlen( oi->sp->consumer_secret ) + 1 + ( oi->token_secret ? strlen( oi->token_secret ) : 0 );
50        if( i > HMAC_BLOCK_SIZE )
51        {
52                sha1_init( &sha1 );
53                sha1_append( &sha1, (uint8_t*) oi->sp->consumer_secret, strlen( oi->sp->consumer_secret ) );
54                sha1_append( &sha1, (uint8_t*) "&", 1 );
55                if( oi->token_secret )
56                        sha1_append( &sha1, (uint8_t*) oi->token_secret, strlen( oi->token_secret ) );
57                sha1_finish( &sha1, key );
58        }
59        else
60        {
61                g_snprintf( (gchar*) key, HMAC_BLOCK_SIZE + 1, "%s&%s",
62                            oi->sp->consumer_secret, oi->token_secret ? oi->token_secret : "" );
63        }
64       
65        /* Inner part: H(K XOR 0x36, text) */
66        sha1_init( &sha1 );
67       
68        for( i = 0; i < HMAC_BLOCK_SIZE; i ++ )
69                key[i] ^= 0x36;
70        sha1_append( &sha1, key, HMAC_BLOCK_SIZE );
71       
72        /* OAuth: text = method&url&params, all http_encoded. */
73        sha1_append( &sha1, (const uint8_t*) method, strlen( method ) );
74        sha1_append( &sha1, (const uint8_t*) "&", 1 );
75       
76        s = g_new0( char, strlen( url ) * 3 + 1 );
77        strcpy( s, url );
78        http_encode( s );
79        sha1_append( &sha1, (const uint8_t*) s, strlen( s ) );
80        sha1_append( &sha1, (const uint8_t*) "&", 1 );
81        g_free( s );
82       
83        s = g_new0( char, strlen( params ) * 3 + 1 );
84        strcpy( s, params );
85        http_encode( s );
86        sha1_append( &sha1, (const uint8_t*) s, strlen( s ) );
87        g_free( s );
88       
89        sha1_finish( &sha1, hash );
90       
91        /* Final result: H(K XOR 0x5C, inner stuff) */
92        sha1_init( &sha1 );
93        for( i = 0; i < HMAC_BLOCK_SIZE; i ++ )
94                key[i] ^= 0x36 ^ 0x5c;
95        sha1_append( &sha1, key, HMAC_BLOCK_SIZE );
96        sha1_append( &sha1, hash, sha1_hash_size );
97        sha1_finish( &sha1, hash );
98       
99        /* base64_encode + HTTP escape it (both consumers
100           need it that away) and we're done. */
101        s = base64_encode( hash, sha1_hash_size );
102        s = g_realloc( s, strlen( s ) * 3 + 1 );
103        http_encode( s );
104       
105        return s;
106}
107
108static char *oauth_nonce()
109{
110        unsigned char bytes[9];
111       
112        random_bytes( bytes, sizeof( bytes ) );
113        return base64_encode( bytes, sizeof( bytes ) );
114}
115
116void oauth_params_add( GSList **params, const char *key, const char *value )
117{
118        char *item;
119       
120        item = g_strdup_printf( "%s=%s", key, value );
121        *params = g_slist_insert_sorted( *params, item, (GCompareFunc) strcmp );
122}
123
124void oauth_params_del( GSList **params, const char *key )
125{
126        int key_len = strlen( key );
127        GSList *l, *n;
128       
129        for( l = *params; l; l = n )
130        {
131                n = l->next;
132               
133                if( strncmp( (char*) l->data, key, key_len ) == 0 &&
134                    ((char*)l->data)[key_len] == '=' )
135                {
136                        g_free( l->data );
137                        *params = g_slist_remove( *params, l->data );
138                }
139        }
140}
141
142void oauth_params_set( GSList **params, const char *key, const char *value )
143{
144        oauth_params_del( params, key );
145        oauth_params_add( params, key, value );
146}
147
148const char *oauth_params_get( GSList **params, const char *key )
149{
150        int key_len = strlen( key );
151        GSList *l;
152       
153        for( l = *params; l; l = l->next )
154        {
155                if( strncmp( (char*) l->data, key, key_len ) == 0 &&
156                    ((char*)l->data)[key_len] == '=' )
157                        return (const char*) l->data + key_len + 1;
158        }
159       
160        return NULL;
161}
162
163static void oauth_params_parse( GSList **params, char *in )
164{
165        char *amp, *eq, *s;
166       
167        while( in && *in )
168        {
169                eq = strchr( in, '=' );
170                if( !eq )
171                        break;
172               
173                *eq = '\0';
174                if( ( amp = strchr( eq + 1, '&' ) ) )
175                        *amp = '\0';
176               
177                s = g_strdup( eq + 1 );
178                http_decode( s );
179                oauth_params_add( params, in, s );
180                g_free( s );
181               
182                *eq = '=';
183                if( amp == NULL )
184                        break;
185               
186                *amp = '&';
187                in = amp + 1;
188        }
189}
190
191void oauth_params_free( GSList **params )
192{
193        while( params && *params )
194        {
195                g_free( (*params)->data );
196                *params = g_slist_remove( *params, (*params)->data );
197        }
198}
199
200char *oauth_params_string( GSList *params )
201{
202        GSList *l;
203        GString *str = g_string_new( "" );
204       
205        for( l = params; l; l = l->next )
206        {
207                char *s, *eq;
208               
209                s = g_malloc( strlen( l->data ) * 3 + 1 );
210                strcpy( s, l->data );
211                if( ( eq = strchr( s, '=' ) ) )
212                        http_encode( eq + 1 );
213                g_string_append( str, s );
214                g_free( s );
215               
216                if( l->next )
217                        g_string_append_c( str, '&' );
218        }
219       
220        return g_string_free( str, FALSE );
221}
222
223void oauth_info_free( struct oauth_info *info )
224{
225        if( info )
226        {
227                g_free( info->auth_url );
228                g_free( info->request_token );
229                g_free( info->token );
230                g_free( info->token_secret );
231                oauth_params_free( &info->params );
232                g_free( info );
233        }
234}
235
236static void oauth_add_default_params( GSList **params, const struct oauth_service *sp )
237{
238        char *s;
239       
240        oauth_params_set( params, "oauth_consumer_key", sp->consumer_key );
241        oauth_params_set( params, "oauth_signature_method", "HMAC-SHA1" );
242       
243        s = g_strdup_printf( "%d", (int) time( NULL ) );
244        oauth_params_set( params, "oauth_timestamp", s );
245        g_free( s );
246       
247        s = oauth_nonce();
248        oauth_params_set( params, "oauth_nonce", s );
249        g_free( s );
250       
251        oauth_params_set( params, "oauth_version", "1.0" );
252}
253
254static void *oauth_post_request( const char *url, GSList **params_, http_input_function func, struct oauth_info *oi )
255{
256        GSList *params = NULL;
257        char *s, *params_s, *post;
258        void *req;
259        url_t url_p;
260       
261        if( !url_set( &url_p, url ) )
262        {
263                oauth_params_free( params_ );
264                return NULL;
265        }
266       
267        if( params_ )
268                params = *params_;
269       
270        oauth_add_default_params( &params, oi->sp );
271       
272        params_s = oauth_params_string( params );
273        oauth_params_free( &params );
274       
275        s = oauth_sign( "POST", url, params_s, oi );
276        post = g_strdup_printf( "%s&oauth_signature=%s", params_s, s );
277        g_free( params_s );
278        g_free( s );
279       
280        s = g_strdup_printf( "POST %s HTTP/1.0\r\n"
281                             "Host: %s\r\n"
282                             "Content-Type: application/x-www-form-urlencoded\r\n"
283                             "Content-Length: %zd\r\n"
284                             "\r\n"
285                             "%s", url_p.file, url_p.host, strlen( post ), post );
286        g_free( post );
287       
288        req = http_dorequest( url_p.host, url_p.port, url_p.proto == PROTO_HTTPS,
289                              s, func, oi );
290        g_free( s );
291       
292        return req;
293}
294
295static void oauth_request_token_done( struct http_request *req );
296
297struct oauth_info *oauth_request_token( const struct oauth_service *sp, oauth_cb func, void *data )
298{
299        struct oauth_info *st = g_new0( struct oauth_info, 1 );
300        GSList *params = NULL;
301       
302        st->func = func;
303        st->data = data;
304        st->sp = sp;
305       
306        oauth_params_add( &params, "oauth_callback", "oob" );
307       
308        if( !oauth_post_request( sp->url_request_token, &params, oauth_request_token_done, st ) )
309        {
310                oauth_info_free( st );
311                return NULL;
312        }
313       
314        return st;
315}
316
317static void oauth_request_token_done( struct http_request *req )
318{
319        struct oauth_info *st = req->data;
320       
321        st->http = req;
322       
323        if( req->status_code == 200 )
324        {
325                GSList *params = NULL;
326               
327                st->auth_url = g_strdup_printf( "%s?%s", st->sp->url_authorize, req->reply_body );
328                oauth_params_parse( &params, req->reply_body );
329                st->request_token = g_strdup( oauth_params_get( &params, "oauth_token" ) );
330                oauth_params_free( &params );
331        }
332       
333        st->stage = OAUTH_REQUEST_TOKEN;
334        st->func( st );
335}
336
337static void oauth_access_token_done( struct http_request *req );
338
339gboolean oauth_access_token( const char *pin, struct oauth_info *st )
340{
341        GSList *params = NULL;
342       
343        oauth_params_add( &params, "oauth_token", st->request_token );
344        oauth_params_add( &params, "oauth_verifier", pin );
345       
346        return oauth_post_request( st->sp->url_access_token, &params, oauth_access_token_done, st ) != NULL;
347}
348
349static void oauth_access_token_done( struct http_request *req )
350{
351        struct oauth_info *st = req->data;
352       
353        st->http = req;
354       
355        if( req->status_code == 200 )
356        {
357                oauth_params_parse( &st->params, req->reply_body );
358                st->token = g_strdup( oauth_params_get( &st->params, "oauth_token" ) );
359                st->token_secret = g_strdup( oauth_params_get( &st->params, "oauth_token_secret" ) );
360        }
361       
362        st->stage = OAUTH_ACCESS_TOKEN;
363        if( st->func( st ) )
364        {
365                /* Don't need these anymore, but keep the rest. */
366                g_free( st->auth_url );
367                st->auth_url = NULL;
368                g_free( st->request_token );
369                st->request_token = NULL;
370                oauth_params_free( &st->params );
371        }
372}
373
374char *oauth_http_header( struct oauth_info *oi, const char *method, const char *url, char *args )
375{
376        GSList *params = NULL, *l;
377        char *sig = NULL, *params_s, *s;
378        GString *ret = NULL;
379       
380        oauth_params_add( &params, "oauth_token", oi->token );
381        oauth_add_default_params( &params, oi->sp );
382       
383        /* Start building the OAuth header. 'key="value", '... */
384        ret = g_string_new( "OAuth " );
385        for( l = params; l; l = l->next )
386        {
387                char *kv = l->data;
388                char *eq = strchr( kv, '=' );
389                char esc[strlen(kv)*3+1];
390               
391                if( eq == NULL )
392                        break; /* WTF */
393               
394                strcpy( esc, eq + 1 );
395                http_encode( esc );
396               
397                g_string_append_len( ret, kv, eq - kv + 1 );
398                g_string_append_c( ret, '"' );
399                g_string_append( ret, esc );
400                g_string_append( ret, "\", " );
401        }
402       
403        /* Now, before generating the signature, add GET/POST arguments to params
404           since they should be included in the base signature string (but not in
405           the HTTP header). */
406        if( args )
407                oauth_params_parse( &params, args );
408        if( ( s = strchr( url, '?' ) ) )
409        {
410                s = g_strdup( s + 1 );
411                oauth_params_parse( &params, s );
412                g_free( s );
413        }
414       
415        /* Append the signature and we're done! */
416        params_s = oauth_params_string( params );
417        sig = oauth_sign( method, url, params_s, oi );
418        g_string_append_printf( ret, "oauth_signature=\"%s\"", sig );
419        g_free( params_s );
420       
421        oauth_params_free( &params );
422        g_free( sig );
423       
424        return ret ? g_string_free( ret, FALSE ) : NULL;
425}
426
427char *oauth_to_string( struct oauth_info *oi )
428{
429        GSList *params = NULL;
430        char *ret;
431       
432        oauth_params_add( &params, "oauth_token", oi->token );
433        oauth_params_add( &params, "oauth_token_secret", oi->token_secret );
434        ret = oauth_params_string( params );
435        oauth_params_free( &params );
436       
437        return ret;
438}
439
440struct oauth_info *oauth_from_string( char *in, const struct oauth_service *sp )
441{
442        struct oauth_info *oi = g_new0( struct oauth_info, 1 );
443        GSList *params = NULL;
444       
445        oauth_params_parse( &params, in );
446        oi->token = g_strdup( oauth_params_get( &params, "oauth_token" ) );
447        oi->token_secret = g_strdup( oauth_params_get( &params, "oauth_token_secret" ) );
448        oauth_params_free( &params );
449        oi->sp = sp;
450       
451        return oi;
452}
Note: See TracBrowser for help on using the repository browser.