以前開発したときは、APNs証明書だけだったのに知らぬうちに2つの方法ができていたので備忘録です。
そもそもAPNsとは？
Apple Push Notification Service(以下、APNs)は、iOSやtvOS、MacOS上で実行されているアプリケーションに対して開発者側から通知を送るためのAppleによるサービスのことを指します。
誤解されがちなのは、Firebase Cloud Messaging(以下、FCM)などの通知を行えるサービスと各アプリケーションが1対1で繋がっているようにとらわれがちですが、Appleデバイスを対象に通知を送付する際は必ずAPNsを介して送付されています。
当たり前ですが、APNsに対してどんなリクエストでも送れてしまったら意図しない通知がユーザーの手元に届いてしまいますので、サーバー側とAPNs間のセキュアな通信を担保するために証明書または、認証キーが必要です。
認証キーと証明書
現在は、Appleデバイスに対してPush通知を送るために用いる認証方法が2つ存在しています。
記事によってはどちらかのみ記載している例があるため、それぞれ記載します。
Apple Push Notification Service SSL
今まで、Push通知を行う際に用いられてた証明書タイプの認証方法です。
アプリごとに証明書を発行する必要があり、発行から1年間の有効期限付きです。
また、SandboxとProductionそれぞれの証明書を発行する必要があります。
Sandboxでは上手く行っていたのに、AdhocやReleaseのアプリに通知が飛ばないとかは、証明書の登録漏れとかが原因だったりすることが多いです。
Apple Push Notification Authentication Key
こちらが新しい方法。(新しいといってもだいぶ前からなんですが、Push関連やることが少なかったので浦島太郎でした。)
アプリごとに証明書を用意する必要がなくベンダー共有の認証キーです。
有効期限がないため、更新する手間がないのがメリットです。
基本的には、こちらの認証方法が現在では推奨されています。
発行方法
Apple Push Notification Authentication Key
Apple Developer Programのページにアクセスし、左側の「Program Resources」以下に表示されている「Certtificates, Identifiers & Profiles」をクリックします。
次に「Keys」にアクセスし、Keys横のプラスボタンをクリックします。
Keyの登録画面になるので、Keyの名称とAPNsのチェックボックスにチェックを入れてContinueをクリックします。
再度確認画面が表示されるのでRegisterをクリックするとKeyを生成することができます。
生成後、p8形式のキーのダウンロードが可能になります。生成されたキーは1度だけダウンロードできます。
1度ダウンロードした後、再ダウンロードすることはできませんので注意が必要です。
Apple Push Notification Service SSL
こちらが古い方法。
Authentication Keyと異なりいくつかのステップがあります。(Developer Programのページで完結しないのが面倒)
1.Certificate Signing Requestの発行
Certificate Signing Reques(以下、CSR)とは、証明書を発行するときに認証局に対してメッセージのことです。
CSRの発行は、手持ちのMacのキーチェーンアクセスアプリから行います。
キーチェーンアクセスから証明書アシスタント→認証局に証明書を要求を選択します。
上記の画面が表示されるので、メールアドレスと通称部分に任意の内容を記入します。
要求の処理では、ディスクに保存と鍵ペア情報を指定にチェックを入れます。
入力とチェックを入れたら続けるを選択します。
CertificateSigningRequest.certSigningRequestの保存先の選択が求められるので、任意のディレクトリに保存しましょう。
鍵ペア情報の選択が求められますが、こちらは初期値のままで大丈夫です。
完了すると上記画面が表示されます。
以上でCSRの発行は完了です。
2. 証明書の生成
認証キー同様に、Apple Developer Programのページにアクセスし、左側の「Program Resources」以下に表示されている「Certtificates, Identifiers & Profiles」をクリックします。
次に「Certificates」にアクセスし、Certificates横のプラスボタンをクリックします。
Create a New Certificate画面が開きますので、Servicesの項目配下にあるApple Push Notification service SSLにチェックを入れます。
証明書にはSandbox環境だけへの接続を認可するものとSandboxとProduction環境どちらへの接続を認可するものがあります。
後者のキーだけでも開発用APNsキーと本番用APNsキーを兼用することはできますが、基本的にはSandbox用とProduction用は別々に発行したほうが良いと思います。
Platformと通知を利用するアプリのAppIDの選択が求められるので、通知を利用するAppIDを探し選択し次に進みます。
先程発行したCSRファイルの登録が求められるので、Choose Fileから発行したCSRファイルを選択します。
次へ進むと証明書のダウンロードが可能になります。生成した証明書をダウンロードしましょう。
cer形式の証明書がダウンロードできます。
3. p12形式に変換する
Firebase Cloud Messagingでは、cer形式の証明書のままではアップロードできませんので手元でp12形式で書き出す必要があります。
ダウンロードしたcer形式の証明書をダブルクリックし、キーチェーン.appに証明書を追加します。
追加した証明書上で右クリック→「キー名」を書き出すを選択します。
証明書の名称、保存先の入力選択が求められるので任意の内容に設定します。フォーマットは「個人情報交換(.p12)」のままで大丈夫です。
保存時にパスワード設定が求められます。任意のパスワードを設定して書き出しましょう。
OKを押すとまれにキーチェーンアクセスからのパスワード入力を求められることがありますが、Macのログインパスワードを入力すればOKです。
任意のパスにp12形式の証明書が書き出されていれば成功です。
Firebaseに認証キー・証明書をアップロードする
Firebaseのコンソールを開き、Push配信を行うプロジェクトを選択します。
選択後、プロジェクトの概要横に表示されている歯車アイコンをクリックし、設定ページを表示します。
次にクラウドメッセージングの設定項目を選択し、iOSアプリの設定から証明書をアップロードすることができます。
Push通知を送るには、認証キー・証明書どちらかをアップロードすればFCMからAPNsを通して、アプリがインストールされている端末に対して通知を送ることが可能になります。
重ねてにはなりますが証明書を用いる場合、開発環境用と本番環境用それぞれの証明書をアップロードする必要があります。
片方だけアップロードしてもどちらかの環境では通知が届かないということが発生しますので注意が必要です。
おわりに
FCMでは、現在認証キーを用いることが推奨されていますが未だに証明書形式でのFCMの利用方法などが記載されている事例が見られたので、改めて2つの方法があるよーということを書かせていただきました。
駆け足にはなりましたが参考になりますと幸いです。