path: root/src/analysis/db/server.c

/* Chrysalide - Outil d'analyse de fichiers binaires
 * server.c - mise en place d'un fournisseur d'éléments ajoutés
 *
 * Copyright (C) 2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  OpenIDA is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "server.h"


#include <assert.h>
#include <malloc.h>
#include <netdb.h>
#include <poll.h>
#include <string.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>


#include "cdb.h"
#include "protocol.h"
#include "misc/rlestr.h"
#include "../../common/io.h"
#include "../../core/params.h"
#include "../../gui/panels/log.h"



/* Informations relatives à un client */
typedef struct _cdb_client
{
    GDbServer *server;                      /* Accès facile en mémoire     */

    int fd;                                 /* Canal de communication      */
    struct sockaddr_in peer;                /* Adresse distante            */

    GThread *thread;                        /* Procédure de traitement     */

} cdb_client;

/* Description de serveur à l'écoute (instance) */
struct _GDbServer
{
    GObject parent;                         /* A laisser en premier        */

    int fd;                                 /* Canal de communication      */
    char *hostname;                         /* Désignation humaine         */
    char *desc;                             /* Désignation du serveur      */
    struct sockaddr_in addr;                /* Adresse d'écoute            */

    GThread *listener;                      /* Procédure de traitement     */

    GList *archives;                        /* Liste des binaires ouverts  */
    cdb_client **clients;                   /* Connexions en place         */
    size_t count;                           /* Quantité de clients         */
    GMutex mutex;                           /* Verrou pour l'accès         */

};

/* Description de serveur à l'écoute (classe) */
struct _GDbServerClass
{
    GObjectClass parent;                    /* A laisser en premier        */

};


/* Initialise la classe des descriptions de fichier binaire. */
static void g_db_server_class_init(GDbServerClass *);

/* Initialise une description de fichier binaire. */
static void g_db_server_init(GDbServer *);

/* Procède à la libération totale de la mémoire. */
static void g_db_server_finalize(GDbServer *);

/* Assure l'accueil des nouveaux clients. */
static void *g_db_server_listener(GDbServer *);

/* Assure le traitement des requêtes de clients. */
//static void *g_db_server_process(cdb_client **);



/* Indique le type défini pour une description de serveur à l'écoute. */
G_DEFINE_TYPE(GDbServer, g_db_server, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des descriptions de fichier binaire.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_server_class_init(GDbServerClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->finalize = (GObjectFinalizeFunc)g_db_server_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : server = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une description de fichier binaire.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_server_init(GDbServer *server)
{
    server->fd = -1;

    g_mutex_init(&server->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : server = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_db_server_finalize(GDbServer *server)
{
    free(server->hostname);

    G_OBJECT_CLASS(g_db_server_parent_class)->finalize(G_OBJECT(server));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : host = hôte à représenter pour le service.                   *
*                port = port de connexion pour les clients.                   *
*                                                                             *
*  Description : Prépare un serveur de BD pour les clients.                   *
*                                                                             *
*  Retour      : Structure mise en plae ou NULL en cas d'échec.               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GDbServer *g_db_server_new(const char *host, short port)
{
    GDbServer *result;                      /* Adresse à retourner         */
    struct hostent *hp;                     /* Informations sur l'hôte     */
    size_t desclen;                         /* Taille de désignation       */

    const char *ip;                         /* Adresse IPv4 ou IPv6        */

    result = g_object_new(G_TYPE_DB_SERVER, NULL);

    result->hostname = strdup(host);

    hp = gethostbyname(host);
    if (hp == NULL)
    {
        perror("gethostbyname");
        goto gdsn_error;
    }

    result->addr.sin_family = hp->h_addrtype;
    memcpy(&result->addr.sin_addr, hp->h_addr_list[0], sizeof(struct in_addr));

    result->addr.sin_port = htons(port);

    desclen = INET6_ADDRSTRLEN + 1 + 5 + 1;
    result->desc = (char *)calloc(desclen, sizeof(char));

    ip = inet_ntop(AF_INET, &result->addr.sin_addr, result->desc, INET6_ADDRSTRLEN);
    if (ip == NULL)
    {
        perror("inet_ntop");
        goto gdsn_error;
    }

    snprintf(result->desc + strlen(ip), 1 + 5, ":%hu", port);

    return result;

 gdsn_error:

    g_object_unref(G_OBJECT(result));

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : server = serveur pour les accès distants à manipuler.        *
*                                                                             *
*  Description : Assure l'accueil des nouveaux clients.                       *
*                                                                             *
*  Retour      : NULL.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void *g_db_server_listener(GDbServer *server)
{
    struct pollfd fds;                      /* Surveillance des flux       */
    int ret;                                /* Bilan d'un appel            */
    struct sockaddr_in peer;                /* Adresse cliente             */
    int fd;                                 /* Canal établi vers un client */
    char source[INET6_ADDRSTRLEN];          /* Adresse du client (IPv4/6)  */
    const char *ip;                         /* Statut de la conversion     */
    DBError error;                          /* Validation de la connexion  */
    uint32_t cmd;                           /* Commande initiale lue       */
    uint32_t version;                       /* Version du client lue       */
    rle_string hash;                        /* Empreinte du binaire visé   */
    rle_string user;                        /* Nom d'utilisateur du client */
    GList *iter;                            /* Boucle de parcours          */
    GCdbArchive *archive;                   /* Destinataire final du client*/

    fds.fd = server->fd;
    fds.events = POLLIN | POLLPRI;

    while (1)
    {
        ret = poll(&fds, 1, -1);
        if (ret != 1) continue;

        /* Le canal est fermé, une sortie doit être demandée... */
        if (fds.revents & POLLNVAL)
            break;

        if (fds.revents & (POLLIN | POLLPRI))
        {
            fd = accept(server->fd, &peer, (socklen_t []) { sizeof(struct sockaddr_in) });
            if (fd == -1)
            {
                perror("accept");
                continue;
            }

            ip = inet_ntop(AF_INET, &peer.sin_addr, source, sizeof(source));
            if (ip == NULL)
            {
                perror("inet_ntop");
                goto gdsl_error;
            }

            error = DBE_NONE;

            /**
             * Le premier "paquet" reçu de la part d'un client doit contenir les informations suivantes :
             *    - la commande 'DBC_HELO'.
             *    - le numéro de version du client.
             *    - l'empreinte du binaire analysé.
             *    - l'identifiant de l'utilisateur effectuant des modifications.
             *
             * Tout ceci est à synchroniser avec la fonction g_db_client_start().
             */

            if (!safe_recv(fd, &cmd, sizeof(uint32_t), 0))
            {
                log_variadic_message(LMT_ERROR, _("Error while getting the initial command from '%s:%hu'..."),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (!safe_recv(fd, &version, sizeof(uint32_t), 0))
            {
                log_variadic_message(LMT_ERROR, _("Error while getting the protocol version from '%s:%hu'..."),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (!recv_rle_string(&hash, fd, 0))
            {
                log_variadic_message(LMT_ERROR, _("Error while getting the binary hash from '%s:%hu'..."),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (!recv_rle_string(&user, fd, 0))
            {
                log_variadic_message(LMT_ERROR, _("Error while getting the user name from '%s:%hu'..."),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (be32toh(cmd) != DBC_HELO)
            {
                log_variadic_message(LMT_ERROR, _("The client from '%s:%hu' did not introduce itself!"),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (be32toh(version) != CDB_PROTOCOL_VERSION)
            {
                log_variadic_message(LMT_ERROR, _("The client from '%s:%hu' does not use the same protocol: 0x%08x vs 0x%08x..."),
                                     source, ntohs(peer.sin_port), be32toh(version), CDB_PROTOCOL_VERSION);
                error = DBE_WRONG_VERSION;
                goto gdsl_error_sending;
            }

            if (is_rle_string_empty(&hash))
            {
                log_variadic_message(LMT_ERROR, _("The submitted binary hash from '%s:%hu' is empty!"),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            if (is_rle_string_empty(&user))
            {
                log_variadic_message(LMT_ERROR, _("No user is associated with the client from '%s:%hu'..."),
                                     source, ntohs(peer.sin_port));
                error = DBE_BAD_EXCHANGE;
                goto gdsl_error_sending;
            }

            /**
             * On met en place le maximum ici, de manière à pouvoir indiquer une erreur
             * en cas d'échec, et être le plus précis possible dans la courte réponse.
             */

            assert(error == DBE_NONE);

            for (iter = g_list_first(server->archives);
                 iter != NULL;
                 iter = g_list_next(iter))
            {
                archive = G_CDB_ARCHIVE(iter->data);
                if (g_cdb_archive_compare_hash(archive, &hash) == 0)
                    break;
            }

            if (iter == NULL)
                archive = g_cdb_archive_new(server->desc, &hash, &user, &error);

            /**
             * Le serveur doit répondre pour un message type :
             *    - la commande 'DBC_WELCOME'.
             *    - un identifiant d'erreur ('DBE_NONE', 'DBE_BAD_EXCHANGE'
             *      ou 'DBE_WRONG_VERSION' ... 'DBE_LOADING_ERROR').
             */

 gdsl_error_sending:

            if (!safe_send(fd, (uint32_t []) { htobe32(DBC_WELCOME) }, sizeof(uint32_t), MSG_MORE))
                goto gdsl_error;

            if (!safe_send(fd, (uint32_t []) { htobe32(error) }, sizeof(uint32_t), 0))
                goto gdsl_error;

            /**
             * L'ajout dans la liste des clients connectés provoque un envoie de mises à jour.
             * L'éventuelle erreur survenant pendant l'envoi ne peut donc pas être remontée
             * lors des échanges initiaux, car ces derniers seraient alors précédés des mises à jour...
             */

            if (archive != NULL)
            {
                assert(error == DBE_NONE);

                server->archives = g_list_append(server->archives, archive);
                error = g_cdb_archive_add_client(archive, fd, &user);

                exit_rle_string(&hash);
                exit_rle_string(&user);

                continue;

            }

            assert(error != DBE_NONE);

 gdsl_error:

            exit_rle_string(&hash);
            exit_rle_string(&user);

            close(fd);

        }

    }

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : server = serveur pour les accès distants à manipuler.        *
*                                                                             *
*  Description : Démarre le serveur de base de données.                       *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_db_server_start(GDbServer *server)
{
    int ret;                                /* Bilan d'un appel            */
    int backlog;                            /* Nombre de connexions maximal*/

    server->fd = socket(AF_INET, SOCK_STREAM, 0);
    if (server->fd == -1)
    {
        perror("socket");
        return false;
    }

    ret = setsockopt(server->fd, SOL_SOCKET, SO_REUSEADDR, (int []) { 1 }, sizeof(int));
    if (ret == -1)
    {
        perror("setsockopt");
        goto gdss_error;
    }

    ret = bind(server->fd, (struct sockaddr *)&server->addr, sizeof(struct sockaddr_in));
    if (ret == -1)
    {
        perror("bind");
        goto gdss_error;
    }

    if (!g_generic_config_get_value(get_main_configuration(), MPK_SERVER_BACKLOG, &backlog))
        goto gdss_error;

    ret = listen(server->fd, backlog);
    if (ret == -1)
    {
        perror("listen");
        goto gdss_error;
    }

    server->listener = g_thread_new("cdb_listener", (GThreadFunc)g_db_server_listener, server);

    log_variadic_message(LMT_PROCESS, _("Server started and listening at %s:%hu"),
                         server->hostname, ntohs(server->addr.sin_port));

    return true;

 gdss_error:

    close(server->fd);
    server->fd = -1;

    return false;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : server = serveur pour les accès distants à manipuler.        *
*                                                                             *
*  Description : Arrête le serveur de base de données.                        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_db_server_stop(GDbServer *server)
{
    size_t i;                               /* Boucle de parcours          */
    GThread *thread;                        /* Procédure de traitement     */

    if (server->fd != -1)
        return;

    close(server->fd);
    server->fd = -1;

    g_thread_join(server->listener);

    for (i = 0; i < server->count; i++)
    {
        /* Sauvegarde de la référene, qui peut disparaître */
        thread = server->clients[i]->thread;

        close(server->clients[i]->fd);
        g_thread_join(thread);

    }

}