Communiquer avec un serveur XMPP

Un livre de Wikilivres.
Aller à : navigation, rechercher
link={{{link}}}
Information :

Ce document a été déplacé vers le wiki de la communauté francophone sur lequel il a été mis à jour.

http://wiki.jabberfr.org/Introduction_au_protocole_XMPP

Ce livre a pour but de vous expliquer comment communiquer avec un serveur XMPP pour la création d'un client. Il n'a pas pour but de montrer des lignes de programmations mais seulement de vous expliquer les échanges entre le client et le serveur.

Les échanges entre le client et le serveur se font en XML et ont donc l'avantage d'être faciles à parser.

La documentation sur le sujet la plus précise est sans doute : RFC3920 et RFC3921. Nous considérons également que vous connaissez déjà XMPP, en cas de doute, vous pouvez consulter Extensible Messaging and Presence Protocol.

Les indentations ne sont ici que pour faciliter la lisibilité des exemples, elles ne sont pas obligatoires. Vous pourrez facilement tester ces exemples grâce à une session telnet sur un serveur XMPP : telnet jabber.org 5222

Les bases[modifier | modifier le wikicode]

Ce chapitre regroupe les actions élémentaires permettant de se connecter à un serveur XMPP et de discuter avec ses contacts en connaissant leur statut.

Initialisation de la connexion[modifier | modifier le wikicode]

Notre client va envoyer ceci :

<?xml version='1.0' encoding='UTF-8'?>

Les échanges entre le client et le serveur se font en XML. On peut également préciser l'encodage des caractères.

<stream:stream xmlns:stream='http://etherx.jabber.org/streams' version='1.0' xmlns='jabber:client' to='jabber.org' >

On ouvre un "stream" qui sera ouvert tout au long de la connexion au serveur.

Le client devra renseigner certains paramètres obligatoirement :

  • xmlns='jabber:client' : indique au serveur que notre client est effectivement un client et non un serveur.
  • xmlns:stream='http://etherx.jabber.org/streams'
  • to : indique l'adresse du serveur auquel on s'adresse

et il est aussi conseillé de renseigner d'autres paramètres :

  • version : indique la version du protocole utilisé
  • xml:lang : indique la langue utilisée par défaut


Le serveur doit nous répondre quelque chose comme ceci :

<stream:stream xmlns='jabber:client' xml:lang='en' xmlns:stream='http://etherx.jabber.org/streams' from='jabber.org' id='166C34A3F3E91' >

Mais s'il y a un problème, celui-ci peut aussi vous envoyer un message tel que : <stream:error>

Identification[modifier | modifier le wikicode]

Maintenant que nous sommes connectés au serveur, nous devons lui dire qui on est pour pouvoir discuter avec nos contacts.

<iq type="get" id="auth_1" to="jabber.org" >
  <query xmlns="jabber:iq:auth">
     <username>toto</username>
  </query>
</iq>

La valeur de id n'est pas obligatoirement "auth_1" mais le serveur va nous répondre en réutilisant cet id pour nous indiquer à quoi il répond et donc il faut le conserver. Le type "get" nous indique que nous demandons une information au serveur. Et en même temps, nous indiquons notre identité (balise query).

Le serveur va alors nous indiquer les informations nécessaire à la connexion.

<iq id='auth_1' type='result'>
  <query xmlns='jabber:iq:auth'>
     <username>toto</username>
     <password/>
     <digest/>
     <resource/>
  </query>
</iq>

Tous ces éléments ne sont pas obligatoires, il est inutile de préciser à la fois password et digest.

On peut alors lui envoyer les informations pour s'identifier :

<iq type="set" id="auth_2" to="jabber.org" >
  <query xmlns="jabber:iq:auth">
     <username>toto</username>
     <password>mot2passe</password>
     <resource>maison</resource>
  </query>
</iq>

Encore une fois, la valeur de id n'est pas obligatoirement "auth_2".

Le serveur doit vous répondre en cas de réussite :

<iq id='auth_2' type='result'/>

Sinon vous pourriez avoir quelque chose comme ceci :

<iq type='error' id='auth_2'>
  <query xmlns='jabber:iq:auth'>
     <username>toto</username>
     <password>mot2passe</password>
     <resource>maison</resource>
  </query>
  <error type='auth' code='401'><not-authorized xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
     <text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>Unauthorized</text>
  </error>
</iq>

Changer son statut[modifier | modifier le wikicode]

Pour le moment, on est certes identifié au serveur mais personne ne sait que vous êtes en ligne. Pour cela, vous devez simplement indiquer votre statut. C'est la balise <presence> qui permet cela.

<presence>
  <show>dnd</show>
  <status>Occupé</status>
  <priority>1</priority>
</presence>

Lorsqu'il n'y a pas les balises "show" et "status" cela veut dire qu'on se dit simplement en ligne. D'ailleurs en général, la première chose faite après l'identification est du type :

<presence>
  <priority>1</priority>
</presence>

La balise priority n'est pas obligatoire, cependant, en cas d'omission, cela revient à lui donner la valeur 0 :

<presence>
  <show>dnd</show>
  <status>Occupé</status>
</presence>

équivaut à :

<presence>
  <show>dnd</show>
  <status>Occupé</status>
  <priority>0</priority>
</presence>
  • show possède 4 états possibles :
    • away : Absent
    • chat : Veut discuter
    • dnd : Ne pas déranger (occupé)
    • xa : Non disponible
  • presence possède également la propriété type qui permet :
    • de se rendre invisible :
<presence type="invisible" />
    • de se déconnecter :
<presence type="unavailable" />

Statut de ses contacts[modifier | modifier le wikicode]

Il n'y a pas besoin de les demander au serveur, du moment où vous êtes en ligne, vous recevrez des messages de présence similaire à ceux que vous pourriez envoyer à la différence près que ceux-là contiennent une propriété "from" (et "to" mais qui ne vous servira pas) :

<presence to='dupont@im.apinc.org' from='toto@jabber.org/ecole'>
  <show>away</show>
  <status>Je suis de retour dans 1 minute !</status>
  <priority>5</priority>
</presence>

Récupérer la liste des contacts[modifier | modifier le wikicode]

Pour demander la liste de ses contacts, il faut envoyer :

<iq type="get" id="aaab" >
  <query xmlns="jabber:iq:roster"/>
</iq>

Encore une fois, vous pouvez mettre ce que vous voulez comme id mais celui-ci doit être unique.

Le serveur peut répondre quelque chose comme ceci :

<iq from='toto@jabber.org/ecole' type='result' id='aaab'>
  <query xmlns='jabber:iq:roster'>
     <item jid='tintin@jabber.org' subscription='both' name='Tintin'/>
     <item subscription='both' name='Dupont' jid='dupont@im.apinc.org'>
        <group>Amis</group>
     </item>
  </query>
</iq>

Attention, un contact peut appartenir à différents groupes. Dans ce cas, vous aurez plusieurs balises <group> contenant les différents groupes auxquels il appartient.

Envoyer des messages[modifier | modifier le wikicode]

Il existe différents types de messages :

  • chat : Le plus couramment employé, c'est celui de la messagerie instantanée, il est fait pour une conversation 1 à 1.
  • error : Permet au serveur de vous envoyer un message d'erreur.
  • groupchat : Utile pour une conversation à plusieurs.
  • headline : Permet au serveur d'envoyer des informations.
  • normal : Envoi un message similaire à un e-mail (sujet et message)

Exemple d'envois de message de type chat :

<message to="toto@jabber.org" type="chat">
        <body>Salut !</body>
</message>

Exemple de réception d'un message de type chat :

<message from="tintin@jabber.org/chateau" type="chat">
        <body>Salut !</body>
</message>

Envoyer une notification de frappe (XEP-0022)[modifier | modifier le wikicode]

Pour cela c'est très simple, il suffit d'envoyer un message qui ne contient pas <body> mais :

<x xmlns='jabber:x:event'>
   <composing/>
</x>

Il peut être souhaitable de préciser un id :

<message from='romeo@montague.net' to='juliette@capulet.com/balcon'>
 <x xmlns='jabber:x:event'>
   <composing/>
   <id>message22</id>
 </x>
</message>

Si Roméo fait une pause, alors il suffit de renvoyer :

<message from='romeo@montague.net' to='juliette@capulet.com/balcon'>
 <x xmlns='jabber:x:event'>
   <id>message22</id>
 </x>
</message>

Ceci a pour effet d'annuler la première information indiquant que Roméo est en train d'écrire.

Envoyer une notification de statut de conversation (XEP-0085)[modifier | modifier le wikicode]

Envoyer du texte en XHTML (XEP-0071)[modifier | modifier le wikicode]

Pour le moment, vous ne savez qu'envoyer des messages texte... Donc vous ne pouviez pas changer de police, de couleur d'écriture etc... Et bien c'est ce que nous allons voir maintenant grâce à la possibilité d'envoyer des messages en XHTML.

Exemple simple :

<message to="toto@jabber.org" type="chat">
  <body>Salut !</body>
  <html xmlns='http://jabber.org/protocol/xhtml-im'>
    <body xmlns='http://www.w3.org/1999/xhtml'>
      <p style='font-weight:bold'>Salut !</p>
    </body>
  </html>
</message>

Vous retrouvez des éléments identiques à l'envoie d'un message en texte simple : <body>Salut !</body>. En effet, cela permet aux clients qui ne gèrent pas cette fonctionnalité d'afficher le message quand même. Le message est ensuite répété en XHTML.

Vous pouvez aller consulter les attributs de chaque balise directement dans la XEP. Regardez bien ceux qui sont obligatoires, recommandés et déconseillés.

A noter la possibilité d'insérer des images mais attention, des clients peuvent préférer afficher le contenu de l'attribut alt à la place de l'image.

Pour savoir si le client de votre contact supporte le XHTML, il suffit de lui demander ce qu'il supporte :

<iq type='get' from='toto@jabber.org/ecole' to='tintin@jabber.fr/lune' id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>

Si le client le supporte, il vous le dira :

<iq type='result' from='toto@jabber.org/ecole' to='tintin@jabber.fr/lune' id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
     ...
     <feature var='http://jabber.org/protocol/xhtml-im'/>
     ...
  </query>
</iq>

Enregistrement d'un nouveau compte (XEP-0077)[modifier | modifier le wikicode]

La connexion au serveur doit juste être initialisée mais vous n'avez pas à vous identifier (ce qui est logique).

Exemple d'enregistrement :

<iq type="set" to="server.org" id="aab0a" >
  <query xmlns="jabber:iq:register">
     <username>Login</username>
     <password>MotDePasse</password>
     <email>login@mailserver.org</email>
  </query>
</iq>

Ceci va créer un nouveau compte sur le serveur XMPP "server.org" avec le pseudo "Login". Ainsi le JID de ce nouveau compte sera login@server.org. L'attribut id permet de connaitre la réponse du serveur, ce qui est très important ici mais il est facultatif. Tout le reste est obligatoire excepté l'email. D'autres balises peuvent aussi être renseigner : nick, name, first, last, address, city, state, zip, phone, url, date, misc... (voir la XEP officielle)

Exemple d'erreur :

<iq type='error' id='aab0a'>
  <query xmlns='jabber:iq:register'>
     <username>Login</username>
     <password>MotDePasse</password>
     <email>login@mailserver.org</email>
  </query>
  <error code='409'>Username Not Available</error>
</iq>

Exemple en cas de succés :

<iq type='result' id='aab0a'/>

Fermeture d'un compte[modifier | modifier le wikicode]

Si vous n'utilisez plus un compte XMPP, vous pouvez décider de le supprimer.

Pour cela, il vous faut déjà être connecté et identifié avec votre mot de passe. Ensuite il suffit d'envoyer :

<iq type="set" to="server.org" id="aab0a" >
  <query xmlns="jabber:iq:register">
     <remove/>
  </query>
</iq>

Changement de mot de passe[modifier | modifier le wikicode]

Pour une raison ou un autre, vous pouvez vouloir changer le mot de passe de votre compte.

Pour cela, il vous faut être déjà connecté et identifié avec votre mot de passe. Ensuite, il suffit d'envoyer :

<iq type="set" to="server.org" id="aab0a" >
  <query xmlns="jabber:iq:register">
     <username>Login</username>
    <password>NouveauMotDePasse</password>
  </query>
</iq>

Gestion des contacts[modifier | modifier le wikicode]

XMPP permet de gérer les contacts par une liste de contact stockée sur le serveur mais à cela se rajoute un système d'autorisation permettant d'accepter que tel ou tel contact puisse voir votre statut.

Autorisations[modifier | modifier le wikicode]

Les différents niveaux d'autorisation[modifier | modifier le wikicode]

  • "none" -- Ni l'utilisateur ni le contact n'ont d'autorisation pour se voir.
  • "to" -- L'utilisateur a l'autorisation de voir la présence du contact mais le contact lui ne l'a pas.
  • "from" -- Le contact a l'autorisation de voir l'utilisateur mais l'utilisateur lui ne l'a pas.
  • "both" -- L'utilisateur et le contact ont tous deux l'autorisation de connaître l'état de présence de l'autre.

Types pour <presence />[modifier | modifier le wikicode]

L'attribut type est optionnel. Une balise "presence" sans attribut est utilisé pour signaliser au serveur le statut de l'expéditeur. La balise "presence" permet aussi de gérer les autorisations.

L'attribut type peut avoir en plus ces valeurs :

  • subscribe : L'expéditeur veut avoir l'autorisation de voir l'état du contact.
  • subscribed : L'expéditeur a accepté de recevoir le statut de présence du contact.
  • unsubscribe : L'expéditeur supprime l'autorisation de l'autre.
  • unsubscribed : La demande d'autorisation a été refusé ou une précédente autorisation a été annulée.

Demander une autorisation[modifier | modifier le wikicode]

<presence type='subscribe' to='toto@im.apinc.org'>
  <status>Je voudrais t'ajouter à ma liste de contacts.</status>
</presence>

La balise "status" n'est pas obligatoire mais permet d'envoyer un message en même temps que la demande.

Toto va recevoir ceci :

<presence type='subscribe' to='toto@im.apinc.org' from='tintin@jabber.org'>
  <status>Je voudrais t'ajouter à ma liste de contacts.</status>
</presence>

Accepter une autorisation[modifier | modifier le wikicode]

<presence type="subscribed" to="tintin@jabber.org" />

Refuser une autorisation[modifier | modifier le wikicode]

<presence type="unsubscribed" to="tintin@jabber.org" />

Gestion de la contact-liste[modifier | modifier le wikicode]

Ajouter un contact[modifier | modifier le wikicode]

<iq type="set" id="ac90a" >
  <query xmlns="jabber:iq:roster">
     <item jid="tintin@jabber.org" />
  </query>
</iq>

L'attribut id est facultatif mais en cas d'erreur, il est bon de toujours spécifier un id pour savoir d'où vient l'erreur. D'autres informations peuvent être ajoutées :

<iq type="set" id="ac90a" >
  <query xmlns="jabber:iq:roster">
     <item name='tintin' jid='tintin@jabber.org'>
        <group>Amis</group>
     </item>
  </query>
</iq>

En cas de succés, le serveur doit vous répondre quelque chose comme ceci :

<iq to='toto@im.apinc.org/ecole' from='toto@im.apinc.org/ecole' type='result' id='ac90a'/>

Supprimer un contact[modifier | modifier le wikicode]

<iq type="set" id="ad8fa" >
  <query xmlns="jabber:iq:roster">
     <item subscription="remove" jid="tintin@jabber.org" />
  </query>
</iq>

Notez à la différence de l'ajout d'un contact, l'attribut subscription avec la valeur "remove" qui indique la suppression du jid spécifié.

Modifier un contact[modifier | modifier le wikicode]

Pour modifier un contact, il suffit d'ajouter à nouveau ce contact mais avec les nouvelles options (groupe et nom).

Procédure complète pour une autorisation mutuelle[modifier | modifier le wikicode]

Vous demandez en premier[modifier | modifier le wikicode]

Ajout du contact dans la contact-liste :

<iq type="set" id="ac90a" >
  <query xmlns="jabber:iq:roster">
     <item jid="tintin@jabber.org" />
  </query>
</iq>

Demande d'inscription :

<presence type='subscribe' to='tintin@jabber.org'>
  <status>Je voudrais t'ajouter à ma liste de contacts.</status>
</presence>

[Réception d'une autorisation et d'une demande d'autorisation]

Envoi d'une autorisation :

<presence type='subscribed' to='tintin@jabber.org' />

Vous recevez une demande d'autorisation[modifier | modifier le wikicode]

Ajout du contact dans la contact-liste :

<iq type="set" id="ac90a" >
  <query xmlns="jabber:iq:roster">
     <item jid="tintin@jabber.org" />
  </query>
</iq>

Vous demandez à votre tour une autorisation :

<presence type='subscribe' to='toto@im.apinc.org' />

Vous acceptez la sienne :

<presence type='subscribed' to='toto@im.apinc.org' />

[reception d'une autorisation]

Fonctionnalités Avancées[modifier | modifier le wikicode]

Recevoir une vCard[modifier | modifier le wikicode]

Publier sa vCard[modifier | modifier le wikicode]

Informations sur le client (XEP-0092)[modifier | modifier le wikicode]

La XEP-0092 permet de demander des informations supplémentaires sur les logiciels utilisés par vos contacts. On peut récupérer 3 informations qui sont le nom, la version et le système d'exploitation sur lequel celui ci tourne.

Pour demander, c'est très simple. Mais vous devrez spécifier la ressource.

<iq type="get" to="toto@jabber.org/ecole" id="version_1" >
  <query xmlns="jabber:iq:version" />
</iq>

Si le client peut lui répondre, alors vous recevrez une réponse, par exemple :

<iq from="toto@jabber.org/ecole" type="result" to="tintin@im.apinc.org/lune" id="version_1" >
  <query xmlns="jabber:iq:version">
     <name>Psi</name>
     <version>0.10-CVS (Jul 27 2005)</version>
     <os>Debian GNU/Linux (testing/unstable)</os>
  </query>
</iq>

Repérez bien ici les 3 balises name, version et os qui correspondent respectivement au nom du client, de sa version et du système d'exploitation. La XEP-0092 n'en prévoit pas d'autres.