/*
This file is part of GNUnet.
Copyright (C) 2020 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @author Tobias Frisch
* @file src/messenger/gnunet-service-messenger_service.h
* @brief GNUnet MESSENGER service
*/
#ifndef GNUNET_SERVICE_MESSENGER_SERVICE_H
#define GNUNET_SERVICE_MESSENGER_SERVICE_H
#include "platform.h"
#include "gnunet_configuration_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_container_lib.h"
#include "gnunet_disk_lib.h"
#include "gnunet_identity_service.h"
#include "messenger_api_ego.h"
#include "gnunet-service-messenger_list_handles.h"
#include "gnunet-service-messenger_contact.h"
#include "gnunet-service-messenger_room.h"
struct GNUNET_MESSENGER_Service
{
const struct GNUNET_CONFIGURATION_Handle *config;
struct GNUNET_SERVICE_Handle *service;
struct GNUNET_SCHEDULER_Task *shutdown;
char *dir;
struct GNUNET_CADET_Handle *cadet;
struct GNUNET_IDENTITY_Handle *identity;
struct GNUNET_CONTAINER_MultiHashMap *egos;
struct GNUNET_MESSENGER_ListHandles handles;
struct GNUNET_CONTAINER_MultiHashMap *contacts;
struct GNUNET_CONTAINER_MultiHashMap *rooms;
};
/**
* Creates and allocates a new service using a given config and a GNUnet service handle.
*
* @param config Configuration
* @param service_handle GNUnet service handle
* @return New service
*/
struct GNUNET_MESSENGER_Service*
create_service (const struct GNUNET_CONFIGURATION_Handle *config, struct GNUNET_SERVICE_Handle *service_handle);
/**
* Destroys a service and frees its memory fully.
*
* @param service Service
*/
void
destroy_service (struct GNUNET_MESSENGER_Service *service);
/**
* Lookups an EGO which was registered to a service under
* a specific identifier.
*
* @param service Service
* @param identifier Identifier string
* @return EGO or NULL
*/
struct GNUNET_MESSENGER_Ego*
lookup_service_ego (struct GNUNET_MESSENGER_Service *service, const char *identifier);
/**
* Updates the registration of an EGO to a service under
* a specific identifier with a new key.
*
* @param service Service
* @param identifier Identifier string
* @param key Private EGO key
*/
void
update_service_ego (struct GNUNET_MESSENGER_Service *service, const char *identifier,
const struct GNUNET_IDENTITY_PrivateKey* key);
/**
* Creates and adds a new handle to a service using a given message queue.
*
* @param service Service
* @param mq Message queue
* @return New handle
*/
struct GNUNET_MESSENGER_SrvHandle*
add_service_handle (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MQ_Handle *mq);
/**
* Removes a handle from a service and destroys it.
*
* @param service Service
* @param handle Handle
*/
void
remove_service_handle (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle);
/**
* Tries to write the peer identity of the peer running a service on to the peer
* parameter. The functions returns GNUNET_OK on success, otherwise GNUNET_SYSERR.
*
* @param service Service
* @param[out] peer Peer identity
* @return GNUNET_OK on success, otherwise GNUNET_SYSERR
*/
int
get_service_peer_identity (const struct GNUNET_MESSENGER_Service *service, struct GNUNET_PeerIdentity *peer);
/**
* Returns a contact of a service identified by a given public key. If no matching contact exists,
* it will tried to create one with the specific public key. If the function still fails to do so,
* NULL gets returned.
*
* @param service Service
* @param pubkey Public key of EGO
* @return Contact
*/
struct GNUNET_MESSENGER_SrvContact*
get_service_contact_by_pubkey (struct GNUNET_MESSENGER_Service *service, const struct GNUNET_IDENTITY_PublicKey *pubkey);
/**
* Changes the public key for a contact known to a service to a specific public key and
* updates local map entries to access the contact by its updated key.
*
* @param service Service
* @param contact Contact
* @param pubkey Public key of EGO
*/
void
swap_service_contact_by_pubkey (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvContact *contact,
const struct GNUNET_IDENTITY_PublicKey *pubkey);
/**
* Tries to generate and allocate a new unique member id for a given room of a service identified by its key.
* If the generation fails caused by too many tries of duplicates, it returns NULL.
*
* @param service Service
* @param key Key of room
* @return Newly generated member id or NULL
*/
struct GNUNET_ShortHashCode*
generate_service_new_member_id (struct GNUNET_MESSENGER_Service *service, const struct GNUNET_HashCode *key);
/**
* Returns the room identified by a given key for a service. If the service doesn't know any room
* using the given key, NULL gets returned.
*
* @param service Service
* @param key Key of room
* @return Room or NULL
*/
struct GNUNET_MESSENGER_SrvRoom*
get_service_room (struct GNUNET_MESSENGER_Service *service, const struct GNUNET_HashCode *key);
/**
* Tries to open a room using a given key for a service by a specific handle. The room will be
* created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.
*
* @param service Service
* @param handle Handle
* @param key Key of room
* @return GNUNET_YES on success, otherwise GNUNET_NO
*/
int
open_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle,
const struct GNUNET_HashCode *key);
/**
* Tries to enter a room using a given key for a service by a specific handle. The room will
* be created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.
*
* The room will be entered through the peer identitied by the peer identity provided as door parameter and
* a new connection will be made.
*
* @param service Service
* @param handle Handle
* @param door Peer identity
* @param key Key of room
* @return GNUNET_YES on success, otherwise GNUNET_NO
*/
int
entry_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle,
const struct GNUNET_PeerIdentity *door, const struct GNUNET_HashCode *key);
/**
* Tries to close a room using a given key for a service by a specific handle. The room will
* be created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.
*
* If the specific handle is currently the host of the room for this service, a new handle which is a member will
* take its place. Otherwise the room will be destroyed for this service.
*
* @param service Service
* @param handle Handle
* @param key Key of room
* @return GNUNET_YES on success, otherwise GNUNET_NO
*/
int
close_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle,
const struct GNUNET_HashCode *key);
/**
* Loads the local configuration for a given room of a service which contains the last messages hash
* and the ruleset for general access of new members.
*
* @param service Service
* @param room Room
*/
void
load_service_room_and_messages (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvRoom *room);
/**
* Saves the configuration for a given room of a service which contains the last messages hash
* and the ruleset for general access of new members locally.
*
* @param service Service
* @param room Room
*/
void
save_service_room_and_messages (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvRoom *room);
/**
* Sends a received or sent message with a given hash to each handle of a service which
* is currently member of a specific room for handling it in the client API.
*
* @param service Service
* @param room Room
* @param message Message
* @param hash Hash of message
*/
void
handle_service_message (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvRoom *room,
const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash);
#endif //GNUNET_SERVICE_MESSENGER_SERVICE_H