本文記錄如何在自己的電腦上把 APNS(Apple Push Notification Service)推播環境跑起來,涵蓋 App ID 設定、憑證與描述檔、伺服器端 PEM 檔的轉換,以及用 PHP 在本機發出第一則通知。推播原理與流程不在此贅述。
登入開發者中心建立 App ID,有兩點務必注意:
com.xxx.*),必須是明確的 Bundle Identifier。已經建立好的 App ID 也可以隨時編輯補上推播服務。
接著分別建立開發版與正式版的憑證(Certificates)與描述檔(Profiles)。細節依 Xcode 版本而異,這裡略過,但有兩點要特別留意:
.certSigningRequest 檔。請務必妥善保存這個檔案。憑證到期後若不用原本這份來更新,而是重新產生一份新的,伺服器端使用的憑證就得從頭再走一次下面的流程。APNS 的伺服器端連線需要一組 PEM 檔,做法是從 Keychain 匯出私鑰後,用 openssl 組合憑證與私鑰。
# 1. 在 Keychain 中匯出對應憑證的私鑰(副檔名 .p12),此例記為 Push.p12 # 2. 把開發者中心下載的 .cer 轉為 PEM openssl x509 -in aps_developer_identity.cer -inform der -out PushChatCert.pem # 3. 從 p12 中取出私鑰 openssl pkcs12 -nocerts -out PushChatKey.pem -in Push.p12 # 4. 把憑證與私鑰合併成一份 cat PushChatCert.pem PushChatKey.pem > ck.pem
最後得到的 ck.pem 就是後續程式要用的檔案。
先測試能不能連到 APNS 的閘道器:
$ telnet gateway.sandbox.push.apple.com 2195 Trying 17.172.232.226... Connected to gateway.sandbox.push-apple.com.akadns.net. Escape character is '^]'.
看到上面的回應,代表你的機器可以連上 APNS。按 Ctrl+C 結束連線。若出現錯誤,請確認防火牆有放行 2195 埠。
接著用 SSL 憑證與私鑰建立一次真正的加密連線:
$ openssl s_client -connect gateway.sandbox.push.apple.com:2195 \
-cert PushChatCert.pem -key PushChatKey.pem
Enter pass phrase for PushChatKey.pem:
成功時會看到完整的握手資訊,此時可以輸入一些字元,按下 Enter 後伺服器就會切斷連線。若過程中出錯,openssl 會印錯誤訊息,那就回頭檢查憑證與私鑰是否配對、金鑰密語是否正確。
macOS 自帶 Apache 與 PHP,稍作設定就能當作測試用的推播發送端。
sudo apachectl start
Apache 的網站根目錄是 /Library/WebServer/Documents/,把檔案放在這裡即可透過瀏覽器測試。
編輯 Apache 設定檔,把 PHP 模組的那一行取消註解:
# 修改 /etc/apache2/httpd.conf # 將 #LoadModule php5_module libexec/apache2/libphp5.so # 改為 LoadModule php5_module libexec/apache2/libphp5.so
接著複製一份 php.ini,並依自己的習慣調整(例如把 error_reporting = E_ALL & ~E_NOTICE 改為 E_ALL 以便除錯):
sudo cp /etc/php.ini.default /etc/php.ini sudo apachectl restart
重啟後可在網站根目錄建立 phpinfo.php 來確認 PHP 已生效。
把第四步產生的 ck.pem 複製到 /Library/WebServer/Documents/,再建立 push.php:
<?php
// 裝置權杖,需在真機上執行 App 後取得(記得移除空白字元)
// 注意:測試版與正式版的 deviceToken 不同
$deviceToken = 'f5b70734ea5f4b91c904544f75457d6ecb908488317e097abaab769e741e6752';
// 私鑰的通行密語
$passphrase = '請填入你設定 p12 時使用的密語';
// 要傳送的內容
$message = array(
'msg' => '小小說閱讀器',
'title' => '小小說',
'url' => 'https://www.apple.com.cn'
);
// 其他可用的 payload 範例:
// $message = array('msg' => '去商品詳細頁面', 'itemtype' => '2', 'id' => '192172');
// $message = array('msg' => '軟體升級');
$ctx = stream_context_create();
stream_context_set_option($ctx, 'ssl', 'local_cert', 'ck.pem');
stream_context_set_option($ctx, 'ssl', 'passphrase', $passphrase);
// 正式環境位址:
// $fp = stream_socket_client('ssl://gateway.push.apple.com:2195', $err, $errstr, 60, STREAM_CLIENT_CONNECT, $ctx);
// 沙盒測試位址(上架後記得改回正式位址)
$fp = stream_socket_client('ssl://gateway.sandbox.push.apple.com:2195', $err, $errstr, 60,
STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT, $ctx);
if (!$fp) {
exit("Failed to connect: $err $errstr" . PHP_EOL);
}
echo 'Connected to APNS' . PHP_EOL;
// 組出 payload
$body['aps'] = array(
'alert' => '逗你玩!哈哈。',
'sound' => 'default',
'badge' => 1
);
$body['type'] = 2;
$body['data'] = $message;
$payload = json_encode($body);
// 組出二元格式的通知主體
$msg = chr(0)
. pack('n', 32)
. pack('H*', $deviceToken)
. pack('n', strlen($payload))
. $payload;
$result = fwrite($fp, $msg, strlen($msg));
if (!$result) {
echo 'Message not delivered' . PHP_EOL;
} else {
echo 'Message successfully delivered' . PHP_EOL;
}
fclose($fp);
?>
重啟 Apache 後,用瀏覽器拜訪一次 https://localhost/push/push.php,手機就會收到通知:
sudo apachectl restart
gateway.sandbox.push.apple.com,上架後要換成 gateway.push.apple.com,憑證也要換成 Production 版本。ck.pem 與 push.php 都含敏感資訊,建議改用環境變數或設定檔並加入 .gitignore。