summaryrefslogtreecommitdiff
path: root/plugins/common/OAuth1Support.vala
blob: 05ba34ffbc17799a46e6a79312b2c2438ca11520 (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/* Copyright 2016 Software Freedom Conservancy Inc.
 * Copyright 2017 Jens Georg <mail@jensge.org>
 *
 * This software is licensed under the GNU Lesser General Public License
 * (version 2.1 or later).  See the COPYING file in this distribution.
 */

namespace Publishing.RESTSupport.OAuth1 {

    public class Session : Publishing.RESTSupport.Session {
        private string? request_phase_token = null;
        private string? request_phase_token_secret = null;
        private string? access_phase_token = null;
        private string? access_phase_token_secret = null;
        private string? username = null;
        private string? consumer_key = null;
        private string? consumer_secret = null;

        public Session(string? endpoint_uri = null) {
            base(endpoint_uri);
        }

        public override bool is_authenticated() {
            return (access_phase_token != null && access_phase_token_secret != null &&
                    username != null);
        }

        public void authenticate_from_persistent_credentials(string token, string secret,
                string username) {
            this.access_phase_token = token;
            this.access_phase_token_secret = secret;
            this.username = username;

            this.authenticated();
        }

        public void deauthenticate() {
            access_phase_token = null;
            access_phase_token_secret = null;
            username = null;
        }

        public void set_api_credentials(string consumer_key, string consumer_secret) {
            this.consumer_key = consumer_key;
            this.consumer_secret = consumer_secret;
        }

        public string sign_transaction(Publishing.RESTSupport.Transaction txn,
                                     Publishing.RESTSupport.Argument[]? extra_arguments = null) {
            string http_method = txn.get_method().to_string();

            debug("signing transaction with parameters:");
            debug("HTTP method = " + http_method);

            Publishing.RESTSupport.Argument[] base_string_arguments = txn.get_arguments();

            foreach (var arg in extra_arguments) {
                base_string_arguments += arg;
            }

            Publishing.RESTSupport.Argument[] sorted_args =
                Publishing.RESTSupport.Argument.sort(base_string_arguments);

            var arguments_string = Argument.serialize_for_sbs(sorted_args);

            string? signing_key = null;
            if (access_phase_token_secret != null) {
                debug("access phase token secret available; using it as signing key");

                signing_key = consumer_secret + "&" + access_phase_token_secret;
            } else if (request_phase_token_secret != null) {
                debug("request phase token secret available; using it as signing key");

                signing_key = consumer_secret + "&" + request_phase_token_secret;
            } else {
                debug("neither access phase nor request phase token secrets available; using API " +
                        "key as signing key");

                signing_key = consumer_secret + "&";
            }

            string signature_base_string = http_method + "&" + GLib.Uri.escape_string(
                    txn.get_endpoint_url()) + "&" +
                GLib.Uri.escape_string (arguments_string);

            debug("signature base string = '%s'", signature_base_string);

            debug("signing key = '%s'", signing_key);

            // compute the signature
            string signature = RESTSupport.hmac_sha1(signing_key, signature_base_string);
            signature = GLib.Uri.escape_string(signature);

            debug("signature = '%s'", signature);

            return signature;
        }

        public void set_request_phase_credentials(string token, string secret) {
            this.request_phase_token = token;
            this.request_phase_token_secret = secret;
        }

        public void set_access_phase_credentials(string token, string secret, string username) {
            this.access_phase_token = token;
            this.access_phase_token_secret = secret;
            this.username = username;

            authenticated();
        }

        public string get_oauth_nonce() {
            return Checksum.compute_for_string(ChecksumType.MD5,
                                               GLib.get_real_time().to_string());
        }

        public string get_oauth_timestamp() {
            return GLib.get_real_time().to_string().substring(0, 10);
        }

        public string get_consumer_key() {
            assert(consumer_key != null);
            return consumer_key;
        }

        public string get_request_phase_token() {
            assert(request_phase_token != null);
            return request_phase_token;
        }

        public string get_access_phase_token() {
            assert(access_phase_token != null);
            return access_phase_token;
        }

        public bool has_access_phase_token() {
            return access_phase_token != null;
        }

        public string get_access_phase_token_secret() {
            assert(access_phase_token_secret != null);
            return access_phase_token_secret;
        }

        public string get_username() {
            assert(is_authenticated());
            return username;
        }
    }

    public class Transaction : Publishing.RESTSupport.Transaction {
        public Transaction(Session session, Publishing.RESTSupport.HttpMethod method =
                Publishing.RESTSupport.HttpMethod.POST) {
            base(session, method);
            setup_arguments();
        }

        public Transaction.with_uri(Session session, string uri,
                Publishing.RESTSupport.HttpMethod method = Publishing.RESTSupport.HttpMethod.POST) {
            base.with_endpoint_url(session, uri, method);
            setup_arguments();
        }

        private void setup_arguments() {
            var session = (Session) get_parent_session();

            add_argument("oauth_nonce", session.get_oauth_nonce());
            add_argument("oauth_signature_method", "HMAC-SHA1");
            add_argument("oauth_version", "1.0");
            add_argument("oauth_timestamp", session.get_oauth_timestamp());
            add_argument("oauth_consumer_key", session.get_consumer_key());
            if (session.has_access_phase_token()) {
                add_argument("oauth_token", session.get_access_phase_token());
            }
        }

        public override async void execute_async() throws Spit.Publishing.PublishingError {
            var signature = ((Session) get_parent_session()).sign_transaction(this);
            add_argument("oauth_signature", signature);

            yield base.execute_async();
        }
    }

    public class UploadTransaction : Publishing.RESTSupport.UploadTransaction {
        protected unowned Publishing.RESTSupport.OAuth1.Session session;
        private Publishing.RESTSupport.Argument[] auth_header_fields;

        public UploadTransaction(Publishing.RESTSupport.OAuth1.Session session,
                                 Spit.Publishing.Publishable publishable,
                                 string endpoint_uri) {
            base.with_endpoint_url(session, publishable, endpoint_uri);

            this.auth_header_fields = new Publishing.RESTSupport.Argument[0];
            this.session = session;

            add_authorization_header_field("oauth_nonce", session.get_oauth_nonce());
            add_authorization_header_field("oauth_signature_method", "HMAC-SHA1");
            add_authorization_header_field("oauth_version", "1.0");
            add_authorization_header_field("oauth_timestamp", session.get_oauth_timestamp());
            add_authorization_header_field("oauth_consumer_key", session.get_consumer_key());
            add_authorization_header_field("oauth_token", session.get_access_phase_token());
        }

        public void add_authorization_header_field(string key, string value) {
            auth_header_fields += new Publishing.RESTSupport.Argument(key, value);
        }

        public string get_authorization_header_string() {
            return "OAuth " + Argument.serialize_list(auth_header_fields, false, true, ", ");
        }

        public void authorize() {
            var signature = session.sign_transaction(this, auth_header_fields);
            add_authorization_header_field("oauth_signature", signature);


            string authorization_header = get_authorization_header_string();

            debug("executing upload transaction: authorization header string = '%s'",
                    authorization_header);
            add_header("Authorization", authorization_header);

        }
    }
}