Yleiskatsaus NPS-todennusvälityspalvelimeen


Tässä artikkelissa kuvataan, kuinka jaettu NPS määritetään käyttämään NPS-todennusvälityspalvelinta, jotta sitä voidaan käyttää myös puheluilmoitusten työntämiseen Webex-sovelluksiin. Jos NPS ei tue muita sovelluksia, voit seurata Webex for BroadWorks -ratkaisuoppaan yksinkertaistettua menettelyä https://help.webex.com/z9gt5j.

NPS-välityspalvelimen yleiskatsaus

Yhteensopivuus Webex for BroadWorksin kanssa edellyttää, että NPS tukee NPS-välityspalvelinominaisuutta, Push Server VoIP:lle UCaaS:ssä.

Ominaisuus toteuttaa Notification Push Serverissä uuden suunnittelun, joka ratkaisee tietoturvahaavoittuvuuden, joka liittyy push-ilmoitusvarmenteen yksityisten avainten jakamiseen mobiiliasiakkaiden palveluntarjoajien kanssa. Sen sijaan, että NPS jakaisi push-ilmoitusvarmenteita ja -avaimia palveluntarjoajan kanssa, se käyttää uutta APIa saadakseen lyhytaikaisen push-ilmoitustunnuksen UCaaS-taustajärjestelmästä ja käyttää tätä tunnusta Applen APN- ja Google FCM -palveluiden todentamiseen.

Ominaisuus parantaa myös Notification Push Serverin kykyä lähettää ilmoituksia Android-laitteille uuden Google Firebase Cloud Messaging (FCM) HTTPv1 API:n kautta.

NPS:ää isännöivän XSP:n (tai Application Delivery Platform ADP:n) on täytettävä seuraavat vaatimukset:

Vähimmäisversiot ja yhteisasumista koskevat rajoitukset

  • NPS on aktivoitava erillisessä XSP/ADP:ssä, ja NPS:n on oltava palvelimen ainoa isännöity sovellus. Tämä poistaa häiriöt Push-ilmoitusten toimittamisessa.

  • Käyttöönotossa saa olla vain yksi NPS-sovellus. Jos käytät mobiilisovellusta UC-One Collaborate/Connect ja/tai UC-One SaaS ja käytät Webex for BroadWorksia, sinun on jaettava tämä yksittäinen NPS kaikille sovelluksille.

  • NPS:n versiossa on oltava R22 tai uudempi XSP tai ADP.

    R22/R23 XSP on yhteensopiva R21-pinon kanssa, jos XSP vain käyttää NPS:ää ja AS on R21.SP1. Katso BroadWorksin yhteensopivuusmatriisi Lisätietoja.

  • Lisätietoja ADP-palvelimesta löytyy osoitteesta https://xchange.broadsoft.com/node/1051580.

Jaettu NPS

Lue nämä huomautukset ennen kuin määrität jaetun NPS:n käyttämään NPS-välityspalvelinta:

  • Jos NPS:täsi käytetään muiden sovellusten (ei vain Webex-sovelluksen) kanssa: Määritä ensin NPS-välityspalvelin ja vaihda sitten NPS vanhasta FCM-sovellusliittymästä FCM HTTP v1 -sovellusliittymään.

  • Kun olet varmistanut, että ilmoitukset toimivat oikein vanhemmissa sovelluksissa NPS-välityspalvelimella, poista sitten Android-sovelluksen FCM-sovellusliittymäavain ja iOS-sovelluksen APN-todennusavain.

APN:t HTTP/2

  • Jos olet ottanut käyttöön iOS-sovelluksia, jotka eivät ole Ciscon/BroadSoftin valmistamia, määritä ne käyttämään HTTP/2 APNS-protokollaa ennen kuin määrität NPS:n käyttämään NPS-välityspalvelinta.

  • XSP/ADP:t, jotka jo tukevat Collaborate- tai SaaS BroadWorks -sovellusta, on siirrettävä HTTP/2:een. Katso tarkemmat tiedot HTTP/2:n määrittämisestä HTTP/2-tuki Notification Push Serverille APNS:lle (NPS:n siirto näiden iOS-sovellusten tukemiseksi on yhteenveto tässä artikkelissa).

Android FCMv1

  • Jos olet ottanut käyttöön Android-sovelluksia, jotka eivät ole Ciscon/BroadSoftin valmistamia, määritä ne käyttämään FCMv1-avaimia, ennen kuin määrität NPS:n käyttämään NPS-välityspalvelinta.

  • Jos XSP/ADP tukee tällä hetkellä Connect- tai UC-One SaaS -sovellusta, ota FCMv1-avaimet käyttöön jälkeen määrität NPS-välityspalvelimen. Suosittelemme, että siirrät kaikki lisäsovellukset FCMv1-avaimiin, otat ne käyttöön ja testaavat ja poistat sitten käytöstä, kunnes olet valmis suorittamaan asennusohjeet (siirtokulku on dokumentoitu tässä artikkelissa).

Kuvio 1. Visuaalinen yhteenveto siirtymisestä NPS-todennusvälityspalvelimeen
Pöytä 1. Yhteenveto NPS-välityspalvelimeen siirrettävistä tehtävistä

Järjestys

Tehtävän otsikko

Milloin/miksi tehtävä vaaditaan?

1

Siirrä NPS HTTP/2:een UC-One SaaS (tai Connect) iOS-sovelluksille.

Jos NPS tukee näitä sovelluksia, eikä niitä ole vielä määritetty HTTP/2:ta varten.

2

Siirrä NPS FCMv1:een UC-One SaaS (tai Connect) Android-sovelluksille.

Jos NPS tukee näitä sovelluksia, eikä niitä ole vielä määritetty FCMv1:lle.

3

Ota FCMv1-tila käyttöön ja testaa push-ilmoituksia.

Jos NPS tukee UC-One Connectia ja/tai muita (ei-Ciscon) Android-sovelluksia.

4

Ota vanha FCM-tila uudelleen käyttöön.

Jos NPS tukee UC-One SaaS -palvelua. Jos jätät FCMv1:n käyttöön, ennen kuin määrität NPS-välityspalvelimen, UC-One SaaS:n push-ilmoitukset alkavat epäonnistua.

5

Asenna NPS-todennusvälityspalvelimen korjaustiedostot.

Jos NPS on XSP R22:ssa tai XSP R23:ssa.

6

Määritä NPS käyttämään NPS-todennusvälityspalvelinta:

  • Liitä NPS:n tekninen tuki

  • Pyydä CI OAuth -tiliä

  • Luo CI-tili NPS:ssä ja määritä päivitystunnuksen aikakatkaisu

  • Lisää Android-sovellustunnukset

  • Lisää iOS-sovellustunnukset

  • Tarkista / aseta URL-osoitteet ja yhteyden aikakatkaisut

  • Lisää sovelluksia AS-lupaluetteloon

  • (Uudelleen)Ota FCMv1 käyttöön

  • Käynnistä XSP / ADP uudelleen

  • Testaa PN:t iOS- ja Android-sovelluksille

Aina vaadittu.

7

Poista vanhat FCM-tilan avaimet.

Sovelluksille, joita NPS tukee onnistuneesti FCMv1:ssä.

Tämä tehtävä on pakollinen push-ilmoituksille UC-One SaaS- ja Webex-sovelluksille iOS-alustoilla.

Ennen kuin aloitat

Jos XSP:ssäsi on R22, sinun on asennettava ap354313, ennen kuin voit määrittää NPS-sovelluksen käyttämään HTTP/2:ta APNS:lle.

1

Aseta tuotannon URL-osoite ja yhteysparametrit osoitteessa XSP_CLI/Applications/NotificationPushServer/APNS/Production>

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

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Huomautus: Älä aseta yhteyden aikakatkaisua alle 1000.

2

Lisää sovellustunnukset APNS-sovelluskontekstiin ja muista jättää Auth-avain pois – aseta se tyhjäksi.

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

Webex-sovellukselle: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

3

Tarkista todennusavaimet XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Jos auth-avain ei ole tyhjä com.broadsoft.uc-one, voit tyhjentää sen käyttämällä XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Ota HTTP/2 käyttöön:

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

6

Vain UC-One SaaS -sovellukset: Kirjaudu sisään jälleenmyyjäportaaliin ja siirry osoitteeseen Kokoonpano > BroadWorks > .

7

Vieritä alas Notification Push Server -osioon ja valitse julkaisusi (esim Julkaisu 22), noudata sitten portaalin ohjeita.

  • Tämä tehtävä koskee XSP:n NPS:ää. Ohita se, jos NPS on ADP:ssä.

  • Voit käyttää tätä menettelyä siirtyessäsi FCMv1-ilmoituksiin UC-One Connect- tai UC-One SaaS Android-sovelluksissa.

  • Sinun on käytettävä FCMv1:tä, jos haluat käyttää NPS-välityspalvelinta push-ilmoitusten todentamiseen UC-One- tai Webex Android -sovelluksiin.

  • Tämä tehtävä valmistelee NPS:n FCMv1:tä varten, jotta voit ottaa sen käyttöön osana NPS-todennusvälityspalvelimen määritystä. Älä ota FCMv1:tä käyttöön ennen kuin olet valmis määrittämään NPS-todennusvälityspalvelimen, tai ilmoitukset SaaS-asiakkaille epäonnistuvat.

1

Hanki projektitunnus Firebase-konsolista:

  1. Kirjaudu sisään osoitteessa console.firebase.google.com.

  2. Valitse UC-One (Connect tai SaaS) -sovellusprojekti, avaa sen projektiasetukset.

  3. Avaa Kenraali -välilehti ja tallenna projektin tunnus.

2

Hanki palvelutilisi yksityinen avain Firebasesta:

  1. Siirry Palvelutilit-välilehteen projektiasetuksissa.

  2. Luo joko uusi palvelutili ja hanki sen yksityinen avain.

  3. Tai avaa olemassa oleva palvelutili ja luo sille uusi yksityinen avain.

    Huomautus: Palvelutilillä on oltava firebaseadmin-sdk lupa.

  4. Lataa avain turvalliseen paikkaan.

3

Kopioi avain NPS:täsi isännöivään XSP:hen.

4

Lisää projektitunnus ja siihen liittyvä yksityinen avain FCM-projektikontekstiin:

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

5

Lisää UC-One (Connect tai SaaS) -sovellus ja siihen liittyvä projektitunnus FCM-sovelluskontekstiin:

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

6

Tarkista FCM-määritykset tässä esitettyjen attribuuttien ja suositeltujen arvojen perusteella. Käyttää set komennon versio muuttaaksesi arvoja tarvittaessa:

Juosta XSP_CLI/Applications/NotificationPushServer/FCM> get

Parametri

Suositeltu arvo

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

  • Tämä tehtävä koskee NPS:ää ADP:ssä. Ohita se, jos NPS on XSP:ssä.

  • Voit käyttää tätä menettelyä siirtyessäsi FCMv1-ilmoituksiin UC-One Connect- tai UC-One SaaS Android-sovelluksissa.

  • Sinun on käytettävä FCMv1:tä, jos haluat käyttää NPS-välityspalvelinta push-ilmoitusten todentamiseen UC-One- tai Webex Android -sovelluksiin.

  • Tämä tehtävä valmistelee NPS:n FCMv1:tä varten, jotta voit ottaa sen käyttöön osana NPS-todennusvälityspalvelimen määritystä. Älä ota FCMv1:tä käyttöön ennen kuin olet valmis määrittämään NPS-todennusvälityspalvelimen, tai ilmoitukset SaaS-asiakkaille epäonnistuvat.

1

Hanki projektitunnus Firebase-konsolista:

  1. Kirjaudu sisään osoitteessa console.firebase.google.com.

  2. Valitse UC-One (Connect tai SaaS) -sovellusprojekti, avaa sen projektiasetukset.

  3. Avaa Kenraali -välilehti ja tallenna projektin tunnus.

2

Hanki palvelutilisi yksityinen avain Firebasesta:

  1. Siirry Palvelutilit-välilehteen projektiasetuksissa.

  2. Luo joko uusi palvelutili ja hanki sen yksityinen avain.

  3. Tai avaa olemassa oleva palvelutili ja luo sille uusi yksityinen avain.

    Huomautus: Palvelutilillä on oltava firebaseadmin-sdk lupa.

  4. Lataa avain (.json-tiedosto) suojattuun paikkaan.

3

Tuo .json-tiedosto ADP-palvelimeen /bw/install.

4

Kirjaudu ADP CLI:hen ja lisää projekti- ja API-avain FCM-projektikontekstiin:

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

5

Lisää sovellus ja projektitunnus FCM-sovelluskontekstiin:

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

6

Tarkista määritykset:

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

Sinun tarvitsee tehdä tämä (osana siirtoa) vain, jos:

  • NPS:ääsi käytetään UC-One SaaS- tai BroadWorks Connect Android-sovelluksissa.

  • Olet jo testannut, että muiden sovellusten puhelujen push-ilmoitukset toimivat FCMv1-sovellusliittymän kanssa.

Olet tilapäisesti poistamassa FCMv1:n käytöstä, koska FCMv1-avaimet näille sovelluksille täytyy vain ottaa käyttöön NPS-todennusvälityspalvelimen määritysprosessin aikana.

1

Kirjaudu sisään XSP:hen, joka isännöi jaettua NPS:ääsi.

2

Siirry FCM-kontekstiin ja poista FCM v1 käytöstä: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false palataksesi FCM:n vanhan API-avaimen käyttöön.

1

Luo palvelupyyntö aloitusyhteyshenkilösi tai TAC:n kanssa luodaksesi (Webex Common Identity) OAuth-asiakastilisi. Nimeä palvelupyyntösi NPS-määritykset todennusvälityspalvelimen asennukseen.

Cisco antaa sinulle OAuth-asiakastunnuksen, asiakassalaisuuden ja päivitystunnuksen, joka on voimassa 60 päivää. Jos tunnus vanhenee ennen kuin käytät sitä NPS:n kanssa, voit esittää uuden pyynnön.
2

Luo asiakastili NPS:ssä:

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

Suorita, jotta voit varmistaa, että antamasi arvot vastaavat sinulle annettuja arvoja XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Anna NPS-välityspalvelimen URL-osoite ja aseta tunnuksen päivitysväli (suositus 30 minuuttia):

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

4

(Android-ilmoitukset) Lisää Android-sovellustunnukset FCM-sovellusten kontekstiin NPS:ssä.

Webex-sovellus Androidille: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

Androidin UC-One-sovellukselle: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect

5

(Apple iOS -ilmoitukset) Lisää sovellustunnus APNS-sovelluskontekstiin ja muista jättää pois Auth-avain – aseta se tyhjäksi.

Webex-sovellus iOS:ssä: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

iOS:n UC-One-sovellukselle: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Määritä seuraavat NPS-URL-osoitteet:

Taulukko 2.

XSP CLI -konteksti

Parametri

Arvo

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

Määritä seuraavat NPS-yhteysparametrit esitettyihin suositeltuihin arvoihin:

Taulukko 3.

XSP CLI -konteksti

Parametri

Arvo

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

Tarkista, tarkistaako sovelluspalvelin sovellustunnuksia, koska sinun on ehkä lisättävä Webex-sovellukset sallittujen luetteloon:

  1. Juosta AS_CLI/System/PushNotification> get ja tarkista arvo enforceAllowedApplicationList. Jos se on true, sinun on suoritettava tämä alitehtävä. Muussa tapauksessa ohita alitehtävän loppuosa.

  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”

1

Käynnistä XSP uudelleen:

bwrestart
2

Testaa puheluilmoituksia Androidille soittamalla BroadWorks-tilaajalta soittavalle asiakkaalle Androidissa. Varmista, että puheluilmoitus näkyy Android-laitteella.

Huomautus: Jos push-ilmoitukset alkavat epäonnistua UC-One Android -sovelluksessa, on mahdollista, että kokoonpanossa on virhe. Jos tilanne on tämä, voit palata vanhaan FCM:ään seuraavasti:

  1. Poista FCMv1 käytöstä: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Käynnistä XSP uudelleen: bwrestart

  3. Tarkista määritykset.

  4. Ota FCMv1 uudelleen käyttöön ja käynnistä XSP uudelleen.

  5. Toista testi.

3

Testaa iOS-puheluilmoituksia soittamalla puheluja BroadWorks-tilaajalta soittavalle asiakkaalle iOS:ssä. Varmista, että puheluilmoitus näkyy iOS-laitteella.

Huomautus: Jos push-ilmoitukset alkavat epäonnistua UC-One iOS -sovelluksessa, on mahdollista, että kokoonpanossa on virhe. Jos tilanne on tämä, voit palata vanhaan binaarikäyttöliittymään set HTTP2Enabled false