Oversigt over NPS-godkendelsesproxy


Denne artikel beskriver, hvordan du konfigurerer en delt NPS til at bruge NPS-godkendelsesproxy, så den også kan bruges til at skubbe opkaldsbeskeder til Webex-apps. Hvis din NPS ikke understøtter andre apps, kan du følge den forenklede fremgangsmåde i Løsningsvejledning til Webex til BroadWorks https://help.webex.com/z9gt5j.

NPS-proxy, oversigt

For at sikre kompatibilitet med Webex til BroadWorks skal din NPS opdateres for at understøtte NPS-proxy funktionen, Pushserver til VoIP i UCaaS.

Funktionen implementerer et nyt design på serveren til push-notifikationer for at løse sikkerhedsrisikoen ved deling af private nøgler til certifikatet for push-notifikationer med serviceudbydere for mobilklienter. I stedet for at dele certifikater og nøgler til push-notifikationer med serviceudbyderen, bruger NPS et nyt API til at få et kortvarigt token til push-notifikationer fra UCaaS-backend og bruger dette token til godkendelse med Apple APNS -og Google FCM-tjenesterne.

Funktionen forbedrer også muligheden for, at serveren til push-notifikationer kan skubbe beskeder til Android -enheder via det nye Google FIREBASE Cloud Messaging (FCM) HTTPV1-API.

BroadWorks-programrettelserne til funktionen er tilgængelige på Xchange: https://xchange.broadsoft.com/node/1046235

Du kan finde flere oplysninger i Pushserver for VoIP i UCaaS-funktionsbeskrivelse på Xchange: https://xchange.broadsoft.com/node/1045458

XSP (eller programleveringsplatforms-ADP), som hoster NPS skal opfylde følgende krav:

Minimumversioner og begrænsninger på placering samme sted

  • NPS skal aktiveres på en dedikeret XSP/ADP, og NPS skal være det eneste hostede program på serveren. Dette er at fjerne interferens ved levering af push-notifikationer.

  • Der må kun være én NPS-app i en installation. Hvis du bruger UC-One Collaborate/Connect og UC-One SaaS (mobil), og du implementerer Webex for BroadWorks, skal du dele denne individuelle NPS med alle apps.

  • NPS skal have version R22 eller nyere XSP eller ADP.

    R22/R23 XSP er kompatibel med en R21-stak, hvis XSP kun kører NPS, og R21 er R21.SP1. Se Kompatibilitetesmatricen for BroadWorks for at få flere oplysninger.

  • Du kan finde flere oplysninger om ADP-serveren på https://xchange.broadsoft.com/node/1051580.

Delt NPS

Læs disse bemærkninger, før du konfigurerer din delte NPS til at bruge NPS-proxyen:

  • Hvis din NPS bruges sammen med andre apps (ikke kun Webex-appen): Konfigurerer NPS-proxyen først, før du ændrer NPS fra at bruge tidligere FCM-API til at bruge FCM http v1 API.

    Du kan skifte, mens du konfigurerer NPS til at bruge NPS-proxy.

  • Når du har bekræftet, at beskeder fungerer korrekt for ældre apps med NPS-proxyen, kan du fjerne FCM API- nøglen til Android-appen og godkendelsesnøglen til APNS for iOS-app'en.

APNS HTTP/2

  • Hvis du har installeret iOS-apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere de pågældende apps til at bruge HTTP/2-APNS-protokollen, før du konfigurer NPS til at bruge NPS-proxyen.

  • XSP/ADP'er, der allerede understøtter appen Collaborate eller SaaS BroadWorks skal overføres til HTTP/2. Hvis du ønsker yderligere oplysninger om konfiguration af HTTP/2, kan du se HTTP/2-support til server til push-notifikationer for APNS (overførsel af NPS for at understøtte disse iOS-apps er opsummeret i denne artikel).

Android FCMv1

  • Hvis du har installeret nogen Android-Apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere de pågældende apps til at bruge FCMv1-nøglerne, før du konfigurerer NPS til at bruge NPS-proxyen.

  • Hvis XSP/ADP i øjeblikket understøtter appen Connect eller UC-One SaaS, kan FCMv1-nøgler ikke aktiveres, før du konfigurerer NPS-proxy. Vi anbefaler, at du overflytter alle yderligere apps til FCMv1-nøgler, aktiverer og tester og derefter deaktiverer, indtil du er klar til at fuldføre opsætningsvejledningen (migrationsforløbet er beskrevet i denne artikel).

Figur 1. Visuel oversigt over migration til NPS-godkendelsesproxy
Tabel 1. Oversigt over opgaver til migration til NPS-proxy

Rækkefølge

Opgavetitel

Hvornår/hvorfor er opgaven påkrævet?

1

Migrer NPS til HTTP/2 for UC-One SaaS (eller Connect) iOS-apps.

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til HTTP/2.

2

Migrer NPS til FCMv1 for UC-One SaaS (eller Connect) Android-Apps.

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til FCMv1.

3

Aktivér FCMv1-tilstand, og test push-notifikationer.

Hvis NPS understøtter UC-en-forbindelse og/eller andre (ikke-Cisco) Android-Apps.

4

Aktivér tidligere FCM-tilstand igen.

Hvis NPS understøtter UC-en-SaaS. Hvis du lader FCMv1 være aktiveret, før du konfigurerer NPS-proxyen, så kan push-notifikationer til UC-One SaaS begynde at mislykkedes.

5

Installér programrettelser til NPS-godkendelsesproxy.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til at bruge NPS-godkendelsesproxyen:

  • Vedhæft teknisk support fra NPS

  • Anmod om CI OAuth-konto

  • Opret CI-konto på NPS, og Konfigurer timeout for opdatering af token

  • Tilføj Android-app-id'er

  • Tilføj iOS-app-id'er

  • Kontrollér/indstil URL-adresser og forbindelsestimeout

  • Føj apps til listen over tilladte programmer

  • (Gen-)aktivér FCMv1

  • Genstart XSP/ADP

  • Test PN'er for iOS-og Android-Apps

Altid påkrævet.

7

Fjern FCM-nøgler i tidlgere tilstand.

For apps, der er understøttet af NPS på FCMv1.

Denne opgave er obligatorisk for push-notifikationer til UC-One-SaaS og Webex-apps på iOS-platforme.

Før du begynder

Hvis din XSP kører R22, skal du anvende ap354313, før du kan konfigurere NPS-programmet til at bruge HTTP/2 for APNS.

1

Angiv produktions-URL-adressen og tilslutningsparametre på XSP_CLI/Applications/NotificationPushServer/APNS/Production>

angiv URL-adressen https://api.push.apple.com/3/device

angiv connectionPoolSize 2

angiv connectionTimeout 3000

angiv connectionIdleTimeoutInSeconds 600

Bemærk: Indstil ikke forbindelsestimeout til under 1000.

2

Føj program-id'erne til konteksten for APNS-programmer, og sørg for at udelade godkendelsesnøglen – indstil den til tom.

For UC-One SaaS:XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> tilføj com.broadsoft.uc-one

For Webex-app: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> tilføj com.cisco.squared

3

Kontrollér godkendelsesnøglerne med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> hent

4

Hvis godkendelsesnøglen ikke er tom for com.broadsoft.uc-one, kan du rydde den med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> ryd godkendelsesnøgle

5

Aktiéer HTTP/2:

XSP_CLI/Applications/NotificationPushServer/APNS/GeneralSettings> indstil HTTP2Enabled til sand

6

Kun for UC-One SaaS-apps: Log på forhandlerportalen, og gå til Konfiguration > BroadWorks > .

7

Rul ned til sektionen Server til push-notifikationer, og vælg din udgivelse (f.eks. version 22), og følg derefter vejledningen på portalen.

  • Denne opgave gælder NPS på XSP. Ignorer den, hvis din NPS er på ADP.

  • Du kan bruge denne procedure til at migrere til FCMv1-beskeder for UC-One Connect- eller UC-One SaaS Android-apps.

  • Du skal bruge FCMv1, hvis du vil bruge NPS-proxyen til at godkende push-notifikationer til UC-One- eller Webex Android-Apps.

  • Denne opgave forbereder NPS for FCMv1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMv1, før du er klar til at konfigurere NPS-godkendelsesproxy, ellers mislykkes beskeder til SaaS-klienter.

1

Hent projekt-id'et fra Firebase-konsollen:

  1. Log på console.firebase.google.com.

  2. Vælg UC-One-app-projektet (Connect eller SaaS), åbn dets projektindstillinger.

  3. Åbn fanen Generelt, og registrer dets projekt-id.

2

Få din servicekontos private nøgle fra Firebase:

  1. Gå til fanen Servicekonti under projektindstillingerne.

  2. Du skal enten oprette en ny servicekonto og få dens private nøgle.

  3. Eller åbne en eksisterende servicekonto og oprette en ny privat nøgle til den.

    Bemærk: Servicekontoen skal have tilladelsen firebaseadmin-sdk.

  4. Download nøglen til en sikker placering.

3

Kopiér nøglen til den XSP, der er vært for din NPS.

4

Føj projekt-id'et og den tilknyttede private nøgle til FCM-projektkonteksten:

XSP_CLI/Applications/NotificationPushServer/FCM/Projects> tilføj projekt-id-sti/til/nøglefil

5

Føj UC-One-programmet (Connect eller SaaS) og det tilknyttede projekt-id til FCM-programkonteksten:

XSP_CLI/Applications/NotificationPushServer/FCM/Applications> tilføj program-id com.broadsoft.connect projectId projekt-id

6

Kontroller konfigurationen for FCM i forhold til attributterne og de anbefalede værdier, der er vist her. Brug indstil version af kommandoen for at ændre værdierne, hvis det er nødvendigt:

Kør XSP_CLI/Applications/NotificationPushServer/FCM> hent

Parameter

Anbefalet værdi

godkendelses-URL-adresse

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

push-URL-adresse

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

område

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

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

630

  • Denne opgave gælder for NPS på ADP. Ignorer den, hvis din NPS er på XSP.

  • Du kan bruge denne procedure til at migrere til FCMv1-beskeder for UC-One Connect- eller UC-One SaaS Android-apps.

  • Du skal bruge FCMv1, hvis du vil bruge NPS-proxyen til at godkende push-notifikationer til UC-One- eller Webex Android-Apps.

  • Denne opgave forbereder NPS for FCMv1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMv1, før du er klar til at konfigurere NPS-godkendelsesproxy, ellers mislykkes beskeder til SaaS-klienter.

1

Hent projekt-id'et fra Firebase-konsollen:

  1. Log på console.firebase.google.com.

  2. Vælg UC-One-app-projektet (Connect eller SaaS), åbn dets projektindstillinger.

  3. Åbn fanen Generelt, og registrer dets projekt-id.

2

Få din servicekontos private nøgle fra Firebase:

  1. Gå til fanen Servicekonti under projektindstillingerne.

  2. Du skal enten oprette en ny servicekonto og få dens private nøgle.

  3. Eller åbne en eksisterende servicekonto og oprette en ny privat nøgle til den.

    Bemærk: Servicekontoen skal have tilladelsen firebaseadmin-sdk.

  4. Download nøglen (.json-fil) til en sikker placering.

3

Importér .json-filen til ADP-serveren /bw/install.

4

Log på ADP CLI, og tilføj projektet og API-nøglen til FCM-projektkonteksten:

ADP_CLI/Applications/NotificationPushServer/FCM/Projects> tilføj connect-ucaas /bw/install/filename.json

5

Føj programmet og projekt-id'et til FCM-programkontekst:

ADP_CLI/Applications/NotificationPushServer/FCM/Applications> tilføj program-id com.broadsoft.ucaas.connect projectId projekt-id

6

Bekræft din konfiguration:

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

Du skal kun gøre dette (som en del af migrationen), hvis:

  • Din NPS bruges til UC-One SaaS- eller BroadWorks Connect Android-Apps.

  • Du har allerede testet, at opkaldspush-notifikationer til andre apps fungerer sammen med FCMv1-API.

Du deaktiverer FCMv1 midlertidigt, fordi FCMv1-nøgler for disse apps kun skal aktiveres under konfigurationsprocessen for NPS-godkendelsesproxyen.

1

Log på den XSP, der er vært for din delte NPS.

2

Naviger til FCM-konteksten, og deaktiver FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> angiv V1enabled til falsk for at vende tilbage til at bruge den tidligere FCM-API-nøgle.

Installér følgende programrettelser for at undersøtte NPS-godkendelsesproxyfunktionen:

R22-programrettelser

R23-programrettelser

1

Opret en tjenesteanmodning med din onboardingkontakt eller med TAC for at klargøre din (Webex Common Identity) OAuth-klientkonto. Giv din serviceanmodning titlen NPS-konfiguration til konfiguration af godkendelsesproxy.

Cisco giver dig et OAuth-klient-id, en klienthemmelighed og et opdateringstoken, der er gyldigt i 60 dage. Hvis tokenet udløber, før du bruger det med din NPS, kan du udløse en anden anmodning.
2

Opret klientkontoen på NPS:

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> angiv 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

Hvis du vil kontrollere de værdier, du har angivet, svarer til det, du har givet, skal du køre XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> hent

3

Angiv NPS-proxy-URL'en, og angiv opdateringsinterval for token (30 minutter anbefales):

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> angiv URL-adresse https://nps.uc-one.broadsoft.com/nps/

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> angiv VOIPTokenRefreshInterval 1800

4

(For Android-beskeder) Føj Android-program-id'erne til FCM-programkonteksten på NPS.

For Webex-app på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> tilføj program-id applicationId com.cisco.wx2.android

For UC-One-app på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> tilføj programid applicationId com.broadsoft.connect

5

(For Apple iOS-beskeder) Føj program-id'et til den pågældende APNS-programkontekst, og sørg for at udelade godkendelsesnøglen – indstil den til tom.

For Webex-app på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> tilføj com.cisco.squared

For UC-One-app på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> tilføj com.cisco.squared

6

Konfigurer følgende NPS-URL-adresser:

Tabel 2.

XSP CLI-kontekst

Parameter

Værdi

XSP_CLI/Applications/NotificationPushServer/FCM>

godkendelses-URL-adresse

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

push-URL-adresse

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

område

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

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

URL-adresse-adresse

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

7

Konfigurer følgende NPS-forbindelsesparametre til de anbefalede værdier, der vises:

Tabel 3.

XSP CLI-kontekst

Parameter

Værdi

XSP_CLI/Applications/NotificationPushServer/FCM>

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

630

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

connectionTimeout

3000

connectionPoolSize

2

connectionIdleTimeoutInSeconds

630

8

Kontrollér, om programserveren screener program-id'er, da du muligvis skal føje Webex-apps til listen over tilladte programmer:

  1. Kør AS_CLI/System/PushNotification> hent, og kontrollér værdien af enforceAllowedApplicationList. Hvis det er Sandt, skal du udføre denne underopgave. Ellers skal du springe resten af under opgaven over.

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

  3. AS_CLI/System/PushNotification/AllowedApplications> tilføj com.cisco.squared “Webex iOS”

1

Genstart XSP:

bwrestart
2

Test opkaldsbeskeder til Android ved at foretage opkald fra en BroadWorks-abonnent til opkaldsklienten på Android. Bekræft, at opkaldsbeskeden vises på Android-enheden.

Bemærk: Hvis push-notifkationer begynder at mislykkedes for UC-One Android-programmet, er det muligt, at der er en forkert konfiguration. Hvis dette er tilfældet, kan du vende tilbage til den tidligere FCM på følgende måde:

  1. Deaktiver FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> indstil V1Enabled til falsk

  2. Genstart XSP: bwrestart

  3. Kontrollér din konfiguration.

  4. Aktiver FCMv1 igen, og genstart XSP.

  5. Gentag testen.

3

Test opkaldsbeskeder til iOS ved at foretage opkald fra en BroadWorks-abonnent til opkaldsklienten på iOS. Bekræft, at opkaldsbeskeden vises på iOS-enheden.

Bemærk: Hvis push-notifikationer begynder at mislykkedes for UC-One iOS-programmet, er det muligt, at der er en forkert konfiguration. Hvis dette er tilfældet, kan du gå tilbage til den tidligere binære grænseflade med angiv HTTP2Enabled til falsk