Prehľad servera proxy na overenie totožnosti NPS

Tento článok popisuje, ako nakonfigurovať zdieľaný server NPS na používanie servera proxy na overenie NPS, aby sa dal použiť aj na odosielanie upozornení na hovory do aplikácií Webex. Ak váš NPS nepodporuje iné aplikácie, môžete postupovať podľa zjednodušeného postupu v príručke Webex for BroadWorks Solution Guide https://help.webex.com/z9gt5j.

Prehľad proxy servera NPS

Pre kompatibilitu s Webex for BroadWorks musí byť váš NPS opravený tak, aby podporoval funkciu NPS Proxy, Push Server pre VoIP v UCaaS.

Táto funkcia implementuje nový dizajn v serveri Notification Push Server na vyriešenie bezpečnostnej zraniteľnosti zdieľania súkromných kľúčov certifikátu push notifikácií s poskytovateľmi služieb pre mobilných klientov. Namiesto zdieľania certifikátov a kľúčov push notifikácií s poskytovateľom služieb používa NPS nové API na získanie krátkodobého tokenu push notifikácií z backendu UCaaS a používa tento token na autentifikáciu so službami Apple APN a Google FCM.

Táto funkcia tiež vylepšuje schopnosť notifikačného servera posielať upozornenia do zariadení so systémom Android prostredníctvom nového rozhrania Google Firebase Cloud Messaging (FCM) HTTPv1 API.

Požiadavky na overenie proxy servera NPS

XSP (alebo Application Delivery Platform ADP), ktorý je hostiteľom NPS, musí spĺňať nasledujúce požiadavky:

Minimálne verzie a obmedzenia spoločného pobytu

  • NPS musí byť aktivovaný na vyhradenom XSP/ADP a NPS musí byť jedinou hostovanou aplikáciou na serveri. Toto má eliminovať interferenciu s doručovaním Push notifikácií.

  • V nasadení by mala byť iba jedna aplikácia NPS. Ak používate mobilné UC-One Collaborate/Connect alebo UC-One SaaS a implementujete Webex for BroadWorks, musíte zdieľať tento jediný NPS pre všetky aplikácie.

  • NPS musí byť vo verzii R22 alebo novšej XSP alebo ADP.

    R22/R23 XSP je kompatibilný so zásobníkom R21, ak je XSP iba beží NPS a AS je R21.SP1. Pozrite si matica kompatibility BroadWorks Pre viac informácií.

  • Viac informácií o serveri ADP nájdete na https://xchange.broadsoft.com/node/1051580.

Zdieľané NPS

Pred konfiguráciou zdieľaného servera NPS na používanie servera proxy NPS si prečítajte tieto poznámky:

  • Ak sa váš NPS používa s inými aplikáciami (nielen s aplikáciou Webex): Najprv nakonfigurujte server proxy NPS a potom zmeňte server NPS z používania staršieho rozhrania API FCM na používanie FCM HTTP v1 API.

  • Po overení, že upozornenia fungujú správne pre staršie aplikácie pomocou servera proxy NPS, odstráňte kľúč FCM API pre aplikáciu Android a kľúč overenia APN pre aplikáciu pre iOS.

APN HTTP/2

  • Ak ste nasadili akékoľvek aplikácie pre iOS, ktoré nepochádzajú od spoločnosti Cisco/BroadSoft, pred konfiguráciou NPS na používanie servera proxy NPS tieto aplikácie nakonfigurujte na používanie protokolu HTTP/2 APNS.

  • XSP/ADP, ktoré už podporujú aplikáciu Collaborate alebo SaaS BroadWorks, je potrebné migrovať na HTTP/2. Podrobné informácie o konfigurácii HTTP/2 nájdete v časti Podpora HTTP/2 pre notifikačný server pre APNS (migrácia NPS na podporu týchto aplikácií pre iOS je zhrnutá v tomto článku).

Android FCMv1

  • Ak ste nasadili akékoľvek aplikácie pre Android, ktoré nepochádzajú od spoločnosti Cisco/BroadSoft, pred konfiguráciou servera NPS na používanie servera proxy NPS tieto aplikácie nakonfigurujte na používanie kľúčov FCMv1.

  • Ak XSP/ADP momentálne podporuje aplikáciu Connect alebo UC-One SaaS, povoľte kľúče FCMv1 po nakonfigurujete NPS proxy. Odporúčame vám migrovať všetky ďalšie aplikácie na kľúče FCMv1, povoliť a otestovať a potom zakázať, kým nebudete pripravení dokončiť pokyny na nastavenie (postup migrácie je zdokumentovaný v tomto článku).

Súhrn migrácie proxy servera NPS

Postava 1. Vizuálne zhrnutie migrácie na autentifikačný proxy server NPS
Stôl 1. Súhrn úloh na migráciu na server proxy NPS

Sekvencia

Názov úlohy

Kedy/prečo je úloha potrebná?

1

Migrujte NPS na HTTP/2 pre aplikácie UC-One SaaS (alebo Connect) pre iOS.

Ak NPS podporuje tieto aplikácie a ešte nie sú nakonfigurované pre HTTP/2.

2

Migrujte NPS na FCMv1 pre aplikácie UC-One SaaS (alebo Connect) pre Android.

Ak NPS podporuje tieto aplikácie a ešte nie sú nakonfigurované pre FCMv1.

3

Povoľte režim FCMv1 a otestujte upozornenia push.

Ak NPS podporuje UC-One Connect a/alebo iné (iné ako Cisco) aplikácie pre Android.

4

Znova povoľte starší režim FCM.

Ak NPS podporuje UC-One SaaS. Ak ponecháte FCMv1 povolený, pred konfiguráciou servera proxy servera NPS začnú odosielané upozornenia do UC-One SaaS zlyhávať.

5

Nainštalujte opravy proxy servera na overenie NPS.

Ak je NPS na XSP R22 alebo XSP R23.

6

Nakonfigurujte server NPS na používanie servera proxy na overenie NPS:

  • Pripojte technickú podporu od NPS

  • Požiadajte o účet CI OAuth

  • Vytvorte účet CI na serveri NPS a nakonfigurujte časový limit obnovovacieho tokenu

  • Pridajte ID aplikácií pre Android

  • Pridajte ID aplikácií pre iOS

  • Skontrolujte/nastavte adresy URL a časové limity pripojenia

  • Pridajte aplikácie do zoznamu povolených AS

  • (Znovu) povoliť FCMv1

  • Reštartujte XSP / ADP

  • Testujte PN pre aplikácie pre iOS a Android

Vždy požadované.

7

Odstráňte kľúče staršieho režimu FCM.

Pre aplikácie, ktoré NPS úspešne podporuje na FCMv1.

Migrujte aplikácie BroadWorks Collaborate iOS na HTTP/2

Táto úloha je povinná pre upozornenia push do aplikácií UC-One SaaS a Webex na platformách iOS.

Predtým ako začneš

Ak váš XSP používa R22, musíte použiť ap354313 predtým, ako budete môcť nakonfigurovať aplikáciu NPS na používanie HTTP/2 pre APNS.

1

Nastavte produkčnú adresu URL a parametre pripojenia na XSP_CLI/Applications/NotificationPushServer/APNS/Production>

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

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Poznámka: Nenastavujte časový limit pripojenia pod 1000.
2

Pridajte ID aplikácií do kontextu aplikácií APNS, pričom nezabudnite vynechať kľúč Auth – nastavte ho na prázdny.

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

Pre aplikáciu Webex: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared
3

Skontrolujte autorizačné kľúče pomocou XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get
4

Ak autorizačný kľúč nie je prázdny pre com.broadsoft.uc-one, môžete to vyčistiť pomocou XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey
5

Povoliť HTTP/2:

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

Len pre aplikácie UC-One SaaS: Prihláste sa na portál predajcu a prejdite na Konfigurácia > BroadWorks > .

7

Posuňte sa nadol do časti Notification Push Server a vyberte svoje vydanie (napr Vydanie 22), potom postupujte podľa pokynov uvedených na portáli.

Migrujte aplikácie BroadWorks UC-One Connect / SaaS Android na FCMv1

  • Táto úloha sa vzťahuje na NPS na XSP. Ak je váš NPS na ADP, ignorujte ho.

  • Tento postup môžete použiť na migráciu na upozornenia FCMv1 pre aplikácie UC-One Connect alebo UC-One SaaS pre Android.

  • Ak chcete použiť server proxy NPS na overenie upozornení push pre UC-One alebo aplikácie Webex pre Android, musíte použiť FCMv1.

  • Táto úloha pripraví server NPS na FCMv1, aby ste ho mohli povoliť ako súčasť konfigurácie servera proxy na autentifikáciu NPS. Nepovoľujte FCMv1, kým nebudete pripravení nakonfigurovať server proxy na overenie NPS, inak zlyhajú upozornenia pre klientov SaaS.

1

Získajte ID projektu z konzoly Firebase:

  1. Prihláste sa na console.firebase.google.com.

  2. Vyberte projekt aplikácie UC-One (Connect alebo SaaS), otvorte jeho nastavenia projektu.

  3. Otvor generál a zaznamenajte si ID projektu.
2

Získajte súkromný kľúč svojho servisného účtu z Firebase:

  1. Prejdite na kartu Servisné účty v nastaveniach projektu.

  2. Buď si vytvorte nový servisný účet a získajte jeho súkromný kľúč.

  3. Alebo otvorte existujúci účet služby a vygenerujte preň nový súkromný kľúč.

    Poznámka: Servisný účet musí mať firebaseadmin-sdk povolenie.

  4. Stiahnite si kľúč na bezpečné miesto.
3

Skopírujte kľúč do XSP, ktoré hostí váš NPS.
4

Pridajte ID projektu a priradený súkromný kľúč do kontextu projektov FCM:

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

Pridajte aplikáciu UC-One (Connect alebo SaaS) a súvisiace ID projektu do kontextu aplikácií FCM:

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

Skontrolujte konfiguráciu FCM v porovnaní s tu uvedenými atribútmi a odporúčanými hodnotami. Použite set verzia príkazu na zmenu hodnôt v prípade potreby:

Bežať XSP_CLI/Applications/NotificationPushServer/FCM> get

Parameter

Odporúčaná hodnota

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

Migrujte aplikácie BroadWorks UC-One Connect / SaaS Android na FCMv1 (na ADP)

  • Táto úloha sa vzťahuje na NPS na ADP. Ak je váš NPS na XSP, ignorujte ho.

  • Tento postup môžete použiť na migráciu na upozornenia FCMv1 pre aplikácie UC-One Connect alebo UC-One SaaS pre Android.

  • Ak chcete použiť server proxy NPS na overenie upozornení push pre UC-One alebo aplikácie Webex pre Android, musíte použiť FCMv1.

  • Táto úloha pripraví server NPS na FCMv1, aby ste ho mohli povoliť ako súčasť konfigurácie servera proxy na autentifikáciu NPS. Nepovoľujte FCMv1, kým nebudete pripravení nakonfigurovať server proxy na overenie NPS, inak zlyhajú upozornenia pre klientov SaaS.

1

Získajte ID projektu z konzoly Firebase:

  1. Prihláste sa na console.firebase.google.com.

  2. Vyberte projekt aplikácie UC-One (Connect alebo SaaS), otvorte jeho nastavenia projektu.

  3. Otvor generál a zaznamenajte si ID projektu.
2

Získajte súkromný kľúč svojho servisného účtu z Firebase:

  1. Prejdite na kartu Servisné účty v nastaveniach projektu.

  2. Buď si vytvorte nový servisný účet a získajte jeho súkromný kľúč.

  3. Alebo otvorte existujúci účet služby a vygenerujte preň nový súkromný kľúč.

    Poznámka: Servisný účet musí mať firebaseadmin-sdk povolenie.

  4. Stiahnite si kľúč (súbor .json) na bezpečné miesto.
3

Importujte súbor .json na server ADP /bw/install.

4

Prihláste sa do ADP CLI a pridajte projekt a kľúč API do kontextu projektov FCM:

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

Pridajte ID aplikácie a projektu do kontextu aplikácií FCM:

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

Overte svoju konfiguráciu:

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

Znova povoľte starší režim FCM

Musíte to urobiť (ako súčasť migrácie), ak:

  • Váš NPS sa používa pre aplikácie UC-One SaaS alebo BroadWorks Connect pre Android.

  • Už ste testovali, že volanie push notifikácií do iných aplikácií funguje s FCMv1 API.

Dočasne zakazujete FCMv1, pretože FCMv1 kľúče pre tieto aplikácie len musí byť povolené počas procesu konfigurácie servera proxy na overenie NPS.

1

Prihláste sa do XSP, ktoré hostí váš zdieľaný NPS.
2

Prejdite do kontextu FCM a vypnite FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false vrátiť sa k používaniu staršieho kľúča API FCM.

Nainštalujte opravy proxy servera na overenie NPS

Nakonfigurujte server NPS na používanie autentifikačného proxy

1

Vytvorte požiadavku na službu s kontaktom na registráciu alebo s TAC, aby ste mohli poskytnúť svoj klientsky účet OAuth (Webex Common Identity). Pomenujte svoju požiadavku na službu Konfigurácia NPS pre nastavenie proxy servera overenia.

Cisco vám poskytne ID klienta OAuth, tajomstvo klienta a obnovovací token, ktorý je platný 60 dní. Ak platnosť tokenu vyprší skôr, ako ho použijete so svojím NPS, môžete podať ďalšiu žiadosť.
2

Vytvorte klientsky účet na 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

Ak chcete overiť, či sa zadané hodnoty zhodujú s tým, čo ste dostali, spustite XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get
3

Zadajte adresu URL proxy servera NPS a nastavte interval obnovenia tokenu (odporúča sa 30 minút):

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://nps.uc-one.broadsoft.com/nps/

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800
4

(Pre upozornenia systému Android) Pridajte ID aplikácií Android do kontextu aplikácií FCM na NPS.

Pre aplikáciu Webex v systéme Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

Pre aplikáciu UC-One v systéme Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect
5

(Pre upozornenia Apple iOS) Pridajte ID aplikácie do kontextu aplikácií APNS, pričom nezabudnite vynechať kľúč Auth – nastavte ho na prázdny.

Pre aplikáciu Webex v systéme iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

Pre aplikáciu UC-One v systéme iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared
6

Nakonfigurujte nasledujúce adresy URL NPS:

Tabuľka 2

Kontext XSP CLI

Parameter

Hodnota

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

Nakonfigurujte nasledujúce parametre pripojenia NPS na zobrazené odporúčané hodnoty:

Tabuľka 3.

Kontext XSP CLI

Parameter

Hodnota

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

Skontrolujte, či aplikačný server kontroluje ID aplikácií, pretože možno budete musieť pridať aplikácie Webex do zoznamu povolených:

  1. Bežať AS_CLI/System/PushNotification> get a skontrolujte hodnotu enforceAllowedApplicationList. Keď to je true, musíte dokončiť túto čiastkovú úlohu. V opačnom prípade preskočte zvyšok podúlohy.

  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”

Reštartujte NPS a testujte upozornenia push

1

Reštartujte XSP:

bwrestart
2

Otestujte upozornenia na hovory pre Android uskutočňovaním hovorov od predplatiteľa BroadWorks volajúcemu klientovi v systéme Android. Skontrolujte, či sa na zariadení so systémom Android zobrazuje upozornenie na hovor.

Poznámka: Ak pre aplikáciu UC-One pre Android začnú upozornenia push zlyhávať, je možné, že došlo k nesprávnej konfigurácii. Ak je to vaša situácia, môžete sa vrátiť k starému FCM takto:

  1. Zakázať FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Reštartujte XSP: bwrestart

  3. Skontrolujte svoju konfiguráciu.

  4. Znova povoľte FCMv1 a reštartujte XSP.

  5. Zopakujte test.
3

Otestujte upozornenia na hovory pre iOS uskutočňovaním hovorov od predplatiteľa BroadWorks volajúcemu klientovi na iOS. Skontrolujte, či sa na zariadení so systémom iOS zobrazuje upozornenie na hovor.

Poznámka: Ak pre aplikáciu UC-One pre iOS začnú upozornenia push zlyhávať, je možné, že došlo k nesprávnej konfigurácii. Ak je to vaša situácia, môžete sa vrátiť k staršiemu binárnemu rozhraniu s set HTTP2Enabled false