package eu.faircode.email; /* This file is part of FairEmail. FairEmail is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. FairEmail is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with FairEmail. If not, see . Copyright 2018-2019 by Marcel Bokhorst (M66B) */ import android.content.Context; import android.content.res.XmlResourceParser; import android.text.TextUtils; import androidx.annotation.NonNull; import org.xbill.DNS.Lookup; import org.xbill.DNS.Record; import org.xbill.DNS.SRVRecord; import org.xbill.DNS.SimpleResolver; import org.xbill.DNS.TextParseException; import org.xbill.DNS.Type; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; import org.xmlpull.v1.XmlPullParserFactory; import java.io.IOException; import java.io.InputStreamReader; import java.net.HttpURLConnection; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Socket; import java.net.URL; import java.net.UnknownHostException; import java.text.Collator; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Locale; import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; public class EmailProvider { public String name; public List domain; public String link; public int order; public String type; public int keepalive; public Server imap = new Server(); public Server smtp = new Server(); public UserType user = UserType.EMAIL; public StringBuilder documentation; // html enum Discover {ALL, IMAP, SMTP} enum UserType {LOCAL, EMAIL} private static final int DNS_TIMEOUT = 5 * 1000; // milliseconds private static final int ISPDB_TIMEOUT = 15 * 1000; // milliseconds private static final ExecutorService executor = Executors.newCachedThreadPool(Helper.backgroundThreadFactory); private EmailProvider() { } EmailProvider(String name) { this.name = name; } private void checkValid() throws UnknownHostException { if (this.imap.host == null || this.imap.port == 0 || this.smtp.host == null || this.smtp.port == 0) throw new UnknownHostException(this.name + " invalid"); } static List loadProfiles(Context context) { List result = null; try { EmailProvider provider = null; XmlResourceParser xml = context.getResources().getXml(R.xml.providers); int eventType = xml.getEventType(); while (eventType != XmlPullParser.END_DOCUMENT) { if (eventType == XmlPullParser.START_TAG) { String name = xml.getName(); if ("providers".equals(name)) result = new ArrayList<>(); else if ("provider".equals(name)) { provider = new EmailProvider(); provider.name = xml.getAttributeValue(null, "name"); provider.order = xml.getAttributeIntValue(null, "order", Integer.MAX_VALUE); provider.keepalive = xml.getAttributeIntValue(null, "keepalive", 0); String domain = xml.getAttributeValue(null, "domain"); if (domain != null) provider.domain = Arrays.asList(domain.split(",")); provider.link = xml.getAttributeValue(null, "link"); provider.type = xml.getAttributeValue(null, "type"); String user = xml.getAttributeValue(null, "user"); if ("local".equals(user)) provider.user = UserType.LOCAL; else if ("email".equals(user)) provider.user = UserType.EMAIL; } else if ("imap".equals(name)) { provider.imap.host = xml.getAttributeValue(null, "host"); provider.imap.port = xml.getAttributeIntValue(null, "port", 0); provider.imap.starttls = xml.getAttributeBooleanValue(null, "starttls", false); } else if ("smtp".equals(name)) { provider.smtp.host = xml.getAttributeValue(null, "host"); provider.smtp.port = xml.getAttributeIntValue(null, "port", 0); provider.smtp.starttls = xml.getAttributeBooleanValue(null, "starttls", false); } else throw new IllegalAccessException(name); } else if (eventType == XmlPullParser.END_TAG) { if ("provider".equals(xml.getName())) { result.add(provider); provider = null; } } eventType = xml.next(); } } catch (Throwable ex) { Log.e(ex); } final Collator collator = Collator.getInstance(Locale.getDefault()); collator.setStrength(Collator.SECONDARY); // Case insensitive, process accents etc Collections.sort(result, new Comparator() { @Override public int compare(EmailProvider p1, EmailProvider p2) { int o = Integer.compare(p1.order, p2.order); if (o == 0) return collator.compare(p1.name, p2.name); else return o; } }); return result; } @NonNull static EmailProvider fromDomain(Context context, String domain, Discover discover) throws IOException { List providers = loadProfiles(context); for (EmailProvider provider : providers) if (provider.domain != null) for (String d : provider.domain) if (domain.toLowerCase(Locale.ROOT).matches(d)) { Log.i("Provider from domain=" + domain + " (" + d + ")"); return provider; } EmailProvider autoconfig = _fromDomain(context, domain.toLowerCase(Locale.ROOT), discover); // Always prefer built-in profiles // - ISPDB is not always correct // - documentation links for (EmailProvider provider : providers) if (provider.imap.host.equals(autoconfig.imap.host) || provider.smtp.host.equals(autoconfig.smtp.host)) { Log.i("Replacing auto config by profile=" + provider.name); return provider; } return autoconfig; } @NonNull private static EmailProvider _fromDomain(Context context, String domain, Discover discover) throws IOException { try { // Assume the provider knows best Log.i("Provider from DNS domain=" + domain); return fromDNS(context, domain, discover); } catch (Throwable ex) { Log.w(ex); try { // Check ISPDB Log.i("Provider from ISPDB domain=" + domain); return fromISPDB(context, domain); } catch (Throwable ex1) { Log.w(ex1); try { // Scan ports Log.i("Provider from template domain=" + domain); return fromTemplate(context, domain, discover); } catch (Throwable ex2) { Log.w(ex2); throw new UnknownHostException(context.getString(R.string.title_setup_no_settings, domain)); } } } } @NonNull private static EmailProvider fromISPDB(Context context, String domain) throws IOException, XmlPullParserException { EmailProvider provider = new EmailProvider(domain); // https://wiki.mozilla.org/Thunderbird:Autoconfiguration HttpURLConnection request; try { URL url = new URL("https://autoconfig." + domain + "/mail/config-v1.1.xml?emailaddress=someone@" + domain); Log.i("Fetching " + url); request = (HttpURLConnection) url.openConnection(); request.setReadTimeout(ISPDB_TIMEOUT); request.setConnectTimeout(ISPDB_TIMEOUT); request.setRequestMethod("GET"); request.setDoInput(true); request.connect(); } catch (IOException ex1) { try { Log.w(ex1.getMessage()); URL url = new URL("https://" + domain + "/.well-known/autoconfig/mail/config-v1.1.xml"); Log.i("Fetching " + url); request = (HttpURLConnection) url.openConnection(); request.setReadTimeout(ISPDB_TIMEOUT); request.setConnectTimeout(ISPDB_TIMEOUT); request.setRequestMethod("GET"); request.setDoInput(true); request.connect(); } catch (IOException ex2) { Log.w(ex2.getMessage()); URL url = new URL("https://autoconfig.thunderbird.net/v1.1/" + domain); Log.i("Fetching " + url); request = (HttpURLConnection) url.openConnection(); request.setReadTimeout(ISPDB_TIMEOUT); request.setConnectTimeout(ISPDB_TIMEOUT); request.setRequestMethod("GET"); request.setDoInput(true); request.connect(); } } try { // https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser XmlPullParserFactory factory = XmlPullParserFactory.newInstance(); XmlPullParser xml = factory.newPullParser(); xml.setInput(new InputStreamReader(request.getInputStream())); boolean imap = false; boolean smtp = false; String href = null; String title = null; int eventType = xml.getEventType(); while (eventType != XmlPullParser.END_DOCUMENT) { if (eventType == XmlPullParser.START_TAG) { String name = xml.getName(); if ("displayShortName".equals(name)) { // GMail eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { String display = xml.getText(); Log.i("Name=" + display); provider.name = display; } continue; } else if ("incomingServer".equals(name)) { // // imap.gmail.com // 993 // SSL // %EMAILADDRESS% // OAuth2 // password-cleartext // imap = "imap".equals(xml.getAttributeValue(null, "type")); } else if ("outgoingServer".equals(name)) { // // smtp.gmail.com // 465 // SSL // %EMAILADDRESS% // OAuth2 // password-cleartext // smtp = "smtp".equals(xml.getAttributeValue(null, "type")); } else if ("hostname".equals(name)) { eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { String host = xml.getText(); Log.i("Host=" + host); if (imap) provider.imap.host = host; else if (smtp) provider.smtp.host = host; } continue; } else if ("port".equals(name)) { eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { String port = xml.getText(); Log.i("Port=" + port); if (imap) { provider.imap.port = Integer.parseInt(port); provider.imap.starttls = (provider.imap.port == 143); } else if (smtp) { provider.smtp.port = Integer.parseInt(port); provider.smtp.starttls = (provider.smtp.port == 587); } } continue; } else if ("socketType".equals(name)) { eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { String socket = xml.getText(); Log.i("Socket=" + socket); if ("SSL".equals(socket)) { if (imap) provider.imap.starttls = false; else if (smtp) provider.smtp.starttls = false; } else if ("STARTTLS".equals(socket)) { if (imap) provider.imap.starttls = true; else if (smtp) provider.smtp.starttls = true; } else Log.w("Unknown socket type=" + socket); } continue; } else if ("username".equals(name)) { eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { String username = xml.getText(); Log.i("Username=" + username); if ("%EMAILADDRESS%".equals(username)) provider.user = UserType.EMAIL; else if ("%EMAILLOCALPART%".equals(username)) provider.user = UserType.LOCAL; else Log.w("Unknown username type=" + username); } continue; } else if ("enable".equals(name)) { // // You need to enable IMAP access // href = xml.getAttributeValue(null, "visiturl"); title = null; } else if ("documentation".equals(name)) { // // How to enable IMAP/POP3 in GMail // href = xml.getAttributeValue(null, "url"); title = null; } else if ("instruction".equals(name) || "descr".equals(name)) { if (href != null) { eventType = xml.next(); if (eventType == XmlPullParser.TEXT) { if (title == null) title = ""; else title += "
"; title += xml.getText(); } continue; } } } else if (eventType == XmlPullParser.END_TAG) { String name = xml.getName(); if ("incomingServer".equals(name)) imap = false; else if ("outgoingServer".equals(name)) smtp = false; else if ("enable".equals(name) || "documentation".equals(name)) { if (href != null) { if (title == null) title = href; addDocumentation(provider, href, title); href = null; title = null; } } } eventType = xml.next(); } } finally { request.disconnect(); } Log.i("imap=" + provider.imap.host + ":" + provider.imap.port + ":" + provider.imap.starttls); Log.i("smtp=" + provider.smtp.host + ":" + provider.smtp.port + ":" + provider.smtp.starttls); provider.checkValid(); return provider; } @NonNull private static EmailProvider fromDNS(Context context, String domain, Discover discover) throws TextParseException, UnknownHostException { // https://tools.ietf.org/html/rfc6186 EmailProvider provider = new EmailProvider(domain); if (discover == Discover.ALL || discover == Discover.IMAP) { SRVRecord imap; boolean starttls; try { // Identifies an IMAP server where TLS is initiated directly upon connection to the IMAP server. imap = lookup(context, "_imaps._tcp." + domain); // ... service is not supported at all at a particular domain by setting the target of an SRV RR to "." if (TextUtils.isEmpty(imap.getTarget().toString(true))) throw new UnknownHostException(imap.toString()); starttls = false; } catch (UnknownHostException ex) { // Identifies an IMAP server that MAY ... require the MUA to use the "STARTTLS" command imap = lookup(context, "_imap._tcp." + domain); if (TextUtils.isEmpty(imap.getTarget().toString(true))) throw new UnknownHostException(imap.toString()); starttls = (imap.getPort() == 143); } provider.imap.host = imap.getTarget().toString(true); provider.imap.port = imap.getPort(); provider.imap.starttls = starttls; } if (discover == Discover.ALL || discover == Discover.SMTP) { // Note that this covers connections both with and without Transport Layer Security (TLS) SRVRecord smtp = lookup(context, "_submission._tcp." + domain); if (TextUtils.isEmpty(smtp.getTarget().toString(true))) throw new UnknownHostException(smtp.toString()); provider.smtp.host = smtp.getTarget().toString(true); provider.smtp.port = smtp.getPort(); provider.smtp.starttls = (provider.smtp.port == 587); } return provider; } @NonNull private static EmailProvider fromTemplate(Context context, String domain, Discover discover) throws ExecutionException, InterruptedException, UnknownHostException { Server imap = null; Server smtp = null; if (discover == Discover.ALL || discover == Discover.IMAP) { List imaps = new ArrayList<>(); // SSL imaps.add(new Server(domain, null, 993)); imaps.add(new Server(domain, "imap", 993)); imaps.add(new Server(domain, "mail", 993)); imaps.add(new Server(domain, "mx", 993)); // STARTTLS imaps.add(new Server(domain, null, 143)); imaps.add(new Server(domain, "imap", 143)); imaps.add(new Server(domain, "mail", 143)); imaps.add(new Server(domain, "mx", 143)); for (Server server : imaps) if (server.reachable.get()) { imap = server; break; } if (imap == null) throw new UnknownHostException(domain + " template"); } if (discover == Discover.ALL || discover == Discover.SMTP) { List smtps = new ArrayList<>(); // SSL smtps.add(new Server(domain, null, 465)); smtps.add(new Server(domain, "smtp", 465)); smtps.add(new Server(domain, "mail", 465)); smtps.add(new Server(domain, "mx", 465)); // STARTTLS smtps.add(new Server(domain, null, 587)); smtps.add(new Server(domain, "smtp", 587)); smtps.add(new Server(domain, "mail", 587)); smtps.add(new Server(domain, "mx", 587)); for (Server server : smtps) if (server.reachable.get()) { smtp = server; break; } if (smtp == null) throw new UnknownHostException(domain + " template"); } EmailProvider provider = new EmailProvider(); provider.name = domain; if (imap != null) { provider.imap.host = imap.host; provider.imap.port = imap.port; provider.imap.starttls = (imap.port == 143); } if (smtp != null) { provider.smtp.host = smtp.host; provider.smtp.port = smtp.port; provider.smtp.starttls = (smtp.port == 587); } return provider; } private static void addDocumentation(EmailProvider provider, String href, String title) { if (provider.documentation == null) provider.documentation = new StringBuilder(); else provider.documentation.append("

"); provider.documentation.append("").append(title).append(""); } @NonNull private static SRVRecord lookup(Context context, String name) throws TextParseException, UnknownHostException { Lookup lookup = new Lookup(name, Type.SRV); SimpleResolver resolver = new SimpleResolver(ConnectionHelper.getDnsServer(context)); lookup.setResolver(resolver); Log.i("Lookup name=" + name + " @" + resolver.getAddress()); Record[] records = lookup.run(); if (lookup.getResult() != Lookup.SUCCESSFUL) if (lookup.getResult() == Lookup.HOST_NOT_FOUND || lookup.getResult() == Lookup.TYPE_NOT_FOUND) throw new UnknownHostException(name); else throw new UnknownHostException(lookup.getErrorString()); if (records.length == 0) throw new UnknownHostException(name); SRVRecord result = (SRVRecord) records[0]; Log.i("Found records=" + records.length + " result=" + result.toString()); return result; } @NonNull @Override public String toString() { return name; } public static class Server { public String host; public int port; public boolean starttls; private Future reachable; private Server() { } private Server(String domain, String prefix, int port) { this.host = (prefix == null ? "" : prefix + ".") + domain; this.port = port; Log.i("Scanning " + host + ":" + port); this.reachable = executor.submit(new Callable() { @Override public Boolean call() { try (Socket socket = new Socket()) { InetAddress[] iaddr = InetAddress.getAllByName(host); for (int i = 0; i < iaddr.length; i++) try { Log.i("Connecting to " + iaddr[i]); InetSocketAddress inetSocketAddress = new InetSocketAddress(iaddr[i], Server.this.port); socket.connect(inetSocketAddress, DNS_TIMEOUT); } catch (Throwable ex) { if (i + 1 == iaddr.length) throw ex; } Log.i("Reachable " + Server.this); return true; } catch (IOException ex) { Log.i("Unreachable " + Server.this + ": " + Helper.formatThrowable(ex)); return false; } } }); } @NonNull @Override public String toString() { return host + ":" + port; } } }