Oversikt over proxy for NPS-godkjenning


Denne artikkelen beskriver hvordan du konfigurerer en delt NPS til å bruke proxy for NPS-godkjenning, slik at den også kan brukes til å sende anropsvarsler til Webex-apper. Hvis NPS-en ikke støtter andre apper, kan du følge den forenklede fremgangsmåten i løsningsveiledningen for Webex for BroadWorkshttps://help.webex.com/z9gt5j .

Oversikt over NPS-proxy

For kompatibilitet med Webex for BroadWorks må NPS-en din være oppdatering for å støtte NPS-proxy-funksjonen, Push-server for VoIP i UCaaS .

Funksjonen implementerer en ny design i varslingsserveren 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ør, bruker NPS en ny API til å hente et kortvarig push-varslingstoken fra UCaaS-serverdelen, og bruker dette tokenet til autentisering med Apple APN-ene og Google FCM-tjenestene.

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

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

Minimumsversjoner og begrensninger for samboende

  • NPS må være aktivert 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 i 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- kompatibilitetsmatrise hvis du vil ha mer informasjon.

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

Delt NPS

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

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

  • Når du har bekreftet at varslene 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 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-proxy.

  • XSP/ADP-er som allerede støtter Collaborate- eller SaaS BroadWorks-appen, må overføres til HTTP/2. Hvis du vil detaljert informasjon om konfigurering av HTTP/2, se HTTP/2-støtte til Push-varslingsserver for APNS (overføring 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-proxy.

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

Figur 1. Visuelt sammendrag av overføring til NPS-godkjenningsproxy
Tabell 1. Sammendrag av oppgaver som skal overføres til NPS-proxy

Sekvens

Oppgavetittel

Når/Hvorfor er oppgave obligatorisk?

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

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, begynner push-varsler til UC-One SaaS å mislykkes.

5

Installer proxy-oppdateringer for NPS-godkjenning.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til å bruke proxy for NPS-godkjenning:

  • Koble til teknisk kundestø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

  • Kontroller/angi nettadresser og tidsavbrudd for tilkobling

  • Legg til apper i listen over tillatelser som AS

  • (Re-)Aktiver FCMv1

  • Start XSP / ADP på nytt

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

Alltid obligatorisk.

7

Fjern FCM-taster for eldre modus.

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

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

Før du starter

Hvis XSP-en din 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 tilkoblingsparametere til 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 APNS-programkonteksten, og sørg for å utelate autentiseringsnøkkelen – angi den til 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

Kontroller 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 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 Push-varsling, og velg versjonen (f.eks Versjon 22 ), og følg deretter instruksjonene i portalen.

  • Denne oppgaven gjelder for NPS på XSP. Ignorer det hvis NPS-en din 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-proxy 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 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)-appprosjektet, åpne prosjektinnstillingene.

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

2

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

  1. Gå til kategorien Tjenestekontoer i prosjektinnstillingene.

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

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

    Merk: tjenestekonto må ha firebaseadmin-sdk tillatelse.

  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 (Connect eller SaaS)-applikasjonen og den tilknyttede prosjekt-ID-en i FCM-programkonteksten:

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

6

Kontroller konfigurasjonen for FCM opp mot attributtene og de anbefalte verdiene som vises her. Bruk set versjon 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

  • Denne oppgaven gjelder for NPS på ADP. Ignorer det hvis NPS-en din 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-proxy 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 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)-appprosjektet, åpne prosjektinnstillingene.

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

2

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

  1. Gå til kategorien Tjenestekontoer i prosjektinnstillingene.

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

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

    Merk: tjenestekonto må ha firebaseadmin-sdk tillatelse.

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

3

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

4

Logg 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:

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 overføringen) 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 må bare aktiveres under konfigurasjonsprosessen for proxy for NPS-godkjenning.

1

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

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.

1

Opprett en tjenesteforespørsel med onboarding-kontakten din, eller med TAC, for å klargjøre (Webex Common Identity) OAuth-klientkontoen din. Gi tjenesteforespørsel ditt NPS-konfigurasjon for Auth Proxy-oppsett .

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 bekrefte at verdiene du oppga samsvarer med det du fikk, kjører du XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Angi URL-adressen for NPS-proxy, og angi oppdateringsintervallet for token (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-program-ID-ene i FCM-programkonteksten på NPS.

For Webex-app 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 autentiseringsnøkkelen – angi den til tom.

For Webex-app 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-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 programserveren 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 av enforceAllowedApplicationList. Hvis det er det true, må du fullføre denne underoppgaven. Hvis ikke, 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-enhet.

Merk: Hvis push-varsler begynner å mislykkes for UC-One Android-applikasjonen, 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. 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 anropsvarsel vises på iOS-enhet.

Merk: 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