Prehľad proxy overovania NPS

Tento článok popisuje, ako nakonfigurovať zdieľaný NPS na používanie proxy servera 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 Sprievodcovi riešením Webex for BroadWorks.

Prehľad proxy NPS

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

Táto funkcia implementuje nový dizajn servera Notification Push Server, ktorý rieši bezpečnostnú zraniteľnosť spočívajúcu v zdieľaní súkromných kľúčov certifikátov push notifikácií s poskytovateľmi služieb pre mobilných klientov. Namiesto zdieľania certifikátov a kľúčov pre push notifikácie s poskytovateľom služieb používa NPS nové API na získanie krátkodobého tokenu pre push notifikácie z backendu UCaaS a tento token používa na autentifikáciu pomocou Apple APN a služieb Google FCM.

Táto funkcia tiež vylepšuje schopnosť Notification Push Servera odosielať oznámenia na zariadenia so systémom Android prostredníctvom nového rozhrania HTTPv1 API od spoločnosti Google Firebase Cloud Messaging (FCM).

Predpoklady proxy na overenie NPS

XSP (alebo platforma na doručovanie aplikácií ADP), ktorá hosťuje NPS, musí spĺňať nasledujúce požiadavky:

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

  • NPS musí byť aktivovaný na vyhradenom serveri. XSP/ADP a NPS musí byť jedinou hosťovanou aplikáciou na serveri. Cieľom je eliminovať rušenie doručovania push notifikácií.

  • V nasadení by mala byť iba jedna aplikácia NPS. Ak používate mobilný UC-One Collaborate/Connect a/alebo UC-One SaaS a implementujete Webex pre BroadWorks, musíte zdieľať tento jeden 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 XSP spúšťa iba NPS a AS je R21.SP1. Viac informácií nájdete v matici kompatibility BroadWorks.

  • Viac informácií o ADP serveri nájdete na stránke Cisco BroadWorks Application Delivery Platform.

Zdieľaný NPS

Pred konfiguráciou zdieľaného NPS na používanie 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 proxy server NPS a potom zmeňte NPS z používania staršieho rozhrania API FCM na používanie rozhrania API FCM HTTP v1.

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

APN HTTP/2

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

  • XSP/ADPs ktoré už podporujú aplikáciu Collaborate alebo SaaS BroadWorks, je potrebné migrovať do HTTP/2. Podrobné informácie o konfigurácii HTTP/2, pozri HTTP/2 Podpora servera Notification Push 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 Cisco/BroadSoft, Pred konfiguráciou NPS na používanie proxy servera NPS nakonfigurujte tieto aplikácie na používanie kľúčov FCMv1.

  • Ak XSP/ADP momentálne podporuje aplikáciu Connect alebo UC-One SaaS, potom po konfigurácii proxy NPS povoľte kľúče FCMv1 . Odporúčame vám migrovať všetky ďalšie aplikácie na kľúče FCMv1, povoliť ich, otestovať a potom ich 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
Vizuálne zhrnutie migrácie na proxy overovania NPS
Tabuľka č. 1 Súhrn úloh migrácie na proxy server NPS

Postupnosť

Názov úlohy

When/Why Je úloha povinná?

1

Migrácia NPS do HTTP/2 pre aplikácie UC-One SaaS (alebo Connect) pre iOS.

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

2

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

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

3

Povoľte režim FCMv1 a otestujte push notifikácie.

Ak NPS podporuje UC-One Connect and/or iné aplikácie pre Android (neod spoločnosti Cisco).

4

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

Ak NPS podporuje UC-One SaaS. Ak necháte FCMv1 povolený pred konfiguráciou proxy servera NPS, odosielanie notifikácií do služby UC-One SaaS začne zlyhávať.

5

Nainštalujte opravy proxy servera na overenie NPS.

Ak je NPS na XSP R22 alebo XSP R23.

6

Konfigurácia NPS na používanie proxy servera na overovanie NPS:

  • Pripojte technickú podporu od NPS

  • Vyžiadať si účet CI OAuth

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

  • Pridať ID aplikácií pre Android

  • Pridať ID aplikácií pre iOS

  • Check/set URL adresy a časové limity pripojenia

  • Pridať aplikácie do zoznamu povolených aplikácií AS

  • (Znovu) povoliť FCMv1

  • Reštartujte XSP / ADP

  • Testovacie profilové čísla pre aplikácie pre iOS a Android

Vždy povinné.

7

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

Pre aplikácie, ktoré sú úspešne podporované službou NPS na platforme FCMv1.
Migrácia aplikácií BroadWorks Collaborate pre iOS do HTTP/2

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

Predtým, ako začnete

Ak váš XSP používa R22, pred konfiguráciou aplikácie NPS na používanie musíte použiť ap354313. HTTP/2 pre APNS.

1

Nastavte produkčnú URL adresu 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 a nezabudnite vynechať autorizačný kľúč – nastavte ho na prázdnu hodnotu.

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 ho vymazať 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

Prejdite nadol do sekcie Notification Push Server a vyberte svoju verziu (napr. Verzia 22), potom postupujte podľa pokynov uvedených na portáli.

Migrácia BroadWorks UC-One Connect / SaaS aplikácie pre Android do FCMv1

  • Táto úloha sa vzťahuje na NPS na XSP. Ignorujte to, ak je váš NPS na ADP.

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

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

  • Táto úloha pripraví NPS na FCMv1, aby ste ho mohli povoliť ako súčasť konfigurácie proxy servera na overenie NPS. Nepovoľujte FCMv1, kým nie ste pripravení nakonfigurovať proxy server na overovanie NPS, inak sa upozornenia klientom SaaS nepodarí.

1

Získajte ID projektu z konzoly Firebase:

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

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

  3. Otvorte kartu Všeobecné a zaznamenajte si ID projektu.

2

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

  1. V nastaveniach projektu prejdite na kartu Servisné účty.

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

  3. Alebo si otvorte existujúci servisný účet a vygenerujte preň nový súkromný kľúč.

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

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

3

Skopírujte kľúč do XSP, na ktorom je hostovaný váš NPS.

4

Pridajte ID projektu a pridružený 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 pre FCM oproti atribútom a odporúčaným hodnotám uvedeným tu. V prípade potreby použite na zmenu hodnôt verziu príkazu set :

Beh 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

Migrácia BroadWorks UC-One Connect / SaaS aplikácie pre Android do FCMv1 (na ADP)

  • Táto úloha sa vzťahuje na NPS na ADP. Ignorujte to, ak je váš NPS na XSP.

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

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

  • Táto úloha pripraví NPS na FCMv1, aby ste ho mohli povoliť ako súčasť konfigurácie proxy servera na overenie NPS. Nepovoľujte FCMv1, kým nie ste pripravení nakonfigurovať proxy server na overovanie NPS, inak sa upozornenia klientom SaaS nepodarí.

1

Získajte ID projektu z konzoly Firebase:

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

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

  3. Otvorte kartu Všeobecné a zaznamenajte si ID projektu.

2

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

  1. V nastaveniach projektu prejdite na kartu Servisné účty.

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

  3. Alebo si otvorte existujúci servisný účet a vygenerujte preň nový súkromný kľúč.

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

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

3

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

4

Prihláste sa do ADP CLI a pridajte projekt a API kľúč 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 si 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
Znovu povoliť starší režim FCM

Toto musíte urobiť (ako súčasť migrácie) iba v prípade, že:

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

  • Už ste otestovali, že notifikácie o volaniach do iných aplikácií fungujú s rozhraním FCMv1 API.

Dočasne deaktivujete FCMv1, pretože kľúče FCMv1 pre tieto aplikácie musia byť povolené iba počas procesu konfigurácie proxy servera overovania NPS.

1

Prihláste sa do XSP, ktorý hosťuje 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.

Inštalácia záplat proxy servera na overovanie NPS
Konfigurácia NPS na používanie overovacieho proxy servera
1

Vytvorte si u svojho kontaktu pre onboarding alebo u TAC servisnú požiadavku na zriadenie vášho klientskeho účtu OAuth (Webex Common Identity). Názov požiadavky na službu Konfigurácia NPS pre nastavenie proxy overenia.

Poskytneme vám ID klienta OAuth, tajný kód klienta a obnovovací token 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

Spustite príkaz a overte, či sa zadané hodnoty zhodujú s hodnotami, ktoré ste dostali. XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

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

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

Pre zvýšenie rýchlosti prekladu DNS odporúčame namiesto aktuálneho FQDN nps.uc-one.broadsoft.com použiť vhodné FQDN na základe vášho regiónu.

Regiónové FQDN:

Východ USA:

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

Západ USA:

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

Európa:

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

Ak push notifikácie vypršia z dôvodu oneskorenia v preklade DNS, zvýšte hodnotu časového limitu v "/etc/resolv.conf" súbor na serveri BroadWorks.

4

(Pre upozornenia systému Android) Pridajte ID aplikácií pre Android do kontextu aplikácií FCM na serveri 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 a nezabudnite vynechať autorizačný kľúč – nastavte ho na prázdnu hodnotu.

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 servera NPS:

Kontext rozhrania 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:

Kontext rozhrania XSP

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 aplikácií:

  1. Spustite AS_CLI/System/PushNotification> get a skontrolujte hodnotu enforceAllowedApplicationList. Ak je to true, musíte dokončiť túto podú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 otestujte push notifikácie
1

Reštartujte XSP:

bwrestart
2

Otestujte upozornenia na hovory do systému Android uskutočnením hovorov z predplatiteľa služby BroadWorks volajúcemu klientovi v systéme Android. Overte, či sa na zariadení so systémom Android zobrazuje upozornenie na hovor.

Poznámka: Ak sa v aplikácii UC-One pre Android začnú zlyhávať push notifikácie, 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 FCM nasledovne:

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

  2. Reštartujte XSP: bwrestart

  3. Skontrolujte si konfiguráciu.

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

  5. Zopakujte test.

3

Otestujte upozornenia na hovory do systému iOS uskutočnením hovorov z predplatiteľa služby BroadWorks volajúcemu klientovi v systéme iOS. Overte, či sa na zariadení so systémom iOS zobrazuje upozornenie na hovor.

Poznámka: Ak sa v aplikácii UC-One pre iOS začnú zlyhávať push notifikácie, 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 pomocou set HTTP2Enabled false