<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[15401] CalendarServer/trunk</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/15401">15401</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2015-12-16 12:34:53 -0800 (Wed, 16 Dec 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make sure APNS topic is properly extracted everywhere it is needed.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverpushutilpy">CalendarServer/trunk/calendarserver/push/util.py</a></li>
<li><a href="#CalendarServertrunkcalendarservertaputilpy">CalendarServer/trunk/calendarserver/tap/util.py</a></li>
<li><a href="#CalendarServertrunktwistedcaldavstdconfigpy">CalendarServer/trunk/twistedcaldav/stdconfig.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverpushutilpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/push/util.py (15400 => 15401)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/push/util.py 2015-12-16 20:13:27 UTC (rev 15400)
+++ CalendarServer/trunk/calendarserver/push/util.py 2015-12-16 20:34:53 UTC (rev 15401)
</span><span class="lines">@@ -14,12 +14,20 @@
</span><span class="cx"> # limitations under the License.
</span><span class="cx"> ##
</span><span class="cx">
</span><del>-from OpenSSL import crypto
</del><span class="cx"> from twext.python.log import Logger
</span><ins>+
</ins><span class="cx"> from twisted.python.constants import Values, ValueConstant
</span><span class="cx">
</span><ins>+from twistedcaldav.util import getPasswordFromKeychain, KeychainAccessError, \
+ KeychainPasswordNotFound
</ins><span class="cx">
</span><ins>+import OpenSSL
+from OpenSSL import crypto
</ins><span class="cx">
</span><ins>+import os
+
+
+
</ins><span class="cx"> class PushPriority(Values):
</span><span class="cx"> """
</span><span class="cx"> Constants to use for push priorities
</span><span class="lines">@@ -30,6 +38,75 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><ins>+def getAPNTopicFromConfig(protocol, accountName, protoConfig):
+ """
+ Given the APNS protocol config, extract the APN topic.
+
+ @param accountName: account name
+ @type accountName: L{str}
+ @param protocol: APNS protocol name
+ @type protocol: L{str}
+ @param protoConfig: APNS specific config
+ @type protoConfig: L{dict}
+
+ @raise: ValueError
+ """
+
+ if hasattr(OpenSSL, "__SecureTransport__"):
+ if protoConfig.KeychainIdentity:
+ # Verify the identity exists
+ error = OpenSSL.crypto.check_keychain_identity(protoConfig.KeychainIdentity)
+ if error:
+ raise ValueError(
+ "The {proto} APNS Keychain Identity ({cert}) cannot be used: {reason}".format(
+ proto=protocol,
+ cert=protoConfig.KeychainIdentity,
+ reason=error
+ )
+ )
+
+ # Verify we can extract the topic
+ if not protoConfig.Topic:
+ topic = getAPNTopicFromIdentity(protoConfig.KeychainIdentity)
+ protoConfig.Topic = topic
+ if not protoConfig.Topic:
+ raise ValueError("Cannot extract {proto} APNS topic".format(proto=protocol))
+
+ else:
+ raise ValueError(
+ "No {proto} APNS Keychain Identity was set".format(proto=protocol))
+
+ else:
+ # Verify the cert exists
+ if not os.path.exists(protoConfig.CertificatePath):
+ raise ValueError(
+ "The {proto} APNS certificate ({cert}) is missing".format(
+ proto=protocol,
+ cert=protoConfig.CertificatePath
+ )
+ )
+
+ # Verify we can extract the topic
+ if not protoConfig.Topic:
+ topic = getAPNTopicFromCertificate(protoConfig.CertificatePath)
+ protoConfig.Topic = topic
+ if not protoConfig.Topic:
+ raise ValueError("Cannot extract {proto} APNS topic".format(proto=protocol))
+
+ # Verify we can acquire the passphrase
+ if not protoConfig.Passphrase:
+ try:
+ passphrase = getPasswordFromKeychain(accountName)
+ protoConfig.Passphrase = passphrase
+ except KeychainAccessError:
+ # The system doesn't support keychain
+ pass
+ except KeychainPasswordNotFound:
+ # The password doesn't exist in the keychain.
+ raise ValueError("Cannot retrieve {proto} APNS passphrase from keychain".format(proto=protocol))
+
+
+
</ins><span class="cx"> def getAPNTopicFromCertificate(certPath):
</span><span class="cx"> """
</span><span class="cx"> Given the path to a certificate, extract the UID value portion of the
</span></span></pre></div>
<a id="CalendarServertrunkcalendarservertaputilpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/tap/util.py (15400 => 15401)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/tap/util.py 2015-12-16 20:13:27 UTC (rev 15400)
+++ CalendarServer/trunk/calendarserver/tap/util.py 2015-12-16 20:34:53 UTC (rev 15401)
</span><span class="lines">@@ -33,7 +33,7 @@
</span><span class="cx"> from calendarserver.provision.root import RootResource
</span><span class="cx"> from calendarserver.push.applepush import APNSubscriptionResource
</span><span class="cx"> from calendarserver.push.notifier import NotifierFactory
</span><del>-from calendarserver.push.util import getAPNTopicFromCertificate, getAPNTopicFromIdentity
</del><ins>+from calendarserver.push.util import getAPNTopicFromConfig
</ins><span class="cx"> from calendarserver.tools import diagnose
</span><span class="cx"> from calendarserver.tools.util import checkDirectory
</span><span class="cx"> from calendarserver.webadmin.landing import WebAdminLandingResource
</span><span class="lines">@@ -79,8 +79,6 @@
</span><span class="cx"> from twistedcaldav.timezones import TimezoneCache
</span><span class="cx"> from twistedcaldav.timezoneservice import TimezoneServiceResource
</span><span class="cx"> from twistedcaldav.timezonestdservice import TimezoneStdServiceResource
</span><del>-from twistedcaldav.util import getPasswordFromKeychain
-from twistedcaldav.util import KeychainAccessError, KeychainPasswordNotFound
</del><span class="cx">
</span><span class="cx"> from txdav.base.datastore.dbapiclient import DBAPIConnector
</span><span class="cx"> from txdav.base.datastore.subpostgres import PostgresService
</span><span class="lines">@@ -1378,73 +1376,12 @@
</span><span class="cx"> ):
</span><span class="cx"> protoConfig = config.Notifications.Services.APNS[protocol]
</span><span class="cx">
</span><del>- if hasattr(OpenSSL, "__SecureTransport__"):
- if protoConfig.KeychainIdentity:
- # Verify the identity exists
- error = OpenSSL.crypto.check_keychain_identity(protoConfig.KeychainIdentity)
- if error:
- message = (
- "The {proto} APNS Keychain Identity ({cert}) cannot be used: {reason}".format(
- proto=protocol,
- cert=protoConfig.KeychainIdentity,
- reason=error
- )
- )
- return False, message
</del><ins>+ try:
+ getAPNTopicFromConfig(protocol, accountName, protoConfig)
+ except ValueError as e:
+ postAlert("PushNotificationCertificateAlert", 0, [])
+ return False, str(e)
</ins><span class="cx">
</span><del>- # Verify we can extract the topic
- if not protoConfig.Topic:
- topic = getAPNTopicFromIdentity(protoConfig.KeychainIdentity)
- protoConfig.Topic = topic
- if not protoConfig.Topic:
- postAlert("PushNotificationKeychainIdentityAlert", 0, [])
- message = "Cannot extract APN topic"
- return False, message
-
- else:
- message = (
- "No {proto} APNS Keychain Identity was set".format(
- proto=protocol,
- )
- )
- postAlert("MissingKeychainIdentityAlert", 0, [])
- return False, message
-
- else:
- # Verify the cert exists
- if not os.path.exists(protoConfig.CertificatePath):
- message = (
- "The {proto} APNS certificate ({cert}) is missing".format(
- proto=protocol,
- cert=protoConfig.CertificatePath
- )
- )
- postAlert("PushNotificationCertificateAlert", 0, [])
- return False, message
-
- # Verify we can extract the topic
- if not protoConfig.Topic:
- topic = getAPNTopicFromCertificate(protoConfig.CertificatePath)
- protoConfig.Topic = topic
- if not protoConfig.Topic:
- postAlert("PushNotificationCertificateAlert", 0, [])
- message = "Cannot extract APN topic"
- return False, message
-
- # Verify we can acquire the passphrase
- if not protoConfig.Passphrase:
- try:
- passphrase = getPasswordFromKeychain(accountName)
- protoConfig.Passphrase = passphrase
- except KeychainAccessError:
- # The system doesn't support keychain
- pass
- except KeychainPasswordNotFound:
- # The password doesn't exist in the keychain.
- postAlert("PushNotificationCertificateAlert", 0, [])
- message = "Cannot retrieve APN passphrase from keychain"
- return False, message
-
</del><span class="cx"> # Let OpenSSL try to use the cert
</span><span class="cx"> try:
</span><span class="cx"> if protoConfig.Passphrase:
</span></span></pre></div>
<a id="CalendarServertrunktwistedcaldavstdconfigpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twistedcaldav/stdconfig.py (15400 => 15401)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twistedcaldav/stdconfig.py 2015-12-16 20:13:27 UTC (rev 15400)
+++ CalendarServer/trunk/twistedcaldav/stdconfig.py 2015-12-16 20:34:53 UTC (rev 15401)
</span><span class="lines">@@ -23,7 +23,7 @@
</span><span class="cx"> import re
</span><span class="cx"> import sys
</span><span class="cx">
</span><del>-from calendarserver.push.util import getAPNTopicFromCertificate
</del><ins>+from calendarserver.push.util import getAPNTopicFromConfig
</ins><span class="cx">
</span><span class="cx"> from twext.enterprise.jobs.jobitem import JobItem
</span><span class="cx"> from twext.enterprise.jobs.queue import ControllerQueue
</span><span class="lines">@@ -1699,31 +1699,13 @@
</span><span class="cx"> continue
</span><span class="cx">
</span><span class="cx"> if not service[protocol]["Topic"]:
</span><del>- certPath = service[protocol]["CertificatePath"]
- if certPath:
- if os.path.exists(certPath):
- topic = getAPNTopicFromCertificate(certPath)
- service[protocol]["Topic"] = topic
- else:
- log.error("APNS certificate not found: {p}", p=certPath)
- else:
- log.error("APNS certificate path not specified")
</del><ins>+ try:
+ getAPNTopicFromConfig(protocol, accountName, service[protocol])
+ except ValueError as e:
+ log.error(e)
</ins><span class="cx">
</span><span class="cx"> # If we already have the cert passphrase, don't fetch it again
</span><del>- if service[protocol]["Passphrase"]:
- continue
-
- # Get passphrase from keychain. If not there, fall back to what
- # is in the plist.
- try:
- passphrase = getPasswordFromKeychain(accountName)
- service[protocol]["Passphrase"] = passphrase
- log.info("{p} APNS certificate passphrase retreived from keychain", p=protocol)
- except KeychainAccessError:
- # The system doesn't support keychain
- pass
- except KeychainPasswordNotFound:
- # The password doesn't exist in the keychain.
</del><ins>+ if not service[protocol]["Passphrase"]:
</ins><span class="cx"> log.info("{p} APNS certificate passphrase not found in keychain", p=protocol)
</span><span class="cx">
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>