Aggiornare Cisco BroadWorks NPS per utilizzare NPS Proxy: Guida alla configurazione

Panoramica del proxy di autenticazione NPS

Questo articolo descrive come configurare un NPS condiviso per utilizzare il proxy di autenticazione NPS, in modo che possa essere utilizzato anche per inviare notifiche di chiamata alle app Webex. Se il suo NPS non supporta altre app, può seguire la procedura semplificata nella Webex for BroadWorks Solution Guide.

Panoramica del proxy NPS

Per compatibilità con Webex for BroadWorks, il suo NPS deve essere patchato per supportare la funzione NPS Proxy, Push Server for VoIP in UCaaS.

La funzionalità implementa un nuovo design nel Notification Push Server per risolvere la vulnerabilità di sicurezza derivante dalla condivisione delle chiavi private dei certificati di notifica push con i fornitori di servizi per i client mobili. Invece di condividere i certificati e le chiavi di notifica push con il fornitore di servizi, l'NPS utilizza una nuova API per ottenere un token di notifica push di breve durata dal backend UCaaS e utilizza questo token per l'autenticazione con gli APN Apple e i servizi FCM di Google.

La funzione migliora anche la capacità del Notification Push Server di inviare notifiche ai dispositivi Android tramite la nuova API HTTP di Google Firebase Cloud Messaging (FCM).

Per ulteriori informazioni, consulti il Push Server for VoIP nella descrizione delle funzionalità UCaaS.
Le patch BroadWorks per la funzionalità sono disponibili su: https://software.cisco.com/download/home/286326302/type/286326345/release/RI.2022.04.
Ulteriori informazioni sul server ADP sono disponibili all'indirizzo Cisco BroadWorks Application Delivery Platform.

Prerequisiti del proxy di autenticazione NPS

L'XSP (o Application Delivery Platform ADP) che ospita NPS deve soddisfare i seguenti requisiti:

Versioni minime e restrizioni di co-residenza

NPS deve essere attivato su un XSP/ADP dedicato e NPS deve essere l'unica applicazione ospitata sul server. Questo per eliminare le interferenze con l'invio delle notifiche push.
Dovrebbe esserci una sola app NPS in una distribuzione. Se sta utilizzando UC-One Collaborate/Connect mobile e/o UC-One SaaS e sta implementando Webex per BroadWorks, deve condividere questo singolo NPS per tutte le app.
NPS deve essere sulla versione R22 o successiva XSP o ADP.

R22/R23 XSP è compatibile con uno stack R21 se l'XSP esegue solo NPS e l'AS è R21.SP1. Per ulteriori informazioni, consultare la BroadWorks Compatibility Matrix.
Ulteriori informazioni sul server ADP sono disponibili all'indirizzo Cisco BroadWorks Application Delivery Platform.

NPS condiviso

Legga queste note prima di configurare il suo NPS condiviso per utilizzare il proxy NPS:

Se il suo NPS viene utilizzato con altre app (non solo l'app Webex): prima configura il proxy NPS, poi cambia l'NPS dall'utilizzo dell'API legacy FCM all'utilizzo dell'API FCM HTTP v1.
Dopo aver verificato che le notifiche funzionino correttamente per le app meno recenti con il proxy NPS, rimuova la chiave API FCM per l'app Android e la chiave di autenticazione APNs per l'app iOS.

PAN HTTP/2

Se ha distribuito app iOS che non sono di Cisco/Broadsoft, configuri tali app per utilizzare il protocollo APNS HTTP/2 prima di configurare NPS per utilizzare il proxy NPS.
Gli XSP/ADP che già supportano l'app Collaborate o SaaS BroadWorks devono essere migrati a HTTP/2. Per informazioni dettagliate sulla configurazione di HTTP/2, vedere Supporto HTTP/2 per Notification Push Server per APNS (la migrazione di NPS per supportare queste app iOS è riassunta in questo articolo).

Android FCMv1

Se ha distribuito app Android che non sono di Cisco/Broadsoft, configuri tali app per utilizzare le chiavi FCMv1 prima di configurare NPS per utilizzare il proxy NPS.
Se XSP/ADP attualmente supporta l'app SaaS Connect o UC-One, abiliti le chiavi FCMv1 dopo aver configurato il proxy NPS. Le consigliamo di migrare tutte le app aggiuntive alle chiavi FCMv1, abilitarle e testarle, quindi disattivarle finché non sarà pronto a completare le istruzioni di configurazione (il flusso di migrazione è documentato in questo articolo).

Riepilogo della migrazione del proxy NPS

***Riepilogo visivo della migrazione al proxy di autenticazione NPS***

Tabella 1. Riepilogo delle attività per la migrazione a NPS Proxy
Sequenza	Titolo dell'attività	Quando/perché è richiesta l'attività?
1	Migrare NPS a HTTP/2 per le app iOS UC-One SaaS (o Connect).	Se l'NPS supporta quelle app e non sono ancora configurate per HTTP/2.
2	Migrare NPS a FCMv1 per le app Android UC-One SaaS (o Connect).	Se l'NPS supporta tali app e non sono ancora configurate per FCMv1.
3	Attiva la modalità FCMv1 e testa le notifiche push.	Se l'NPS supporta UC-One Connect e/o altre app Android (non Cisco).
4	Riattivare la modalità legacy di FCM.	Se l'NPS supporta UC-One SaaS. Se lascia abilitato FCMv1, prima di configurare il proxy NPS, le notifiche push su UC-One SaaS iniziano a fallire.
5	Installa le patch del proxy di autenticazione NPS.	Se NPS è su XSP R22 o XSP R23.
6	Configurare NPS per utilizzare il proxy di autenticazione NPS: Allegare il supporto tecnico di NPS Richiedere un account CI OAuth Crea un account CI su NPS e configura il timeout del token di aggiornamento Aggiungere gli ID delle app Android Aggiungere gli ID delle app iOS Controlla/imposta gli URL e i timeout di connessione Aggiungere app all'elenco dei dispositivi consentiti di AS (Ri) Abilita FCMv1 Riavvii XSP/ADP Testare i PN per app iOS e Android	Sempre richiesto.
7	Rimuovere le chiavi della modalità legacy di FCM.	Per le app supportate con successo da NPS su FCMv1.

Migrare le app iOS BroadWorks Collaborate su HTTP/2

Questa attività è obbligatoria per le notifiche push alle app UC-One SaaS e Webex su piattaforme iOS.

Prima che Lei cominci

Se il suo XSP esegue R22, deve applicare ap354313 prima di poter configurare l'applicazione NPS per utilizzare HTTP/2 per APNS.

1	Imposta l'URL di produzione e i parametri di connessione su `XSP_CLI/Applications/NotificationPushServer/apns/Production>` `imposta l'url https://api.push.apple.com/3/device` `set ConnectionPoolSize 2` `imposta ConnectionTimeout 3000` `imposta il tempo di inattività della connessione in secondi 600` Nota: Non imposti il timeout di connessione al di sotto di 1000.
2	Aggiunga gli ID delle applicazioni al contesto delle applicazioni APNS, assicurandosi di omettere la chiave di autenticazione: impostala su vuota. `Per UC-One SaaS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> aggiungere com.broadsoft.uc-one` Per l'app Webex: `XSP_CLI/Applications/NotificationPushServer/apns/production/tokens>` aggiungi com.cisco.squared
3	`Controlli le chiavi di autenticazione con XSP_CLI/Applications/NotificationPushServer/apns/production/tokens> get`
4	`Se la chiave di autenticazione non è vuota per com.broadsoft.uc-one, può cancellarla con XSP_CLI/Applications/NotificationPushServer/apns/production/tokens> clear the-authkey`
5	Abilita HTTP/2: `XSP_CLI/Applications/NotificationPushServer/APNS/GeneralSettings>` `imposta HTTP2Enabled su true`
6	Solo per le app SaaS UC-One: acceda al portale per rivenditori e vada su Configurazione > BroadWorks >.
7	Scorra verso il basso fino alla sezione Notification Push Server e selezioni la sua release (ad esempio Release 22), quindi segua le istruzioni fornite nel portale.

Migrare le app Android BroadWorks UC-One Connect/SaaS su FCMv1

Questa attività si applica all'NPS su XSP. Lo ignori se il suo NPS è su ADP.
Può utilizzare questa procedura per la migrazione alle notifiche FCMv1 per le app Android UC-One Connect o UC-One SaaS.
Deve utilizzare FCMv1 se desidera utilizzare il proxy NPS per autenticare le notifiche push su UC-One o sulle app Webex Android.
Questa attività prepara l'NPS per FCMv1 in modo che Lei possa abilitarlo come parte della configurazione del proxy di autenticazione NPS. Non abiliti FCMv1 finché non è pronto a configurare il proxy di autenticazione NPS, altrimenti le notifiche ai client SaaS falliranno.

Ottenga l'ID del progetto dalla console Firebase:

Accedere a console.firebase.google.com.
Seleziona il progetto dell'app UC-One (Connect o SaaS), apra le impostazioni del progetto.
Aprire la scheda Generale e registrare l'ID del progetto.

Ottenga la chiave privata del suo account di servizio da Firebase:

Vai alla scheda Account di servizio nelle impostazioni del progetto.
O crea un nuovo account di servizio e ne ottiene la chiave privata.
Oppure apra un account di servizio esistente e generi una nuova chiave privata.

Nota: l'account del servizio deve avere l'autorizzazione firebaseadmin-sdk.
Scarichi la chiave per un luogo sicuro.

Copia la chiave dell'XSP che ospita il suo NPS.

Aggiungere l'ID del progetto e la chiave privata associata al contesto dei progetti FCM:

XSP_CLI/Applications/NotificationPushServer/FCM/Projects> aggiungi il percorso dell'ID del progetto/al/keyfile

Aggiungere l'applicazione UC-One (Connect o SaaS) e l'ID di progetto associato al contesto delle applicazioni FCM:

xsp_cli/Applications/NotificationPushServer/FCM/Applications> aggiungi ApplicationID com.broadsoft.connect ProjectID project-id

Controlli la configurazione di FCM rispetto agli attributi e ai valori consigliati mostrati qui. Usa la versione impostata del comando per modificare i valori, se necessario:

Esegui XSP_CLI/Applications/NotificationPushServer/fcm> get

Parametro	Valore consigliato
`URL dell'autore`	`https://www.googleapis.com/oauth2/v4/token`
`PushURL`	`https://fcm.googleapis.com/v1/projects/ PROJECT-ID /messaggi:inviare`
`ambito`	`https://www.googleapis.com/auth/firebase.messaging`
`Un centesimo di tempo in secondi`	3600
`Dimensioni del pool di connessione`	10
`Timeout di connessione in millisecondi`	3000
`Tempo di inattività della connessione in secondi`	600

Migrare le app Android BroadWorks UC-One Connect/SaaS su FCMv1 (su ADP)

Questa attività si applica all'NPS su ADP. Lo ignori se il suo NPS è su XSP.
Può utilizzare questa procedura per la migrazione alle notifiche FCMv1 per le app Android UC-One Connect o UC-One SaaS.
Deve utilizzare FCMv1 se desidera utilizzare il proxy NPS per autenticare le notifiche push su UC-One o sulle app Webex Android.
Questa attività prepara l'NPS per FCMv1 in modo che Lei possa abilitarlo come parte della configurazione del proxy di autenticazione NPS. Non abiliti FCMv1 finché non è pronto a configurare il proxy di autenticazione NPS, altrimenti le notifiche ai client SaaS falliranno.

1	Ottenga l'ID del progetto dalla console Firebase: Accedere a console.firebase.google.com. Seleziona il progetto dell'app UC-One (Connect o SaaS), apra le impostazioni del progetto. Aprire la scheda Generale e registrare l'ID del progetto.
2	Ottenga la chiave privata del suo account di servizio da Firebase: Vai alla scheda Account di servizio nelle impostazioni del progetto. O crea un nuovo account di servizio e ne ottiene la chiave privata. Oppure apra un account di servizio esistente e generi una nuova chiave privata. Nota: l'account del servizio deve avere l'autorizzazione firebaseadmin-sdk. Scarichi la chiave (file.json) in un luogo sicuro.
3	`Importi il file .json nel server ADP /bw/install.`
4	Accedere all'interfaccia a riga di comando di ADP e aggiungere il progetto e la chiave API al contesto dei progetti FCM: `adp_cli/Applications/NotificationPushServer/FCM/Projects> aggiungi connect-ucaas /bw/install/ filename.json`
5	Aggiungere l'ID dell'applicazione e del progetto al contesto delle applicazioni FCM: `ADP_CLI/Applications/NotificationPushServer/FCM/Applications> aggiungi ApplicationID com.broadsoft.ucaas.connect ProjectID project-id`
6	Verifichi la sua configurazione: `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`

Riattivare la modalità FCM Legacy

Deve farlo (come parte della migrazione) solo se:

Il suo NPS viene utilizzato per le app Android UC-One SaaS o BroadWorks Connect.
Lei ha già verificato che le notifiche push delle chiamate ad altre app funzionano con l'API FCMv1.

Sta disabilitando temporaneamente FCMv1 perché le chiavi FCMv1 per queste app devono essere abilitate solo durante il processo di configurazione del proxy di autenticazione NPS.

1	Acceda all'XSP che ospita il suo NPS condiviso.
2	Passa al contesto FCM e disabilita FCM v1: `XSP_CLI/Applications/NotificationPushServer/FCM>` set v1Enabled false per tornare a utilizzare la chiave API legacy FCM.

Installa le patch del proxy di autenticazione NPS

Installa le seguenti patch per supportare la funzione proxy di autenticazione NPS:

Cerotti R22

Cerotti R23

Configurare NPS per utilizzare il proxy di autenticazione

Crei una richiesta di servizio con il suo contatto di onboarding, o con TAC, per fornire il suo account cliente OAuth (Webex Common Identity). Assegna un nome alla sua richiesta di servizio NPS Configuration for Auth Proxy Setup.

Le diamo un ID cliente OAuth, un segreto cliente e un token di aggiornamento valido per 60 giorni. Se il token scade prima che Lei lo utilizzi con il suo NPS, può presentare un'altra richiesta.

Crea l'account cliente sull'NPS:

XSP_CLI/Applicazioni/NotificationPushServer/Cisco CI/Client> imposta l'ID cliente dal passo 1

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

Esegua il comando per verificare che i valori inseriti corrispondano a quelli forniti. XSP_CLI/Applicazioni/NotificationPushServer/Cisco CI/Client > get

Inserisca l'URL del proxy NPS e imposti l'intervallo di aggiornamento del token (30 minuti consigliati):

FQDN basati sulla regione:

Stati Uniti orientali:

xsp_cli/Applications/NotificationPushServer/CloudNPSService> imposta l'url https://broadworks-idp-proxy-a.wbx2.com/nps/

Stati Uniti occidentali:

xsp_cli/Applications/NotificationPushServer/CloudNPSService> imposta l'url https://broadworks-idp-proxy-r.wbx2.com/nps/

Europa:

xsp_cli/Applications/NotificationPushServer/CloudNPSService> imposta l'url https://broadworks-idp-proxy-k.wbx2.com/nps/

XSP_CLI/Applicazioni/NotificationPushServer/CloudNPSService > imposta l'intervallo di aggiornamento del token VoIP 1800

Arabia Saudita:

xsp_cli/Applications/NotificationPushServer/CloudNPSService> imposta l'url https://broadworks-idp-proxy-d.wbx2.com/nps/

Australia:

xsp_cli/Applications/NotificationPushServer/CloudNPSService> imposta l'url https://broadworks-idp-proxy-m.wbx2.com/nps/

Se le notifiche push scadono a causa di un ritardo nella risoluzione DNS, aumenti il valore di timeout nel file «/etc/resolv.conf» sul server BroadWorks.

(Per le notifiche Android) Aggiungere gli ID delle applicazioni Android al contesto delle applicazioni FCM sull'NPS.

Per l'app Webex su Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> aggiungere com.cisco.wx2.android

Per l'app UC-One su Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> aggiungere com.broadsoft.connect

(Per Apple iOS le notifiche) Aggiungi l'ID dell'applicazione al contesto delle applicazioni APNS, assicurandosi di omettere la chiave di autenticazione: impostala su vuota.

Per l'app Webex su iOS: XSP_CLI/Applications/NotificationPushServer/apns/production/tokens> aggiungi com.cisco.squared

Per l'app UC-One su iOS: XSP_CLI/Applications/NotificationPushServer/apns/production/tokens> aggiungi com.cisco.squared

Configura i seguenti URL NPS:

Contesto della CLI XSP	Parametro	Valore
`xsp_CLI/Applicazioni/NotificationPushServer/fcm>`	`URL dell'autore`	`https://www.googleapis.com/oauth2/v4/token`
	`PushURL`	`https://fcm.googleapis.com/v1/projects//messages:send`
	`ambito`	`https://www.googleapis.com/auth/firebase.messaging`
`XSP_CLI/Applicazioni/NotificationPushServer/APNS/Produzione>`	`url`	`https://api.push.apple.com/3/device`

Configura i seguenti parametri di connessione NPS in base ai valori consigliati mostrati:

Contesto della CLI XSP	Parametro	Valore
`xsp_CLI/Applicazioni/NotificationPushServer/fcm>`	`Un centesimo di tempo in secondi`	3600
	`Dimensioni del pool di connessione`	10
	`Timeout di connessione in millisecondi`	3000
	`Tempo di inattività della connessione in secondi`	600
`XSP_CLI/Applicazioni/NotificationPushServer/APNS/Produzione>`	`Timeout di connessione`	3000
	`Dimensioni del pool di connessione`	2
	`Tempo di inattività della connessione in secondi`	600

Controlli se l'Application Server sta esaminando gli ID delle applicazioni, perché potrebbe essere necessario aggiungere le app Webex all'elenco delle applicazioni consentite:

Esegui as_CLI/System/PushNotification> ottenga e controlli il valore di EnforceAllowedApplicationList. Se è vero, deve completare questa attività secondaria. Altrimenti, salti il resto dell'attività secondaria.
as_CLI/System/Pushnotification/Applicazioni consentite > aggiungere com.cisco.wx2.android «Webex Android»
as_CLI/System/Pushnotification/Applicazioni consentite > aggiungere com.cisco.squared «Webex iOS»

Riavviare NPS e testare le notifiche push

1	Riavvii l'XSP: `brestart`
2	Prova le notifiche di chiamata su Android effettuando chiamate da un abbonato BroadWorks al client di chiamata su Android. Verifichi che la notifica di chiamata sia visualizzata sul dispositivo Android. Nota: se le notifiche push iniziano a non funzionare per l'applicazione Android UC-One, è possibile che ci sia un errore di configurazione. Se questa è la sua situazione, può tornare all'FCM precedente come segue: `Disabiliti FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> imposta V1Enabled false` `Riavviare XSP: bwrestart` Controlli la sua configurazione. Riattivare FCMv1 e riavviare l'XSP. Ripetere il test.
3	Prova le notifiche di chiamata su iOS effettuando chiamate da un abbonato BroadWorks al client di chiamata su iOS. Verifichi che la notifica di chiamata sia visualizzata sul dispositivo iOS. Nota: se le notifiche push iniziano a non funzionare per l'applicazione UC-One iOS, è possibile che ci sia un errore di configurazione. Se questa è la sua situazione, può tornare all'interfaccia binaria precedente con `set Http2Enabled` false

Cisco AI Assistant

Grazie per il feedback.