Oversigt over NPS-godkendelsesproxy

Denne artikel beskriver, hvordan du konfigurerer en delt NPS til at bruge NPS-godkendelsesproxy, så den også kan bruges til at skubbe opkaldsunderretninger til Webex-apps. Hvis din NPS ikke understøtter andre apps, kan du følge den forenklede procedure i løsningsvejledningen til Webex forhttps://help.webex.com/z9gt5j.

Oversigt over NPS-proxy

For at være kompatibel med Webex til Broad Works skal din NPS være programmeret for at understøtte NPS-proxyfunktionen, Push Server for VoIP i UC aa.

Funktionen implementerer et nyt design i beskedpush-serveren for at løse sikkerhedssårbarheden ved at dele private nøgler med tjenesteudbydere for mobile klienter. I stedet for at dele push-notifikationscertifikater og -nøgler med tjenesteudbyderen bruger NPS et nyt API til at få et kortvarigt push-notifikationstoken fra UCAAS backend og bruger dette token til godkendelse med Apple APN'er og Google FCM-tjenester.

Funktionen forbedrer også beskedpush-serverens mulighed for at skubbe beskeder til Android-enheder via den nye Google Firebase Cloud Messaging (FCM) HTTPV1 API.

Forudsætninger for NPS-godkendelsesproxy

XSP (eller Application Delivery Platform ADP), der er vært for NPS, skal opfylde følgende krav:

Minimumsversioner og begrænsninger for medbopæl

  • NPS skal aktiveres på en dedikeret XSP/ADP, og NPS skal være det eneste hostede program på serveren. Dette er for at eliminere interferens med levering af push-beskeder.

  • Der bør kun være én NPS-app i en installation. Hvis du bruger mobil UC-One Collaborate/Connect og eller UC-One SaaS og implementerer Webex til Broad Works, skal du dele denne enkelte NPS for alle apps.

  • NPS skal være på version R22 eller nyere XSP eller ADP.

    R22/R23 XSP er kompatibel med en R21-stak, hvis XSP kun kører NPS, og AS er R21.SP1. Se Broad Works Kompatibility Matrix for yderligere oplysninger.

  • Yderligere oplysninger om ADP-serveren kan findes på https://xchange.broadsoft.com/node/1051580.

Delt NPS

Læs disse noter, før du konfigurerer din delte NPS til at bruge NPS-proxyen:

  • Hvis din NPS bruges sammen med andre apps (ikke kun Webex-appen): Konfigurer først NPS-proxyen, og skift derefter NPS fra at bruge det ældre FCM API til at bruge FCM HTTP v1-API.

  • Når du har bekræftet, at underretninger fungerer korrekt for ældre apps med NPS-proxy, skal du fjerne FCM API-nøglen for Android-appen og APN's godkendelsesnøgle for iOS-appen.

APN'er HTTP/2

  • Hvis du har installeret nogle iOS-apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere disse apps til at bruge HTTP/2 APNS-protokollen, før du konfigurerer NPS til at bruge NPS-proxyen.

  • XSP/ADP'er, der allerede understøtter appen Collaborate eller SaaS Broad Works, skal overføres til HTTP/2. For detaljerede oplysninger om konfiguration af HTTP/2, se HTTP/2 Support to Notification Push Server for APNS (migration af NPS for at understøtte disse i OS-apps er opsummeret i denne artikel).

Android FCMV1

  • Hvis du har installeret Android-apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere disse apps til at bruge FCMV1-tasterne, før du konfigurerer NPS til at bruge NPS-proxyen.

  • Hvis XSP/ADP i øjeblikket understøtter Connect- eller UC-One SaaS-appen, skal du aktivere FCM v1-taster, når du konfigurerer NPS-proxy. Vi anbefaler, at du migrerer alle yderligere apps til FCMV1-nøgler, aktiverer og tester og derefter deaktiverer, indtil du er klar til at fuldføre opsætningsvejledningen (migrationsstrømmen er dokumenteret i denne artikel).

Oversigt over NPS-proxymigrering
Visuel oversigt over migrering til NPS-godkendelsesproxy
Tabel 1. Oversigt over opgaver, der skal migreres til NPS-proxy

Rækkefølge

Opgavetitel

Hvornår/hvorfor er opgaven påkrævet?

1

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

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til HTTP/2.

2

Migrer NPS til FCMV1 for UC-One SaaS (eller Connect) Android-apps.

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til FCMV1.

3

Aktivér FCM v1-tilstand, og test push-beskeder.

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

4

Aktivér ældre FCM-tilstand igen.

Hvis NPS understøtter UC-One SaaS. Hvis du lader FCMV1 være aktiveret, før du konfigurerer NPS-proxyen, begynder beskeder til UC-One SaaS at mislykkes.

5

Installer NPS-godkendelsesproxy-programrettelser.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til at bruge NPS-godkendelsesproxy:

  • Vedhæft teknisk support fra NPS

  • Anmod om CI OA uth-konto

  • Opret CI-konto på NPS, og konfigurer timeout for opdateringstoken

  • Tilføj Android-app-id'er

  • Tilføj iOS-app-id'er

  • Kontrollér/indstil URL-adresser og forbindelses timeout

  • Føj apps til listen over AS-tilladelser

  • (Genstart)Aktivér FCMV1

  • Genstart XSP/ADP

  • Test PN'er for iOS- og Android-apps

Altid påkrævet.

7

Fjern ældre FCM-taster.

For apps, der understøttes af NPS på FCMV1.
Migrer Broad Works Collaborate iOS-apps til HTTP/2

Denne opgave er obligatorisk for push-underretninger til UC-One SaaS og Webex-apps på iOS-platforme.

Før du begynder

Hvis din XSP kører R22, skal du anvende ap354313, før du kan konfigurere NPS-applikationen til at bruge HTTP/2 til APNS.

1

Indstil produktionens URL-adresse og forbindelsesparametre 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

Bemærk: Indstil ikke forbindelsens timeout under 1000.

2

Føj applikations-id'erne til APNS-programkonteksten, og sørg for at udelade godkendelsesnøglen – indstil den til at tømme.

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

Kontrollér godkendelsestasterne med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Hvis godkendelsesnøglen ikke er tom for com.broadsoft.uc-one, kan du rydde det med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Aktivér HTTP/2:

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

6

Kun for UC-One Saa S-apps: Log ind på forhandlerportalen, og gå til Konfiguration > Brede værker > .

7

Rul ned til sektionen Notification Push Server, og vælg din version (f.eks. version 22), og følg derefter anvisningerne i portalen.

Migrer Broad Works UC-One Connect / SaaS Android-apps til FCMV1

  • Denne opgave gælder for NPS på XSP. Ignorer det, hvis din NPS er på ADP.

  • Du kan bruge denne procedure til at migrere til FCM v1-underretninger for UC-One Connect eller UC-One SaaS Android-apps.

  • Du skal bruge FCMV1, hvis du vil bruge NPS-proxy til at godkende push-underretninger til UC-One eller Webex Android-apps.

  • Denne opgave forbereder NPS til FCMV1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMV1, før du er klar til at konfigurere NPS-godkendelsesproxy, eller underretninger til SaaS-klienter mislykkes.

1

Få projekt-id'et fra Firebase-konsollen:

  1. Log ind på console.firebase.google.com.

  2. Vælg UC-One-appprojektet (Connect eller SaaS), åbn dets projektindstillinger.

  3. Åbn fanen Generelt , og optag projekt-id'et.

2

Få din tjenestekontos private nøgle fra Firebase:

  1. Naviger til fanen Tjenestekonti i projektindstillingerne.

  2. Opret enten en ny tjenestekonto, og hent dens private nøgle.

  3. Eller åbn en eksisterende tjenestekonto og generer en ny privat nøgle til den.

    Bemærk: Tjenestekontoen skal have firebaseadmin-sdk tilladelsen.

  4. Download nøglen til en sikker placering.

3

Kopiér nøglen til den XSP, der hoster din NPS.

4

Føj projekt-id'et og den tilknyttede private nøgle til FCM-projektkonteksten:

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

5

Føj UC-One-applikationen (Connect eller SaaS) og tilknyttede projekt-id til FCM-programkonteksten:

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

6

Kontrollér konfigurationen for FCM i forhold til de attributter og anbefalede værdier, der vises her. Brug set version af kommandoen til ændring af værdier, hvis det er nødvendigt:

Kør XSP_CLI/Applications/NotificationPushServer/FCM> get

Parameter

Anbefalet værdi

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 Broad Works UC-One Connect/SaaS Android-apps til FCMV1 (på ADP)

  • Denne opgave gælder for NPS på ADP. Ignorer det, hvis din NPS er på XSP.

  • Du kan bruge denne procedure til at migrere til FCM v1-underretninger for UC-One Connect eller UC-One SaaS Android-apps.

  • Du skal bruge FCMV1, hvis du vil bruge NPS-proxy til at godkende push-underretninger til UC-One eller Webex Android-apps.

  • Denne opgave forbereder NPS til FCMV1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMV1, før du er klar til at konfigurere NPS-godkendelsesproxy, eller underretninger til SaaS-klienter mislykkes.

1

Få projekt-id'et fra Firebase-konsollen:

  1. Log ind på console.firebase.google.com.

  2. Vælg UC-One-appprojektet (Connect eller SaaS), åbn dets projektindstillinger.

  3. Åbn fanen Generelt , og optag projekt-id'et.

2

Få din tjenestekontos private nøgle fra Firebase:

  1. Naviger til fanen Tjenestekonti i projektindstillingerne.

  2. Opret enten en ny tjenestekonto, og hent dens private nøgle.

  3. Eller åbn en eksisterende tjenestekonto og generer en ny privat nøgle til den.

    Bemærk: Tjenestekontoen skal have firebaseadmin-sdk tilladelsen.

  4. Download tasten (.json-filen) til en sikker placering.

3

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

4

Log ind på ADP CLI, og tilføj projekt- og API-nøglen til FCM-projektkonteksten:

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

5

Føj program- og projekt-id'et til FCM-programkonteksten:

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

6

Bekræft din konfiguration:

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
Aktivér ældre FCM-tilstand igen

Du behøver kun at gøre dette (som en del af migreringen), hvis:

  • Din NPS bruges til UC-One SaaS eller Broad Works Connect Android-apps.

  • Du har allerede testet, at meddelelser om opkaldstryk til andre apps fungerer med FCMV1 API.

Du deaktiverer midlertidigt FCMV1, fordi FCM v1-taster til disse apps kun skal aktiveres under konfigurationsprocessen for NPS-godkendelsesproxy.

1

Log ind på den XSP, der er vært for din delte NPS.

2

Naviger til FCM-konteksten, og deaktiver FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false for at vende tilbage til at bruge den ældre FCM API-nøgle.

Installer NPS-godkendelsesproxy-programrettelser
Konfigurer NPS til at bruge godkendelsesproxy
1

Opret en tjenesteanmodning med din onboardingkontakt eller med TAC for at klargøre din (Webex Common Identity) OA uth-klientkonto. Titel på din tjenesteanmodning NPS-konfiguration for godkendelsesproxyopsætning.

Cisco giver dig et OA uth-klient-id, en klienthemmelighed og et opdateringstoken, der er gyldigt i 60 dage. Hvis tokenet udløber, før du bruger det sammen med din NPS, kan du fremsætte en anden anmodning.
2

Opret 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 bekræfte de indtastede værdier, stemmer overens med det, du fik, skal du køre XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Indtast NPS-proxy-URL-adressen, og indstil intervallet for tokenopdatering (anbefalet 30 minutter):

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-underretninger) Føj Android-applikations-id'erne til FCM-programkonteksten på NPS.

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

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

5

(For Apple i OS-underretninger) Føj applikations-id'et til APNS-programkonteksten, sørg for at udelade godkendelsesnøglen – indstil den til at tømme.

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

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

6

Konfigurer følgende NPS URL-adresser:

XSP CLI Kontekst

Parameter

Værdi

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-forbindelsesparametre til de anbefalede værdier, der vises:

XSP CLI Kontekst

Parameter

Værdi

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

Kontrollér, om applikationsserveren screener program-id'er, da du muligvis skal føje Webex-apps til listen over tilladelser:

  1. Kør AS_CLI/System/PushNotification> get og kontroller værdien af enforceAllowedApplicationList. Hvis det er true, du skal udføre denne underopgave. Ellers skal du springe resten af underopgaven over.

  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”

Genstart NPS- og testpush-underretninger
1

Genstart XSP:

bwrestart
2

Test opkaldsunderretninger til Android ved at foretage opkald fra en Broad Works-abonnent til opkaldsklienten på Android. Bekræft, at opkaldsunderretning vises på Android-enheden.

Bemærk: Hvis push-underretninger begynder at mislykkes for UC-One Android-applikationen, er det muligt, at der er en fejlkonfiguration. Hvis dette er din situation, kan du vende tilbage til den ældre FCM på følgende måde:

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

  2. Genstart XSP: bwrestart

  3. Kontrollér din konfiguration.

  4. Aktivér FCM v1 igen, og genstart XSP.

  5. Gentag testen.

3

Test opkaldsunderretninger til iOS ved at foretage opkald fra en Broad Works-abonnent til opkaldsklienten på iOS. Bekræft, at opkaldsunderretning vises på iOS-enheden.

Bemærk: Hvis push-underretninger begynder at mislykkes for UC-One i OS-applikationen, er det muligt, at der er en fejlkonfiguration. Hvis dette er din situation, kan du vende tilbage til den ældre binære grænseflade med set HTTP2Enabled false