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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * client.c - connexion à un serveur Chrysalide
 *
 * Copyright (C) 2014-2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide 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.
 *
 *  Chrysalide 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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "client.h"


#include <assert.h>
#include <netdb.h>
#include <poll.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <openssl/err.h>


#include <i18n.h>


#include "auth.h"
#include "protocol.h"
#include "misc/rlestr.h"
#include "../../common/extstr.h"
#include "../../common/io.h"
#include "../../common/xdg.h"
#include "../../core/logs.h"



/* Format générique des adresses de connexion */
typedef union _gen_sockaddr_t
{
    struct sockaddr_in inet4_addr;          /* Adresse d'écoute IPv4       */
    struct sockaddr_in6 inet6_addr;         /* Adresse d'écoute IPv6       */
    struct sockaddr inet_4_6_addr;          /* Adresse d'écoute IPv4/6     */

} gen_sockaddr_t;


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

    rle_string hash;                        /* Empreinte du binaire lié    */
    GList *collections;                     /* Collections d'un binaire    */

    char *working;                          /* Répertoire de travail       */

    SSL_CTX *tls_ctx;                       /* Contexte du chiffrement     */

    int fd;                                 /* Canal de communication      */
    SSL *tls_fd;                            /* Même canal, mais sécurisé   */
    char *desc;                             /* Description du lien         */

    GMutex sending_lock;                    /* Concurrence des envois      */
    bool can_get_updates;                   /* Réception de maj possibles ?*/
    GThread *update;                        /* Procédure de traitement     */

};

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

};


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

/* Initialise une description de fichier binaire. */
static void g_hub_client_init(GHubClient *);

/* Supprime toutes les références externes. */
static void g_hub_client_dispose(GHubClient *);

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

/* Démarre réellement la connexion à la base de données. */
static bool g_hub_client_start_common(GHubClient *, char *);

/* Assure l'accueil des nouvelles mises à jour. */
static void *g_hub_client_update(GHubClient *);

/* Identifie le canal de communication pour envois au serveur. */
static SSL *g_hub_client_get_ssl_fd(GHubClient *);

/* Marque le canal de communication comme disponible. */
static void g_hub_client_put_ssl_fd(GHubClient *, SSL *);



/* Indique le type défini pour une description de client à l'écoute. */
G_DEFINE_TYPE(GHubClient, g_hub_client, G_TYPE_OBJECT);


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

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

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_hub_client_dispose;
    object->finalize = (GObjectFinalizeFunc)g_hub_client_finalize;

}


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

static void g_hub_client_init(GHubClient *client)
{
    client->working = NULL;

    client->tls_ctx = NULL;

    client->fd = -1;
    client->tls_fd = NULL;
    client->desc = NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : archive = instance d'objet GLib à traiter.                   *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_hub_client_dispose(GHubClient *client)
{
    g_hub_client_stop(client);

    G_OBJECT_CLASS(g_hub_client_parent_class)->dispose(G_OBJECT(client));

}


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

static void g_hub_client_finalize(GHubClient *client)
{
    unset_rle_string(&client->hash);

    if (client->working != NULL)
        free(client->working);

    assert(client->tls_ctx == NULL);

    assert(client->tls_fd == NULL);

    if (client->desc != NULL)
        free(client->desc);

    G_OBJECT_CLASS(g_hub_client_parent_class)->finalize(G_OBJECT(client));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : hash        = empreinte d'un binaire en cours d'analyse.     *
*                collections = ensemble de collections existantes.            *
*                                                                             *
*  Description : Prépare un client pour une connexion à une BD.               *
*                                                                             *
*  Retour      : Structure mise en place ou NULL en cas d'échec.              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GHubClient *g_hub_client_new(const char *hash, GList *collections)
{
    GHubClient *result;                     /* Adresse à retourner         */

    result = g_object_new(G_TYPE_HUB_CLIENT, NULL);

    init_static_rle_string(&result->hash, hash);
    result->collections = collections;

    return result;

}


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

bool g_hub_client_start_internal(GHubClient *client)
{
    bool status;                            /* Bilan de la connexion       */
    struct sockaddr_un addr;                /* Adresse de transmission     */
    int ret;                                /* Bilan d'un appel            */
    char *desc;                             /* Description du serveur ciblé*/

    /* Identification du serveur à contacter */

    status = build_internal_server_socket(&addr);
    if (!status) goto fs_error;

    /* Création d'un canal de communication */

    client->fd = socket(AF_UNIX, SOCK_STREAM, 0);
    if (client->fd == -1)
    {
        LOG_ERROR_N("socket");
        goto fs_error;
    }

    ret = connect(client->fd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un));
    if (ret == -1)
    {
        LOG_ERROR_N("connect");
        goto no_listening;
    }

    asprintf(&desc, "unix://%s", addr.sun_path);

    client->working = get_db_working_directory("clients", "standalone", NULL, NULL);

    status = g_hub_client_start_common(client, desc);

    if (!status)
        goto no_listening;

    return true;

 no_listening:

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

 fs_error:

    return false;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                host   = hôte à représenter pour le service.                 *
*                port   = port de connexion pour les clients.                 *
*                ipv6   = adopte une préférence pour les adresses IPv6.       *
*                                                                             *
*  Description : Démarre la connexion à la base de données distante.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_hub_client_start_remote(GHubClient *client, const char *host, const char *port, bool ipv6)
{
    struct addrinfo hints;                  /* Cadre de connexion souhaité */
    struct addrinfo *available;             /* Cadres de connexion dispos  */
    int ret;                                /* Bilan d'une consultation    */
    int domain;                             /* Domaine du canal            */
    struct addrinfo *iter;                  /* Boucle de parcours          */
    gen_sockaddr_t addr;                    /* Adresse d'écoute générique  */
    socklen_t sock_len;                     /* Taille de cette adresse     */
    char *desc;                             /* Description du serveur ciblé*/
    bool status;                            /* Bilan de la connexion       */

    /* Détermination du point d'écoute */

    memset(&hints, 0, sizeof(hints));

    hints.ai_family = AF_UNSPEC;
    hints.ai_socktype = SOCK_STREAM;
    hints.ai_protocol = IPPROTO_TCP;

    ret = getaddrinfo(host, port, &hints, &available);
    if (ret != 0)
    {
        LOG_ERROR_GAI_N("getaddrinfo", ret);
        goto no_target;
    }

    domain = AF_UNSPEC;

    /**
     * Premier tour : on essaie de se plier à la demande.
     */

    for (iter = available; iter != NULL && domain == AF_UNSPEC; iter = iter->ai_next)
    {
        if (ipv6 && iter->ai_family != AF_INET6)
            continue;

        if (!ipv6 && iter->ai_family != AF_INET)
            continue;

        domain = iter->ai_family;

        memcpy(&addr.inet_4_6_addr, iter->ai_addr, iter->ai_addrlen);
        sock_len = iter->ai_addrlen;

    }

    /**
     * Second tour : on fait avec ce qu'on a.
     */

    for (iter = available; iter != NULL && domain == AF_UNSPEC; iter = iter->ai_next)
    {
        if (iter->ai_family != AF_INET6 && iter->ai_family != AF_INET)
            continue;

        domain = iter->ai_family;

        memcpy(&addr.inet_4_6_addr, iter->ai_addr, iter->ai_addrlen);
        sock_len = iter->ai_addrlen;

    }

    if (available != NULL)
        freeaddrinfo(available);

    if (domain == AF_UNSPEC)
    {
        log_variadic_message(LMT_ERROR, _("No suitable address found for %s:%s"), host, port);
        goto no_target;
    }

    /* Création d'un canal de communication */

    client->fd = socket(domain, SOCK_STREAM, 0);
    if (client->fd == -1)
    {
        LOG_ERROR_N("socket");
        goto error_socket;
    }

    ret = connect(client->fd, (struct sockaddr *)&addr, sock_len);
    if (ret == -1)
    {
        LOG_ERROR_N("connect");
        goto no_listening;
    }

    asprintf(&desc, "%s:%s", host, port);

    client->working = get_db_working_directory("clients", host, port, NULL);

    status = g_hub_client_start_common(client, desc);

    if (!status)
        goto no_listening;

    return true;

 no_listening:

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

 error_socket:
 no_target:

    return false;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                host   = hôte à représenter pour le service.                 *
*                port   = port de connexion pour les clients.                 *
*                                                                             *
*  Description : Démarre réellement la connexion à la base de données.        *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_hub_client_start_common(GHubClient *client, char *desc)
{
    const SSL_METHOD *method;               /* Mode du canal sécurisé      */
    char *filename;                         /* Fichier PEM à manipuler     */
    int ret;                                /* Bilan d'un appel            */
    char *rootdir;                          /* Racine pour le client       */
    packed_buffer out_pbuf;                 /* Tampon d'émission           */
    bool status;                            /* Bilan d'une opération       */
    packed_buffer in_pbuf;                  /* Tampon de réception         */
    uint32_t data;                          /* Mot de données lues         */
    DBError error;                          /* Validation de la connexion  */

    client->desc = desc;

    /* Définition d'un environnement TLS */

    method = TLS_client_method();

    client->tls_ctx = SSL_CTX_new(method);

    if (client->tls_ctx == NULL)
    {
        LOG_ERROR_OPENSSL;
        goto quick_error;
    }

    filename = strdup(client->working);
    filename = stradd(filename, "client-cert.pem");

    ret = SSL_CTX_use_certificate_file(client->tls_ctx, filename, SSL_FILETYPE_PEM);

    free(filename);

    if (ret != 1)
    {
        LOG_ERROR_OPENSSL;
        goto tls_error;
    }

    rootdir = get_db_working_directory("clients", NULL, NULL, NULL);

    filename = strdup(rootdir);
    filename = stradd(filename, "client-key.pem");

    ret = SSL_CTX_use_PrivateKey_file(client->tls_ctx, filename, SSL_FILETYPE_PEM);

    free(filename);
    free(rootdir);

    if (ret != 1)
    {
        LOG_ERROR_OPENSSL;
        goto tls_error;
    }

    /* Validation des certificats */

    SSL_CTX_set_verify(client->tls_ctx, SSL_VERIFY_PEER, NULL);

    filename = strdup(client->working);
    filename = stradd(filename, "ca-cert.pem");

    ret = SSL_CTX_load_verify_locations(client->tls_ctx, filename, NULL);

    free(filename);

    if (ret != 1)
    {
        LOG_ERROR_OPENSSL;
        goto tls_error;
    }

    /* Mise en place d'un canal de communication */

    client->tls_fd = SSL_new(client->tls_ctx);

    if (client->tls_fd == NULL)
    {
        LOG_ERROR_OPENSSL;
        goto tls_error;
    }

    SSL_set_fd(client->tls_fd, client->fd);

    ret = SSL_connect(client->tls_fd);

    if (ret != 1)
    {
        LOG_ERROR_OPENSSL;
        goto ssl_error;
    }

    /**
     * On réalise l'envoi initial ; le premier paquet doit contenir :
     *    - la commande 'DBC_HELO'.
     *    - le numéro de version du client.
     *    - l'empreinte du binaire analysé.
     *
     * Tout ceci est à synchroniser avec la fonction g_db_server_listener().
     */

    init_packed_buffer(&out_pbuf);

    status = extend_packed_buffer(&out_pbuf, (uint32_t []) { DBC_HELO }, sizeof(uint32_t), true);
    if (!status) goto setup_error;

    status = extend_packed_buffer(&out_pbuf, (uint32_t []) { CDB_PROTOCOL_VERSION }, sizeof(uint32_t), true);
    if (!status) goto setup_error;

    status = pack_rle_string(&client->hash, &out_pbuf);
    if (!status) goto setup_error;

    status = ssl_send_packed_buffer(&out_pbuf, client->tls_fd);
    if (!status) goto setup_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').
     */

    init_packed_buffer(&in_pbuf);

    status = ssl_recv_packed_buffer(&in_pbuf, client->tls_fd);
    if (!status) goto comm_error;

    status = extract_packed_buffer(&in_pbuf, &data, sizeof(uint32_t), true);
    if (!status) goto comm_error;

    if (data != DBC_WELCOME)
    {
        log_variadic_message(LMT_ERROR, _("The server '%s' did not welcome us!"), desc);
        goto comm_error;
    }

    status = extract_packed_buffer(&in_pbuf, &data, sizeof(uint32_t), true);
    if (!status) goto comm_error;

    error = data;

    switch (error)
    {
        case DBE_NONE:
            log_variadic_message(LMT_INFO, _("Connected to the server '%s'!"), desc);
            break;

        case DBE_WRONG_VERSION:
            log_variadic_message(LMT_ERROR, _("The server '%s' does not use our protocol version (0x%08x)..."),
                                 desc, CDB_PROTOCOL_VERSION);
            goto comm_error;
            break;

        case DBE_XML_VERSION_ERROR:
            log_variadic_message(LMT_ERROR, _("The archive from the server '%s' does not use our protocol version (0x%08x)..."),
                                 desc, CDB_PROTOCOL_VERSION);
            goto comm_error;
            break;

        case DBE_DB_LOADING_ERROR:
            log_variadic_message(LMT_ERROR, _("The server '%s' got into troubles while loading the database...."),
                                 desc);
            goto comm_error;
            break;

        default:
            log_variadic_message(LMT_ERROR, _("The server '%s' has run into an error (%u)..."),
                                 desc, error);
            goto comm_error;
            break;

    }

    client->can_get_updates = false;

    client->update = g_thread_try_new("cdb_client", (GThreadFunc)g_hub_client_update, client, NULL);
    if (client->update == NULL)
    {
        log_variadic_message(LMT_ERROR, _("Failed to start a listening thread for the server '%s'!"),
                             desc);
        goto comm_error;
    }

    exit_packed_buffer(&out_pbuf);
    exit_packed_buffer(&in_pbuf);

    return true;

 comm_error:

    exit_packed_buffer(&in_pbuf);

 setup_error:

    exit_packed_buffer(&out_pbuf);

 ssl_error:

    SSL_free(client->tls_fd);
    client->tls_fd = NULL;

 tls_error:

    SSL_CTX_free(client->tls_ctx);
    client->tls_ctx = NULL;

 quick_error:

    return false;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                                                                             *
*  Description : Assure l'accueil des nouvelles mises à jour.                 *
*                                                                             *
*  Retour      : NULL.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void *g_hub_client_update(GHubClient *client)
{
    packed_buffer out_pbuf;                 /* Tampon d'émission           */
    bool status;                            /* Bilan d'une opération       */
    struct pollfd fds;                      /* Surveillance des flux       */
    packed_buffer in_pbuf;                  /* Tampon de réception         */
    int ret;                                /* Bilan d'un appel            */
    uint32_t tmp32;                         /* Valeur sur 32 bits          */
    uint32_t command;                       /* Commande de la requête      */
    DBError error;                          /* Bilan d'une commande passée */
    GDbCollection *collec;                  /* Collection visée au final   */
    uint8_t tmp8;                           /* Valeur sur 8 bits           */
    char *msg;                              /* Message d'erreur à imprimer */

    /**
     * Avant toute chose, on demande un stage d'actualisation !
     */

    init_packed_buffer(&out_pbuf);

    status = extend_packed_buffer(&out_pbuf, (uint32_t []) { DBC_GET_ALL_ITEMS }, sizeof(uint32_t), true);
    if (!status)
    {
        exit_packed_buffer(&out_pbuf);
        goto exit;
    }

    status = ssl_send_packed_buffer(&out_pbuf, client->tls_fd);
    if (!status)
    {
        log_simple_message(LMT_INFO, _("Failed to get all updates"));
        exit_packed_buffer(&out_pbuf);
        goto exit;
    }

    exit_packed_buffer(&out_pbuf);

    /**
     * Phase d'écoute continue...
     */

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

    init_packed_buffer(&in_pbuf);

    while (client->fd != -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;

        /**
         * Même chose, cf. "TCP: When is EPOLLHUP generated?"
         * https://stackoverflow.com/questions/52976152/tcp-when-is-epollhup-generated/52976327#52976327
         */

        if (fds.revents & (POLLHUP | POLLRDHUP))
            break;

        if (fds.revents & (POLLIN | POLLPRI))
        {
            reset_packed_buffer(&in_pbuf);

            status = ssl_recv_packed_buffer(&in_pbuf, client->tls_fd);
            if (!status) goto gdcu_bad_exchange;

 next_command:

            status = extract_packed_buffer(&in_pbuf, &command, sizeof(uint32_t), true);
            if (!status) goto gdcu_bad_exchange;

            switch (command)
            {
                case DBC_SAVE:

                    status = extract_packed_buffer(&in_pbuf, &tmp32, sizeof(uint32_t), true);
                    if (!status) goto gdcu_bad_exchange;

                    error = tmp32;

                    if (error == DBE_NONE)
                        log_variadic_message(LMT_INFO, _("Archive saved for binary '%s'"),
                                             get_rle_string(&client->hash));
                    else
                        log_variadic_message(LMT_ERROR, _("Failed to save the archive for binary '%s'"),
                                             get_rle_string(&client->hash));

                    break;

                case DBC_COLLECTION:

                    status = extract_packed_buffer(&in_pbuf, &tmp32, sizeof(uint32_t), true);
                    if (!status) goto gdcu_bad_exchange;

                    collec = find_collection_in_list(client->collections, tmp32);
                    if (collec == NULL) goto gdcu_bad_exchange;

                    if (client->can_get_updates)
                        status = g_db_collection_unpack(collec, &in_pbuf, NULL);
                    else
                        status = _g_db_collection_unpack(collec, &in_pbuf, (DBAction []) { 0 }, NULL);

                    if (!status) goto gdcu_bad_exchange;

                    break;

                case DBC_GET_ALL_ITEMS:
                    log_variadic_message(LMT_INFO,
                                         _("This command is not available on this side: 0x%08x"), command);
                    goto gdcu_bad_exchange;
                    break;

                case DBC_SET_ALL_ITEMS:

                    status = extract_packed_buffer(&in_pbuf, &tmp8, sizeof(uint8_t), true);
                    if (!status) goto gdcu_bad_exchange;

                    client->can_get_updates = (tmp8 == 0x1);
                    break;

            }

            if (has_more_data_in_packed_buffer(&in_pbuf))
                goto next_command;

            client->can_get_updates = true;
            continue;

 gdcu_bad_exchange:

            asprintf(&msg, _("Bad reception from %s"), client->desc);

            LOG_ERROR(LMT_ERROR, msg);

            free(msg);

            break;

        }

    }

 exit:

    g_hub_client_stop(client);

    exit_packed_buffer(&in_pbuf);

    return NULL;

}


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

void g_hub_client_stop(GHubClient *client)
{
    int fd;                                 /* Canal à clôturer            */
    int ret;                                /* Bilan d'un appel            */

    /* Canal de communication */

    if (client->fd == -1)
    {
        /**
         * Si la fermture est forcée, le thread de traitement va terminer en erreur.
         * Donc cette fonction sera appelée deux fois. Seule la première va affecter
         * le contexte, donc on le peut pas s'assurer de la condition suivante dans
         * tous les cas.
         */

        /*assert(client->tls_ctx == NULL);*/
        return;
    }

    fd = client->fd;

    client->fd = -1;

    ret = close(fd);
    if (ret == -1) LOG_ERROR_N("close");

    if (g_thread_self() != client->update)
        g_thread_join(client->update);

    /* Environnement TLS */

    SSL_free(client->tls_fd);
    client->tls_fd = NULL;

    SSL_CTX_free(client->tls_ctx);
    client->tls_ctx = NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                                                                             *
*  Description : Identifie le canal de communication pour envois au serveur.  *
*                                                                             *
*  Retour      : Descripteur de flux normalement ouvert.                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static SSL *g_hub_client_get_ssl_fd(GHubClient *client)
{
    SSL *result;                            /* Canal à retourner           */
#ifndef NDEBUG
    int ret;                                /* Validation de transmission  */
#endif

    g_mutex_lock(&client->sending_lock);

    result = client->tls_fd;

    if (result == NULL)
        g_mutex_unlock(&client->sending_lock);

    else
    {
#ifndef NDEBUG
        ret = SSL_up_ref(result);
        assert(ret == 1);
#else
        SSL_up_ref(result);
#endif
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                tls_fd = canal de communication SSL.                         *
*                                                                             *
*  Description : Marque le canal de communication comme disponible.           *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_hub_client_put_ssl_fd(GHubClient *client, SSL *tls_fd)
{
    g_mutex_unlock(&client->sending_lock);

    SSL_free(tls_fd);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                                                                             *
*  Description : Effectue une demande de sauvegarde de l'état courant.        *
*                                                                             *
*  Retour      : true si la commande a bien été envoyée, false sinon.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_hub_client_save(GHubClient *client)
{
    bool result;                            /* Bilan partiel à remonter    */
    packed_buffer out_pbuf;                 /* Tampon d'émission           */
    SSL *tls_fd;                            /* Canal de communication SSL  */

    init_packed_buffer(&out_pbuf);

    tls_fd = g_hub_client_get_ssl_fd(client);

    if (tls_fd == NULL)
        result = false;

    else
    {
        result = extend_packed_buffer(&out_pbuf, (uint32_t []) { DBC_SAVE }, sizeof(uint32_t), true);

        if (result)
            result = ssl_send_packed_buffer(&out_pbuf, tls_fd);

        g_hub_client_put_ssl_fd(client, tls_fd);

    }

    exit_packed_buffer(&out_pbuf);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client = client pour les accès distants à manipuler.         *
*                item   = élémnent à pousser vers un serveur de collection.   *
*                                                                             *
*  Description : Ajoute un élément à la collection d'un serveur.              *
*                                                                             *
*  Retour      : true si la commande a bien été envoyée, false sinon.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_hub_client_add_item(GHubClient *client, const GDbItem *item)
{
    bool result;                            /* Bilan partiel à remonter    */
    packed_buffer out_pbuf;                 /* Tampon d'émission           */
    SSL *tls_fd;                            /* Canal de communication SSL  */
    DBFeatures feature;                     /* Domaine de fonctionnalité   */
    GDbCollection *collec;                  /* Collection visée au final   */

    init_packed_buffer(&out_pbuf);

    tls_fd = g_hub_client_get_ssl_fd(client);

    if (tls_fd == NULL)
        result = false;

    else
    {
        feature = g_db_item_get_feature(item);

        collec = find_collection_in_list(client->collections, feature);
        if (collec == NULL)
        {
            result = false;
            goto bad_item_feature;
        }

        result = g_db_collection_pack(collec, &out_pbuf, DBA_ADD_ITEM, item);

        if (result)
            result = ssl_send_packed_buffer(&out_pbuf, tls_fd);

 bad_item_feature:

        g_hub_client_put_ssl_fd(client, tls_fd);

    }

    exit_packed_buffer(&out_pbuf);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : client    = client pour les accès distants à manipuler.      *
*                timestamp = date du dernier élément à garder comme actif.    *
*                                                                             *
*  Description : Active les éléments en amont d'un horodatage donné.          *
*                                                                             *
*  Retour      : true si la commande a bien été envoyée, false sinon.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_hub_client_set_last_active(GHubClient *client, timestamp_t timestamp)
{
    bool result;                            /* Bilan partiel à remonter    */
    packed_buffer out_pbuf;                 /* Tampon d'émission           */
    SSL *tls_fd;                            /* Canal de communication SSL  */

    init_packed_buffer(&out_pbuf);

    tls_fd = g_hub_client_get_ssl_fd(client);

    if (tls_fd == NULL)
        result = false;

    else
    {
        result = extend_packed_buffer(&out_pbuf, (uint32_t []) { DBC_SET_LAST_ACTIVE }, sizeof(uint32_t), true);

        if (result)
            result = pack_timestamp(&timestamp, &out_pbuf);

        if (result)
            result = ssl_send_packed_buffer(&out_pbuf, tls_fd);

        g_hub_client_put_ssl_fd(client, tls_fd);

    }

    exit_packed_buffer(&out_pbuf);

    return result;

}