Dactyloidae/mailnews/base/prefs/content/accountcreation/readFromXML.js
Matt A. Tobin 1531d6498d Issue #1258 - Part 8: Ifdef MailNews OAuth2 Support
Use --disable-mailnews-oauth2 to exclude it. Confvars won't be respected.
2019-11-17 00:09:28 +08:00

243 lines
8.7 KiB
JavaScript

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
/**
* Takes an XML snipplet (as JXON) and reads the values into
* a new AccountConfig object.
* It does so securely (or tries to), by trying to avoid remote execution
* and similar holes which can appear when reading too naively.
* Of course it cannot tell whether the actual values are correct,
* e.g. it can't tell whether the host name is a good server.
*
* The XML format is documented at
* <https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat>
*
* @param clientConfigXML {JXON} The <clientConfig> node.
* @return AccountConfig object filled with the data from XML
*/
Components.utils.import("resource:///modules/hostnameUtils.jsm");
function readFromXML(clientConfigXML)
{
function array_or_undef(value) {
return value === undefined ? [] : value;
}
var exception;
if (typeof(clientConfigXML) != "object" ||
!("clientConfig" in clientConfigXML) ||
!("emailProvider" in clientConfigXML.clientConfig))
{
dump("client config xml = " + JSON.stringify(clientConfigXML) + "\n");
var stringBundle = getStringBundle(
"chrome://messenger/locale/accountCreationModel.properties");
throw stringBundle.GetStringFromName("no_emailProvider.error");
}
var xml = clientConfigXML.clientConfig.emailProvider;
var d = new AccountConfig();
d.source = AccountConfig.kSourceXML;
d.id = sanitize.hostname(xml["@id"]);
d.displayName = d.id;
try {
d.displayName = sanitize.label(xml.displayName);
} catch (e) { logException(e); }
for (var domain of xml.$domain)
{
try {
d.domains.push(sanitize.hostname(domain));
} catch (e) { logException(e); exception = e; }
}
if (d.domains.length == 0)
throw exception ? exception : "need proper <domain> in XML";
exception = null;
// incoming server
for (let iX of array_or_undef(xml.$incomingServer)) // input (XML)
{
let iO = d.createNewIncoming(); // output (object)
try {
// throws if not supported
iO.type = sanitize.enum(iX["@type"], ["pop3", "imap", "nntp"]);
iO.hostname = sanitize.hostname(iX.hostname);
iO.port = sanitize.integerRange(iX.port, kMinPort, kMaxPort);
// We need a username even for Kerberos, need it even internally.
iO.username = sanitize.string(iX.username); // may be a %VARIABLE%
if ("password" in iX) {
d.rememberPassword = true;
iO.password = sanitize.string(iX.password);
}
for (let iXsocketType of array_or_undef(iX.$socketType))
{
try {
iO.socketType = sanitize.translate(iXsocketType,
{ plain : 1, SSL: 2, STARTTLS: 3 });
break; // take first that we support
} catch (e) { exception = e; }
}
if (!iO.socketType)
throw exception ? exception : "need proper <socketType> in XML";
exception = null;
for (let iXauth of array_or_undef(iX.$authentication))
{
try {
iO.auth = sanitize.translate(iXauth,
{ "password-cleartext" : Ci.nsMsgAuthMethod.passwordCleartext,
// @deprecated TODO remove
"plain" : Ci.nsMsgAuthMethod.passwordCleartext,
"password-encrypted" : Ci.nsMsgAuthMethod.passwordEncrypted,
// @deprecated TODO remove
"secure" : Ci.nsMsgAuthMethod.passwordEncrypted,
"GSSAPI" : Ci.nsMsgAuthMethod.GSSAPI,
"NTLM" : Ci.nsMsgAuthMethod.NTLM,
#ifdef MOZ_MAILNEWS_OAUTH2
"OAuth2" : Ci.nsMsgAuthMethod.OAuth2
#endif
});
break; // take first that we support
} catch (e) { exception = e; }
}
if (!iO.auth)
throw exception ? exception : "need proper <authentication> in XML";
exception = null;
// defaults are in accountConfig.js
if (iO.type == "pop3" && "pop3" in iX)
{
try {
if ("leaveMessagesOnServer" in iX.pop3)
iO.leaveMessagesOnServer =
sanitize.boolean(iX.pop3.leaveMessagesOnServer);
if ("daysToLeaveMessagesOnServer" in iX.pop3)
iO.daysToLeaveMessagesOnServer =
sanitize.integer(iX.pop3.daysToLeaveMessagesOnServer);
} catch (e) { logException(e); }
try {
if ("downloadOnBiff" in iX.pop3)
iO.downloadOnBiff = sanitize.boolean(iX.pop3.downloadOnBiff);
} catch (e) { logException(e); }
}
// processed successfully, now add to result object
if (!d.incoming.hostname) // first valid
d.incoming = iO;
else
d.incomingAlternatives.push(iO);
} catch (e) { exception = e; }
}
if (!d.incoming.hostname)
// throw exception for last server
throw exception ? exception : "Need proper <incomingServer> in XML file";
exception = null;
// outgoing server
for (let oX of array_or_undef(xml.$outgoingServer)) // input (XML)
{
let oO = d.createNewOutgoing(); // output (object)
try {
if (oX["@type"] != "smtp")
{
var stringBundle = getStringBundle(
"chrome://messenger/locale/accountCreationModel.properties");
throw stringBundle.GetStringFromName("outgoing_not_smtp.error");
}
oO.hostname = sanitize.hostname(oX.hostname);
oO.port = sanitize.integerRange(oX.port, kMinPort, kMaxPort);
for (let oXsocketType of array_or_undef(oX.$socketType))
{
try {
oO.socketType = sanitize.translate(oXsocketType,
{ plain : 1, SSL: 2, STARTTLS: 3 });
break; // take first that we support
} catch (e) { exception = e; }
}
if (!oO.socketType)
throw exception ? exception : "need proper <socketType> in XML";
exception = null;
for (let oXauth of array_or_undef(oX.$authentication))
{
try {
oO.auth = sanitize.translate(oXauth,
{ // open relay
"none" : Ci.nsMsgAuthMethod.none,
// inside ISP or corp network
"client-IP-address" : Ci.nsMsgAuthMethod.none,
// hope for the best
"smtp-after-pop" : Ci.nsMsgAuthMethod.none,
"password-cleartext" : Ci.nsMsgAuthMethod.passwordCleartext,
// @deprecated TODO remove
"plain" : Ci.nsMsgAuthMethod.passwordCleartext,
"password-encrypted" : Ci.nsMsgAuthMethod.passwordEncrypted,
// @deprecated TODO remove
"secure" : Ci.nsMsgAuthMethod.passwordEncrypted,
"GSSAPI" : Ci.nsMsgAuthMethod.GSSAPI,
"NTLM" : Ci.nsMsgAuthMethod.NTLM,
#ifdef MOZ_MAILNEWS_OAUTH2
"OAuth2" : Ci.nsMsgAuthMethod.OAuth2,
#endif
});
break; // take first that we support
} catch (e) { exception = e; }
}
if (!oO.auth)
throw exception ? exception : "need proper <authentication> in XML";
exception = null;
if ("username" in oX ||
// if password-based auth, we need a username,
// so go there anyways and throw.
oO.auth == Ci.nsMsgAuthMethod.passwordCleartext ||
oO.auth == Ci.nsMsgAuthMethod.passwordEncrypted)
oO.username = sanitize.string(oX.username);
if ("password" in oX) {
d.rememberPassword = true;
oO.password = sanitize.string(oX.password);
}
try {
// defaults are in accountConfig.js
if ("addThisServer" in oX)
oO.addThisServer = sanitize.boolean(oX.addThisServer);
if ("useGlobalPreferredServer" in oX)
oO.useGlobalPreferredServer =
sanitize.boolean(oX.useGlobalPreferredServer);
} catch (e) { logException(e); }
// processed successfully, now add to result object
if (!d.outgoing.hostname) // first valid
d.outgoing = oO;
else
d.outgoingAlternatives.push(oO);
} catch (e) { logException(e); exception = e; }
}
if (!d.outgoing.hostname)
// throw exception for last server
throw exception ? exception : "Need proper <outgoingServer> in XML file";
exception = null;
d.inputFields = new Array();
for (let inputField of array_or_undef(xml.$inputField))
{
try {
var fieldset =
{
varname : sanitize.alphanumdash(inputField["@key"]).toUpperCase(),
displayName : sanitize.label(inputField["@label"]),
exampleValue : sanitize.label(inputField.value)
};
d.inputFields.push(fieldset);
} catch (e) { logException(e); } // for now, don't throw,
// because we don't support custom fields yet anyways.
}
return d;
}