Protocole de chat Client/Serveur - version 2.28

• CBX constitue l' ensemble de règles de communication entre un client et un serveur de chat CBX.
• TBX est le protocole du Tracker.
  
  Ce document ne fait que décrire une suite de protocoles. Leur implémentation est libre.
  
  
  • I. Protocole TBX
    • I.1 Connection du serveur de chat au tracker
    • I.2 Connection du client au Tracker
  • II. Protocole CBX
    • II.1 P Infos utilisateur
    • II.2 F Liste des utilisateurs
    • II.3 M Message chat standard
    • II.4 X Alerte administrative du serveur
    • II.5 Y Message administratif
    • II.6 Q Quelqu'un quitte le chat
    • II.7 @ Le serveur stoppe son service
  
  
  La partie de ce document décrivant CBX a pour but de permettre l' écriture de programmes clients pour le chat CBX, avec tout langage de programmation autorisant l'emploi d'un socket et le traitement de chaînes de caractères.
  La majorité des langages le permettent, notammant: C/C++, Java, assembleur, C#, Ada, Delphi, Fortran, cobol, D, Nice, OCaml, Pascal, Perl, Python, Tcl, VB...
  Libre aux programmeurs d'agencer leur code et leur interface.
  
  
  Un serveur CBX, et deux clients écrits en VB6 sous Windows XP
  
  
  Un serveur CBX, et deux clients écrits en C/GTK+ sous Linux
  
  
  Emoticones interprétables par le client
  

  Changements

  • 12/12/06 Version 2.28
  • 08/12/06 Version 2.27
  • 09/02/06 Version 2.21
  
  

  I. Protocole TBX

  
  

  
  
  • I.1 Connection du serveur de chat au tracker
    Lorsque le serveur de chat est lancé, il doit signaler au tracker son IP pour que celui-ci puisse plus tard l' indiquer aux clients afin que les clients obtiennent l' IP du serveur de chat pour s'y connecter.
    
    
    fig.1 Le serveur de chat indique au Tracker son IP
    
    Pour celà le tracker met à sa disposition une ressource CGI:
    
    /CBX/addcurrent
    
    Où addcurrent est une ressource CGI qui obtient l' IP publique du serveur de chat, et la stocke. Il peut la stocker dans une variable d' environnement, ou dans un fichier.
    
    L' IP publique du serveur est stockée dans la variable d' environnement REMOTE_ADDR. Après récupération elle peut être convertie au format long.
    
    Important: stocker dans le fichier l' IP et rien que l' IP, pas de retour charriot.
    
    Après stockage de la variable, le tracker doit envoyer un string de confirmation de la forme suivante:
    
    Your IP was written as current
    
    L' IP est ensuite redistribuée à tout client se connectant au tracker comme indiqué dans la partie 2.
    
    
    • I.1.1 script Perl

      #!/usr/bin/perl
      $ip = $ENV{'REMOTE_ADDR'};
      $fichier = "/local/home/truc/CBX/id";
      &add_ip;
      
      #ouvre fichier, convertit et écrit
      sub add_ip {
        open (SERVER,">$fichier") || 
      	die "Can't Open $fichier: $!\n";
        print SERVER "ip2long($ip)";
        close (SERVER);
      
        #envoie response au serveur chat
        #print "Content-type: text/plain\n\n";
        print "Your IP was written as current";
      }
      

    • I.1.2 script PHP

      <?php
      // obtient REMOTE_ADDR
      $REMOTE_ADDR = "1.1.128.54";
      //echo $_ENV["REMOTE_ADDR"];
      
      // écrase le fichier.
      $fic = 'id';
      if (is_writable($fic)) {
       if ($!handle = fopen($fic, 'w')) {
        echo "Impossible d'ouvrir le fichier!\n";
        exit;
       }
       if (fwrite($handle, ip2long ($REMOTE_ADDR)) === FALSE) {
        echo "Impossible d'écrire dans le fichier!\n";
        exit;
       }
       echo "Your IP was written as current\n";
       fclose($handle);
       } 
       else {echo "Le fichier n'est pas accessible en écriture!\n";}
       ?>
      

    • I.1.3 CGI compilé en C

      unsigned int ip2long(char *s)
      {
       struct sockaddr_in n;
       #ifndef WIN32
        inet_aton(s,&n.sin_addr);
        return ntohl(n.sin_addr.s_addr);
       #else
        return ntohl(inet_addr(s));
       #endif
      }
      
      int main()
      {
        FILE *f;
        fprintf (f, "%u",ip2long (getenv("REMOTE_ADDR")));
        //signale au serveur chat si l' écriture a réussi
        printf("Your IP was written as current");
        return 0;
      }
      

    • I.1.4 CGI compilé en VB6

      Private Declare Sub CopyMemory Lib "kernel32"
      		 Alias "RtlMoveMemory" (Destination As Any,
      		Source As Any, ByVal Length As Long)
      
      Function ip2long(ByVal IPAddr As String) As Long
       Dim V As Variant
       V = Split(IPAddr, ".")
       Dim I As Long, B As Byte
       B = V(0): CopyMemory ByVal VarPtr(I) + 3, ByVal VarPtr(B), 1
       B = V(1): CopyMemory ByVal VarPtr(I) + 2, ByVal VarPtr(B), 1
       B = V(2): CopyMemory ByVal VarPtr(I) + 1, ByVal VarPtr(B), 1
       B = V(3): CopyMemory ByVal VarPtr(I) + 0, ByVal VarPtr(B), 1
       ip2long = I
      End Function
      
      Sub Main()
       Open App.Path & "\test.txt" for Output As #1
       print #1, ip2long(remote_addr)
       Close #1
      End Sub
      

  I.2 Connection du client au Tracker

  
  

  • 
    fig.2 Joe veut rejoindre le chat
    Chaque client a besoin de connaître l' adresse IP du serveur de chat.
    Comme le serveur de chat a rarement une IP fixe, le tracker est le tiers-médian qui relie les clients au serveur en stockant son IP et en la donnant aux clients qui veulent se connecter.
    
    A cet effet TBX est le protocole qui définit les règles de ce processus permettant au tracker de faire le relai entre les clients et serveur de chat.
    
    Le tracker agit d'un certain point de vue comme un serveur DNS. C' est un service web ultra minimal, TRES peu demandeur en ressources pour le serveur, autant du point de vue de la bande passante que la charge du serveur.
    
    Le tracker peut être implémenté avec plusieurs langages de programmation: un serveur web et une interface CGI constituée de quelques scripts écrits en Perl, python ou PHP, ou un CGI compilé en C/C++ Assembleur ou tout autre langage. Un exécutable dédié à l' écoute sur le port 80 peut également se substituer au serveur web.
    
    Le tracker stocke l' IP du serveur chat dans le fichier
    
    /CBX/id.txt
    
    L' IP est stockée non pas au format string et points (exemple 25.112.254.21) mais au format long non signé, dans l' ordre machine: ainsi 127.0.0.1 est 2130706433. Voir le 3 pour savoir comment convertir.
    
    
  • (1) Connection du client au tracker
    
    Le client établit une connection TCP avec le tracker sur le port TCP 80. Ceci peut éventuellement passer par une requête DNS prélable pour se connecter au tracker, dans le cas où l' adresse connue du tracker soit de la forme d'une URL plutôt que par son IP.
    
    Pour obtenir la ressource, deux façons: demander directement le fichier par une requête HTTP classique, soit par le biais d'une interface CGI.
    
    
    • 1.1 Obtenir le fichier texte par une requête HTTP
      C'est le cas le plus simple: le client demande le fichier comme il le ferait pour une page html statique.
      
      Lorsque la connection est établie, le client envoie une requête HTTP pour demander l' URI CBX/id.
      Exemple de requête HTTP pour obtenir le fichier:
      
      
      GET http://www.unsite.com/path/CBX/id HTTP/1.1\r\n\r\n
      
      
      
    • 1.2 Obtenir le fichier par l' interface CGI
      /CBX/id est une ressource CGI. Voici des exemples dans divers langages :
      
      
      • 1.2.1 script Perl
        

        #!/usr/bin/perl
        $fichier = "/local/home/truc/CBX/id";
        &repondre;
        
        sub repondre {
          #ouvre le fichier, place contenu dans $LINES
          open (FILE,"$fichier") || die "Can't Open $fichier: $!\n";
          $LINES=<FILE>;
          close(FILE);
        
          # et envoie reponse au client
          print "Content-type: text/plain\n\n";
          print "$LINES";
        }
        

      • 1.2.2 script PHP

        <?php // ouvre le fichier et envoie
         echo file_get_contents ("id");
        ?>
        

      • 1.2.3 CGI compilé en C
      • 1.2.4 CGI compilé en VB6

        Sub Main()
          Dim myChar As String
          Open "c:\0.php" For Input As #1 ' Ouvre le fichier
          ' place contenu dans variable
             Do While Not EOF(1)
              myChar = Input(FileLen("c:\0.php"), #1)
             Loop
            Close #1
          End
        End Sub
        

      Le tracker ferme alors la connection.
      A la réception de cette chaîne, le client utilise ces valeurs pour se connecter au serveur de chat.(voir II.1 du protocole CBX).
      
      Cas possibles traités par le client:
      
      • Le tracker est down
      • Le serveur chat est down
      • Le service est indisponible
      • La valeur renvoyée par le tracker est corrompue

  
  
• (3) Connection au Serveur de chat
  
  A ce stade, le client a l' IP du serveur de chat. Il sait qu'il doit s'y connecter sur le port 4404 (TCP).
  
  Si la demande de connection est acceptée, le client doit alors envoyer sa requête de connection pour rejoindre le groupe des utilisateurs, en envoyant un code [P] (cf. II.1).
  
  Le serveur vérifie alors que:
  • le 1er caractère de la chaine reçue est un délimiteur
  • MAX_USERS n'est pas atteint
  • le nom contient 20 caractères maximum
  • le nom ne contient que des caractère alphanumériques
  • le nom n'est pas déjà pris
  
  Si la requête de connection n'est pas acceptée, le demandeur reçoit une alerte administrative qui précise pourquoi la demande a été rejetée. Sinon, le serveur envoie un code [F] qui contient la liste des utilisateurs, voir (4) du shema. De plus le serveur signale aux autres utilisateurs déjà connectés qu'un nouveau a rejoint le chat en leur répercutant le code [P].