Kevin Bataille

Kamailio : tutoriel découverte partie 1

Kevin BATAILLE

J’ai découvert Kamailio il y a un an alors que mon besoin était de développer un SBC (Session Border Controller) qui avait pour fonction principale de protéger une instance Asterisk. Entre temps, le besoin initial a évolué et par définition la solution technique également. J’ai pu monter en compétence sur le logiciel et par la même occasion acquis de la souplesse avec celui-ci dans une stack technique VoIP.

Alors que les ressources en ligne concernant les cas d’usage de Kamailio s’avèrent relativement limitées, je vais essayer d’expliquer ce logiciel au travers d’une série d’articles avec des exemples de configuration.

En premier lieu et avant de engouffrer plus largement dans cet tutoriel, il est recommandé d’avoir des connaissances en SIP (RFC 3261).

Définitions

Pour mieux comprendre les concepts mentionnés dans cet article et l’écosystème Kamailio en général, voici une liste des définitions essentielles.

Rôles SIP fondamentaux

Remarque : La plupart des points de terminaison SIP (comme les téléphones IP ou les PBX) agissent à la fois comme UAC et UAS, selon qu’ils émettent ou reçoivent un appel.

Composants VoIP

Qu’est-ce que Kamailio ?

Kamailio (anciennement OpenSER) est un serveur SIP gratuit et open source. Il est écrit en C avec une attention toute particulière pour la performance. Kamailio est hautement configurable et peut agir comme registrar, proxy ou encore load-balancer SIP, grâce à son architecture modulaire.

Contrairement à ce que l’on pourrait penser, Kamailio n’est pas un PBX et diffère d’Asterisk, FreeSwitch et consorts. Kamailio n’est pas non plus un B2BUA (Back-to-Back User Agent) et ne gère que la signalisation (SIP) là où un PBX va en plus gérer les médias (voix) ou encore avoir des fonctions de call-center.

Pour répondre à un besoin avec Kamailio vous devez le configurer. La configuration initiale de Kamailio ne fait rien, cependant elle donne un aperçu des possibilités du logiciel. C’est aussi en ce sens qu’il est nécessaire d’avoir des connaissances en SIP, car vous devez avoir une idée des requêtes et réponses nécessaires au bon fonctionnement de ce logiciel.

Note : Kamailio ne gère pas les médias. Pour cela je vous invite à utiliser RTPEngine de SIPWise.

Où trouver la documentation Kamailio ?

Sur le site officiel de Kamailio vous pouvez retrouver deux documentations : le wiki officiel et celle des modules. La documentation officielle est très complète et aussi bien le Wiki, que les pages des modules, éclairent très bien la configuration de Kamailio.

En revanche, lorsqu’il s’agit des cas d’usage et des architectures avec des composants tiers, il est plus difficile d’avoir un aperçu de haut niveau. Des personnages comme Fred POSNER font souvent les éloges de Kamailio et de grâce, il existe la chaîne YouTube Kamailio World. En somme, il est aussi possible de s’inspirer de la documentation OpenSIPS et de ses tutoriels, cependant on y trouve très vite de divergences.

Installer Kamailio

Kamailio est disponible sur Linux et BSD. Sur Ubuntu, installez Kamailio depuis les dépôts officiel : $ sudo apt install kamailio

Éditez la configuration : /etc/kamailio.cfg .

Il est aussi possible d’utiliser Kamailio avec Docker avec une configuration comme ci-après :

networks:
  default:
  # database:
  #   external: true

services:
  # Primary Kamailio instance
  kamailio:
    image: ghcr.io/kamailio/kamailio:6.0.4-bookworm
    restart: unless-stopped
    volumes:
      - ./kamailio:/etc/kamailio
      - ./kamailio/logs/kamailio:/var/log/kamailio
    network_mode: host # Expose 5060 for TCP/UDP and 5061 for TLS

  # RTP Engine service
  rtpengine:
    image: fonoster/rtpengine:latest
    container_name: rtpengine
    restart: unless-stopped
    network_mode: "host" # At the moment this option only works in Linux
    environment:
      # RTPENGINE_PUBLIC_IP: ${DOCKER_HOST_ADDRESS:-192.168.1.210} When commented, use Netdiscover (https://github.com/fonoster/rtpengine/blob/main/Dockerfile)
      RTPENGINE_BIND_NG_IP: ${RTPENGINE_BIND_NG_IP:-127.0.0.1}
      RTPENGINE_BIND_NG_PORT: ${RTPENGINE_BIND_NG_PORT:-2223}
      RTPENGINE_PORT_MIN: 10000
      RTPENGINE_PORT_MAX: 20000
      RTPENGINE_LOG_LEVEL: "6"

Notez tout de même que network_mode=host n’est supporté que sur Linux. Aussi, les protocoles SIP et RTP apprécient moyennement d’être confrontés à du NAT (Network Address Translation) si vous décidez d’exposer les ports de Kamailio et RTPEngine avec Docker.

Quelques notions de SIP

Pour ce premier article je vais lister lister quelque-unes des requêtes SIP à connaître. Ils vous seront utiles aussi bien pour travailler avec Kamailio que pour n’importe quel autre PBX.

Requête SIPDescription
INVITEInitie une session d’appel.
ACKConfirme la réception d’une réponse finale (ex. après INVITE).
BYETermine une session existante.
CANCELAnnule une requête INVITE en attente avant qu’elle ne soit répondue.
REGISTEREnregistre la localisation d’un utilisateur auprès d’un serveur SIP.
OPTIONSInterroge les capacités d’un serveur ou d’un point d’extrémité.
INFOTransporte des informations de contrôle en cours de session (ex. DTMF).
PRACKAccuse réception des réponses provisoires fiables lorsqu’elles sont utilisées.
UPDATEModifie les paramètres de la session sans refaire un INVITE.
REFERDemande au destinataire d’initier une nouvelle requête (souvent pour le transfert d’appel).

Découvrir Kamailio

C’est parti pour démarrer ce tutoriel avec Kamailio. Voici quelques notions de SIP qui vous seront utiles si vous êtes débutant. À défaut cela fera tout de même un rappel.

Exemple de requête INVITE

Prenons l’exemple d’une requête SIP qui permet de passer un appel : INVITE. Imaginons comme deux utilisateurs 1001 et 1002 et que 1001 souhaite appeler 1002.

Selon la RFC 3261, 1001 doit émettre une requête SIP à destination de 1002, cependant cela implique de savoir l’adresse IP et le port sur lequel 1002 est disponible. Dans la pratique, cela ne se passe jamais comme ça et 1001 va émettre cette requete à un serveur SIP qui se chargera de la relayer (à la façon d’un proxy) ou d’en émettre une nouvelle à la façon d’un PBX (B2BUA).

INVITE sip:1002@voip.operateur.re SIP/2.0

Dans un schéma avec deux téléphones, cette requête fait « sonner » le téléphone de 1002. Si nous envoyions ce message à un PBX générique, celui-ci aurait la logique nécessaire pour savoir qu’il dispose d’une extension 1001 et ferait sonner l’extension 1002.

Avec un PBX

Un PBX générique examine l’URI de requête dans le message INVITE qu’il a reçu et dispose d’une logique prédéfinie pour savoir que 1002 est un appareil qu’il a enregistré et que nous voulons nous connecter à cet appareil. Il envoie donc l’appel à l’appareil correspondant (1002). Ceci est le fonctionnement « classique » d’Asterisk, de FreeSwitch ou de n’importe quel PBX. Pour en dire plus à ce sujet, si nous envoyons cette requête à Asterisk, celui-ci vérifierai qu’il dispose des utilisateurs (endpoint dans PJSIP) et si le dialplan le permet redirigerai la requête vers le destinataire (exemple de ligne de dialplan : Dial(PJSIP/{EXTEN},30,tTr)). La gestion des réponses est automatique avec un PBX et celui se concentre sur la logique coeur, c’est à dire établir des appels entre les utilisateurs, qu’ils soient locaux ou distants par le biais d’un trunk par exemple.

Avec Kamailio

Kamailio fonctionne d’une toute autre façon. Si vous souhaitez que Kamailio réagisse à cette requête il faut l’écrire dans sa configuration et lui indiquer – à la façon d’un langage de programmation – les actions à prendre. Sommairement cela reviendrait à programmer Kamailio pour accepter les requêtes INVITE, vérifier si l’adresse d’enregistrement du destinataire (AoR : Address of Record) se trouve en mémoire, de répondre par un 100 Trying puis de transférer l’INVITE à la destination puis de répondre à l’appelant 200 OK, ce qui donne le diagramme suivant :

Flux d’appel utilisant Kamailio

Ici, j’ai omis le fait que nous devons également gérer les réponses 4XX si l’appelé est occupé ou absent, les utilisateurs ou encore les médias voix (RTP). Bien que tout cela semble difficile à gérer, il ne s’agit ici que de « programmation » au sens large du terme.

Même si cet exemple peut paraitre bateau, il vous permet de comprendre comment le système gère et achemine vos messages SIP. En somme, cela ouvre la porte à beaucoup de fonctionnalités, comme le fait de pouvoir gérer des autorisations d’appels pré-payé ou affranchi (post-paid), de sauvegarder le détail des communications (Call Detail Records), de faire du firewalling, du load-balancing, du LCR (Least Cost Routing), etc.

Le mot de la fin

Kamailio est un logiciel difficile à prendre en main. Les premières approches que vous aurez peuvent rebuter et vous aurez parfois l’envie d’abandonner. Avec un peu d’expérience il est possible de faire beaucoup de choses avec Kamailio qui peut être utilisé comme softswitch de classe 5 (pour entreprise) ou de classe 4 (pour opérateur).

Quitter la version mobile