Dans cet article
Aperçu du proxy d'authentification NPS
dropdown icon
Prérequis pour l’authentification du proxy NPS
    Versions minimales et restrictions de co-résidence
    NPS partagé
    Noms de point d'accès HTTP/2
    Android FCMv1
Résumé du transfert du proxy NPS
Migrer les applications BroadWorks Collaborate iOS vers HTTP/2
Migrer les applications Android BroadWorks UC-One Connect/SaaS vers FCMv1
Migrer les applications Android BroadWorks UC-One Connect/SaaS vers FCMv1 (sur ADP)
Réactiver le mode hérité FCM
dropdown icon
Installer les correctifs du proxy d'authentification NPS
    R22 Correctifs
    R23 Correctifs
Configurer NPS pour utiliser le proxy d’authentification
Redémarrer les notifications NPS et test Push
Mettre à jour Cisco BroadWorks NPS pour utiliser le proxy NPS : Guide de configuration
list-menuDans cet article
list-menuUn commentaire ?

Apprenez à mettre à jour Cisco BroadWorks NPS pour utiliser le proxy NPS avec ce guide de configuration. Découvrez les instructions étape par étape, les considérations et les meilleures pratiques pour une intégration transparente et une performance réseau améliorée.

Présentation du proxy d’authentification NPS

Cet article décrit comment configurer un NPS partagé pour utiliser le proxy d’authentification NPS, pour qu’il puisse également être utilisé pour pousser les notifications d’appel vers les applications Webex. Si votre NPS ne prend pas en charge d’autres applications, vous pouvez suivre la procédure simplifiée dans le Guide de la solution Webex pour BroadWorks.

Aperçu du proxy NPS

Pour des raisons de compatibilité avec Webex pour BroadWorks, votre serveur NPS doit être corrigé pour prendre en charge la fonctionnalité de proxy NPS, Serveur Push pour la VoIP dans UCaaS.

La fonctionnalité implémente un nouveau design dans le serveur Push de notification pour résoudre la vulnérabilité de sécurité du partage des clés privées de notification Push avec les fournisseurs de services pour les clients mobiles. Au lieu de partager des certificats et des clés de notification push avec le fournisseur de services, le NPS utilise une nouvelle API pour obtenir un jeton de notification push de courte durée à partir du backend UCaaS, et utilise ce jeton pour l’authentification avec les APN d’Apple et les services Google FCM.

Cette fonctionnalité améliore également la capacité du serveur push de notification à diffuser des notifications sur les périphériques Android via la nouvelle API HTTPv1 Google Firebase Cloud Messaging (FCM).

Prérequis pour le proxy d’authentification NPS

Le XSP (ou ADP de la plateforme de livraison d’applications) qui héberge NPS doit répondre aux exigences suivantes :

Versions minimum et restrictions de co-résidence

  • NPS doit être activé sur un XSP/ADP dédié et NPS doit être la seule application hébergée sur le serveur. Ceci afin d’éliminer les interférences lors de l’envoi des notifications Push.

  • Il ne doit y avoir qu’une seule application NPS dans un déploiement. Si vous utilisez mobile UC-One Collaborate/Connect et ou UC-One SaaS et que vous implémentez Webex pour BroadWorks, vous devez partager ce NPS unique pour toutes les applications.

  • NPS doit être sur la version R22 ou ultérieure XSP, ou ADP.

    R22/R23 XSP est compatible avec une pile R21 si le XSP only exécute NPS et que le AS est R21.SP1. Reportez-vous à la matrice de compatibilité BroadWorks pour plus d'informations.

  • Vous trouverez plus d’informations sur le serveur ADP à l’adresse Plateforme de livraison d’applications Cisco BroadWorks.

NPS partagé

Lisez ces notes avant de configurer votre NPS partagé pour utiliser le proxy NPS :

  • Si votre NPS est utilisé avec d’autres applications (pas seulement l’application Webex) : Tout d'abord configurez le proxy NPS, puis changez le NPS de l'utilisation de l'API FCM héritée à l'utilisation de l'API FCM HTTP v1.

  • Après avoir vérifié que les notifications fonctionnent correctement pour les anciennes applications avec le proxy NPS, supprimez la clé API FCM pour l’application Android et la clé d’authentification des noms de point d’accès pour l’application iOS.

HTTP/ des noms de point d'accès2

  • Si vous avez déployé des applications iOS qui ne proviennent pas de Cisco/BroadSoft, configurez ces applications pour qu’elles utilisent le protocole HTTP/2 APNS avant de configurer NPS pour utiliser le proxy NPS.

  • Les XSP/ADP qui prennent déjà en charge l’application Collaborate ou SaaS BroadWorks doivent être migrés vers HTTP/2. Pour des informations détaillées sur la configuration de HTTP/2, voir HTTP/2 Prise en charge du serveur push de notification pour APNS (la migration de NPS pour prendre en charge ces applications iOS est résumée dans cet article).

FCMv Android1

  • Si vous avez déployé des applications Android qui ne proviennent pas de Cisco/BroadSoft, configurez ces applications pour utiliser les clés FCMv1 avant de configurer NPS pour utiliser le proxy NPS.

  • Si XSP/ADP prend actuellement en charge l'application Connect ou UC-One SaaS, activez alors FCMv1 clés après avoir 2configuré le proxy NPS. Nous vous recommandons de migrer toutes les applications supplémentaires vers les clés FCMv1, d'activer et de tester, puis de désactiver jusqu'à ce que vous soyez prêt à terminer les instructions de configuration (le flux de migration est documenté dans cet article).

Résumé de la migration du proxy NPS

Résumé visuel de la migration vers le proxy d'authentification NPS
Table 1. Summary of Tasks to Migrate to NPS Proxy

Séquence

Titre de la tâche

Quand/Pourquoi une tâche est-elle requise ?

1

Migrer NPS vers HTTP/2 pour les applications iOS UC-One SaaS (ou Connect).

Si le NPS prend en charge ces applications et qu’elles ne sont pas encore configurées pour HTTP/2.

2

Migrer NPS vers FCMv1 pour les applications Android UC-One SaaS (ou Connect).

Si le NPS prend en charge ces applications et qu'elles ne sont pas encore configurées pour FCMv1.

3

Activez le mode FCMv1 et testez les notifications Push.

Si le NPS est en charge UC-One Connect et/ou autres applications Android (non Cisco).

4

Activer à nouveau le mode FCM legacy.

Si le NPS supporte UC-One SaaS. Si vous laissez FCMv1 activé, avant de configurer le proxy NPS, alors les notifications push vers UC-One SaaS commencent à échouer.

5

Installer les patches du proxy d’authentification NPS.

Si NPS est sur XSP R22 ou XSP R23.

6

Configurer NPS pour utiliser le proxy d’authentification NPS :

  • Joindre la support technique à partir du NPS

  • Demander le compte OAuth CI

  • Créez un compte CI sur NPS et configurez l’actualisation du délai d’actualisation du jeton

  • Ajouter les id de l’application Android

  • Ajouter les id de l’application iOS

  • Vérifier/configurer les URL et les délais d’échec de la connexion

  • Ajouter des applications à la liste d’autoriser AS

  • (Re-)activer FCMv1

  • Redémarrer XSP /ADP

  • Tester les PN pour les applications iOS et Android

Toujours obligatoire.

7

Supprimer les clés du mode FCM hérité.

Pour les applications prises en charge avec succès par NPS sur FCMv1.

Migrer les applications BroadWorks Collaborate iOS vers HTTP/2

Cette tâche est obligatoire pour les notifications Push vers les applications UC-One SaaS et Webex sur les plateformes iOS.

Avant de commencer

Si votre XSP exécute R22, vous devez appliquer ap354313 avant de pouvoir configurer l’application NPS pour utiliser HTTP/2 pour APNS.

1

Définir l'URL de production et les paramètres de connexion à XSP_CLI/Applications/NotificationPushServer/APNS/Production>

set url https://api.push.apple.com/3/device

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Remarque : Ne définissez pas le délai d'expiration de la connexion au-dessous de 1000.

2

Ajoutez les ID de l’application au contexte des applications APNS, en s’assurer d’omettre la clé d’auth – la configurer sur vide.

Pour UC-One SaaS :XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.broadsoft.uc-one

Pour l’application Webex : XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

3

Vérifiez les clés d’authentification avec XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Si la clé d'1ère n’est pas vide pour com.broadsoft.uc-one, vous pouvez le faire avec XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Activer HTTP/2 :

XSP_CLI/Applications/NotificationPushServer/APNS/GeneralSettings> set HTTP2Enabled true

6

Pour les applications UC-One SaaS uniquement : Connectez-vous au portail du revendeur et allez à Configuration > BroadWorks > .

7

Faites défiler jusqu'à la section Serveur Push de notification et sélectionnez votre version (par exemple version 22), puis suivez les instructions fournies dans le portail.

Migrer les applications Android BroadWorks UC-One Connect/SaaS vers FCMv1

  • Cette tâche s’applique au NPS sur XSP. Ignorez-le si votre NPS est sur ADP.

  • Vous pouvez utiliser cette procédure pour migrer vers les notifications FCMv1 pour les applications Android UC-One Connect ou UC-One SaaS.

  • Vous devez utiliser FCMv1 si vous souhaitez utiliser le proxy NPS pour authentifier les notifications Push sur UC-One ou les applications Webex Android.

  • Cette tâche prépare le serveur NPS pour FCMv1 afin que vous puissiez l'activer dans le cadre de la configuration du proxy d'authentification NPS. N'activez pas FCMv1 tant que vous n'êtes pas prêt à configurer le proxy d'authentification NPS, ou les notifications aux clients SaaS échoueront.

1

Obtenir l’ID du projet à partir de la console Firebase :

  1. Connectez-vous à l console.firebase.google.com.

  2. Sélectionnez le projet d’application UC-One (Connect ou SaaS), ouvrez ses paramètres de projet.

  3. Ouvrez l’onglet Général et enregistrez l’ID du projet.

2

Obtenez la clé privée de votre compte de service à partir de Firebase :

  1. Accédez à l’onglet Comptes de service dans les paramètres du projet.

  2. Créez un nouveau compte de service et obtenez sa clé privée.

  3. Ou ouvrez un compte de service existant et générz-lui une nouvelle clé privée.

    Remarque : Le compte de service doit avoir l’autorisation firebaseadmin-sdk.

  4. Téléchargez la clé dans un emplacement sécurisé.

3

Copiez la clé vers le XSP hébergeant votre NPS.

4

Ajoutez l’ID du projet et la clé privée associée au contexte des projets FCM :

XSP_CLI/Applications/NotificationPushServer/FCM/Projects> add project-id path/to/keyfile

5

Ajoutez l’application UC-One (Connect ou SaaS) et l’ID du projet associé au contexte des applications FCM :

XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.broadsoft.connect projectId project-id

6

Vérifiez la configuration pour FCM par rapport aux attributs et aux valeurs recommandées affichées ici. Utiliser set version de la commande pour changer les valeurs si nécessaire :

Exécuter XSP_CLI/Applications/NotificationPushServer/FCM> get

Paramètre

Valeur recommandée

authURL

https://www.googleapis.com/oauth2/v4/token

pushURL

https://fcm.googleapis.com/v1/projects/PROJECT-ID/messages:send

scope

https://www.googleapis.com/auth/firebase.messaging

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

600

Migrer les applications Android BroadWorks UC-One Connect/SaaS vers FCMv1 (sur ADP)

  • Cette tâche s’applique au NPS sur ADP. Ignorez-le si votre NPS est sur XSP.

  • Vous pouvez utiliser cette procédure pour migrer vers les notifications FCMv1 pour les applications Android UC-One Connect ou UC-One SaaS.

  • Vous devez utiliser FCMv1 si vous souhaitez utiliser le proxy NPS pour authentifier les notifications Push sur UC-One ou les applications Webex Android.

  • Cette tâche prépare le serveur NPS pour FCMv1 afin que vous puissiez l'activer dans le cadre de la configuration du proxy d'authentification NPS. N'activez pas FCMv1 tant que vous n'êtes pas prêt à configurer le proxy d'authentification NPS, ou les notifications aux clients SaaS échoueront.

1

Obtenir l’ID du projet à partir de la console Firebase :

  1. Connectez-vous à l console.firebase.google.com.

  2. Sélectionnez le projet d’application UC-One (Connect ou SaaS), ouvrez ses paramètres de projet.

  3. Ouvrez l’onglet Général et enregistrez l’ID du projet.

2

Obtenez la clé privée de votre compte de service à partir de Firebase :

  1. Accédez à l’onglet Comptes de service dans les paramètres du projet.

  2. Créez un nouveau compte de service et obtenez sa clé privée.

  3. Ou ouvrez un compte de service existant et générz-lui une nouvelle clé privée.

    Remarque : Le compte de service doit avoir l’autorisation firebaseadmin-sdk.

  4. Téléchargez la clé (fichier .json) dans un emplacement sécurisé.

3

Importez le fichier .json sur le serveur ADP /bw/install.

4

Connectez-vous à ADP CLI et ajoutez la clé de projet et l’API au contexte des projets FCM :

ADP_CLI/Applications/NotificationPushServer/FCM/Projects> add connect-ucaas /bw/install/filename.json

5

Ajoutez l’application et l’ID du projet au contexte des applications FCM :

ADP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.broadsoft.ucaas.connect projectId project-id

6

Vérifiez votre configuration :

ADP_CLI/Applications/NotificationPushServer/FCM/Projects> get
Project ID Accountkey
========================
connect-ucaas ********
ADP_CLI/Applications/NotificationPushServer/FCM/Applications> get
Application ID Project ID
===================================
com.broadsoft.ucaas.connect connect-ucaas

Ré-activer le mode FCM Legacy

Vous devez le faire (dans le cadre de la migration) si :

  • Votre NPS est utilisé pour les applications UC-One SaaS ou BroadWorks Connect Android.

  • Vous avez déjà testé que les notifications push d’appels vers d’autres applications fonctionnent avec l’API FCMv1.

Vous désactivez temporairement FCMv1 car les clés FCMv1 pour ces applications doivent être activées uniquement pendant le processus de configuration du proxy d’authentification NPS.

1

Connectez-vous au XSP hébergeant votre NPS partagé.

2

Accédez au contexte FCM et désactivez FCM v1 : XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false pour revenir à l’utilisation de la clé API fcM héritée.

Configurer NPS pour utiliser le proxy d’authentification

1

Créez une demande de service avec votre contact d’intégration, ou avec le CAT, pour provisionner votre compte client (Webex Identité commune) OAuth. Tirez votre demande de service Configuration NPS pour la configuration du proxy d’authentification.

Nous vous donnons un ID client OAuth, un code secret client et un jeton d’actualisation valide pendant 60 jours. Si le jeton expire avant d’utiliser avec votre NPS, vous pouvez demander une autre demande.
2

Créer le compte client sur le NPS :

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set clientId client-Id-From-Step1

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set clientSecret
New Password: client-Secret-From-Step1

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set RefreshToken
New Password: Refresh-Token-From-Step1

Exécutez la commande pour vérifier que les valeurs que vous avez saisies correspondent à celles qui vous ont été fournies. XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Saisissez l’URL du proxy NPS et définissez l’intervalle d’actualisation du jeton (30 minutes recommandées) :

FDQN basés sur la région :

Est des États-Unis :

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://broadworks-idp-proxy-a.wbx2.com/nps/

Ouest américain :

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://broadworks-idp-proxy-r.wbx2.com/nps/

Europe :

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://broadworks-idp-proxy-k.wbx2.com/nps/

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

Arabie saoudite :

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://broadworks-idp-proxy-d.wbx2.com/nps/

Australie:

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://broadworks-idp-proxy-m.wbx2.com/nps/

Si les notifications Push expirent en raison d'un délai de résolution DNS, augmentez la valeur du délai d'expiration dans le fichier "/etc/resolv.conf" sur le serveur BroadWorks.

4

(Pour les notifications Android) Ajoutez les ID de l’application Android au contexte des applications FCM sur le NPS.

Pour l’application Webex sur Android : XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

Pour l’application UC-One sur Android : XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect

5

(Pour les notifications Apple iOS) Ajoutez l’ID de l’application au contexte des applications APNS, en s’assurer d’omettre la clé Dauth – la configurer sur vide.

Pour l’application Webex sur iOS : XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

Pour l’application UC-One sur iOS : XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Configurez les URL NPS suivantes :

Contexte CLI XSP

Paramètre

Valeur

XSP_CLI/Applications/NotificationPushServer/FCM>

authURL

https://www.googleapis.com/oauth2/v4/token

pushURL

https://fcm.googleapis.com/v1/projects//messages:send

scope

https://www.googleapis.com/auth/firebase.messaging

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

url

https://api.push.apple.com/3/device

7

Configurez les paramètres de connexion NPS suivants aux valeurs recommandées indiquées :

Contexte CLI XSP

Paramètre

Valeur

XSP_CLI/Applications/NotificationPushServer/FCM>

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

600

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

connectionTimeout

3000

connectionPoolSize

2

connectionIdleTimeoutInSeconds

600

8

Vérifiez si le serveur d’applications vérifie les ID des applications, car vous devez ajouter les applications Webex à la liste d’autoriser :

  1. Exécuter AS_CLI/System/PushNotification> get et vérifier la valeur de enforceAllowedApplicationList. Si c’est true, vous devez terminer cette sous-tâche. Sinon, ignorez le reste de la sous-tâche.

  2. AS_CLI/System/PushNotification/AllowedApplications> add com.cisco.wx2.android “Webex Android”

  3. AS_CLI/System/PushNotification/AllowedApplications> add com.cisco.squared “Webex iOS”

Redémarrer NPS et tester les notifications Push

1

Redémarrez le XSP :

bwrestart
2

Testez les notifications d’appel sur Android en appelant à partir d’un abonné BroadWorks vers le client appelant sur Android. Vérifiez que la notification d’appel s’affiche sur l’appareil Android.

Remarque : Si les notifications Push commencent à échouer pour l’application Android UC-One, il est possible qu’il y a une mauvaise configuration. Dans ce cas, vous pouvez revenir à l’héritage FCM comme suit :

  1. Désactiver FCMv1 : XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Redémarrer XSP : bwrestart

  3. Vérifiez votre configuration.

  4. Réactivez FCMv1 et redémarrez le XSP.

  5. Répétez le test.

3

Testez les notifications d’appel sur iOS en appelant à partir d’un abonné BroadWorks vers le client appelant sur iOS. Vérifiez que la notification d’appel s’affiche sur le périphérique iOS.

Remarque : Si les notifications Push commencent à échouer pour l’application iOS UC-One, il est possible qu’il y a une mauvaise configuration. Si c’est votre situation, vous pouvez revenir à l’interface binaire héritée avec set HTTP2Enabled false

Cet article était-il utile ?
Cet article était-il utile ?