Pregled proxy servera NPS potvrde identiteta

Ovaj članak opisuje kako se deljeni NPS konfiguriše tako da koristi proxy server za potvrdu identiteta NPS, tako da se može koristiti i za guranje obaveštenja o pozivima u Webex aplikacije. If your NPS doesn’t support other apps, you can follow the simplified procedure in the Webex for BroadWorks Solution Guide.

Pregled proxy servera NPS

Da biste bili kompatibilni sa Webex-om za BroadWorks, NPS mora biti zakrpljen da bi podržao NPS proxy funkciju, Push Server za VoIP u UCaaS-u.

Funkcija primenjuje novi dizajn u serveru za guranje obaveštenja da bi rešila bezbednosnu ranjivost deljenja potvrde o guranju privatnih ključeva certifikata sa dobavljačima usluga za mobilne klijente. Instead of sharing push notification certificates and keys with the service provider, the NPS uses a new API to obtain a short-lived push notification token from the UCaaS backend, and uses this token for authentication with the Apple APNs and Google FCM services.

Funkcija takođe poboljšava mogućnost Notification Push Servera da gura obaveštenja na Android uređaje putem novog Google Firebase Cloud Messaging (FCM) HTTPv1 API.

NPS preduslovi za potvrdu identiteta

XSP (ili Platforma za isporuku aplikacija ADP) koja je domaćin NPS-u mora da ispuni sledeće zahteve:

Minimalne verzije i ograničenja boravka

  • NPS mora biti aktiviran na namenskom XSP/ADP i NPS mora biti jedina hostovana aplikacija na serveru. Ovo je da bi se eliminisale smetnje u isporuci Push obaveštenja.

  • U primeni bi trebalo da postoji samo jedna NPS aplikacija. Ako koristite mobilni UC-One Collaborate/Connect i ili UC-One SaaS i implementirate Webex za BroadWorks, morate da delite ovaj jedinstveni NPS za sve aplikacije.

  • NPS mora biti na verziji R22 ili novijoj XSP ili ADP.

    R22/R23 XSP je kompatibilan sa R21 nizom ako XSP pokreće samo NPS, a AS R21. SP1. Više informacija potražite u matrici kompatibilnosti za BroadWorks.

  • More information on the ADP server can be found at Cisco BroadWorks Application Delivery Platform.

Deljeni NPS

Pročitajte ove beleške pre nego što konfigurišete deljeni NPS da koristi NPS Proxy server:

  • If your NPS is used with other apps (not just the Webex App): Prvo konfigurišite NPS proxy server, a zatim promenite NPS od korišćenja FCM zastarelog API-ja u korišćenje FCM HTTP v1 API.

  • After you’ve verified that notifications are working properly for older apps with the NPS proxy, then remove the FCM API key for the Android app, and the APNs auth key for the iOS app.

APNs HTTP/2

  • If you’ve deployed any iOS apps that aren’t from Cisco/BroadSoft, configure those apps to use the HTTP/2 APNS protocol before configuring NPS to use the NPS proxy.

  • XSP/ADPs koji već podržavaju aplikaciju Collaborate ili SaaS BroadWorks treba migrirati na HTTP/2. Detaljne informacije o konfigurisanju HTTP/2 potražite u članku HTTP/2 Podrška za obaveštavanje Push Server za APNS (migracija NPS-a radi podrške za ove iOS aplikacije je rezimirana u ovom članku).

Android FCMv1

  • If you’ve deployed any Android apps that aren’t from Cisco/BroadSoft, configure those apps to use the FCMv1 keys before configuring NPS to use the NPS proxy.

  • If XSP/ADP currently supports the Connect or UC-One SaaS app, then enable FCMv1 keys after you configure the NPS proxy. We recommend that you migrate all additional apps to FCMv1 keys, enable, and test, then disable until you're ready to complete the setup instructions (the migration flow is documented in this article).

Rezime NPS proxy migracije
Visual Summary of Migration to NPS Authentication Proxy
Table 1. Rezime zadataka za migraciju na NPS proxy server

Sekvenca

Naslov zadatka

Kada/zašto je zadatak potreban?

1

Preseli NPS u HTTP/2 za UC-One SaaS (ili Connect) iOS aplikacije.

Ako NPS podržava te aplikacije, a one još uvek nisu konfigurisane za HTTP/2.

2

Preseli NPS u FCMv1 za UC-One SaaS (ili Connect) Android aplikacije.

Ako NPS podržava te aplikacije, a one još uvek nisu konfigurisane za FCMv1.

3

Omogućite FCMv1 režim i testirajte push obaveštenja.

Ako NPS podržava UC-One Connect i/ili druge (non-Cisco) Android aplikacije.

4

Ponovo omogućite FCM zastareli režim.

Ako NPS podržava UC-One SaaS. Ako fcMv1 ostavite omogućen, pre nego što konfigurišete NPS proxy server, onda gurni obaveštenja na UC-One SaaS počnite da otkazujete.

5

Instalirajte NPS proxy zakrpe za potvrdu identiteta.

Ako je NPS na XSP R22 ili XSP R23.

6

Konfigurišite NPS da koristi proxy server za NPS potvrdu identiteta:

  • Priloži techsupport iz NPS-a

  • Zahtevaj CI OAuth nalog

  • Kreiraj CI nalog na NPS-u i konfiguriši vremensko osvežavanje tokena

  • Dodavanje ID-a Android aplikacija

  • Dodavanje iOS id-a aplikacija

  • Provere/podešavanje URL adresa i vremenskih tajmauta veze

  • Dodavanje aplikacija na AS listu dozvoljenih lokacija

  • (Ponovo) Omogući FCMv1

  • Ponovo pokreni XSP / ADP

  • Testiranje PNS-a za iOS i Android aplikacije

Uvek obavezno.

7

Uklonite tastere FCM zastarelog režima.

Za aplikacije koje NPS uspešno podržava na FCMv1.
Preseli BroadWorks Collaborate iOS aplikacije u HTTP/2

Ovaj zadatak je obavezan za guranje obaveštenja UC-One SaaS i Webex aplikacijama na iOS platformama.

Pre nego što počneš

Ako XSP radi pod operativnim sistemom R22, potrebno je da primenite ap354313 da biste mogli da konfigurišete NPS aplikaciju da koristi HTTP/2 za APNS.

1

Postavljanje URL adrese proizvodnje i parametara veze na XSP_CLI/Applications/NotificationPushServer/APNS/Production>

set url https://api.push.apple.com/3/device

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Napomena: Nemojte postavljati vremensko vreme veze ispod 1000.

2

Dodajte ID-ove aplikacije u kontekst APNS aplikacija, obavezno izostavite taster Auth – podesite ga na prazan.

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

Za Webex aplikaciju: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

3

Proverite ključeve od potvrde pomoću XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

If the auth key is not empty for com.broadsoft.uc-one, you can clear it with XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Omogući HTTP/2:

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

6

Samo za UC-One SaaS aplikacije: Sign in to the reseller portal and go to Configuration > BroadWorks > .

7

Scroll down to the Notification Push Server section, and select your release (e.g. Release 22), then follow the instructions provided in the portal.

Migrate BroadWorks UC-One Connect / SaaS Android Apps to FCMv1

  • Ovaj zadatak se primenjuje na NPS na XSP- u. Ignorišite to ako je NPS u ADP-u.

  • Ovu proceduru možete da koristite za migraciju na FCMv1 obaveštenja za UC-One Connect ili UC-One SaaS Android aplikacije.

  • Morate da koristite FCMv1 ako želite da koristite NPS proxy server da biste potvrdili verodostojnost push obaveštenja UC-One ili Webex Android aplikacijama.

  • Ovaj zadatak priprema NPS za FCMv1 tako da ga možete omogućiti kao deo konfiguracije proxy servera NPS potvrde identiteta. Nemojte omogućiti FCMv1 dok ne budete spremni da konfigurišete proxy server za potvrdu identiteta NPS-a ili obaveštenja sa SaaS klijentima neće uspeti.

1

Nabavite ID projekta sa Firebase konzole:

  1. Prijavite se u console.firebase.google.com.

  2. Izaberite UC-One (Connect ili SaaS) projekat aplikacije, otvorite njegove postavke projekta.

  3. Otvorite karticu Opšte postavke i zakažete ID projekta.

2

Nabavite privatni ključ svog naloga za servis iz Firebase-a:

  1. Dođite do kartice "Nalozi usluge" u postavkama projekta.

  2. Kreirajte novi nalog usluge i nabavite njegov privatni ključ.

  3. Ili otvorite postojeći nalog usluge i generišite novi privatni ključ za njega.

    Napomena: The service account must have the firebaseadmin-sdk permission.

  4. Preuzmite ključ na bezbednu lokaciju.

3

Kopirajte ključ na XSP hosting vašeg NPS-a.

4

Dodajte ID projekta i pridruženi privatni ključ kontekstu FCM projekata:

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

5

Dodajte UC-One (Connect ili SaaS) aplikaciju i pridruženi ID projekta u kontekst FCM aplikacija:

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

6

Proverite konfiguraciju FCM-a u odnosu na atribute i preporučene vrednosti prikazane ovde. Use set version of the command to change values if necessary:

Pokreni XSP_CLI/Applications/NotificationPushServer/FCM> get

Parametar

Preporučena vrednost

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

Migrate BroadWorks UC-One Connect / SaaS Android Apps to FCMv1 (on ADP)

  • Ovaj zadatak se primenjuje na NPS u ADP-u. Ignorišite to ako je vaš NPS na XSP-u.

  • Ovu proceduru možete da koristite za migraciju na FCMv1 obaveštenja za UC-One Connect ili UC-One SaaS Android aplikacije.

  • Morate da koristite FCMv1 ako želite da koristite NPS proxy server da biste potvrdili verodostojnost push obaveštenja UC-One ili Webex Android aplikacijama.

  • Ovaj zadatak priprema NPS za FCMv1 tako da ga možete omogućiti kao deo konfiguracije proxy servera NPS potvrde identiteta. Nemojte omogućiti FCMv1 dok ne budete spremni da konfigurišete proxy server za potvrdu identiteta NPS-a ili obaveštenja sa SaaS klijentima neće uspeti.

1

Nabavite ID projekta sa Firebase konzole:

  1. Prijavite se u console.firebase.google.com.

  2. Izaberite UC-One (Connect ili SaaS) projekat aplikacije, otvorite njegove postavke projekta.

  3. Otvorite karticu Opšte postavke i zakažete ID projekta.

2

Nabavite privatni ključ svog naloga za servis iz Firebase-a:

  1. Dođite do kartice "Nalozi usluge" u postavkama projekta.

  2. Kreirajte novi nalog usluge i nabavite njegov privatni ključ.

  3. Ili otvorite postojeći nalog usluge i generišite novi privatni ključ za njega.

    Napomena: The service account must have the firebaseadmin-sdk permission.

  4. Preuzmite ključ (.json datoteka) na bezbednu lokaciju.

3

Import the .json file to the ADP server /bw/install.

4

Prijavite se na ADP CLI i dodajte projekat i API ključ kontekstu FCM projekata:

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

5

Dodajte aplikaciju i ID projekta kontekstu FCM aplikacija:

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

6

Proverite konfiguraciju:

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
Ponovo omogući FCM zastareli režim

Ovo je potrebno da uradite (kao deo migracije) samo ako:

  • Vaš NPS se koristi za UC-One SaaS ili BroadWorks Connect Android aplikacije.

  • Već ste testirali da obaveštenja o guranju poziva drugim aplikacijama rade sa FCMv1 API.

Privremeno onemogućavate FCMv1 jer FCMv1 ključevi za ove aplikacije moraju biti omogućeni samo tokom procesa konfiguracije proxy servera NPS potvrde identiteta.

1

Prijavite se na XSP hosting deljenog NPS-a.

2

Krećite se do FCM konteksta i onemogućite FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false da biste se vratili na korišćenje FCM zastarelog API ključa.

Instaliranje proxy zakrpa za NPS potvrdu identiteta
Configure NPS to use authentication proxy
1

Kreirajte zahtev za uslugu sa kontaktom na brodu ili sa TAC-om da biste obezbedili svoj (Webex Common Identity) OAuth klijentski nalog. Naslov zahteva za uslugu NPS Konfiguracija za podešavanje Auth Proxy servera.

We give you an OAuth client ID, a client secret, and a refresh token that's valid for 60 days. Ako simbol istekne pre nego što ga upotrebite sa NPS-om, možete da podignete još jedan zahtev.
2

Kreirajte klijentski nalog u NPS-u:

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

Run the command to verify that the values you entered match the ones provided to you. XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Unesite NPS proxy URL adresu i podesite interval osvežavanja simbola (preporučuje se 30 minuta):

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

To enhance the DNS resolution speed, instead of the current FQDN nps.uc-one.broadsoft.com we recommend you to use the appropriate FQDN based on your region.

Region-based FQDNs:

US East:

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

US West:

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

Evropa:

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

If push notifications time out due to a delay in DNS resolution, increase the timeout value in the "/etc/resolv.conf" file on the BroadWorks server.

4

(Za Android obaveštenja) Dodajte ID-ove Android aplikacija u kontekst FCM aplikacija na NPS- u.

For Webex App on Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

For UC-One App on Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect

5

(Za Apple iOS obaveštenja) Dodajte ID aplikacije u kontekst APNS aplikacija, obavezno izostavite taster Auth – podesite ga na prazan.

For Webex App on iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

Za UC-One aplikaciju na iOS-u: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Konfigurišite sledeće NPS URL adrese:

XSP CLI context

Parametar

Vrednost

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

Konfigurišite sledeće parametre NPS veze sa prikazanim preporučenim vrednostima:

XSP CLI kontekst

Parametar

Vrednost

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

Proverite da li server aplikacije pregleda ID-ove aplikacija zato što ćete možda morati da dodate Webex aplikacije na listu dozvoljenih stavki:

  1. Run AS_CLI/System/PushNotification> get and check the value of enforceAllowedApplicationList. If it's true, you need to complete this sub task. U suprotnom, preskočite ostatak potkompjute.

  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”

Ponovo pokreni NPS i testiraj push obaveštenja
1

Ponovo pokreni XSP:

bwrestart
2

Testirajte obaveštenja o pozivima na Android tako što ćete na Androidu pozivati pretplatnika sa BroadWorksa na klijenta za pozivanje. Proverite da li se obaveštenje o pozivu pojavljuje na Android uređaju.

Napomena: Ako push obaveštenja počnu da otkazuju za UC-One android aplikaciju, moguće je da postoji pogrešna konfiguracija. Ako je ovo vaša situacija, možete se vratiti na zaostavštinu FCM na sledeći način:

  1. Onemogući FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Ponovo pokreni XSP: bwrestart

  3. Proverite konfiguraciju.

  4. Ponovo omogućite FCMv1 i ponovo pokrenite XSP.

  5. Ponovite test.

3

Testirajte obaveštenja o pozivima na iOS tako što ćete pozivati pretplatnika broadWorks-a na klijenta koji zove na iOS-u. Proverite da li se obaveštenje o pozivu pojavljuje na iOS uređaju.

Napomena: Ako push obaveštenja počnu da otkazuju za UC-One iOS aplikaciju, moguće je da postoji pogrešna konfiguracija. Ako je ovo vaša situacija, možete se vratiti na zastareli binarni interfejs sa set HTTP2Enabled false