Overzicht van de NPS-verificatieproxy


In dit artikel wordt beschreven hoe u een gedeelde NPS configureert om NPS-verificatieproxy te gebruiken, zodat deze ook kan worden gebruikt voor het pushen van gespreksmeldingen naar Webex-toepassingen. Als uw NPS geen andere toepassingen ondersteunt, kunt u de vereenvoudigde procedure volgen in de Webex voor BroadWorks-oplossingshandleiding https://help.webex.com/z9gt5j.

Overzicht NPS-proxy

Voor compatibiliteit met Webex voor BroadWorks moet uw NPS worden bijgewerkt om de NPS-proxyfunctie, Pushserver voor VoIP in UCaaS te ondersteunen.

Met deze functie wordt een nieuw ontwerp geïmplementeerd op de server voor pushmeldingen om het beveiligingsprobleem van privésleutels voor pushmeldingscertificaten te verhelpen met serviceproviders voor mobiele clients. In plaats van pushmeldingscertificaten en -sleutels te delen met de serviceprovider, gebruikt de NPS een nieuwe API om een pushberichttoken voor een korte levensduur te verkrijgen van de UCaaS-back-end en wordt dit token gebruikt voor verificatie met de Apple APNs- en Google FCM-services.

De functie verbetert ook de mogelijkheid van de server voor pushmeldingen om meldingen naar Android-apparaten te pushen via de nieuwe Google Firebase Cloud Messaging (FCM) HTTPv1-API.

De BroadWorks-patches voor de functie zijn beschikbaar op Xchange: https://xchange.broadsoft.com/node/1046235

Zie voor meer informatie de functiebeschrijving Pushserver voor VoIP in UCaaS op Xchange: https://xchange.broadsoft.com/node/1045458

De XSP (of de platform-ADP voor de levering van toepassingen) die NPS host, moet voldoen aan de volgende vereisten:

Minimale versies en co-residentiebeperkingen

  • NPS moet worden geactiveerd op een toegewezen XSP/ADP en NPS moet de enige gehoste toepassing op de server zijn. Dit is om interferentie met de bezorging van pushmeldingen te elimineren.

  • Er mag slechts één NPS-toepassing in een implementatie aanwezig zijn. Als u mobiele UC-One Collaborate/Connect en-of UC-One SaaS gebruikt, en u Webex voor BroadWorks implementeert, moet u deze enkele NPS delen voor alle toepassingen.

  • NPS moet XSP-versie R22 of hoger, of ADP hebben.

    R22/R23 XSP is compatibel met een R21-stack als de XSP alleen NPS uitvoert en de AS R21.SP1 is. Zie de BroadWorks-compatibiliteitsmatrix voor meer informatie.

  • Meer informatie over de ADP-server vindt u op https://xchange.broadsoft.com/node/1051580.

Gedeelde NPS

Lees deze notities voordat u uw gedeelde NPS configureert om de NPS-proxy te gebruiken:

  • Als uw NPS wordt gebruikt met andere toepassingen (niet alleen de Webex-toepassing): wijzig de NPS niet met de FCM Legacy-API om de FCM HTTP v1-API te gebruiken voordat u de NPS-proxy configureert.

    U kunt overschakelen terwijl u NPS configureert voor het gebruik van NPS-proxy.

  • Wanneer u hebt gecontroleerd of meldingen correct werken voor oudere toepassingen met de NPS-proxy, kunt u de FCM-API -sleutel voor de Android-toepassing en de verificatiesleutel van de APN voor de IOS-app verwijderen.

APNs HTTP/2

  • Als u een iOS-toepassing hebt geïmplementeerd die niet van Cisco/BroadSoft is, configureert u deze apps om het HTTP/2 APNS-protocol te gebruiken voordat u NPS configureert om de NPS-proxy te gebruiken.

  • XSP/ADP's die de samenwerking of SaaS BroadWorks al ondersteunen, moeten worden gemigreerd naar HTTP/2. Meer informatie over het configureren van HTTP/2 vindt u in HTTP/2-ondersteuning voor de server voor pushmeldingen voor APNS (migratie van NPS voor ondersteuning van deze IOS-apps wordt in dit artikel samengevat).

Android FCMv1

  • Als u Android-toepassingen hebt geïmplementeerd die niet van Cisco/BroadSoft zijn, configureert u deze toepassingen om de FCMv1-sleutels te gebruiken voordat u NPS configureert om de NPS-proxy te gebruiken.

  • Als de XSP/ADP momenteel de toepassing Connect of UC-One SaaS ondersteunt, kunnen FCMv1-sleutels niet worden ingeschakeld voordat u de NPS- proxy configureert. We raden u aan om alle extra apps naar FCMv1-sleutels te migreren, in te schakelen en te testen en deze vervolgens uit te schakelen totdat u gereed bent om de installatie-instructies te voltooien (de migratiestroom wordt beschreven in dit artikel).

Afbeelding 1. Visueel overzicht van de migratie naar de NPS-verificatieproxy
Tabel 1. Overzicht van taken om te migreren naar de NPS-proxy

Volgorde

Titel van de taak

Wanneer/waarom is een taak vereist?

1

Migreer NPS naar HTTP/2 voor UC-One SaaS (of Connect) iOS-toepassingen.

Als de NPS deze toepassingen ondersteunt, en deze nog niet zijn geconfigureerd voor HTTP/2.

2

Migreer NPS naar FCMv1 voor UC-One SaaS (of Connect) Android-toepassingen.

Als de NPS deze toepassingen ondersteunt, en deze nog niet zijn geconfigureerd voor FCMv1.

3

Schakel de modus FCMv1 in en test pushmeldingen.

Als de NPS UC-One Connect en/of andere Android-toepassingen ondersteunt die niet van Cisco zijn.

4

Schakel de oude FCM-modus opnieuw in.

Als de NPS UC-One SaaS ondersteunt. Als u FCMv1 ingeschakeld laat voordat u de NPS-proxy configureert, mislukken pushmeldingen naar UC-One SaaS.

5

Installeer proxy-patchen voor NPS-verificatie.

Als de NPS zich op XSP R22 of XSP R23 bevindt.

6

Configureer NPS voor het gebruik van de NPS-verificatieproxy:

  • Technische ondersteuning koppelen vanuit NPS

  • CI OAuth-account aanvragen

  • CI-account maken op NPS en nieuwe vervaldatum voor token configureren

  • Android-app-ID's toevoegen

  • iOS-app-ID's toevoegen

  • URL's en time-outs voor verbindingen controleren/instellen

  • Toepassingen toevoegen aan AS-lijst voor toestaan

  • (Re-)FCMv1 inschakelen

  • XSP/ADP opnieuw starten

  • PN's testen voor iOS- en Android-toepassingen

Altijd vereist.

7

Verwijder de sleutels voor de verouderde FCM-modus.

Voor toepassingen die door NPS worden ondersteund op FCMv1.

Deze taak is verplicht voor pushmeldingen naar UC-One SaaS en Webex-toepassingen op iOS-platforms.

Voordat u begint

Als uw XSP wordt uitgevoerd op R22, moet u ap354313 toepassen voordat u de NPS-toepassing kunt configureren voor het gebruik van HTTP/2 voor APNS.

1

Stel de productie-URL en verbindingsparameters in op XSP_CLI/Applications/NotificationPushServer/APNS/Production>

URL https://api.push.apple.com/3/device instellen

connectionPoolSize 2 instellen

connectionTimeout 3000 instellen

connectionIdleTimeoutInSeconds 600 instellen

Opmerking: stel de time-out voor verbinding niet in onder 1000.

2

Voeg de toepassings-ID's toe aan de context van de APNS-toepassingen en zorg ervoor dat u de verificatiesleutel weglaat – stel deze in op leeg.

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

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

3

Controleer de verificatiesleutels met XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Als de verificatiesleutel niet leeg is voor com.broadsoft.uc-one, kunt u deze wissen met XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Schakel HTTP/2 in:

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

6

Alleen voor UC-One SaaS-toepassingen: meld u aan bij de resellerportal en ga naar Configuratie > BroadWorks >.

7

Blader naar beneden naar het gedeelte Pushmeldingsserver en selecteer uw versie (bijvoorbeeld Release 22) en volg de instructies in de portal.

  • Deze taak is van toepassing op NPS op XSP. Negeer dit als uw NPS op ADP staat.

  • U kunt deze procedure gebruiken voor het migreren naar FCMv1-meldingen voor UC-One Connect- of UC-One SaaS Android-toepassingen.

  • U moet FCMv1 gebruiken als u de NPS-proxy wilt gebruiken om pushmeldingen te verifiëren naar UC-One- of de Webex Android-toepassingen.

  • Met deze taak wordt de NPS voor FCMv1 voorbereid zodat u deze kunt inschakelen als onderdeel van de configuratie van de NPS-verificatieproxy. Schakel FCMv1 pas in als u de NPS-verificatieproxy wilt configureren, anders mislukken meldingen naar SaaS-clients.

1

De project-ID ophalen uit de Firebase-console:

  1. Meld u aan bij console.firebase.google.com.

  2. Selecteer het UC-One (Connect of SaaS) app-project, open de projectinstellingen.

  3. Open het tabblad Algemeen en neem de project-ID op.

2

De privésleutel van uw serviceaccount ophalen van Firebase:

  1. Ga naar het tabblad Serviceaccounts in de projectinstellingen.

  2. Maak een nieuw serviceaccount en ontvang de persoonlijke sleutel.

  3. Of open een bestaand serviceaccount en genereer een nieuwe persoonlijke sleutel.

    Opmerking: het serviceaccount moet beschikken over de machtiging firebaseadmin-sdk.

  4. Download de sleutel naar een veilige locatie.

3

Kopieer de sleutel naar de XSP die als host optreedt voor uw NPS.

4

Voeg de project-ID en de bijbehorende persoonlijke sleutel toe aan de FCM-projectcontext:

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

5

Voeg de UC-One-toepassing (Connect of SaaS) en de bijbehorende project-ID toe aan de FCM-toepassingscontext:

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

6

Controleer de configuratie voor FCM met de attributen en aanbevolen waarden die hier worden weergegeven. Gebruik de set-versie van de opdracht om de waarden indien nodig te wijzigen:

Voer XSP_CLI/Applications/NotificationPushServer/FCM> get uit

Parameter

Aanbevolen waarde

authURL

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

pushURL

https://fcm.googleapis.com/v1/projects/PROJECT-ID/messages:send

bereik

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

tokenTimeToLiveInSeconds

3872

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

360

  • Deze taak is van toepassing op NPS op ADP. Negeer dit als uw NPS op XSP staat.

  • U kunt deze procedure gebruiken voor het migreren naar FCMv1-meldingen voor UC-One Connect- of UC-One SaaS Android-toepassingen.

  • U moet FCMv1 gebruiken als u de NPS-proxy wilt gebruiken om pushmeldingen te verifiëren naar UC-One- of de Webex Android-toepassingen.

  • Met deze taak wordt de NPS voor FCMv1 voorbereid zodat u deze kunt inschakelen als onderdeel van de configuratie van de NPS-verificatieproxy. Schakel FCMv1 pas in als u de NPS-verificatieproxy wilt configureren, anders mislukken meldingen naar SaaS-clients.

1

De project-ID ophalen uit de Firebase-console:

  1. Meld u aan bij console.firebase.google.com.

  2. Selecteer het UC-One (Connect of SaaS) app-project, open de projectinstellingen.

  3. Open het tabblad Algemeen en neem de project-ID op.

2

De privésleutel van uw serviceaccount ophalen van Firebase:

  1. Ga naar het tabblad Serviceaccounts in de projectinstellingen.

  2. Maak een nieuw serviceaccount en ontvang de persoonlijke sleutel.

  3. Of open een bestaand serviceaccount en genereer een nieuwe persoonlijke sleutel.

    Opmerking: het serviceaccount moet beschikken over de machtiging firebaseadmin-sdk.

  4. Download de sleutel (.json-bestand) naar een veilige locatie.

3

Importeer het .json-bestand in de ADP-server /bw/install.

4

Meld u aan bij ADP CLI en voeg het project en de API-sleutel toe aan de FCM-projectcontext:

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

5

Voeg de toepassing en de project-ID toe aan de context van de FCM-toepassing:

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

6

Controleer de configuratie:

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

U hoeft dit alleen te doen (als onderdeel van de migratie) als:

  • Uw NPS wordt gebruikt voor UC-One SaaS- of BroadWorks Connect Android-toepassingen.

  • U hebt al gecontroleerd of pushmeldingen voor gesprekken naar andere toepassingen werken met FCMv1-API.

U FCMv1 tijdelijk uitschakelt omdat FCMv1-sleutels voor deze toepassingen alleen mogen worden ingeschakeld tijdens het configuratieproces van de NPS-verificatieproxy.

1

Meld u aan bij de XSP die als host optreedt voor uw gedeelde NPS.

2

Ga naar de FCM-context en schakel FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false in om terug te keren naar het gebruik van de FCM API-legacysleutel.

Installeer de volgende patches om de functie NPS-verificatieproxy te ondersteunen:

R22-patches

R23-patches

1

Een serviceaanvraag maken met uw onboard contactpersoon, of met TAC, om uw OAuth-clientaccount (Webex Common Identity) in te richten . Geef uw serviceaanvraag de naam NPS-configuratie voor de configuratie van de verificatieproxy.

Cisco geeft u een OAuth-client-ID, een geheim voor de client en een vernieuwingstoken die geldig zijn gedurende 60 dagen. Als het token vervalt voordat u het gebruikt met de NPS, kunt u een andere aanvraag indienen.
2

Maak het clientaccount in de 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

Als u wilt controleren of de ingevoerde waarden overeenkomen met wat u hebt opgegeven, voert u XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get uit

3

Voer de URL voor de NPS-proxy in en stel het vernieuwingsinterval van het token in (30 minuten aanbevolen):

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

4

(Voor Android-meldingen) Voeg de Android-toepassings-ID's toe aan de context van de FCM-toepassing op de NPS.

Voor Webex-app op Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.cisco.wx2.android

Voor UC-One-app op Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.broadsoft.connect

5

(Voor Apple iOS-meldingen) Voeg de toepassings-ID toe aan de context van de APNS-toepassingen en zorg ervoor dat u de verificatiesleutel weglaat – stel deze in op leeg.

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

Voor UC-One-app op iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Configureer de volgende NPS-URL's:

Tabel 2.

XSP CLI-context

Parameter

Waarde

XSP_CLI/Applications/NotificationPushServer/FCM>

authURL

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

pushURL

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

bereik

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

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

URL

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

7

Configureer de volgende NPS-verbindingsparameters voor de weergegeven aanbevolen waarden:

Tabel 3.

XSP CLI-context

Parameter

Waarde

XSP_CLI/Applications/NotificationPushServer/FCM>

tokenTimeToLiveInSeconds

3872

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

360

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

connectionTimeout

3000

connectionPoolSize

2

connectionIdleTimeoutInSeconds

360

8

Controleer of de toepassingsserver toepassings-ID's screent, omdat u mogelijk de Webex-toepassingen moet toevoegen aan de lijst met toegestane toepassingen:

  1. Voer AS_CLI/System/pushnotification> get en controleer de waarde van enforceAllowedApplicationList. Als deze op true staat, moet u deze subtaak voltooien. U kunt ook de rest van de subtaak overslaan.

  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 de XSP opnieuw:

bwrestart
2

Test gespreksmeldingen naar Android door gesprekken te voeren van een BroadWorks-abonnee naar de bellende client op Android. Controleer of de gespreksmelding wordt weergegeven op het Android-apparaat.

Opmerking: als pushmeldingen niet worden gestart voor de UC-One Android-toepassing, is het mogelijk dat er een fout is opgetreden. In dat geval kunt u als volgt terugkeren naar de oude FCM:

  1. FCMv1 uitschakelen: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. XSP opnieuw starten: bwrestart

  3. Controleer uw configuratie.

  4. Schakel FCMv1 opnieuw in en start de XSP opnieuw.

  5. Herhaal de test.

3

Test gespreksmeldingen naar iOS door gesprekken te voeren van een BroadWorks-abonnee naar de bellende client op iOS. Controleer of de gespreks melding wordt weergegeven op het IOS-toestel.

Opmerking: als pushmeldingen niet worden gestart voor de UC-One IOS-toepassing, is het mogelijk dat er een fout is opgetreden. Als dit het geval is, kunt u teruggaan naar de oude binaire interface met set HTTP2Enabled False