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
229
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* Provides OAuth 2.0 authentication.
* @see RFC 6749
*/
var EXPORTED_SYMBOLS = ["OAuth2"];
var {classes: Cc, interfaces: Ci, results: Cr, utils: Cu} = Components;
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
Cu.import("resource:///modules/gloda/log4moz.js");
Cu.importGlobalProperties(["fetch"]);
// Only allow one connecting window per endpoint.
var gConnecting = {};
function OAuth2(aBaseURI, aScope, aAppKey, aAppSecret) {
this.authURI = aBaseURI + "oauth2/auth";
this.tokenURI = aBaseURI + "oauth2/token";
this.consumerKey = aAppKey;
this.consumerSecret = aAppSecret;
this.scope = aScope;
this.extraAuthParams = [];
this.log = Log4Moz.getConfiguredLogger("TBOAuth");
}
OAuth2.prototype = {
consumerKey: null,
consumerSecret: null,
completionURI: "http://localhost",
requestWindowURI: "chrome://messenger/content/browserRequest.xul",
requestWindowFeatures: "chrome,private,centerscreen,width=980,height=600",
requestWindowTitle: "",
scope: null,
accessToken: null,
refreshToken: null,
tokenExpires: 0,
connect: function connect(aSuccess, aFailure, aWithUI, aRefresh) {
this.connectSuccessCallback = aSuccess;
this.connectFailureCallback = aFailure;
if (!aRefresh && this.accessToken) {
aSuccess();
} else if (this.refreshToken) {
this.requestAccessToken(this.refreshToken, true);
} else {
if (!aWithUI) {
aFailure('{ "error": "auth_noui" }');
return;
}
if (gConnecting[this.authURI]) {
aFailure("Window already open");
return;
}
this.requestAuthorization();
}
},
requestAuthorization: function requestAuthorization() {
let params = [
["response_type", "code"],
["client_id", this.consumerKey],
["redirect_uri", this.completionURI],
];
// The scope can be optional.
if (this.scope) {
params.push(["scope", this.scope]);
}
// Add extra parameters
params.push(...this.extraAuthParams);
// Now map the parameters to a string
params = params.map(([k,v]) => k + "=" + encodeURIComponent(v)).join("&");
this._browserRequest = {
account: this,
url: this.authURI + "?" + params,
_active: true,
iconURI: "",
cancelled: function() {
if (!this._active) {
return;
}
this.account.finishAuthorizationRequest();
this.account.onAuthorizationFailed(Components.results.NS_ERROR_ABORT, '{ "error": "cancelled"}');
},
loaded: function (aWindow, aWebProgress) {
if (!this._active) {
return;
}
this._listener = {
window: aWindow,
webProgress: aWebProgress,
_parent: this.account,
QueryInterface: XPCOMUtils.generateQI([Ci.nsIWebProgressListener,
Ci.nsISupportsWeakReference]),
_cleanUp: function() {
this.webProgress.removeProgressListener(this);
this.window.close();
delete this.window;
},
_checkForRedirect: function(aURL) {
if (aURL.indexOf(this._parent.completionURI) != 0)
return;
this._parent.finishAuthorizationRequest();
this._parent.onAuthorizationReceived(aURL);
},
onStateChange: function(aWebProgress, aRequest, aStateFlags, aStatus) {
const wpl = Ci.nsIWebProgressListener;
if (aStateFlags & (wpl.STATE_START | wpl.STATE_IS_NETWORK))
this._checkForRedirect(aRequest.name);
},
onLocationChange: function(aWebProgress, aRequest, aLocation) {
this._checkForRedirect(aLocation.spec);
},
onProgressChange: function() {},
onStatusChange: function() {},
onSecurityChange: function() {},
};
aWebProgress.addProgressListener(this._listener,
Ci.nsIWebProgress.NOTIFY_ALL);
aWindow.document.title = this.account.requestWindowTitle;
}
};
this.wrappedJSObject = this._browserRequest;
gConnecting[this.authURI] = true;
Services.ww.openWindow(null, this.requestWindowURI, null, this.requestWindowFeatures, this);
},
finishAuthorizationRequest: function() {
gConnecting[this.authURI] = false;
if (!("_browserRequest" in this)) {
return;
}
this._browserRequest._active = false;
if ("_listener" in this._browserRequest) {
this._browserRequest._listener._cleanUp();
}
delete this._browserRequest;
},
// @see RFC 6749 section 4.1.2: Authorization Response
onAuthorizationReceived(aURL) {
this.log.info("OAuth2 authorization received: url=" + aURL);
let params = new URLSearchParams(aURL.split("?", 2)[1]);
if (params.has("code")) {
this.requestAccessToken(params.get("code"), false);
} else {
this.onAuthorizationFailed(null, aURL);
}
},
onAuthorizationFailed: function(aError, aData) {
this.connectFailureCallback(aData);
},
/**
* Request a new access token, or refresh an existing one.
* @param {string} aCode - The token issued to the client.
* @param {boolean} aRefresh - Whether it's a refresh of a token or not.
*/
requestAccessToken(aCode, aRefresh) {
// @see RFC 6749 section 4.1.3. Access Token Request
// @see RFC 6749 section 6. Refreshing an Access Token
let data = new URLSearchParams();
data.append("client_id", this.consumerKey);
data.append("client_secret", this.consumerSecret);
if (aRefresh) {
data.append("grant_type", "refresh_token");
data.append("refresh_token", aCode);
} else {
data.append("grant_type", "authorization_code");
data.append("code", aCode);
data.append("redirect_uri", this.completionURI);
}
this.log.info(
`Making access token request to the token endpoint: ${this.tokenURI}`
);
fetch(this.tokenURI, {
method: "POST",
cache: "no-cache",
body: data,
})
.then(response => response.json())
.then(result => {
this.log.info("The authorization server issued an access token.");
this.accessToken = result.access_token;
if ("refresh_token" in result) {
this.refreshToken = result.refresh_token;
}
if ("expires_in" in result) {
this.tokenExpires = new Date().getTime() + result.expires_in * 1000;
} else {
this.tokenExpires = Number.MAX_VALUE;
}
this.tokenType = result.token_type;
this.connectSuccessCallback();
})
.catch(err => {
// Getting an access token failed.
this.log.info(
`The authorization server returned an error response: ${err}`
);
this.connectFailureCallback(err);
});
}
};
|
