messenger_api_message.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020--2026 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 <http://www.gnu.org/licenses/>.
 
   SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_MESSENGER_API_MESSAGE_H
#define GNUNET_MESSENGER_API_MESSAGE_H
 
#include "gnunet_common.h"
#include "gnunet_util_lib.h"
 
#include "gnunet_pils_service.h"
#include "gnunet_messenger_service.h"
 
#define GNUNET_MESSENGER_SALT_ANNOUNCEMENT_KEY \
        "gnunet-messenger-announcement-key-k*d-p!80"
#define GNUNET_MESSENGER_SALT_EPOCH_KEY \
        "gnunet-messenger-epoch-key-ePGN3bGR-}*i$<2"
#define GNUNET_MESSENGER_SALT_GROUP_KEY \
        "gnunet-messenger-group-key-L)&7{4i(WSEPpR-"
#define GNUNET_MESSENGER_SALT_SECRET_KEY \
        "gnunet-messenger-secret-key-}xJ(eTuk[+xu{S"
#define GNUNET_MESSENGER_SALT_ENCRYPTION_KEY \
        "gnunet-messenger-encryption-key-9*Qaj7A+zv"
 
#define GNUNET_MESSENGER_SALT_EPOCH_IV "gnunet-messenger-epoch-iv"
#define GNUNET_MESSENGER_SALT_ENCRYPTION_IV "gnunet-messenger-encryption-iv"
#define GNUNET_MESSENGER_SALT_SECRET_IV "gnunet-messenger-secret-iv"
 
#define GNUNET_MESSENGER_MAX_MESSAGE_SIZE (GNUNET_MAX_MESSAGE_SIZE \
                                           - GNUNET_MIN_MESSAGE_SIZE)
 
#define GNUNET_MESSENGER_PADDING_MIN (sizeof(uint16_t) + sizeof(char))
#define GNUNET_MESSENGER_PADDING_LEVEL0 (512)
#define GNUNET_MESSENGER_PADDING_LEVEL1 (4096)
#define GNUNET_MESSENGER_PADDING_LEVEL2 (32768)
 
enum GNUNET_MESSENGER_PackMode
{
  GNUNET_MESSENGER_PACK_MODE_ENVELOPE = 0x1,
  GNUNET_MESSENGER_PACK_MODE_UNKNOWN = 0x0,
};
 
struct GNUNET_MESSENGER_Message*
create_message (enum GNUNET_MESSENGER_MessageKind kind);
 
struct GNUNET_MESSENGER_Message*
copy_message (const struct GNUNET_MESSENGER_Message *message);
 
void
copy_message_header (struct GNUNET_MESSENGER_Message *message,
                     const struct GNUNET_MESSENGER_MessageHeader *header);
 
void
cleanup_message (struct GNUNET_MESSENGER_Message *message);
 
void
destroy_message (struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
is_message_session_bound (const struct GNUNET_MESSENGER_Message *message);
 
uint16_t
get_message_kind_size (enum GNUNET_MESSENGER_MessageKind kind,
                       enum GNUNET_GenericReturnValue include_header);
 
uint16_t
get_message_size (const struct GNUNET_MESSENGER_Message *message,
                  enum GNUNET_GenericReturnValue include_header);
 
void
encode_message_signature (const struct GNUNET_MESSENGER_Message *message,
                          uint16_t length,
                          char *buffer);
 
void
encode_message (const struct GNUNET_MESSENGER_Message *message,
                uint16_t length,
                char *buffer,
                enum GNUNET_GenericReturnValue include_header);
 
enum GNUNET_GenericReturnValue
decode_message (struct GNUNET_MESSENGER_Message *message,
                uint16_t length,
                const char *buffer,
                enum GNUNET_GenericReturnValue include_header,
                uint16_t *padding);
 
void
hash_message (const struct GNUNET_MESSENGER_Message *message,
              uint16_t length,
              const char *buffer,
              struct GNUNET_HashCode *hash);
 
void
sign_message (struct GNUNET_MESSENGER_Message *message,
              const struct GNUNET_HashCode *hash,
              const struct GNUNET_CRYPTO_BlindablePrivateKey *key);
 
struct GNUNET_PILS_Operation*
sign_message_by_peer (struct GNUNET_MESSENGER_Message *message,
                      const struct GNUNET_HashCode *hash,
                      struct GNUNET_PILS_Handle *pils,
                      const GNUNET_PILS_SignResultCallback sign_cb,
                      void *cls);
 
enum GNUNET_GenericReturnValue
sign_message_by_key (struct GNUNET_MESSENGER_Message *message,
                     const struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 
enum GNUNET_GenericReturnValue
verify_message (const struct GNUNET_MESSENGER_Message *message,
                const struct GNUNET_HashCode *hash,
                const struct GNUNET_CRYPTO_BlindablePublicKey *key);
 
enum GNUNET_GenericReturnValue
verify_message_by_peer (const struct GNUNET_MESSENGER_Message *message,
                        const struct GNUNET_HashCode *hash,
                        const struct GNUNET_PeerIdentity *identity);
 
enum GNUNET_GenericReturnValue
verify_message_by_key (const struct GNUNET_MESSENGER_Message *message,
                       const struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 
enum GNUNET_GenericReturnValue
encrypt_message (struct GNUNET_MESSENGER_Message *message,
                 const struct GNUNET_CRYPTO_HpkePublicKey *hpke_key);
 
enum GNUNET_GenericReturnValue
decrypt_message (struct GNUNET_MESSENGER_Message *message,
                 const struct GNUNET_CRYPTO_HpkePrivateKey *hpke_key);
 
struct GNUNET_MESSENGER_Message*
transcribe_message (const struct GNUNET_MESSENGER_Message *message,
                    const struct GNUNET_CRYPTO_BlindablePublicKey *key);
 
enum GNUNET_GenericReturnValue
encrypt_secret_message (struct GNUNET_MESSENGER_Message *message,
                        const union GNUNET_MESSENGER_EpochIdentifier *identifier
                        ,
                        const struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 
enum GNUNET_GenericReturnValue
decrypt_secret_message (struct GNUNET_MESSENGER_Message *message,
                        const struct GNUNET_CRYPTO_SymmetricSessionKey *key);
 
enum GNUNET_GenericReturnValue
read_transcript_message (struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
extract_access_message_key (const struct GNUNET_MESSENGER_Message *message,
                            const struct GNUNET_CRYPTO_HpkePrivateKey *key,
                            struct GNUNET_CRYPTO_SymmetricSessionKey *
                            shared_key);
 
enum GNUNET_GenericReturnValue
extract_authorization_message_key (struct GNUNET_MESSENGER_Message *message,
                                   const struct
                                   GNUNET_CRYPTO_SymmetricSessionKey *key,
                                   struct GNUNET_CRYPTO_SymmetricSessionKey *
                                   shared_key);
 
struct GNUNET_TIME_Relative
get_message_timeout (const struct GNUNET_MESSENGER_Message *message);
 
struct GNUNET_MQ_Envelope*
pack_message (struct GNUNET_MESSENGER_Message *message,
              struct GNUNET_HashCode *hash,
              enum GNUNET_MESSENGER_PackMode mode);
 
enum GNUNET_GenericReturnValue
is_peer_message (const struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
is_service_message (const struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
is_epoch_message (const struct GNUNET_MESSENGER_Message *message);
 
enum GNUNET_GenericReturnValue
filter_message_sending (const struct GNUNET_MESSENGER_Message *message);
 
const struct GNUNET_ShortHashCode*
get_message_discourse (const struct GNUNET_MESSENGER_Message *message);
 
#endif // GNUNET_MESSENGER_API_MESSAGE_H