Oversikt over NPS-autentiseringsproxy

Denne artikkelen beskriver hvordan du konfigurerer en delt NPS til å bruke NPS-autentiseringsproxy, slik at den også kan brukes til å sende anropsvarsler til Webex-apper. Hvis NPS-en din ikke støtter andre apper, kan du følge den forenklede prosedyren i Webex for BroadWorks-løsningsveiledningen.

Oversikt over NPS-proxy

For kompatibilitet med Webex for BroadWorks må NPS-en din oppdateres for å støtte NPS Proxy-funksjonen, Push Server for VoIP i UCaaS.

Funksjonen implementerer en ny design i Notification Push Server for å løse sikkerhetsproblemet ved deling av private nøkler for push-varslingssertifikater med tjenesteleverandører for mobilklienter. I stedet for å dele push-varslingssertifikater og -nøkler med tjenesteleverandøren, bruker NPS et nytt API for å hente et kortvarig push-varslingstoken fra UCaaS-backend, og bruker dette tokenet til autentisering med Apple APN-er og Google FCM-tjenester.

Funksjonen forbedrer også muligheten til at Notification Push Server kan sende varsler til Android-enheter via det nye Google Firebase Cloud Messaging (FCM) HTTPv1 API-et.

Forutsetninger for NPS-autentiseringsproxy

XSP-en (eller Application Delivery Platform ADP) som er vert for NPS må oppfylle følgende krav:

Minimumsversjoner og begrensninger for samboerskap

  • NPS må aktiveres på en dedikert XSP/ADP og NPS må være den eneste vertsbaserte applikasjonen på serveren. Dette er for å eliminere forstyrrelser med levering av push-varsler.

  • Det skal bare være én NPS-app i en distribusjon. Hvis du bruker mobil UC-One Collaborate/Connect og/eller UC-One SaaS, og implementerer Webex for BroadWorks, må du dele denne ene NPS-en for alle appene.

  • NPS må være på versjon R22 eller nyere av XSP eller ADP.

    R22/R23 XSP er kompatibel med en R21-stack hvis XSP bare kjører NPS og AS er R21.SP1. Se BroadWorks-kompatibilitetsmatrisen for mer informasjon.

  • Mer informasjon om ADP-serveren finner du på Cisco BroadWorks Application Delivery Platform.

Delt NPS

Les disse merknadene før du konfigurerer den delte NPS-en din til å bruke NPS-proxyen:

  • Hvis NPS-en din brukes med andre apper (ikke bare Webex-appen): Konfigurer først NPS-proxyen, og endre deretter NPS fra å bruke det eldre FCM-APIet til å bruke FCM HTTP v1 API.

  • Etter at du har bekreftet at varsler fungerer som de skal for eldre apper med NPS-proxyen, fjerner du FCM API-nøkkelen for Android-appen og APNs-autentiseringsnøkkelen for iOS-appen.

APN-er HTTP/2

  • Hvis du har distribuert iOS-apper som ikke er fra Cisco/BroadSoft, konfigurer disse appene til å bruke HTTP/2 APNS-protokollen før du konfigurerer NPS til å bruke NPS-proxyen.

  • XSP/ADPs som allerede støtter Collaborate- eller SaaS BroadWorks-appen, må migreres til HTTP/2. For detaljert informasjon om konfigurasjon HTTP/2, se HTTP/2 Støtte til Notification Push Server for APNS (migrering av NPS for å støtte disse iOS-appene er oppsummert i denne artikkelen).

Android FCMv1

  • Hvis du har distribuert Android-apper som ikke er fra Cisco/BroadSoft, Konfigurer disse appene til å bruke FCMv1-nøklene før du konfigurerer NPS til å bruke NPS-proxyen.

  • Hvis XSP/ADP støtter for øyeblikket Connect- eller UC-One SaaS-appen, og aktiver deretter FCMv1-nøkler etter at du har konfigurert NPS-proxyen. Vi anbefaler at du migrerer alle tilleggsapper til FCMv1-nøkler, aktiverer og tester, og deretter deaktiverer dem til du er klar til å fullføre konfigurasjonsinstruksjonene (migreringsflyten er dokumentert i denne artikkelen).

Sammendrag av NPS-proxymigrering
Visuelt sammendrag av migrering til NPS-autentiseringsproxy
Tabell 1. Sammendrag av oppgaver for migrering til NPS Proxy

Sekvens

Oppgavetittel

When/Why Er oppgaven obligatorisk?

1

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

Hvis NPS støtter disse appene, og de ennå ikke er konfigurert for HTTP/2.

2

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

Hvis NPS støtter disse appene, og de ennå ikke er konfigurert for FCMv1.

3

Aktiver FCMv1-modus og test push-varsler.

Hvis NPS støtter UC-One Connect and/or andre (ikke-Cisco) Android-apper.

4

Aktiver FCM-modus på nytt.

Hvis NPS-en støtter UC-One SaaS. Hvis du lar FCMv1 være aktivert før du konfigurerer NPS-proxyen, vil push-varsler til UC-One SaaS begynne å mislykkes.

5

Installer NPS-autentiseringsproxy-oppdateringer.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til å bruke NPS-autentiseringsproxyen:

  • Koble til teknisk støtte fra NPS

  • Be om CI OAuth-konto

  • Opprett CI-konto på NPS og konfigurer tidsavbrudd for oppdateringstoken

  • Legg til Android-app-ID-er

  • Legg til iOS-app-ID-er

  • Check/set URL-er og tidsavbrudd for tilkobling

  • Legg til apper i AS-tillatelseslisten

  • Aktiver FCMv1 på nytt

  • Start XSP på nytt / ADP

  • Test PN-er for iOS- og Android-apper

Alltid påkrevd.

7

Fjern FCM-nøkler for eldre modus.

For apper som støttes av NPS på FCMv1.
Migrer BroadWorks Collaborate iOS-apper til HTTP/2

Denne oppgaven er obligatorisk for push-varsler til UC-One SaaS- og Webex-apper på iOS-plattformer.

Før du begynner

Hvis XSP-en din kjører R22, må du bruke ap354313 før du kan konfigurere NPS-applikasjonen til å bruke HTTP/2 for APNS.

1

Angi produksjons-URL-en og tilkoblingsparameterne på XSP_CLI/Applications/NotificationPushServer/APNS/Production>

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

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Note: Ikke sett tidsavbruddet for tilkoblingen under 1000.

2

Legg til program-ID-ene i APNS-programkonteksten, og sørg for å utelate Auth-nøkkelen – sett den til tom.

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

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

3

Sjekk autentiseringsnøklene med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Hvis autentiseringsnøkkelen ikke er tom for com.broadsoft.uc-one, kan du slette den med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Aktiver HTTP/2:

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

6

Kun for UC-One SaaS-apper: Logg inn på forhandlerportalen og gå til Konfigurasjon > BroadWorks > .

7

Bla ned til delen Varslingspush-server, og velg utgivelsen din (f.eks. Versjon 22), følg deretter instruksjonene i portalen.

Migrer BroadWorks UC-One Connect / SaaS Android-apper til FCMv1

  • Denne oppgaven gjelder for NPS på XSP. Ignorer det hvis NPS-en din er på ADP.

  • Du kan bruke denne prosedyren for å migrere til FCMv1-varsler for UC-One Connect- eller UC-One SaaS Android-apper.

  • Du må bruke FCMv1 hvis du vil bruke NPS-proxyen til å autentisere push-varsler til UC-One eller Webex Android-appene.

  • Denne oppgaven forbereder NPS for FCMv1 slik at du kan aktivere den som en del av konfigurasjonen av NPS-autentiseringsproxyen. Ikke aktiver FCMv1 før du er klar til å konfigurere NPS-autentiseringsproxy, ellers vil varsler til SaaS-klienter mislykkes.

1

Hent prosjekt-ID-en fra Firebase-konsollen:

  1. Logg inn på console.firebase.google.com.

  2. Velg UC-One-appprosjektet (Connect eller SaaS), og åpne prosjektinnstillingene.

  3. Åpne fanen Generelt og registrer prosjekt-ID-en.

2

Hent den private nøkkelen til tjenestekontoen din fra Firebase:

  1. Naviger til fanen Tjenestekontoer i prosjektinnstillingene.

  2. Enten opprett en ny tjenestekonto og hent den private nøkkelen.

  3. Eller åpne en eksisterende tjenestekonto og generer en ny privat nøkkel for den.

    Note: Tjenestekontoen må ha tillatelsen firebaseadmin-sdk.

  4. Last ned nøkkelen til et sikkert sted.

3

Kopier nøkkelen til XSP-en som er vert for NPS-en din.

4

Legg til prosjekt-ID-en og den tilhørende private nøkkelen i FCM-prosjektkonteksten:

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

5

Legg til UC-One-applikasjonen (Connect eller SaaS) og tilhørende prosjekt-ID i FCM-applikasjonskonteksten:

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

6

Sjekk konfigurasjonen for FCM mot attributtene og anbefalte verdiene som vises her. Bruk set -versjonen av kommandoen for å endre verdier om nødvendig:

Løp XSP_CLI/Applications/NotificationPushServer/FCM> get

Parameter

Anbefalt verdi

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 BroadWorks UC-One Connect / SaaS Android-apper til FCMv1 (på ADP)

  • Denne oppgaven gjelder for NPS på ADP. Ignorer det hvis NPS-en din er på XSP.

  • Du kan bruke denne prosedyren for å migrere til FCMv1-varsler for UC-One Connect- eller UC-One SaaS Android-apper.

  • Du må bruke FCMv1 hvis du vil bruke NPS-proxyen til å autentisere push-varsler til UC-One eller Webex Android-appene.

  • Denne oppgaven forbereder NPS for FCMv1 slik at du kan aktivere den som en del av konfigurasjonen av NPS-autentiseringsproxyen. Ikke aktiver FCMv1 før du er klar til å konfigurere NPS-autentiseringsproxy, ellers vil varsler til SaaS-klienter mislykkes.

1

Hent prosjekt-ID-en fra Firebase-konsollen:

  1. Logg inn på console.firebase.google.com.

  2. Velg UC-One-appprosjektet (Connect eller SaaS), og åpne prosjektinnstillingene.

  3. Åpne fanen Generelt og registrer prosjekt-ID-en.

2

Hent den private nøkkelen til tjenestekontoen din fra Firebase:

  1. Naviger til fanen Tjenestekontoer i prosjektinnstillingene.

  2. Enten opprett en ny tjenestekonto og hent den private nøkkelen.

  3. Eller åpne en eksisterende tjenestekonto og generer en ny privat nøkkel for den.

    Note: Tjenestekontoen må ha tillatelsen firebaseadmin-sdk.

  4. Last ned nøkkelen (.json-filen) til et sikkert sted.

3

Importer .json-filen til ADP-serveren /bw/install.

4

Logg inn på ADP CLI og legg til prosjektet og API-nøkkelen i FCM-prosjektkonteksten:

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

5

Legg til applikasjons- og prosjekt-ID-en i FCM-applikasjonskonteksten:

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

6

Bekreft konfigurasjonen din:

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
Aktiver FCM Legacy-modus på nytt

Du trenger bare å gjøre dette (som en del av migreringen) hvis:

  • NPS-en din brukes til UC-One SaaS- eller BroadWorks Connect Android-apper.

  • Du har allerede testet at push-varsler for anrop til andre apper fungerer med FCMv1 API.

Du deaktiverer FCMv1 midlertidig fordi FCMv1-nøkler for disse appene bare må aktiveres under konfigurasjonsprosessen for NPS-autentiseringsproxy.

1

Logg på XSP-en som er vert for den delte NPS-en din.

2

Naviger til FCM-konteksten og deaktiver FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false for å gå tilbake til å bruke den eldre FCM API-nøkkelen.

Installer NPS-autentiseringsproxy-oppdateringer
Konfigurer NPS til å bruke autentiseringsproxy
1

Opprett en tjenesteforespørsel med din onboarding-kontakt, eller med TAC, for å klargjøre din (Webex Common Identity) OAuth-klientkonto. Gi tjenesteforespørselen din tittelen NPS-konfigurasjon for oppsett av autentiseringsproxy.

Vi gir deg en OAuth-klient-ID, en klienthemmelighet og et oppdateringstoken som er gyldig i 60 dager. Hvis tokenet utløper før du bruker det med NPS-en din, kan du sende inn en ny forespørsel.
2

Opprett klientkontoen på 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

Kjør kommandoen for å bekrefte at verdiene du skrev inn samsvarer med de du fikk oppgitt. XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Skriv inn URL-adressen til NPS-proxyen, og angi oppdateringsintervallet for tokenet (anbefalt 30 minutter):

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

For å forbedre DNS-oppløsningshastigheten, anbefaler vi at du bruker riktig FQDN basert på din region i stedet for den nåværende FQDN-en nps.uc-one.broadsoft.com.

Regionbaserte FQDN-er:

USA Øst:

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

USAs vestre del:

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

Europa:

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

Hvis push-varsler utløper på grunn av en forsinkelse i DNS-oppløsningen, øk tidsavbruddsverdien i "/etc/resolv.conf" filen på BroadWorks-serveren.

4

(For Android-varsler) Legg til Android-applikasjons-ID-ene i FCM-applikasjonskonteksten på NPS.

For Webex-appen på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

For UC-One-appen på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect

5

(For Apple iOS-varsler) Legg til program-ID-en i APNS-programkonteksten, og sørg for å utelate Auth-nøkkelen – sett den til tom.

For Webex-appen på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

For UC-One-appen på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Konfigurer følgende NPS-URL-er:

XSP CLI-kontekst

Parameter

Verdi

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

Konfigurer følgende NPS-tilkoblingsparametere til de anbefalte verdiene som vises:

XSP CLI-kontekst

Parameter

Verdi

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

Sjekk om applikasjonsserveren sjekker applikasjons-ID-er, fordi du må kanskje legge til Webex-appene i tillatelseslisten:

  1. Kjør AS_CLI/System/PushNotification> get og sjekk verdien av enforceAllowedApplicationList. Hvis det er true, må du fullføre denne deloppgaven. Ellers hopper du over resten av deloppgaven.

  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”

Start NPS på nytt og test push-varsler
1

Start XSP-en på nytt:

bwrestart
2

Test anropsvarsler til Android ved å foreta anrop fra en BroadWorks-abonnent til den anropende klienten på Android. Kontroller at anropsvarselet vises på Android-enheten.

Note: Hvis push-varsler begynner å mislykkes for UC-One Android-applikasjonen, er det mulig at det er en feilkonfigurasjon. Hvis dette er tilfellet for deg, kan du gå tilbake til den eldre FCM-versjonen på følgende måte:

  1. Deaktiver FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Start XSP på nytt: bwrestart

  3. Sjekk konfigurasjonen din.

  4. Aktiver FCMv1 på nytt og start XSP på nytt.

  5. Gjenta testen.

3

Test anropsvarsler til iOS ved å foreta anrop fra en BroadWorks-abonnent til den anropende klienten på iOS. Kontroller at anropsvarselet vises på iOS-enheten.

Note: Hvis push-varsler begynner å mislykkes for UC-One iOS-appen, er det mulig at det er en feilkonfigurasjon. Hvis dette er din situasjon, kan du gå tilbake til det eldre binære grensesnittet med set HTTP2Enabled false