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 push anropsvarsler til Webex-apper. Hvis NPS ikke støtter andre apper, kan du følge den forenklede fremgangsmåten i Webex for BroadWorks-løsningsveiledningen https://help.webex.com/z9gt5j.

NPS-proxyoversikt

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

Funksjonen implementerer et nytt design i Notification Push Server for å løse sikkerhetsproblemet med å dele push varselsertifikat og private nøkler med tjenesteleverandører for mobile klienter. I stedet for å dele pushvarselsertifikater og -nøkler med tjenesteleverandøren, bruker NPS et nytt API for å skaffe et kortvarig push-varsling-token fra UCaaS-serverdelen, og bruker dette tokenet for godkjenning med Apple APN-er og Google FCM-tjenestene.

Funksjonen forbedrer også muligheten for NPS-serveren for å sende pushvarsler til Android-enheter via det nye Google Firebase Cloud Messaging (FCM) HTTPV1 API-et.

BroadWorks-oppdateringer for funksjonen er tilgjengelige på Xchange: https://xchange.broadsoft.com/node/1046235

Hvis du vil ha mer informasjon, kan du se beskrivelsen av pushserver for VoIP i UCaaS-funksjon på Xchange: https://xchange.broadsoft.com/node/1045458

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

Minimumsversjoner og begrensninger for sameksistens

  • NPS må aktiveres på en dedikert XSP/ADP og NPS må være det eneste vertsprogrammet på serveren. Dette er for å eliminere forstyrrelse med leveringen av push-varsler.

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

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

    R22/R23-XSP er kompatibel med en R21-stakk hvis XSP bare kjører NPS og AS er R21. SP1. Se BroadWorks-kompatibilitetsmatrisen 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-en brukes med andre apper (ikke bare Webex-appen): Ikke endre NPS fra å bruke FCM Legacy API til å bruke FCM HTTP v1-API før du konfigurerer NPS-proxyen.

    Du kan endre dette under konfigurasjonen av NPS for å bruke NPS-proxy.

  • Når du har kontrollert at varslene fungerer som de skal for eldre apper med NPS-proxyen, kan du fjerne FCM API- nøkkelen for Android-appen, og APNs-godkjenningsnøkkelen for iOS-appen.

APNs 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 samarbeids-eller SaaS BroadWorks-appen, må overføres til HTTP/2. For detaljert informasjon om konfigurasjon av http/2, se http/2-støtte til varsel push-server for APNS (overføringen av NPS til å støtte disse IOS-appene summeres 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 appene Connect eller UC-One SaaS, kan ikke FCMv1-nøkler aktiveres før du konfigurerer 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 klargjøringsinstruksjonene (overføringsflyten er dokumentert i denne artikkelen).

Figur 1. Visuelt sammendrag av migrering til NPS-autentiseringsproxy
Tabell 1. Sammendrag av oppgaver som skal migreres til NPS-proxy

Sekvens

Oppgavetittel

Når/hvorfor er oppgaver obligatorisk?

1

Migrere 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

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

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

3

Aktivere FCMv1-modus, og teste push-varslinger.

Hvis NPS-en 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 begynner å mislykkes.

5

Installer NPS-autentiseringsproxy-oppdateringer.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurere NPS til å bruke NPS-autentiseringsproxyen:

  • Legg ved techsupport fra NPS

  • Forespør 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 på AS-tillatt-liste

  • Aktiver FCMv1 (på nytt)

  • Start XSP/ADP på nytt

  • Test PNs for iOS- og Android-apper

Alltid nødvendig.

7

Fjerne FCM-nøkler for eldre modus.

For apper som er støttet av NPS på FCMv1.

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-en og tilkoblingsparametre på XSP_CLI/Applications/notificationpushserver/APNs/Production->

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

Angi connectionPoolSize 2

Angi connectionTimeout 3000

Angi connectionIdleTimeoutInSeconds 600

Merk: Ikke angi tidsavbrudd for tilkobling under 1000.

2

Legg til program-ID-ene i konteksten for APNS-programmer, og pass på å utelate godkjenningsnøkkelen – angi at den skal være tom.

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

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

3

Merk av for godkjenningsnøklene med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Hvis godkjenningsnøkkelen ikke er tom for com.broadsoft.uc-one, you can clear it with 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 Configuration > BroadWorks > .

7

Rull ned til delen Notification Push Server og velg din versjon (for eksempel versjon 22), og følg instruksjonene som er angitt i portalen.

  • Denne oppgaven gjelder for NPS på XSP. Ignorer den 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 å autentisere 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 mislykkes varsler til Saas-klienter.

1

Hent prosjekt-ID-en fra FIREBASE-konsollen:

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

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

  3. Åpne fanen Generelt og ta opp prosjekt-ID-en.

2

Få tjenestekontoens private nøkkel fra Firebase:

  1. Naviger til tjenestekontofanen i prosjektinnstillingene.

  2. Du må enten opprette en ny tjenestekonto og få dens private nøkkel

  3. eller åpne en eksisterende tjenestekonto og generere 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-verten din for NPS.

4

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

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

5

Legg til UC One-programmet (Connect eller SaaS) og den tilknyttede prosjekt-ID-en i konteksten til 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 for å endre verdier hvis det er 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

omfang

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

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

600

  • Denne oppgaven gjelder for NPS på ADP. Ignorere den 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 å autentisere 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 mislykkes varsler til Saas-klienter.

1

Hent prosjekt-ID-en fra Firebase-konsollen:

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

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

  3. Åpne fanen Generelt og ta opp prosjekt-ID-en.

2

Få tjenestekontoens private nøkkel fra Firebase:

  1. Naviger til tjenestekontofanen i prosjektinnstillingene.

  2. Du må enten opprette en ny tjenestekonto og få dens private nøkkel.

  3. eller åpne en eksisterende tjenestekonto og generere 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 for FCM-prosjektet:

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

5

Legg til program-og prosjekt-ID-en i FCM-programkonteksten:

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

6

Bekreft 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

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

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

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

Du deaktiverer FCMv1 midlertidig fordi FCMv1-nøkler for disse appene bare skal være aktivert under konfigurasjonen av NPS-autentiseringsproxyen.

1

Logg deg 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 å bytte tilbake til den eldre FCM API-nøkkelen.

Installer følgende oppdateringer for å støtte NPS-autentiseringsproxy-funksjonen:

R22-oppdateringer

R23-oppdateringer

1

Opprett en serviceforespørsel med den opplastede kontakten, eller med TAC, for å klargjøre (Webex Common Identity) OAuth-klientsertifikat kontoen din. Navngi forespørselen NPS Configuration for Auth Proxy 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 med 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

Hvis du vil kontrollere at verdiene du skrev inn, samsvarer med det du har fått, kjører du XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

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

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-program-ID-ene i FCM-programkonteksten på NPS.

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

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

5

(For Apple iOS-varsler) Legg til program-ID-en i konteksten for APNS-programmer. Sørg for å utelate godkjenningsnøkkelen – angi at den skal være 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:

Tabell 2.

XSP CLI Context

Parameter

Verdi

XSP_CLI/Applications/NotificationPushServer/FCM>

authURL

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

pushURL

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

omfang

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-tilkoblingsparametre til de anbefalte verdiene som vises:

Tabell 3.

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 programserveren undersøker program-ID-er, siden du kanskje må legge til Webex-appene i tillatelseslisten:

  1. Kjør AS_CLI/system/pushnotification get og avmerk verdien for enforceAllowedApplicationList. Hvis den 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”

1

Start XSP på nytt:

bwrestart
2

Test anropsvarsler til Android ved å foreta anrop fra en BroadWorks-abonnent til anropsklienten på Android. Kontroller at anropsvarsel vises på Android-enheten.

Merk: Hvis push-varslinger starter å mislykkes for UC-One Android-programmet, kan det være en feilkonfigurasjon. Hvis dette er situasjonen, kan du gå tilbake til den eldre FCM på følgende måte:

  1. Deaktiver rFCMv1: 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 å foreta anrop fra en BroadWorks-abonnent til anropsklienten på iOS. Kontroller at anrops varsel vises på IOS-enheten.

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