Oversikt over proxy for NPS-godkjenning

Denne artikkelen beskriver hvordan du konfigurerer en delt NPS til å bruke NPS-godkjenningsproxy, slik at den også kan brukes til å sende anropsvarsler til Webex-apper. Hvis NPS ikke støtter andre apper, kan du følge den forenklede prosedyren i Webex for BroadWorks Solution Guide https://help.webex.com/z9gt5j.

Oversikt over NPS-proxy

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

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

Funksjonen forbedrer også muligheten til Notification Push Server for å sende varsler til Android-enheter gjennom den nye Google Firebase Cloud Messaging (FCM) HTTPv1 API.

Proxy-forutsetninger for NPS-godkjenning

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

Minimumsversjoner og begrensninger for samtidig opphold

  • NPS må aktiveres på en dedikert XSP/ADP, og NPS må være det eneste vertsbaserte programmet på serveren. Dette er for å eliminere forstyrrelser i leveringen av Push-varsler.

  • Det bør 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 enkle NPS-en for alle appene.

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

    R22/R23 XSP er kompatibel med en R21-stakk hvis XSP bare kjører NPS og AS er R21. SP1. Se Kompatibilitetsmatrisen for BroadWorks hvis du vil ha mer informasjon.

  • Du finner mer informasjon om ADP-serveren på https://xchange.broadsoft.com/node/1051580.

Delt NPS

Les disse notatene før du konfigurerer det delte NPS til å bruke NPS Proxy:

  • Hvis NPS brukes med andre apper (ikke bare Webex-appen): Konfigurer først NPS-proxyen, og endre deretter NPS fra å bruke fcm eldre API 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 godkjenningsnøkkel for iOS-appen.

APNer HTTP/2

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

  • XSP/ADPer som allerede støtter Collaborate- eller SaaS BroadWorks-appen, må overføres til HTTP/2. Hvis du vil ha detaljert informasjon om hvordan du konfigurerer HTTP/2, kan du se HTTP/2 Support to 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, konfigurerer du disse appene til å bruke FCMv1-nøklene før du konfigurerer NPS til å bruke NPS-proxyen.

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

Sammendrag av NPS-proxy-migrering

Figur 1. Visuell oppsummering av overføring til nps-godkjenningsproxy
Tabell 1. Sammendrag av aktiviteter som skal overføres til NPS-proxy

Sekvens

Tittel på oppgave

Når/hvorfor kreves oppgaven?

1

Overfør 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

Overfør 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-varslinger.

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

4

Aktiver eldre FCM-modus på nytt.

Hvis NPS støtter UC-One SaaS. Hvis du lar FCMv1 være aktivert, før du konfigurerer NPS-proxyen, må du sende varslinger til UC-One SaaS for å mislykkes.

5

Installer proxy-oppdateringer for NPS-godkjenning.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til å bruke NPS-godkjenningsproxyen:

  • 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

  • Legge til id-er for iOS-apper

  • Kontrollere/angi URL-adresser og tidsavbrudd for tilkobling

  • Legg til apper i AS-tillatelseslisten

  • (Re-) Aktiver FCMv1

  • Start XSP / ADP på nytt

  • Teste bestillinger for iOS- og Android-apper

Alltid nødvendig.

7

Fjern nøkler for eldre FCM-modus.

For apper som støttes av NPS på FCMv1.

Overfør BroadWorks Collaborate iOS-apper til HTTP/2

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

Før du starter

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

1

Angi URL-adresse for produksjon og tilkoblingsparametere 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

Merk: Ikke angi tidsavbruddet for tilkobling under 1000.
2

Legg til program-IDene i APNS-programkonteksten, og pass på at du utelater Auth-tasten – 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

Kontroller godkjenningsnøklene med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get
4

Hvis godkjenningsnøkkelen ikke er tom for com.broadsoft.uc-one, kan du fjerne 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

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

7

Rull ned til Delen Notification Push Server, og velg utgaven din (f.eks. versjon 22), og følg deretter instruksjonene i portalen.

Overfør BroadWorks UC-One Connect / SaaS Android-apper til FCMv1

  • Denne aktiviteten gjelder for NPS på XSP. Ignorer det hvis NPS er på ADP.

  • Du kan bruke denne fremgangsmåten til å 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 klargjør NPS for FCMv1 slik at du kan aktivere den som en del av konfigurasjonen av NPS-godkjenningsproxy. Ikke aktiver FCMv1 før du er klar til å konfigurere NPS-godkjenningsproxy, ellers vil varslinger til SaaS-klienter mislykkes.

1

Få prosjekt-IDen fra Firebase-konsollen:

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

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

  3. Åpne kategorien Generelt , og registrer prosjekt-IDen.
2

Få privatnøkkelen for tjenestekontoen din fra Firebase:

  1. Gå til kategorien Servicekontoer i prosjektinnstillingene.

  2. Opprett en ny tjenestekonto, og hent privatnøkkelen.

  3. Du kan også åpne en eksisterende tjenestekonto og generere en ny privatnøkkel for den.

    Merk: Tjenestekontoen må ha firebaseadmin-SDK-tillatelsen .

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

Kopier nøkkelen til XSP som er vert for NPS.
4

Legg til prosjekt-IDen og den tilknyttede privatnøkkelen i FCM-prosjektkonteksten:

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

Legg til UC-One-programmet (Connect eller SaaS) og tilknyttet prosjekt-ID i FCM-programkonteksten:

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

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

Kjør 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

Migrere BroadWorks UC-One Connect / SaaS Android-apper til FCMv1 (på ADP)

  • Denne aktiviteten gjelder for NPS på ADP. Ignorer det hvis NPS er på XSP.

  • Du kan bruke denne fremgangsmåten til å 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 klargjør NPS for FCMv1 slik at du kan aktivere den som en del av konfigurasjonen av NPS-godkjenningsproxy. Ikke aktiver FCMv1 før du er klar til å konfigurere NPS-godkjenningsproxy, ellers vil varslinger til SaaS-klienter mislykkes.

1

Få prosjekt-IDen fra Firebase-konsollen:

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

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

  3. Åpne kategorien Generelt , og registrer prosjekt-IDen.
2

Få privatnøkkelen for tjenestekontoen din fra Firebase:

  1. Gå til kategorien Servicekontoer i prosjektinnstillingene.

  2. Opprett en ny tjenestekonto, og hent privatnøkkelen.

  3. Du kan også åpne en eksisterende tjenestekonto og generere en ny privatnøkkel for den.

    Merk: Tjenestekontoen må ha firebaseadmin-SDK-tillatelsen .

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

Importere 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 program- og prosjekt-IDen i FCM-programkonteksten:

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

Kontroller konfigurasjonen:

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

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

  • NPS brukes for UC-One SaaS- eller BroadWorks Connect Android-apper.

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

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

1

Logg på XSP som er vert for det delte NPS.
2

Gå 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.

Installere proxy-oppdateringer for NPS-godkjenning

Konfigurere NPS til å bruke godkjenningsproxy

1

Opprett en serviceforespørsel med onboarding-kontakten din, eller med TAC, for å klargjøre OAuth-klientkontoen din (Webex Common Identity). Gi tjenesteforespørselen nps-konfigurasjon for AuthProxy Setup.

Cisco 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 sammen med NPS, kan du fremme en ny forespørsel.
2

Opprett klientkontoen i 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

Hvis du vil kontrollere at verdiene du skrev inn, samsvarer med det du fikk, kjører du XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get
3

Angi NPS Proxy URL,og angi tokenoppdateringsintervallet (30 minutter anbefales):

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

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

(For Android-varsler) Legg til Android-applikasjons-IDene 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-IDen i APNS-programkonteksten, og pass på at du utelater godkjenningsnø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-adresser:

Tabell 2.

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:

Tabell 3.

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

Kontroller om Application Server screener program-IDer, fordi du kanskje må legge til Webex-appene i tillatelseslisten:

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

  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-varslinger

1

Start XSP på nytt:

bwrestart
2

Test anropsvarsler til Android ved å ringe fra en BroadWorks-abonnent til anropsklienten på Android. Bekreft at anropsvarselet vises på Android-enheten.

Merk: Hvis push-varsler begynner å mislykkes for UC-One Android-applikasjonen, er det mulig at det er en feilkonfigurasjon. Hvis dette er din situasjon, kan du gå tilbake til den eldre FCM som følger:

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

  2. Start XSP på nytt: bwrestart

  3. Kontroller konfigurasjonen.

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

  5. Gjenta testen.
3

Test anropsvarsler til iOS ved å ringe fra en BroadWorks-abonnent til anropsklienten på iOS. Kontroller at anropsvarslingen vises på iOS-enheten.

Merk: Hvis push-varslinger begynner å mislykkes for UC-One iOS-applikasjonen, 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