Merge #2276
2276: Autoconfig of email clients r=mergify[bot] a=nextgens ## What type of PR? Feature ## What does this PR do? It provides auto-configuration templates for email clients and encourages them to use implicit TLS (see https://nostarttls.secvuln.info/) There are numerous caveats: - it will only work if suitable DNS records are created and certificates obtained (autoconfig, autodiscover, ...) - the mobileconfig file isn't signed - the credentials will be prompted... we could/should provision a token on each request instead - it currently doesn't advertise caldav - it's IMAP only ### Related issue(s) - close #224 ## Prerequisites Before we can consider review and merge, please make sure the following list is done and checked. If an entry in not applicable, you can check it or remove it from the list. - [x] In case of feature or enhancement: documentation updated accordingly - [x] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file. Co-authored-by: Florent Daigniere <nextgens@freenetproject.org>master
bors[bot]
3 years ago
committed by
GitHub
commit
c15e4e6015
@ -1,3 +1,3 @@
|
|||||||
__all__ = [
|
__all__ = [
|
||||||
'auth', 'postfix', 'dovecot', 'fetch', 'rspamd'
|
'auth', 'autoconfig', 'postfix', 'dovecot', 'fetch', 'rspamd'
|
||||||
]
|
]
|
||||||
|
|||||||
@ -0,0 +1,183 @@
|
|||||||
|
from mailu.internal import internal
|
||||||
|
|
||||||
|
from flask import current_app as app
|
||||||
|
import flask
|
||||||
|
import xmltodict
|
||||||
|
|
||||||
|
@internal.route("/autoconfig/mozilla")
|
||||||
|
def autoconfig_mozilla():
|
||||||
|
# https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
|
||||||
|
hostname = app.config['HOSTNAME']
|
||||||
|
xml = f'''<?xml version="1.0"?>
|
||||||
|
<clientConfig version="1.1">
|
||||||
|
<emailProvider id="%EMAILDOMAIN%">
|
||||||
|
<domain>%EMAILDOMAIN%</domain>
|
||||||
|
|
||||||
|
<displayName>Email</displayName>
|
||||||
|
<displayShortName>Email</displayShortName>
|
||||||
|
|
||||||
|
<incomingServer type="imap">
|
||||||
|
<hostname>{hostname}</hostname>
|
||||||
|
<port>993</port>
|
||||||
|
<socketType>SSL</socketType>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
</incomingServer>
|
||||||
|
|
||||||
|
<outgoingServer type="smtp">
|
||||||
|
<hostname>{hostname}</hostname>
|
||||||
|
<port>465</port>
|
||||||
|
<socketType>SSL</socketType>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<addThisServer>true</addThisServer>
|
||||||
|
<useGlobalPreferredServer>true</useGlobalPreferredServer>
|
||||||
|
</outgoingServer>
|
||||||
|
|
||||||
|
<documentation url="https://{hostname}/admin/client">
|
||||||
|
<descr lang="en">Configure your email client</descr>
|
||||||
|
</documentation>
|
||||||
|
</emailProvider>
|
||||||
|
</clientConfig>\r\n'''
|
||||||
|
return flask.Response(xml, mimetype='text/xml', status=200)
|
||||||
|
|
||||||
|
@internal.route("/autoconfig/microsoft.json")
|
||||||
|
def autoconfig_microsoft_json():
|
||||||
|
proto = flask.request.args.get('Protocol', 'Autodiscoverv1')
|
||||||
|
if proto == 'Autodiscoverv1':
|
||||||
|
hostname = app.config['HOSTNAME']
|
||||||
|
json = f'"Protocol":"Autodiscoverv1","Url":"https://{hostname}/autodiscover/autodiscover.xml"'
|
||||||
|
return flask.Response('{'+json+'}', mimetype='application/json', status=200)
|
||||||
|
else:
|
||||||
|
return flask.abort(404)
|
||||||
|
|
||||||
|
@internal.route("/autoconfig/microsoft", methods=['POST'])
|
||||||
|
def autoconfig_microsoft():
|
||||||
|
# https://docs.microsoft.com/en-us/previous-versions/office/office-2010/cc511507(v=office.14)?redirectedfrom=MSDN#Anchor_3
|
||||||
|
hostname = app.config['HOSTNAME']
|
||||||
|
try:
|
||||||
|
xmlRequest = (flask.request.data).decode("utf-8")
|
||||||
|
xml = xmltodict.parse(xmlRequest[xmlRequest.find('<'):xmlRequest.rfind('>')+1])
|
||||||
|
schema = xml['Autodiscover']['Request']['AcceptableResponseSchema']
|
||||||
|
if schema != 'http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a':
|
||||||
|
return flask.abort(404)
|
||||||
|
email = xml['Autodiscover']['Request']['EMailAddress']
|
||||||
|
xml = f'''<?xml version="1.0" encoding="utf-8" ?>
|
||||||
|
<Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
|
||||||
|
<Response xmlns="{schema}">
|
||||||
|
<Account>
|
||||||
|
<AccountType>email</AccountType>
|
||||||
|
<Action>settings</Action>
|
||||||
|
<Protocol>
|
||||||
|
<Type>IMAP</Type>
|
||||||
|
<Server>{hostname}</Server>
|
||||||
|
<Port>993</Port>
|
||||||
|
<LoginName>{email}</LoginName>
|
||||||
|
<DomainRequired>on</DomainRequired>
|
||||||
|
<SPA>off</SPA>
|
||||||
|
<SSL>on</SSL>
|
||||||
|
</Protocol>
|
||||||
|
<Protocol>
|
||||||
|
<Type>SMTP</Type>
|
||||||
|
<Server>{hostname}</Server>
|
||||||
|
<Port>465</Port>
|
||||||
|
<LoginName>{email}</LoginName>
|
||||||
|
<DomainRequired>on</DomainRequired>
|
||||||
|
<SPA>off</SPA>
|
||||||
|
<SSL>on</SSL>
|
||||||
|
</Protocol>
|
||||||
|
</Account>
|
||||||
|
</Response>
|
||||||
|
</Autodiscover>'''
|
||||||
|
return flask.Response(xml, mimetype='text/xml', status=200)
|
||||||
|
except:
|
||||||
|
return flask.abort(400)
|
||||||
|
|
||||||
|
@internal.route("/autoconfig/apple")
|
||||||
|
def autoconfig_apple():
|
||||||
|
# https://developer.apple.com/business/documentation/Configuration-Profile-Reference.pdf
|
||||||
|
hostname = app.config['HOSTNAME']
|
||||||
|
sitename = app.config['SITENAME']
|
||||||
|
xml = f'''<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
|
||||||
|
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||||
|
<plist version="1.0">
|
||||||
|
<dict>
|
||||||
|
<key>PayloadContent</key>
|
||||||
|
<array>
|
||||||
|
<dict>
|
||||||
|
<key>EmailAccountDescription</key>
|
||||||
|
<string>{sitename}</string>
|
||||||
|
<key>EmailAccountName</key>
|
||||||
|
<string>{hostname}</string>
|
||||||
|
<key>EmailAccountType</key>
|
||||||
|
<string>EmailTypeIMAP</string>
|
||||||
|
<key>EmailAddress</key>
|
||||||
|
<string></string>
|
||||||
|
<key>IncomingMailServerAuthentication</key>
|
||||||
|
<string>EmailAuthPassword</string>
|
||||||
|
<key>IncomingMailServerHostName</key>
|
||||||
|
<string>{hostname}</string>
|
||||||
|
<key>IncomingMailServerPortNumber</key>
|
||||||
|
<integer>993</integer>
|
||||||
|
<key>IncomingMailServerUseSSL</key>
|
||||||
|
<true/>
|
||||||
|
<key>IncomingMailServerUsername</key>
|
||||||
|
<string></string>
|
||||||
|
<key>IncomingPassword</key>
|
||||||
|
<string></string>
|
||||||
|
<key>OutgoingMailServerAuthentication</key>
|
||||||
|
<string>EmailAuthPassword</string>
|
||||||
|
<key>OutgoingMailServerHostName</key>
|
||||||
|
<string>{hostname}</string>
|
||||||
|
<key>OutgoingMailServerPortNumber</key>
|
||||||
|
<integer>465</integer>
|
||||||
|
<key>OutgoingMailServerUseSSL</key>
|
||||||
|
<true/>
|
||||||
|
<key>OutgoingMailServerUsername</key>
|
||||||
|
<string></string>
|
||||||
|
<key>OutgoingPasswordSameAsIncomingPassword</key>
|
||||||
|
<true/>
|
||||||
|
<key>PayloadDescription</key>
|
||||||
|
<string>{sitename}</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>{hostname}</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>{hostname}.email</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string></string>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>com.apple.mail.managed</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>72e152e2-d285-4588-9741-25bdd50c4d11</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
<key>PreventAppSheet</key>
|
||||||
|
<true/>
|
||||||
|
<key>PreventMove</key>
|
||||||
|
<false/>
|
||||||
|
<key>SMIMEEnabled</key>
|
||||||
|
<false/>
|
||||||
|
<key>disableMailRecentsSyncing</key>
|
||||||
|
<false/>
|
||||||
|
</dict>
|
||||||
|
</array>
|
||||||
|
<key>PayloadDescription</key>
|
||||||
|
<string>{hostname} - E-Mail Account Configuration</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>E-Mail Account {hostname}</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>E-Mail Account {hostname}</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string>{hostname}</string>
|
||||||
|
<key>PayloadRemovalDisallowed</key>
|
||||||
|
<false/>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>Configuration</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>56db43a5-d29e-4609-a908-dce94d0be48e</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
</dict>
|
||||||
|
</plist>\r\n'''
|
||||||
|
return flask.Response(xml, mimetype='text/xml', status=200)
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Provide auto-configuration files (autodiscover, autoconfig & mobileconfig); Please update your DNS records
|
||||||
Loading…
Reference in New Issue