mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 06:05:44 +00:00
422 lines
12 KiB
JavaScript
422 lines
12 KiB
JavaScript
/* 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/. */
|
|
|
|
/**
|
|
* Temporary abstraction layer for common Fx Accounts operations.
|
|
* For now, we will be using this module only from B2G but in the end we might
|
|
* want this to be merged with FxAccounts.jsm and let other products also use
|
|
* it.
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
this.EXPORTED_SYMBOLS = ["FxAccountsManager"];
|
|
|
|
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
|
|
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/FxAccounts.jsm");
|
|
Cu.import("resource://gre/modules/Promise.jsm");
|
|
Cu.import("resource://gre/modules/FxAccountsCommon.js");
|
|
|
|
this.FxAccountsManager = {
|
|
|
|
init: function() {
|
|
Services.obs.addObserver(this, ONLOGOUT_NOTIFICATION, false);
|
|
},
|
|
|
|
observe: function(aSubject, aTopic, aData) {
|
|
if (aTopic !== ONLOGOUT_NOTIFICATION) {
|
|
return;
|
|
}
|
|
|
|
// Remove the cached session if we get a logout notification.
|
|
this._activeSession = null;
|
|
},
|
|
|
|
// We don't really need to save fxAccounts instance but this way we allow
|
|
// to mock FxAccounts from tests.
|
|
_fxAccounts: fxAccounts,
|
|
|
|
// We keep the session details here so consumers don't need to deal with
|
|
// session tokens and are only required to handle the email.
|
|
_activeSession: null,
|
|
|
|
// We only expose the email and the verified status so far.
|
|
get _user() {
|
|
if (!this._activeSession || !this._activeSession.email) {
|
|
return null;
|
|
}
|
|
|
|
return {
|
|
accountId: this._activeSession.email,
|
|
verified: this._activeSession.verified
|
|
}
|
|
},
|
|
|
|
_error: function(aError, aDetails) {
|
|
log.error(aError);
|
|
let reason = {
|
|
error: aError
|
|
};
|
|
if (aDetails) {
|
|
reason.details = aDetails;
|
|
}
|
|
return Promise.reject(reason);
|
|
},
|
|
|
|
_getError: function(aServerResponse) {
|
|
if (!aServerResponse || !aServerResponse.error || !aServerResponse.error.errno) {
|
|
return;
|
|
}
|
|
let error = SERVER_ERRNO_TO_ERROR[aServerResponse.error.errno];
|
|
return error;
|
|
},
|
|
|
|
_serverError: function(aServerResponse) {
|
|
let error = this._getError({ error: aServerResponse });
|
|
return this._error(error ? error : ERROR_SERVER_ERROR, aServerResponse);
|
|
},
|
|
|
|
// As with _fxAccounts, we don't really need this method, but this way we
|
|
// allow tests to mock FxAccountsClient. By default, we want to return the
|
|
// client used by the fxAccounts object because deep down they should have
|
|
// access to the same hawk request object which will enable them to share
|
|
// local clock skeq data.
|
|
_getFxAccountsClient: function() {
|
|
return this._fxAccounts.getAccountsClient();
|
|
},
|
|
|
|
_signInSignUp: function(aMethod, aAccountId, aPassword) {
|
|
if (Services.io.offline) {
|
|
return this._error(ERROR_OFFLINE);
|
|
}
|
|
|
|
if (!aAccountId) {
|
|
return this._error(ERROR_INVALID_ACCOUNTID);
|
|
}
|
|
|
|
if (!aPassword) {
|
|
return this._error(ERROR_INVALID_PASSWORD);
|
|
}
|
|
|
|
// Check that there is no signed in account first.
|
|
if (this._activeSession) {
|
|
return this._error(ERROR_ALREADY_SIGNED_IN_USER, {
|
|
user: this._user
|
|
});
|
|
}
|
|
|
|
let client = this._getFxAccountsClient();
|
|
return this._fxAccounts.getSignedInUser().then(
|
|
user => {
|
|
if (user) {
|
|
return this._error(ERROR_ALREADY_SIGNED_IN_USER, {
|
|
user: this._user
|
|
});
|
|
}
|
|
return client[aMethod](aAccountId, aPassword);
|
|
}
|
|
).then(
|
|
user => {
|
|
let error = this._getError(user);
|
|
if (!user || !user.uid || !user.sessionToken || error) {
|
|
return this._error(error ? error : ERROR_INTERNAL_INVALID_USER, {
|
|
user: user
|
|
});
|
|
}
|
|
|
|
// If the user object includes an email field, it may differ in
|
|
// capitalization from what we sent down. This is the server's
|
|
// canonical capitalization and should be used instead.
|
|
user.email = user.email || aAccountId;
|
|
return this._fxAccounts.setSignedInUser(user).then(
|
|
() => {
|
|
this._activeSession = user;
|
|
log.debug("User signed in: " + JSON.stringify(this._user) +
|
|
" - Account created " + (aMethod == "signUp"));
|
|
return Promise.resolve({
|
|
accountCreated: aMethod === "signUp",
|
|
user: this._user
|
|
});
|
|
}
|
|
);
|
|
},
|
|
reason => { return this._serverError(reason); }
|
|
);
|
|
},
|
|
|
|
_getAssertion: function(aAudience) {
|
|
return this._fxAccounts.getAssertion(aAudience);
|
|
},
|
|
|
|
_signOut: function() {
|
|
if (!this._activeSession) {
|
|
return Promise.resolve();
|
|
}
|
|
|
|
// We clear the local session cache as soon as we get the onlogout
|
|
// notification triggered within FxAccounts.signOut, so we save the
|
|
// session token value to be able to remove the remote server session
|
|
// in case that we have network connection.
|
|
let sessionToken = this._activeSession.sessionToken;
|
|
|
|
return this._fxAccounts.signOut(sessionToken).then(
|
|
() => {
|
|
// At this point the local session should already be removed.
|
|
|
|
// The client can create new sessions up to the limit (100?).
|
|
// Orphaned tokens on the server will eventually be garbage collected.
|
|
if (Services.io.offline) {
|
|
return Promise.resolve();
|
|
}
|
|
// Otherwise, we try to remove the remote session.
|
|
let client = this._getFxAccountsClient();
|
|
return client.signOut(sessionToken).then(
|
|
result => {
|
|
let error = this._getError(result);
|
|
if (error) {
|
|
return this._error(error, result);
|
|
}
|
|
log.debug("Signed out");
|
|
return Promise.resolve();
|
|
},
|
|
reason => {
|
|
return this._serverError(reason);
|
|
}
|
|
);
|
|
}
|
|
);
|
|
},
|
|
|
|
_uiRequest: function(aRequest, aAudience, aParams) {
|
|
let ui = Cc["@mozilla.org/fxaccounts/fxaccounts-ui-glue;1"]
|
|
.createInstance(Ci.nsIFxAccountsUIGlue);
|
|
if (!ui[aRequest]) {
|
|
return this._error(ERROR_UI_REQUEST);
|
|
}
|
|
|
|
if (!aParams || !Array.isArray(aParams)) {
|
|
aParams = [aParams];
|
|
}
|
|
|
|
return ui[aRequest].apply(this, aParams).then(
|
|
result => {
|
|
// Even if we get a successful result from the UI, the account will
|
|
// most likely be unverified, so we cannot get an assertion.
|
|
if (result && result.verified) {
|
|
return this._getAssertion(aAudience);
|
|
}
|
|
|
|
return this._error(ERROR_UNVERIFIED_ACCOUNT, {
|
|
user: result
|
|
});
|
|
},
|
|
error => {
|
|
return this._error(ERROR_UI_ERROR, error);
|
|
}
|
|
);
|
|
},
|
|
|
|
// -- API --
|
|
|
|
signIn: function(aAccountId, aPassword) {
|
|
return this._signInSignUp("signIn", aAccountId, aPassword);
|
|
},
|
|
|
|
signUp: function(aAccountId, aPassword) {
|
|
return this._signInSignUp("signUp", aAccountId, aPassword);
|
|
},
|
|
|
|
signOut: function() {
|
|
if (!this._activeSession) {
|
|
// If there is no cached active session, we try to get it from the
|
|
// account storage.
|
|
return this.getAccount().then(
|
|
result => {
|
|
if (!result) {
|
|
return Promise.resolve();
|
|
}
|
|
return this._signOut();
|
|
}
|
|
);
|
|
}
|
|
return this._signOut();
|
|
},
|
|
|
|
getAccount: function() {
|
|
// We check first if we have session details cached.
|
|
if (this._activeSession) {
|
|
// If our cache says that the account is not yet verified,
|
|
// we kick off verification before returning what we have.
|
|
if (this._activeSession && !this._activeSession.verified &&
|
|
!Services.io.offline) {
|
|
this.verificationStatus(this._activeSession);
|
|
}
|
|
|
|
log.debug("Account " + JSON.stringify(this._user));
|
|
return Promise.resolve(this._user);
|
|
}
|
|
|
|
// If no cached information, we try to get it from the persistent storage.
|
|
return this._fxAccounts.getSignedInUser().then(
|
|
user => {
|
|
if (!user || !user.email) {
|
|
log.debug("No signed in account");
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
this._activeSession = user;
|
|
// If we get a stored information of a not yet verified account,
|
|
// we kick off verification before returning what we have.
|
|
if (!user.verified && !Services.io.offline) {
|
|
log.debug("Unverified account");
|
|
this.verificationStatus(user);
|
|
}
|
|
|
|
log.debug("Account " + JSON.stringify(this._user));
|
|
return Promise.resolve(this._user);
|
|
}
|
|
);
|
|
},
|
|
|
|
queryAccount: function(aAccountId) {
|
|
log.debug("queryAccount " + aAccountId);
|
|
if (Services.io.offline) {
|
|
return this._error(ERROR_OFFLINE);
|
|
}
|
|
|
|
let deferred = Promise.defer();
|
|
|
|
if (!aAccountId) {
|
|
return this._error(ERROR_INVALID_ACCOUNTID);
|
|
}
|
|
|
|
let client = this._getFxAccountsClient();
|
|
return client.accountExists(aAccountId).then(
|
|
result => {
|
|
log.debug("Account " + result ? "" : "does not" + " exists");
|
|
let error = this._getError(result);
|
|
if (error) {
|
|
return this._error(error, result);
|
|
}
|
|
|
|
return Promise.resolve({
|
|
registered: result
|
|
});
|
|
},
|
|
reason => { this._serverError(reason); }
|
|
);
|
|
},
|
|
|
|
verificationStatus: function() {
|
|
log.debug("verificationStatus");
|
|
if (!this._activeSession || !this._activeSession.sessionToken) {
|
|
this._error(ERROR_NO_TOKEN_SESSION);
|
|
}
|
|
|
|
// There is no way to unverify an already verified account, so we just
|
|
// return the account details of a verified account
|
|
if (this._activeSession.verified) {
|
|
log.debug("Account already verified");
|
|
return;
|
|
}
|
|
|
|
if (Services.io.offline) {
|
|
this._error(ERROR_OFFLINE);
|
|
}
|
|
|
|
let client = this._getFxAccountsClient();
|
|
client.recoveryEmailStatus(this._activeSession.sessionToken).then(
|
|
data => {
|
|
let error = this._getError(data);
|
|
if (error) {
|
|
this._error(error, data);
|
|
}
|
|
// If the verification status has changed, update state.
|
|
if (this._activeSession.verified != data.verified) {
|
|
this._activeSession.verified = data.verified;
|
|
this._fxAccounts.setSignedInUser(this._activeSession);
|
|
}
|
|
log.debug(JSON.stringify(this._user));
|
|
},
|
|
reason => { this._serverError(reason); }
|
|
);
|
|
},
|
|
|
|
/*
|
|
* Try to get an assertion for the given audience.
|
|
*
|
|
* aOptions can include:
|
|
*
|
|
* refreshAuthentication - (bool) Force re-auth.
|
|
*
|
|
* silent - (bool) Prevent any UI interaction.
|
|
* I.e., try to get an automatic assertion.
|
|
*
|
|
*/
|
|
getAssertion: function(aAudience, aOptions) {
|
|
if (!aAudience) {
|
|
return this._error(ERROR_INVALID_AUDIENCE);
|
|
}
|
|
|
|
if (Services.io.offline) {
|
|
return this._error(ERROR_OFFLINE);
|
|
}
|
|
|
|
return this.getAccount().then(
|
|
user => {
|
|
if (user) {
|
|
// We cannot get assertions for unverified accounts.
|
|
if (!user.verified) {
|
|
return this._error(ERROR_UNVERIFIED_ACCOUNT, {
|
|
user: user
|
|
});
|
|
}
|
|
|
|
// RPs might require an authentication refresh.
|
|
if (aOptions &&
|
|
aOptions.refreshAuthentication) {
|
|
let gracePeriod = aOptions.refreshAuthentication;
|
|
if (typeof gracePeriod != 'number' || isNaN(gracePeriod)) {
|
|
return this._error(ERROR_INVALID_REFRESH_AUTH_VALUE);
|
|
}
|
|
|
|
if ((Date.now() / 1000) - this._activeSession.authAt > gracePeriod) {
|
|
// Grace period expired, so we sign out and request the user to
|
|
// authenticate herself again. If the authentication succeeds, we
|
|
// will return the assertion. Otherwise, we will return an error.
|
|
return this._signOut().then(
|
|
() => {
|
|
if (aOptions.silent) {
|
|
return Promise.resolve(null);
|
|
}
|
|
return this._uiRequest(UI_REQUEST_REFRESH_AUTH,
|
|
aAudience, user.accountId);
|
|
}
|
|
);
|
|
}
|
|
}
|
|
|
|
return this._getAssertion(aAudience);
|
|
}
|
|
|
|
log.debug("No signed in user");
|
|
|
|
if (aOptions && aOptions.silent) {
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
// If there is no currently signed in user, we trigger the signIn UI
|
|
// flow.
|
|
return this._uiRequest(UI_REQUEST_SIGN_IN_FLOW, aAudience);
|
|
}
|
|
);
|
|
}
|
|
|
|
};
|
|
|
|
FxAccountsManager.init();
|