1# OAuth 1.0 and 2.0 for Qt
2
3This library encapsulates the OAuth 1.0 and 2.0 client authentication flows, and the sending of authenticated HTTP requests.
4
5The primary target is Qt Quick applications on embedded devices.
6
7Notes to contributors:
8
9   * Please follow the coding style of the existing source
10   * Code contributions are released under Simplified BSD License, as specified in LICENSE. Do not contribute if this license does not suit your code
11
12## Classes
13
14Class | Header | Purpose
15:-- | :-- | :--
16O0AbstractStore | o0abstractstore.h | Base class of persistent stores
17O0BaseAuth | o0baseauth.h | Base class of OAuth authenticators
18O0SettingsStore | o0settingsstore.h | QSettings-based persistent store
19o0keyChainStore | o0keychainstore.h | Settings stored through the system keychain [keychain](https://github.com/frankosterfeld/qtkeychain)
20O0SimpleCrypt | o0simplecrypt.h | Simple encryption and decryption by Andre Somers
21O1 | o1.h | Generic OAuth 1.0 authenticator
22O1Dropbox | o1dropbox.h | Dropbox OAuth specialization
23O1Flickr | o1flickr.h | Flickr OAuth specialization
24O1Freshbooks | o1freshbooks.h | Freshbooks OAuth specialization
25O1Requestor | o1requestor.h | Makes authenticated OAuth 1.0 requests: GET, POST or PUT, handles timeouts
26O1RequestParameter | o1.h | An extra request parameter participating in request signing
27O1Twitter | o1twitter.h | Twitter OAuth specialization
28O1SmugMug | o1smugmug.h | SmugMug OAuth specialization
29O2 | o2.h | Generic OAuth 2.0 authenticator
30O2Facebook | o2facebook.h | Facebook OAuth specialization
31O2Gft | o2gft.h | Google Fusion Tables OAuth specialization
32O2Google | o2google.h | Google Oauth specialization [scopes](https://developers.google.com/identity/protocols/googlescopes)
33O2Hubic | o2hubic.h | Hubic OAuth specialization
34O2Reply | o2reply.h | A network request/reply that can time out
35O2ReplyServer | o2replyserver.h | HTTP server to process authentication responses
36O2Requestor | o2requestor.h | Makes authenticated OAuth 2.0 requests (GET, POST or PUT), handles timeouts and token expiry
37O2Skydrive | o2skydrive.h | OneDrive OAuth specialization
38O2SurveyMonkey | o2surveymonkey.h | SurveyMonkey OAuth specialization
39OXTwitter | oxtwitter.h | Twitter XAuth specialization
40
41## Installation
42
43Clone the Github repository, then add all files in *src* to your Qt project, by including *src/src.pri*.
44
45## Basic Usage
46
47This example assumes a hypothetical Twitter client that will post tweets. Twitter is using OAuth 1.0.
48
49### Setup
50
51Include the required header files, and have some member variables that will be used for authentication and sending requests:
52
53    #include "o1twitter.h"
54    #include "o1requestor.h"
55    O1Twitter *o1;
56
57### Initialization
58
59Instantiate one of the authenticator classes, like O1Twitter, set your application ID and application secret, and install the signal handlers:
60
61    o1 = new O1Twitter(this);
62    o1->setClientId(MY_CLIENT_ID);
63    o1->setClientSecret(MY_CLIENT_SECRET);
64    connect(o1, SIGNAL(linkedChanged()), this, SLOT(onLinkedChanged()));
65    connect(o1, SIGNAL(linkingFailed()), this, SLOT(onLinkingFailed()));
66    connect(o1, SIGNAL(linkingSucceeded()), this, SLOT(onLinkingSucceeded()));
67    connect(o1, SIGNAL(openBrowser(QUrl)), this, SLOT(onOpenBrowser(QUrl)));
68    connect(o1, SIGNAL(closeBrowser()), this, SLOT(onCloseBrowser()));
69
70**Note:** For browserless Twitter authentication, you can use the OXTwitter specialized class which can do Twitter XAuth. You will need to additionally provide your Twitter login credentials (username & password) before calling *link()*.
71
72### Handling Signals
73
74O2 is an asynchronous library. It will send signals at various stages of authentication and request processing.
75
76To handle these signals, implement the following slots in your code:
77
78    void onLinkedChanged() {
79        // Linking (login) state has changed.
80        // Use o1->linked() to get the actual state
81    }
82
83    void onLinkingFailed() {
84        // Login has failed
85    }
86
87    void onLinkingSucceeded() {
88        // Login has succeeded
89    }
90
91    void onOpenBrowser(const QUrl *url) {
92        // Open a web browser or a web view with the given URL.
93        // The user will interact with this browser window to
94        // enter login name, password, and authorize your application
95        // to access the Twitter account
96    }
97
98    void onCloseBrowser() {
99        // Close the browser window opened in openBrowser()
100    }
101
102### Logging In
103
104To log in (e.g. to link your application to the OAuth service), call the link() method:
105
106    o1->link();
107
108This initiates the authentication sequence. Your signal handlers above will be called at various stages. Lastly, if linking succeeds, onLinkingSucceeded() will be called.
109
110### Logging Out
111
112To log out, call the unlink() method:
113
114    o1->unlink();
115
116Logging out always succeeds, and requires no user interaction.
117
118### Sending Authenticated Requests
119
120Once linked, you can start sending authenticated requests to the service. We start with a simple example of sending a text-only tweet or as it's known in Twitter docs, a 'status update'.
121
122First we need a Qt network manager and an O1 requestor object:
123
124    QNetworkAccessManager *manager = new QNetworkAccessManager(this);
125    O1Requestor *requestor = new O1Requestor(manager, o1, this);
126
127Next, create parameters for posting the update:
128
129    QByteArray paramName("status");
130    QByteArray tweetText("My first tweet!");
131
132    QList<O1RequestParameter> requestParams = QList<O1RequestParameter>();
133    requestParams << O1RequestParameter(paramName, tweetText);
134
135    QByteArray postData = O1::createQueryParams(requestParams);
136
137    // Using Twitter's REST API ver 1.1
138    QUrl url = QUrl("https://api.twitter.com/1.1/statuses/update.json");
139
140    QNetworkRequest request(url);
141    request.setHeader(QNetworkRequest::ContentTypeHeader, O2_MIME_TYPE_XFORM);
142
143Finally we authenticate and send the request using the O1 requestor object:
144
145    QNetworkReply *reply = requestor->post(request, reqestParams, postData);
146
147Continuing with the example, we will now send a tweet containing an image as well as a message.
148
149We create an HTTP request containing the image and the message, in the format specified by Twitter:
150
151    QString imagePath("/tmp/image.jpg");
152    QString message("My tweet with an image!");
153
154    QFileInfo fileInfo(imagePath);
155    QFile file(imagePath);
156    file.open(QIODevice::ReadOnly);
157
158    QString boundary("7d44e178b0439");
159    QByteArray data(QString("--" + boundary + "\r\n").toAscii());
160    data += "Content-Disposition: form-data; name=\"media[]\"; filename=\"" + fileInfo.fileName() + "\"\r\n";
161    data += "Content-Transfer-Encoding: binary\r\n";
162    data += "Content-Type: application/octet-stream\r\n\r\n";
163    data += file.readAll();
164    file.close();
165    data += QString("\r\n--") + boundary + "\r\n";
166    data += "Content-Disposition: form-data; name=\"status\"\r\n";
167    data += "Content-Transfer-Encoding: binary\r\n";
168    data += "Content-Type: text/plain; charset=utf-8\r\n\r\n";
169    data += message.toUtf8();
170    data += QString("\r\n--") + boundary + "--\r\n";
171
172    QNetworkRequest request;
173    // Using Twitter's REST API ver 1.1
174    request.setUrl(QUrl("https://api.twitter.com/1.1/statuses/update_with_media.json"));
175    request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + boundary);
176    request.setHeader(QNetworkRequest::ContentLengthHeader, data.length());
177
178    QNetworkReply *reply = requestor->post(request, QList<O1RequestParameter>(), data);
179
180That's it. Tweets using the O2 library!
181
182### Storing OAuth Tokens
183
184O2 provides simple storage classes for writing OAuth tokens in a peristent location. Currently, a QSettings based backing store **O2SettingsStore** is provided in O2. O2SettingsStore keeps all token values in an encrypted form. You have to specify the encryption key to use while constructing the object:
185
186    O0SettingsStore settings = new O0SettingsStore("myencryptionkey");
187    // Set the store before starting OAuth, i.e before calling link()
188    o1->setStore(settings);
189    ...
190
191You can also create it with your customized QSettings object. O2SettingsStore will then use that QSettings object for storing the tokens:
192
193    O0SettingsStore settings = new O0SettingsStore(mySettingsObject, "myencryptionkey");
194
195Once set, O2SettingsStore takes ownership of the QSettings object.
196
197**Note:** If you do not specify a storage object to use, O2 will create one by default (which QSettings based), and use it. In such a case, a default encryption key is used for encrypting the data. *This is not a secure solution: prefer storing the tokens in a Keychain or Wallet based facility instead*.
198
199**Note:** If using O2SettingsStore, make sure organization name, domain and application name are set:
200
201```
202QCoreApplication::setOrganizationName("MySoft");
203QCoreApplication::setOrganizationDomain("mysoft.com");
204QCoreApplication::setApplicationName("Star Runner");
205```
206
207### Extra OAuth Tokens
208
209Some OAuth service providers provide additional information in the access token response. Eg: Twitter returns 2 additional tokens in it's access token response - *screen_name* and *user_id*.
210
211O2 provides all such tokens via the property - *extraTokens*. You can query this property after a successful OAuth exchange, i.e after the *linkingSucceeded()* signal has been emitted.
212
213## More Examples
214
215The *examples* folder contains complete example applications:
216
217Name | Description
218:-- | :--
219facebookdemo | Command line application authenticating with Facebook
220sialis | QT Quick Twitter client using OAuth 1
221twitterdemo | Command line client for authenticating with Twitter and posting status updates. Uses OAuth 1 or Twitter XAuth
222
223## Change Log
224
225### 0.1.0
226
227* Persist the extra tokens, too
228* Add Qt Quick Twitter client example
229
230
231
232
233