Overzicht VAN NPS-verificatieproxy


Dit artikel beschrijft hoe u een gedeelde NPS configureert voor het gebruik van de NPS-verificatieproxy, zodat het ook kan worden gebruikt om oproepmeldingen naar Webex-apps te pushen. Als uw NPS geen andere apps ondersteunt, kunt u de vereenvoudigde procedure volgen in de Webex voor BroadWorks Solution Guide https://help.webex.com/z9gt5j.

Overzicht NPS-proxy

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

De functie implementeert een nieuw ontwerp in de Push-server voor meldingen om het beveiligingsprobleem van het delen van pushmeldingcertificaat privésleutels met serviceproviders voor mobiele clients op te lossen. In plaats van pushmeldingscertificaten en -sleutels te delen met de serviceprovider, gebruikt de NPS een nieuwe API om een pushmelding token voor korte gegevens te verkrijgen van UCaaS backend en gebruikt deze token voor verificatie met de Apple APN's en Google FCM-services.

De functie biedt ook een verbeterde functionaliteit van de Berichten pushserver om meldingen naar Android-apparaten te pushen via de nieuwe FCM-API voor Google Firebase Cloud Messaging (FCM).

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

Zie de Push-server voor meer informatie over VoIP in de UCaaS-functiebeschrijving over Xchange: https://xchange.broadsoft.com/node/1045458

De XSP (of Application Delivery Platform ADP) die nps host moet aan de volgende vereisten voldoen:

Minimale versies en beperkingen voor co-residentie

  • NPS moeten worden geactiveerd in een speciale XSP/ADP en NPS moeten de enige gehoste toepassing op de server zijn. Hiermee voorkomt u storing bij de levering van pushmeldingen.

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

  • NPS moet op versie R22 of hoger XSP of ADP zijn.

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

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

Gedeelde NPS

Lees deze aantekeningen voordat u uw gedeelde NPS configureert voor het gebruik van de NPS Proxy:

  • Als uw NPS wordt gebruikt met andere apps (niet alleen de Webex-app): Wijzig de NPS niet van het gebruik van de FCM legacy API in het gebruik van FCM HTTP v1 API voordat u de NPS-proxy configureert.

    U kunt over deze tijd heen wijzigen bij het configureren van NPS voor het gebruik van de NPS-proxy.

  • Als u hebt gecontroleerd of meldingen goed werken voor oudere apps met de NPS-proxy, kunt u de FCM API-sleutel voor de Android-app verwijderen en de auth-sleutel voor APN's voor de iOS-app.

APN's HTTP/2

  • Als u iOS-apps hebt geïmplementeerd die niet afkomstig zijn van Cisco/BroadSoft, configureert u deze apps voor het gebruik van het HTTP/2 APNS-protocol voordat u NPS configureert voor het gebruik van de NPS-proxy.

  • XSP/ADP's die de app Collaborate of SaaS BroadWorks al ondersteunen, moeten worden gemigreerd naar HTTP/2. Zie HTTP/2-ondersteuning voor pushserver voor meldingen voor APNS (migratie van NPS om deze iOS-apps te ondersteunen is in dit artikel samengevat voor gedetailleerde informatie over het configureren van HTTP/2).

Android FCMv1

  • Als u Android-apps hebt geïmplementeerd die niet afkomstig zijn van Cisco/BroadSoft, configureert u deze apps voor het gebruik van de FCMv1-sleutels voordat u NPS configureert voor het gebruik van de NPS-proxy.

  • Als de XSP/ADP op dit moment de Connect- of UC-One SaaS-app ondersteunt, kunnen FCMv1-sleutels niet worden ingeschakeld voordat u de NPS-proxy configureert. We raden u aan alle aanvullende apps te migreren naar FCMv1-sleutels, de sleutels in te schakelen en te testen en vervolgens uit te schakelen totdat u klaar bent om de installatie-instructies te voltooien (de migratiestroom is vastgelegd in dit artikel).

Afbeelding 1. Visuele samenvatting van migratie naar NPS-verificatieproxy
Tabel 1. Samenvatting van taken om te migreren naar NPS-proxy

Volgorde

Taaktitel

Wanneer/waarom is een taak vereist?

1

Nps migreren naar HTTP/2 voor UC-One SaaS- (of Connect) iOS-apps.

Als de NPS deze apps ondersteunt en ze nog niet zijn geconfigureerd voor HTTP/2.

2

NPS migreren naar FCMv1 voor UC-One SaaS- (of Connect)-Android-apps.

Als de NPS deze apps ondersteunt en ze nog niet zijn geconfigureerd voor FCMv1.

3

Schakel de FCMv1-modus in en test pushmeldingen.

Als de NPS UC-One Connect en/of andere Android-apps (niet Cisco) ondersteunt.

4

FcM legacy-modus opnieuw inschakelen.

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 NPS-verificatie proxypatches.

Als NPS op XSP R22 of XSP R23 staat.

6

Configureer NPS om de NPS-verificatieproxy te gebruiken:

  • Voeg technische ondersteuning toe vanuit NPS

  • CI OAuth-account aanvragen

  • CI-account maken in NPS en vernieuwen token time-out configureren

  • Android-app-id's toevoegen

  • iOS-app-id's toevoegen

  • URL's en verbindings time-outs controleren/instellen

  • Apps toevoegen aan AS lijst toestaan

  • (Opnieuw) FCMv1 inschakelen

  • XSP/ADP opnieuw starten

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

Altijd vereist.

7

Bestaande FCM-modussleutels verwijderen.

Voor apps die worden ondersteund door NPS op FCMv1.

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

Voordat u begint

Als uw XSP R22 gebruikt, 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 de verbindingsparameters in XSP_CLI/Applications/NotificationPushServer/APNS/Production>

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

verbinding instellenPoolSize 2

connectionTimeout 3000 instellen

instellen connectionIdleTimeoutInTijd 600

Opmerking: Stel de verbindings time-out niet onder 1000 in.

2

Voeg de toepassings-ID's toe aan de context van APNS-toepassingen, zodat u de Auth-sleutel weglaten en deze leeg laat.

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

Voor de Webex-app: XSP_CLI/applications/NotificationPushServer/APNS/Production/tokens> add com.cisco.squared

3

Controleer de auth-sleutels met XSP_CLI/Toepassingen/NotificationPushServer/APNS/Production/Tokens> krijgen

4

Als de auth-sleutel niet leeg is voor com.broadsoft.uc-one , kunt u deze leeg maken met XSP_CLI/Toepassingen/NotificationPushServer/APNS/Production/Tokens> de -authkey vrij te maken

5

HTTP/2 inschakelen:

XSP_CLI/Applications/NotificationPushServer/APNS/GeneralSettings> http2Enabled true

6

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

7

Scrol omlaag naar het gedeelte Pushserver voor berichten en selecteer uw versie (bijvoorbeeld release 22) en volg de instructies in de portal.

  • Deze taak is van toepassing op NPS op XSP. Negeer het als uw NPS een ADP-beleid heeft.

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

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

  • Deze taak bereidt de NPS voor FCMv1 voor zodat u deze kunt inschakelen als onderdeel van de configuratie van NPS-verificatieproxy. Schakel FCMv1 pas in als u klaar bent om de NPS-verificatieproxy te configureren, of meldingen voor SaaS-clients mislukken.

1

Haal de project-id op uit de Firebase-console:

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

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

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

2

Haal de privésleutel van uw serviceaccount op vanuit Firebase:

  1. Ga naar het tabblad Serviceaccounts in de projectinstellingen.

  2. Maak een nieuw service account en haal de privésleutel op.

  3. Of open een bestaand serviceaccount en genereer er een nieuwe privésleutel voor.

    Opmerking: Het serviceaccount moet de toestemming voor de firebaseadmin-sdk hebben.

  4. Download de sleutel naar een veilige locatie.

3

Kopieer de sleutel naar de XSP die uw NPS host.

4

Voeg de project-id en de bijbehorende privésleutel toe aan de context van fcm-projecten:

XSP_CLI/toepassingen/NotificationPushServer/FCM/Projects>project-id-pad/naar/keyfile toevoegen

5

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

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

6

Controleer de configuratie voor FCM op de kenmerken en aanbevolen waarden die hier worden weergegeven. Gebruik, indien nodig, een versie van de opdracht om de waarden te wijzigen:

Voer XSP_CLI/toepassingen/NotificationPushServer/FCM uit> ontvang

Parameter

Aanbevolen waarde

authURL

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

pushURL

https://fcm.googleapis.com/v1/projects/PROJECT-ID/berichten:verzenden

Scope

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

tokenTimeToLiveInDemomenten

3600

connectionPoolSize

10

connectionTimeoutInMilli milliseconden

3000

connectionIdleTimeoutIn Milliseconden

600

  • Deze taak is van toepassing op NPS binnen ADP. Negeer het 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-apps.

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

  • Deze taak bereidt de NPS voor FCMv1 voor zodat u deze kunt inschakelen als onderdeel van de configuratie van NPS-verificatieproxy. Schakel FCMv1 pas in als u klaar bent om de NPS-verificatieproxy te configureren, of meldingen voor SaaS-clients mislukken.

1

Haal de project-id op uit de Firebase-console:

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

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

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

2

Haal de privésleutel van uw serviceaccount op vanuit Firebase:

  1. Ga naar het tabblad Serviceaccounts in de projectinstellingen.

  2. Maak een nieuw service account en haal de privésleutel op.

  3. Of open een bestaand serviceaccount en genereer er een nieuwe privésleutel voor.

    Opmerking: Het serviceaccount moet de toestemming voor de firebaseadmin-sdk hebben.

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

3

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

4

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

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

5

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

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

6

Controleer uw configuratie:


  ADP_CLI/Applications/NotificationPushServer/FCM/Projects> haal Project ID Accountkey 
 == 
 connect-ucaas **

  ADP_CLI/Applications/NotificationPushServer/FCM/Applications> get Application ID 
 Project ID 
 == 
 com.broadsoft.ucaas.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-apps.

  • U hebt al getest dat pushmeldingen voor bellen naar andere apps werken met FCMv1 API.

U staat FCMv1 tijdelijk uit omdat FCMv1-sleutels voor deze apps alleen moeten worden ingeschakeld tijdens het NPS-verificatieproxyconfiguratieproces.

1

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

2

Navigeer naar de FCM-context en schakel FCM v1 uit: XSP_CLI/Applications/NotificationPushServer/FCM stelt > V1enabled false in om terug te keren naar het gebruik van de verouderde FCM API-sleutel.

Installeer de volgende patches ter ondersteuning van de NPS-verificatieproxyfunctie:

R22-patches

R23 Patches

1

Maak een serviceverzoek bij uw onboardingcontact of met TAC om uw (Webex Common Identity) OAuth-clientaccount in te stellen. Titel van uw serviceaanvraag NPS-configuratie voor auth-proxyconfiguratie.

Cisco geeft u een OAuth-client-id, een client geheim en een vernieuwend token die 60 dagen geldig is. Als het token verloopt voordat u het gebruikt met uw NPS, kunt u nog een verzoek indienen.
2

Maak de clientaccount in de NPS:

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client>clientId client-Id-From-Step1 instellen


  XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> clientSecret Nieuw wachtwoord instellen: client-Secret-From-Step1

  XSP_CLI/toepassingen/NotificationPushServer/CiscoCI/Client> vernieuwenToken nieuw wachtwoord instellen: Vernieuwen-token-van-stap 1

Als u wilt controleren of de waarden die u hebt ingevoerd, overeenkomen met wat u hebt gekregen, voer dan XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> de

3

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

XSP_CLI/Toepassingen/MeldingPushServer/CloudNPSService> url instellen https://nps.uc-one.broadsoft.com/nps/

XSP_CLI/applications/NotificationPushServer/CloudNPSService> voIPTokenRefreshInterval 1800 instellen

4

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

Voor de Webex-app in Android: XSP_CLI/applications/NotificationPushServer/FCM/Applications> applicationId com.cisco.wx2.android toe

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

5

(Voor Apple iOS-meldingen) Voeg de toepassings-id toe aan de context van APNS-toepassingen, zodat u de Auth-sleutel weglaten en deze leeg laat.

Voor de Webex-app in iOS: XSP_CLI/applications/NotificationPushServer/APNS/Production/tokens> add com.cisco.squared

Voor UC-One-app in 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/toepassingen/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

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

Tabel 3.

XSP CLI-context

Parameter

Waarde

XSP_CLI/toepassingen/NotificationPushServer/FCM>

tokenTimeToLiveInDemomenten

3600

connectionPoolSize

10

connectionTimeoutInMilli milliseconden

3000

connectionIdleTimeoutIn Milliseconden

600

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

Connectiontimeout

3000

connectionPoolSize

2

connectionIdleTimeoutIn Milliseconden

600

8

Controleer of de toepassingsserver een toepassings-id heeft, omdat u de Webex-apps mogelijk aan de lijst met toegestane toepassingen moet toevoegen:

  1. Voer AS_CLI/System/PushNotification uit> de waarde van enforceAllowedApplicationList in en controleerdeze waarde. Als dat het gevalis, moet u deze subtaak voltooien. Anders slaat u de rest van de subtaak 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'

1

Start de XSP opnieuw:

bwrestart
2

Test oproepmeldingen naar Android door oproepen via een BroadWorks-abonnee naar de belclient in Android uit te voeren. Controleer of de oproepmelding wordt weergegeven op het Android-apparaat.

Opmerking: Als pushmeldingen beginnen te mislukken voor de UC-One Android-toepassing, is het mogelijk dat er een verkeerde configuratie is. Als dit uw situatie is, kunt u als volgt terugkeren naar de verouderde FCM:

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

  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 oproepmeldingen naar iOS door te bellen via een BroadWorks-abonnee naar de belclient in iOS. Controleer of de oproepmelding wordt weergegeven op het iOS-apparaat.

Opmerking: Als pushmeldingen beginnen te mislukken voor de UC-One iOS-toepassing, is het mogelijk dat er een verkeerde configuratie is. Als dit uw situatie is, kunt u terugkeren naar de verouderde binaire interface met ingesteld HTTP2Enabled false