【iOS】コマンドを使ってPush通知を送信する方法【株式会社ライトコード】

はじめに

最近、iOS の Push 通知の実装を修正したのですが、その際、設定がうまくいっているか確認するため、コマンドを使ってPush通知を送信しました。
今回、コマンドを使ってPush通知を送信する方法を備忘録としてまとめたいと思います。

参考
- コマンドラインツールを使用してプッシュ通知を送信する：https://developer.apple.com/documentation/usernotifications/sending-push-notifications-using-command-line-tools

証明書(.p12)を使用して Push 通知を送信

iOS の Push 通知には、トークン(.p8)を使用しての通知送信と証明書(.p12)を使用しての通知送信があります。
まずは、証明書(.p12)を使用しての通知送信についてです。

参考
- APNs への証明書ベースの接続を確立する：https://developer.apple.com/documentation/usernotifications/establishing-a-certificate-based-connection-to-apns

P12 形式のファイルを PEM 形式に変換する

Push 通知の証明書からキーを書き出す際に P12 形式で書き出しますが、コマンド送信の際には、P12 形式を使用することができないため、PEM 形式への変換が必要になります。
以下のコマンドを実行し、P12 形式から PEM 形式へ変更を行います。

openssl pkcs12 -in $HOME/my-project-push.p12 -out $HOME/my-project-push.pem -legacy -nodes

環境変数の設定

Push 通知を送信する際に必要な情報は、あらかじめ環境変数に設定しておきます。

CERTIFICATE_FILE_NAME='$HOME/my-project-push.cer' // プッシュ通知証明書のパスを設定

CERTIFICATE_KEY_FILE_NAME='$HOME/my-project-push.pem' // P12形式から変換したPEM形式のファイルパスを設定

TOPIC='com.myProject' // アプリのBundleIDを設定

DEVICE_TOKEN='1234567890...' // アプリで発行されるデバイストークンを設定

APNS_HOST_NAME='api.sandbox.push.apple.com' // APNsのホスト名を設定。開発環境と本番環境で異なる

APNS_HOST_NAME には APNs サーバーのホスト名を設定します。
APNs には開発サーバーと本番サーバーがあり、以下のいずれかを設定します。

開発サーバー：api.sandbox.push.apple.com
本番サーバー：api.push.apple.com

基本的に Xcode で実機ビルドした場合はapi.sandbox.push.apple.com、TestFlight で実機インストールした場合はapi.push.apple.comになるかと思います。

参考：
- APNs への接続を確立する：https://developer.apple.com/documentation/usernotifications/sending-notification-requests-to-apns#Establish-a-connection-to-APNs

APNs への接続確認

以下のコマンドを実行し、APNs へ問題なく接続できることを確認します。

openssl s_client \

-connect "${APNS_HOST_NAME}":443 \

-cert "${CERTIFICATE_FILE_NAME}" \

-certform DER \

-key "${CERTIFICATE_KEY_FILE_NAME}" \

-keyform PEM

特にエラーなど表示されず、Verify return code: 0 (ok)が表示されれば OK です。

Push 通知の送信

APNs の接続確認ができたら、以下のコマンドで Push 通知を送信します。

curl -v \

--header "apns-topic: ${TOPIC}" \

--header "apns-push-type: alert" \

--cert "${CERTIFICATE_FILE_NAME}" \

--cert-type DER \

--key "${CERTIFICATE_KEY_FILE_NAME}" \

--key-type PEM \

--data '{"aps":{"alert":"test"}}' \

--http2 https://${APNS_HOST_NAME}/3/device/${DEVICE_TOKEN}