summaryrefslogtreecommitdiff
path: root/rest/oauth-proxy.h
blob: 2616a34c96e4e6c30bccb67e5ae23d1bd8d4b861 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
 * librest - RESTful web services access
 * Copyright (c) 2008, 2009, Intel Corporation.
 *
 * Authors: Rob Bradford <rob@linux.intel.com>
 *          Ross Burton <ross@linux.intel.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU Lesser General Public License,
 * version 2.1, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

#ifndef _OAUTH_PROXY
#define _OAUTH_PROXY

#include <rest/rest-proxy.h>

G_BEGIN_DECLS

#define OAUTH_TYPE_PROXY oauth_proxy_get_type()
G_DECLARE_FINAL_TYPE (OAuthProxy, oauth_proxy, OAUTH, PROXY, RestProxy)

GType oauth_signature_method_get_type (void) G_GNUC_CONST;
#define OAUTH_TYPE_SIGNATURE_METHOD (oauth_signature_method_get_type())

/**
 * OAuthSignatureMethod:
 * @PLAINTEXT: plain text signatures (not recommended)
 * @HMAC_SHA1: HMAC-SHA1 signatures (recommended)
 *
 * The signature method to use when signing method calls.  @PLAINTEXT is only
 * recommended for testing, in general @HMAC_SHA1 is well supported and more
 * secure.
 */
typedef enum {
  PLAINTEXT,
  HMAC_SHA1
} OAuthSignatureMethod;

RestProxy            *oauth_proxy_new                  (const char           *consumer_key,
                                                        const char           *consumer_secret,
                                                        const gchar          *url_format,
                                                        gboolean              binding_required);
RestProxy            *oauth_proxy_new_with_token       (const char           *consumer_key,
                                                        const char           *consumer_secret,
                                                        const char           *token,
                                                        const char           *token_secret,
                                                        const gchar          *url_format,
                                                        gboolean              binding_required);
gboolean              oauth_proxy_request_token        (OAuthProxy           *proxy,
                                                        const char           *function,
                                                        const char           *callback_uri,
                                                        GError              **error);
void                  oauth_proxy_request_token_async  (OAuthProxy           *proxy,
                                                        const char           *function,
                                                        const char           *callback_uri,
                                                        GCancellable         *cancellable,
                                                        GAsyncReadyCallback   callback,
                                                        gpointer              user_data);
gboolean              oauth_proxy_request_token_finish (OAuthProxy           *proxy,
                                                        GAsyncResult         *result,
                                                        GError              **error);
gboolean              oauth_proxy_is_oauth10a          (OAuthProxy           *proxy);
void                  oauth_proxy_set_oauth10a         (OAuthProxy           *proxy,
                                                        gboolean              oauth10a);
gboolean              oauth_proxy_access_token         (OAuthProxy           *proxy,
                                                        const char           *function,
                                                        const char           *verifier,
                                                        GError              **error);
void                  oauth_proxy_access_token_async   (OAuthProxy           *proxy,
                                                        const char           *function,
                                                        const char           *verifier,
                                                        GCancellable         *cancellable,
                                                        GAsyncReadyCallback   callback,
                                                        gpointer              user_data);
gboolean              oauth_proxy_access_token_finish  (OAuthProxy           *proxy,
                                                        GAsyncResult         *result,
                                                        GError              **error);
const char           *oauth_proxy_get_consumer_key     (OAuthProxy           *proxy);
const char           *oauth_proxy_get_consumer_secret  (OAuthProxy           *proxy);
const char           *oauth_proxy_get_token            (OAuthProxy           *proxy);
void                  oauth_proxy_set_token            (OAuthProxy           *proxy,
                                                        const char           *token);
const char           *oauth_proxy_get_token_secret     (OAuthProxy           *proxy);
void                  oauth_proxy_set_token_secret     (OAuthProxy           *proxy,
                                                        const char           *token_secret);
const char           *oauth_proxy_get_signature_host   (OAuthProxy           *proxy);
void                  oauth_proxy_set_signature_host   (OAuthProxy           *proxy,
                                                        const char           *signature_host);
RestProxy            *oauth_proxy_new_echo_proxy       (OAuthProxy           *proxy,
                                                        const char           *service_url,
                                                        const gchar          *url_format,
                                                        gboolean              binding_required);
gboolean              oauth_proxy_is_echo              (OAuthProxy           *proxy);
const char           *oauth_proxy_get_service_url      (OAuthProxy           *proxy);
OAuthSignatureMethod  oauth_proxy_get_sign_method      (OAuthProxy           *proxy);

G_END_DECLS

#endif /* _OAUTH_PROXY */