Sonata — SIP provisioning server

Jag vet inte vad jag ska jämföra provisioning med. Kanske en katt? Det går nog utan den, men med den blir det lite bättre. Särskilt om den jobbar))

Problemställning:

1. Jag vill kunna konfigurera SIP-telefoner snabbt, enkelt och säkert. Vid installation av telefon och särskilt vid omkonfigurering.
2. Många leverantörer har sina egna konfigurationsformat, sina egna verktyg för att generera konfigurationer och sina sätt att skydda dem. Att förstå sig på alla dem är inte så roligt.
3. Många lösningar för provisioning, a) är inriktade på en leverantör eller ett telefonsystem, b) implementeras ganska tungt, med massor av skript och parametrar, usch...

Angående punkt 3 vill jag kommentera att det finns utmärkta provisioning-system för FreePBX, för FusionPBX, för Kazoo, där det finns mallar för telefoner från olika leverantörer tillgängliga offentligt. Det finns kommersiella lösningar där man också kan konfigurera en modul för provisioning av telefoner från olika tillverkare, exempelvis Yeastar PBX.

Det finns också många recept på Habr om hur man konfigurerar apparater från olika leverantörer: ett, två. Men som man säger, alla system har en fatal brist. Därför gör vi vår egen cykel.

vårt eget format

Som det sägs i xkcd, om du inte vill förstå dig på 14 format — kom på en 15:e. Därför använder vi gemensamma inställningar för alla telefoner och skapar vårt eget JSON-format för konfigurationer.

Ungefär så här:

{
   "key": "sdgjdeu9443908",
   "token": "590sfdsf8u984",
   "model": "gxp1620",
   "vendor": "grandstream",
   "mac": "001565113af8",
   "timezone_offset": "GMT+03",
   "ntp_server": "pool.ntp.org",
   "status": true,
   "accounts": [
      {
         "name": "MOBILON",
         "line": 1,
         "sip_register": "sip.mobilonsip.ru",
         "sip_name": "sip102",
         "sip_user": "sip102",
         "sip_password": "4321",
         "sip_auth": "sip102"
      }
   ]
}

Så, i vilken telefon som helst måste man konfigurera lokal tid, SIP-linjer. Här är allt enkelt. Man kan även kolla fler exempel här.

vår provisioning-server

I tillverkarens manualer finns vanligtvis en punkt där det står: ta en CSV, skriv dit inloggning-lösenord-MAC-adress, generera filer med vårt proprietära skript och lägg dem på din Apache-webbserver, så blir det bra.

I nästa punkt i manualen brukar det även nämnas att man kan kryptera den genererade konfigurationsfilen.

Men det är allt klassiskt. Den moderna ansatsen med smoothies och Twitter säger att man bör göra en färdig webbserver, som inte är lika kraftfull som Apache, men bara gör en liten sak. Att skapa och leverera konfigurationer via länk.

Här stannar vi upp och påminner oss om att nästan alla SIP-telefoner nu kan få konfigurationer via http/https, därför kommer vi inte att överväga andra implementeringar (ftp, tftp, ftps). Varje telefon känner till sin MAC-adress. Därför kommer vi att göra två länkar: en personlig - baserad på enhetens nyckel, den andra allmän, som fungerar med en kombination av en gemensam token och MAC-adressen.

Jag kommer inte heller att stanna vid zero-configuration, dvs. att ställa in telefonen "från grunden", det vill säga att du kopplar in den i nätverket och den plötsligt fungerar. Nej, i mitt scenario kopplar du in den i nätverket, gör en förinställning (ställer in den för att hämta konfigurationen från provisionsservern), och sedan njuter du av en piña colada och omkonfigurerar telefonen som du vill genom provision. Att distribuera Option 66 är DHCP-serverns ansvar.

Förresten, jag har verkligen tröttnat på att säga "provisioning", så ordet har förkortats till "provision", snälla sparka mig inte i sidan.

Och en till sak: vår provisionsserver har ingen UI, det vill säga användargränssnitt. Kanske, för tillfället, men jag är inte säker, eftersom jag inte behöver det. Men det finns en API för att spara/radera inställningar, få en lista över stödda leverantörer, modeller, allt beskrivet enligt swagger-specifikationen.

Varför API istället för UI? Eftersom jag redan har mitt eget telefonsystem, har jag en källa för autentiseringsuppgifter, där jag enkelt kan hämta dessa uppgifter, komponera det nödvändiga json:et och publicera det på provisionsservern. Och provisionsservern kommer enligt reglerna som anges i json-filen att ge den aktuella enheten sin konfiguration, eller inte ge det om enheten inte är korrekt, eller inte uppfyller kriterierna som också anges i denna json.

Så här har vi fått en sådan mikrotjänst för provision. Den kallas sonata, källkoden är tillgänglig på github, det finns också en färdig docker-image, ett exempel på hur man använder docker här.

Nyckelfunktioner:

• i alla fall begränsad tillgång till konfigurationen över tid, som standard 10 minuter. Om du vill göra konfigurationen tillgänglig igen - publicera konfigurationen på nytt.

• ett format för alla leverantörer, all anpassning är borttagen i sonata, du skickar standardiserat json, och konfigurerar vilken tillgänglig hårdvara som helst.

• alla utgivna konfigurationer till enheterna loggas, alla problemområden kan ses i loggen och eventuella fel kan identifieras

• Det är möjligt att använda en gemensam länk med en token, varje telefon får sin egen konfiguration genom att ange MAC-adressen. Eller en personlig länk baserad på en nyckel.

• API för hantering och tilldelning av konfigurationer till telefoner är separerade efter portar.

• Tester. För mig var det mycket viktigt att fastställa formatet på den tilldelade konfigurationen och att täcka alla vanliga situationer med tester. Så att allt fungerar som det ska.

Nackdelar:

För närvarande används ingen kryptering inom Sonata. Det vill säga, ni kan självklart börja använda https, till exempel genom att sätta upp Nginx framför Sonata. Men de proprietära metoderna används fortfarande inte. Varför? Projektet är fortfarande ungt och har knappt provisionerat sin första hundra enheter. Jag samlar såklart in idéer och feedback. Vidare, för att göra allt säkert och förhindra att konfigurationerna kan sniffas i nätverket, kan det vara värt att satsa på krypteringsnycklar, TLS och liknande, men det blir en fortsättning.

Avsaknad av UI. Detta kan vara en betydande nackdel för slutanvändaren, men för systemadministratören är en kommandoradsverktyg troligen viktigare än en fullständig applikation. Att skapa en kommandoradsverktyg var i planerna men jag är osäker på om det verkligen behövs?

Vad blir resultatet?

En liten och enkel webserver för provisioning av flera telefonmodeller med API för hantering.

Hur ska detta fungera igen?

1. Vi installerar Sonata.
2. Vi formar en JSON-konfiguration och publicerar den i Sonata.
3. Därefter får vi en länk från Sonata för provisioning.
4. Denna länk anger vi i telefonapparaten.
5. Apparaten hämtar konfigurationen.

I den efterföljande användningen finns bara två steg:

1. Vi formar en JSON-konfiguration och publicerar den i Sonata.
2. Apparaten hämtar konfigurationen.

Vilka telefoner provisioneras?

Leverantörer såsom Grandstream, Fanvil, Yealink. Konfigurationerna inom varje leverantör är mer eller mindre lika, men kan variera beroende på firmware — det kan behövas ytterligare tester.

Vilka regler kan ställas?

Efter tid. Du kan ange en tidsgräns för när konfigurationen ska vara tillgänglig.
Efter MAC-adress. Vid tilldelning av konfigurationer via den personliga länken kommer även MAC-adressen att kontrolleras.
Efter IP. Baserat på den IP-adress där förfrågan görs.

Hur interagerar man med Sonata?

Genom API, genom att göra HTTP-förfrågningar. API kommer att finnas i din installation. Eftersom API stöder Swagger-specifikationer kan du använda ett online-verktyg för testförfrågningar till API.

Okej, utmärkt. Det låter som en intressant sak, hur kan jag testa?

Det är enklast att köra en docker-avbildning baserad på ett repository sonata-sample. I repositoryt finns en installationsguide.

А если знаю node.js?

Om du har erfarenhet av att använda JavaScript kommer du snabbt att förstå hur allt här fungerar.

Kommer sonata att utvecklas?

Delvis har jag nått mina mål. Vidare utveckling är en fråga om mina uppgifter gällande automatisering av telefoninställningar. Det finns också möjlighet att utöka konfigurationerna för att ställa in telefonknappar, lägga till provisioneringsadressböcker, och kanske något mer, skriv gärna i kommentarerna.

Sammanfattning och tack

Jag ser fram emot konstruktiva förslag, invändningar, kommentarer och frågor, då det kan finnas något jag har beskrivit oklart.

Jag vill också uttrycka min tacksamhet till alla kollegor som har hjälpt, rådgett, testat, samt till de som har tillhandahållit/givit telefoner för tester. Många människor har på olika sätt varit involverade i projektet, med vilka jag har haft kontakt genom arbete, på AsterConfi chattar och e-post. Tack för idéerna och tankarna.

Källa: habr.com