source: lib/oauth.h @ 18dbb20

Last change on this file since 18dbb20 was 18dbb20, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-04-27T22:42:07Z

Valgrind cleanup.

  • Property mode set to 100644
File size: 3.3 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 program is free software; you can redistribute it and/or modify     *
9*  it under the terms of the GNU General Public License as published by     *
10*  the Free Software Foundation; either version 2 of the License, or        *
11*  (at your option) any later version.                                      *
12*                                                                           *
13*  This program 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            *
16*  GNU General Public License for more details.                             *
17*                                                                           *
18*  You should have received a copy of the GNU General Public License along  *
19*  with this program; if not, write to the Free Software Foundation, Inc.,  *
20*  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.              *
21*                                                                           *
22\***************************************************************************/
23
24/* http://oauth.net/core/1.0a/ */
25
26struct oauth_info;
27
28/* Callback function called twice during the access token request process.
29   Return FALSE if something broke and the process must be aborted. */
30typedef gboolean (*oauth_cb)( struct oauth_info * );
31
32typedef enum
33{
34        OAUTH_INIT,
35        OAUTH_REQUEST_TOKEN,
36        OAUTH_ACCESS_TOKEN,
37} oauth_stage_t;
38
39struct oauth_info
40{
41        oauth_stage_t stage;
42       
43        oauth_cb func;
44        void *data;
45       
46        struct http_request *http;
47       
48        char *auth_params;
49        char *request_token;
50       
51        char *access_token;
52};
53
54/* http://oauth.net/core/1.0a/#auth_step1 (section 6.1)
55   Request an initial anonymous token which can be used to construct an
56   authorization URL for the user. This is passed to the callback function
57   in a struct oauth_info. */
58struct oauth_info *oauth_request_token( const char *url, oauth_cb func, void *data );
59
60/* http://oauth.net/core/1.0a/#auth_step3 (section 6.3)
61   The user gets a PIN or so which we now exchange for the final access
62   token. This is passed to the callback function in the same
63   struct oauth_info. */
64void oauth_access_token( const char *url, const char *pin, struct oauth_info *st );
65
66/* http://oauth.net/core/1.0a/#anchor12 (section 7)
67   Generate an OAuth Authorization: HTTP header. access_token should be
68   saved/fetched using the functions above. args can be a string with
69   whatever's going to be in the POST body of the request. GET args will
70   automatically be grabbed from url. */
71char *oauth_http_header( char *access_token, const char *method, const char *url, char *args );
72
73/* Shouldn't normally be required unless the process is aborted by the user. */
74void oauth_info_free( struct oauth_info *info );
Note: See TracBrowser for help on using the repository browser.