Azure Notification Hubs の安全なプッシュ

[アーティクル]
06/01/2023

概要

Microsoft Azure でプッシュ通知がサポートされたことで、マルチプラットフォームに対応し、簡単に使用できる、スケールアウトされたプッシュ通知インフラストラクチャを利用できるようになりました。これにより、モバイルプラットフォーム向けアプリケーション (コンシューマー用途およびエンタープライズ用途) にプッシュ通知機能を実装する作業が大幅に簡略化されます。

規制やセキュリティの制約により、アプリケーションでは、標準のプッシュ通知インフラストラクチャからは転送できないものを通知に含める必要がある場合があります。このチュートリアルでは、クライアントのデバイスとアプリケーションのバックエンドとの間の安全で認証された接続を通して機密情報を送信することによって、同じエクスペリエンスを実現する方法について説明します。

大まかには、フローは次のようになります。

アプリケーションのバックエンド:
- バックエンドデータベースに安全なペイロードを格納します。
- この通知の ID をデバイスに送信します (安全でない情報は送信しません)。
通知を受け取ったときのデバイスのアプリケーション:
- デバイスは、安全なペイロードを要求するバックエンドにアクセスします。
- アプリケーションはデバイスに通知としてペイロードを表示できます。

重要なのは、前のフロー (およびこのチュートリアル) では、デバイスは、ユーザーがログインした後、認証トークンをローカルストレージに保存すると想定していることです。これにより、デバイスはこのトークンを使用して通知のセキュリティ保護されたペイロードを取得できるため、シームレスなエクスペリエンスが保証されます。アプリケーションがデバイスに認証トークンを格納しない、またはそれらのトークンが期限切れの場合、デバイスのアプリは、通知を受け取ったときに、ユーザーにアプリの起動を促す一般的な通知を表示する必要があります。その後、アプリケーションはユーザーを認証し、通知ペイロードを表示します。

この安全なプッシュのチュートリアルでは、プッシュ通知を安全に送信する方法を説明します。このチュートリアルは「ユーザーへの通知」チュートリアルに基づいて記述されているため、先にそのチュートリアルでの手順を完了してください。

注意

このチュートリアルでは、「Azure Notification Hubs を使用して iOS アプリにプッシュ通知を送信する」の説明のとおり通知ハブを作成し、構成したと想定しています。

Web API プロジェクト

Visual Studio で、 ユーザーへの通知 チュートリアルで作成した AppBackend プロジェクトを開きます。

Notifications.cs の Notifications クラス全体を次のコードで置き換えます。必ず、プレースホルダーを通知ハブの (フルアクセスを持つ) 接続文字列とハブの名前に置き換えます。これらの値は Azure ポータルから取得できます。ここで、このモジュールは、送信される、セキュリティで保護された別の通知を表します。完全な実装では、通知はデータベースに格納されますが、ここでは、操作を簡単にするために、メモリに格納します。

 public class Notification
 {
     public int Id { get; set; }
     public string Payload { get; set; }
     public bool Read { get; set; }
 }

 public class Notifications
 {
     public static Notifications Instance = new Notifications();

     private List<Notification> notifications = new List<Notification>();

     public NotificationHubClient Hub { get; set; }

     private Notifications() {
         Hub = NotificationHubClient.CreateClientFromConnectionString("{conn string with full access}",     "{hub name}");
     }

     public Notification CreateNotification(string payload)
     {
         var notification = new Notification() {
         Id = notifications.Count,
         Payload = payload,
         Read = false
         };

         notifications.Add(notification);

         return notification;
     }

     public Notification ReadNotification(int id)
     {
         return notifications.ElementAt(id);
     }
 }

NotificationsController.cs の NotificationsController クラス定義内のコードを次のコードで置き換えます。このコンポーネントは、デバイスが安全に通知を取得する方法を実装します。また、(このチュートリアルでは) 自分のデバイスへの安全なプッシュをトリガーする方法も提供します。通知ハブに通知を送信するときに、通知の ID のみを含む (実際のメッセージは含まない) 直接通知を送信することに注意してください。

 public NotificationsController()
 {
     Notifications.Instance.CreateNotification("This is a secure notification!");
 }

 // GET api/notifications/id
 public Notification Get(int id)
 {
     return Notifications.Instance.ReadNotification(id);
 }

 public async Task<HttpResponseMessage> Post()
 {
     var secureNotificationInTheBackend = Notifications.Instance.CreateNotification("Secure confirmation.");
     var usernameTag = "username:" + HttpContext.Current.User.Identity.Name;

     // windows
     var rawNotificationToBeSent = new Microsoft.Azure.NotificationHubs.WindowsNotification(secureNotificationInTheBackend.Id.ToString(),
                     new Dictionary<string, string> {
                         {"X-WNS-Type", "wns/raw"}
                     });
     await Notifications.Instance.Hub.SendNotificationAsync(rawNotificationToBeSent, usernameTag);

     // apns
     await Notifications.Instance.Hub.SendAppleNativeNotificationAsync("{\"aps\": {\"content-available\": 1}, \"secureId\": \"" + secureNotificationInTheBackend.Id.ToString() + "\"}", usernameTag);

     // gcm
     await Notifications.Instance.Hub.SendGcmNativeNotificationAsync("{\"data\": {\"secureId\": \"" + secureNotificationInTheBackend.Id.ToString() + "\"}}", usernameTag);

     return Request.CreateResponse(HttpStatusCode.OK);
 }

Post メソッドは、トースト通知を送信しません。通知 ID のみを含み、慎重な扱いを要するコンテンツは含まない直接通知を送信します。また、通知ハブで資格情報を構成していないプラットフォームの送信操作は必ずコメントアウトしてください。そうしないと、エラーになります。

次に、このアプリを Azure の Web サイトにもう一度デプロイして、すべてのデバイスからアクセスできるようにします。 AppBackend プロジェクトを右クリックして [発行] を選択します。
発行先として Azure の Web サイトを選択します。 Azure アカウントでサインインし、既存または新規の Web サイトを選択します。 [接続] タブの [宛先 URL] プロパティをメモしておきます。後で、この URL を バックエンドエンドポイント として参照します。 [発行] をクリックします。

iOS プロジェクトを変更する

これで、通知の ID のみを送信するようにアプリバックエンドが変更されたので、その通知を処理し、バックエンドをコールバックして、表示されるセキュリティ保護されたメッセージを取得するように iOS アプリを変更する必要があります。

そのためには、アプリケーションバックエンドから安全なコンテンツを取得するロジックを作成する必要があります。

AppDelegate.m で、アプリが確実にサイレント通知に登録して、バックエンドから送信された通知 ID を処理するようにしてください。 didFinishLaunchingWithOptions に UIRemoteNotificationTypeNewsstandContentAvailability オプションを追加します。
```
[[UIApplication sharedApplication] registerForRemoteNotificationTypes: UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeNewsstandContentAvailability];
```

AppDelegate.m で、次の宣言を使用して実装セクションを先頭に追加します。

@interface AppDelegate ()
- (void) retrieveSecurePayloadWithId:(int)payloadId completion: (void(^)(NSString*, NSError*)) completion;
@end

次に、実装セクションに次のコードを追加します。プレースホルダー {back-end endpoint} を前に取得したバックエンドのエンドポイントに置き換えます。

NSString *const GetNotificationEndpoint = @"{back-end endpoint}/api/notifications";

- (void) retrieveSecurePayloadWithId:(int)payloadId completion: (void(^)(NSString*, NSError*)) completion;
{
    // check if authenticated
    ANHViewController* rvc = (ANHViewController*) self.window.rootViewController;
    NSString* authenticationHeader = rvc.registerClient.authenticationHeader;
    if (!authenticationHeader) return;

    NSURLSession* session = [NSURLSession
                                sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
                                delegate:nil
                                delegateQueue:nil];

    NSURL* requestURL = [NSURL URLWithString:[NSString stringWithFormat:@"%@/%d", GetNotificationEndpoint, payloadId]];
    NSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:requestURL];
    [request setHTTPMethod:@"GET"];
    NSString* authorizationHeaderValue = [NSString stringWithFormat:@"Basic %@", authenticationHeader];
    [request setValue:authorizationHeaderValue forHTTPHeaderField:@"Authorization"];

    NSURLSessionDataTask* dataTask = [session dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSHTTPURLResponse* httpResponse = (NSHTTPURLResponse*) response;
        if (!error && httpResponse.statusCode == 200)
        {
            NSLog(@"Received secure payload: %@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);

            NSMutableDictionary *json = [NSJSONSerialization JSONObjectWithData:data options: NSJSONReadingMutableContainers error: &error];

            completion([json objectForKey:@"Payload"], nil);
        }
        else
        {
            NSLog(@"Error status: %ld, request: %@", (long)httpResponse.statusCode, error);
            if (error)
                completion(nil, error);
            else {
                completion(nil, [NSError errorWithDomain:@"APICall" code:httpResponse.statusCode userInfo:nil]);
            }
        }
    }];
    [dataTask resume];
}

このメソッドは、共有設定に格納された資格情報によってアプリケーションバックエンドを呼び出して通知コンテンツを取得します。

ここでは、受信通知を処理し、上記のメソッドを使用して、表示するコンテンツを取得します。最初に、プッシュ通知を受信するときに iOS アプリがバックグラウンドで実行されるようにします。 XCode で、左側のパネルのアプリケーションプロジェクトを選択し、中央のウィンドウの [ターゲット] セクションでメインアプリケーションターゲットをクリックします。
次に、中央ペインの上部にある [機能] タブをクリックし、 [リモート通知] ボックスをオンにします。

AppDelegate.m で、次のメソッドを追加してプッシュ通知を処理します。

-(void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
    NSLog(@"%@", userInfo);

    [self retrieveSecurePayloadWithId:[[userInfo objectForKey:@"secureId"] intValue] completion:^(NSString * payload, NSError *error) {
        if (!error) {
            // show local notification
            UILocalNotification* localNotification = [[UILocalNotification alloc] init];
            localNotification.fireDate = [NSDate dateWithTimeIntervalSinceNow:0];
            localNotification.alertBody = payload;
            localNotification.timeZone = [NSTimeZone defaultTimeZone];
            [[UIApplication sharedApplication] scheduleLocalNotification:localNotification];

            completionHandler(UIBackgroundFetchResultNewData);
        } else {
            completionHandler(UIBackgroundFetchResultFailed);
        }
    }];

}

認証ヘッダープロパティが不明な場合やバックエンドによって拒否された場合などに対応できるようにすることをお勧めします。これらの場合への具体的な対処は、ほぼターゲットユーザーのエクスペリエンスに依存します。 1 つのオプションとしては、ユーザーに通知と共に認証を求める一般的なプロンプトを表示して、実際の通知を取得する方法があります。

アプリケーションの実行

アプリケーションを実行するには、以下の手順に従います。

XCode を使用して、物理 iOS デバイスでアプリケーションを実行します (プッシュ通知はシミュレーターでは機能しません)。
iOS アプリケーションの UI で、ユーザー名とパスワードを入力します。文字列は任意ですが、値は同じである必要があります。
iOS アプリケーションの UI で、 [ログイン] をクリックします。次に、 [プッシュを送信する] をクリックします。通知センターに安全な通知が表示されます。

Azure Notification Hubs の安全なプッシュ

概要

Web API プロジェクト

iOS プロジェクトを変更する

アプリケーションの実行

その他のリソース