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 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 et nytt design i Notification Push Server for å løse sikkerhetssårbarheten ved å dele push-varslingssertifikatets private nøkler med tjenesteleverandører for mobilklienter. I stedet for å dele push-varslingssertifikater og nøkler med tjenesteleverandøren, bruker NPS en ny API for å skaffe et kortvarig push-varslingstoken fra UCaaS-backend, og bruker dette tokenet til godkjenning med Apple APN-er og Google FCM-tjenester.

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

Forutsetninger for NPS-autentiseringsproxy

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

Minimumsversjoner og begrensninger for samkjøring

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

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

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

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

Delt NPS

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

  • 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.

  • Når 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økkelen for iOS-appen.

APN HTTP/2

  • Hvis du har distribuert noen 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/ADP-er 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 (overføring av NPS til å støtte disse iOS-appene er oppsummert i denne artikkelen).

Android FCMv1

  • Hvis du har distribuert noen 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, må du aktivere 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
Visuelt sammendrag av overføring til NPS-autentiseringsproxy
Tabell 1. Sammendrag av oppgaver som skal overføres til NPS-proxy

Sekvens

Oppgavetittel

Når/hvorfor er oppgave nødvendig?

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 FCM eldre 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 trykke på 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-autentiseringsproxy:

  • Fest teknisk støtte fra NPS

  • Be om CI OAuth-konto

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

  • Legg til app-id-er for Android

  • Legg til app-id-er for iOS

  • Kontroller/angi URL-adresser og tidsavbrudd for tilkobling

  • Legg til apper i tillatelseslisten AS

  • (På nytt)Aktiver FCMv1

  • Start XSP / ADP på nytt

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

Alltid påkrevd.

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 begynner

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

1

Angi produksjons-URL og tilkoblingsparametre 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 tidsavbrudd for tilkobling under 1000.

2

Legg til program-ID-ene i konteksten for APNS-programmer, og sørg for å utelate godkjenningsnø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

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

4

Hvis autentiseringsnø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

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

7

Bla ned til delen Notification Push Server, og velg din versjon (f.eks. Utgivelse 22), og følg deretter instruksjonene i portalen.

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

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

  • Du kan bruke denne fremgangsmåten for å overføre til FCMv1-varsler for UC-One Connect- eller UC-One SaaS Android-apper.

  • Du må bruke FCMv1 hvis du vil bruke NPS-proxyen til å godkjenne push-varslinger 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-autentiseringsproxy. 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 på console.firebase.google.com.

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

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

2

Få tjenestekontoens private nøkkel fra Firebase:

  1. Gå til Tjenestekontofanen i prosjektinnstillingene.

  2. Enten opprett en ny tjenestekonto og få sin private nøkkel.

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

    Merk: Tjenestekontoen må ha tillatelsen firebaseadmin-sdk .

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

3

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

4

Legg til prosjekt-ID-en og den tilknyttede private nøkkelen i konteksten til FCM-prosjektene:

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

5

Legg til UC-One (Connect eller SaaS)-programmet og den tilknyttede prosjekt-ID-en i konteksten for FCM-programmet:

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

6

Kontroller konfigurasjonen for FCM mot attributtene og de anbefalte verdiene som vises her. Bruk set versjonen av kommandoen til å 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

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

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

  • Du kan bruke denne fremgangsmåten for å overføre til FCMv1-varsler for UC-One Connect- eller UC-One SaaS Android-apper.

  • Du må bruke FCMv1 hvis du vil bruke NPS-proxyen til å godkjenne push-varslinger 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-autentiseringsproxy. 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 på console.firebase.google.com.

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

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

2

Få tjenestekontoens private nøkkel fra Firebase:

  1. Gå til Tjenestekontofanen i prosjektinnstillingene.

  2. Enten opprett en ny tjenestekonto og få sin private nøkkel.

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

    Merk: 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 på ADP CLI og legg til prosjekt- og API-nøkkelen i konteksten til FCM-prosjektene:

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

5

Legg til program- og prosjekt-ID-en i konteksten for FCM-programmer:

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

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

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

  • Du har allerede testet at anrop push-varsler 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 som er vert for din 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 NPS-autentiseringsproxy-oppdateringer
Konfigurer NPS til å bruke autentiseringsproxy
1

Opprett en serviceforespørsel med din onboarding-kontakt, eller med TAC, for å klargjøre din (Webex Common Identity) OAuth-klientkonto. Tittelen på tjenesteforespørselen din NPS-konfigurasjon for auth proxy-oppsett.

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 din NPS, kan du sende 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 har fått. XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Angi NPS-proxy-URL, og angi oppdateringsintervallet for token (30 minutter anbefales):

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

For å forbedre DNS-oppløsningshastigheten anbefaler vi i stedet for gjeldende FQDN nps.uc-one.broadsoft.com at du bruker riktig FQDN basert på din region.

Områdebaserte FQDN-er:

USA øst:

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

USA, vest:

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

Europa:

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

Hvis varsler blir tidsavbrutt på grunn av en forsinkelse i DNS-oppløsningen, øker du tidsavbruddsverdien i filen "/etc/resolv.conf" på BroadWorks-serveren.

4

(For Android-varsler) Legg til Android-program-ID-ene i FCM-programkonteksten 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 konteksten for APNS-programmer, og sørg for å utelate godkjenningsnøkkelen – angi 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 Context

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 applikasjonsserveren kontrollerer program-ID-er, fordi du kanskje må legge til Webex-appene i tillatelseslisten:

  1. Kjør AS_CLI/System/PushNotification> get og sjekk verdien til enforceAllowedApplicationList. Hvis det er true, må du fullføre denne underoppgaven. 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-varslinger
1

Start XSP på nytt:

bwrestart
2

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

Merk: Hvis push-varslinger begynner å mislykkes for UC-One Android-programmet, er det mulig at det er en feilkonfigurasjon. Hvis dette er situasjonen din, kan du gå tilbake til den eldre FCM 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 anropsklienten på iOS. Kontroller at anropsvarselet vises på iOS-enheten.

Merk: Hvis push-varslinger begynner å mislykkes for UC-One iOS-programmet, er det mulig at det er en feilkonfigurasjon. Hvis dette er situasjonen din, kan du gå tilbake til det gamle binære grensesnittet med set HTTP2Enabled false