cadet_protocol.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2007 - 2017 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 CADET_PROTOCOL_H_
#define CADET_PROTOCOL_H_
 
#define DEBUG_KX 0
#if DEBUG_KX
#warning NEVER run this in production! KX debugging is on!
#endif
 
#include "platform.h"
#include "gnunet_util_lib.h"
#include "cadet.h"
 
#ifdef __cplusplus
 
struct GNUNET_CADET_TunnelMessage;
extern "C"
{
#if 0
/* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
/******************************************************************************/
/********************      CADET NETWORK MESSAGES     **************************/
/******************************************************************************/
 
GNUNET_NETWORK_STRUCT_BEGIN
 
 
/******************************************************************************/
/*****************************   CONNECTION  **********************************/
/******************************************************************************/
 
 
struct GNUNET_CADET_ConnectionCreateMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t options GNUNET_PACKED;
 
  int has_monotime;
 
  struct GNUNET_TIME_AbsoluteNBO monotime;
 
  struct GNUNET_CRYPTO_EddsaSignature monotime_sig;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
 
  /* struct GNUNET_PeerIdentity peers[path_length]; */
};
 
 
struct GNUNET_CADET_ConnectionCreateAckMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
};
 
 
struct GNUNET_CADET_ConnectionBrokenMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
 
  struct GNUNET_PeerIdentity peer1;
 
  struct GNUNET_PeerIdentity peer2;
};
 
 
struct GNUNET_CADET_ConnectionDestroyMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
};
 
 
/******************************************************************************/
/*******************************   TUNNEL   ***********************************/
/******************************************************************************/
 
struct CadetEncryptedMessageIdentifier
{
  uint32_t pid GNUNET_PACKED;
};
 
 
enum GNUNET_CADET_KX_Flags
{
  GNUNET_CADET_KX_FLAG_NONE = 0,
 
  GNUNET_CADET_KX_FLAG_FORCE_REPLY = 1
};
 
 
struct GNUNET_CADET_TunnelKeyExchangeMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t flags GNUNET_PACKED;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
 
  struct GNUNET_CRYPTO_EcdhePublicKey ephemeral_key;
 
#if DEBUG_KX
  struct GNUNET_CRYPTO_EcdhePrivateKey ephemeral_key_XXX; // for debugging KX-crypto!
 
  struct GNUNET_CRYPTO_EddsaPrivateKey private_key_XXX; // for debugging KX-crypto!
#endif
 
  struct GNUNET_CRYPTO_EcdhePublicKey ratchet_key;
};
 
 
struct GNUNET_CADET_TunnelKeyExchangeAuthMessage
{
  struct GNUNET_CADET_TunnelKeyExchangeMessage kx;
 
#if DEBUG_KX
  struct GNUNET_CRYPTO_EcdhePublicKey r_ephemeral_key_XXX; // for debugging KX-crypto!
#endif
 
  struct GNUNET_HashCode auth;
};
 
 
struct GNUNET_CADET_AxHeader
{
  uint32_t Ns GNUNET_PACKED;
 
  uint32_t PNs GNUNET_PACKED;
 
  struct GNUNET_CRYPTO_EcdhePublicKey DHRs;
};
 
 
struct GNUNET_CADET_TunnelEncryptedMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ConnectionTunnelIdentifier cid;
 
  struct GNUNET_ShortHashCode hmac;
 
  struct GNUNET_CADET_AxHeader ax_header;
 
};
 
 
/******************************************************************************/
/*******************************   CHANNEL  ***********************************/
/******************************************************************************/
 
 
struct GNUNET_CADET_ChannelOpenMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t opt GNUNET_PACKED;
 
  struct GNUNET_HashCode h_port;
 
  struct GNUNET_CADET_ChannelTunnelNumber ctn;
};
 
 
struct GNUNET_CADET_ChannelOpenAckMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ChannelTunnelNumber ctn;
 
  struct GNUNET_HashCode port;
};
 
 
struct GNUNET_CADET_ChannelDestroyMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t reserved GNUNET_PACKED;
 
  struct GNUNET_CADET_ChannelTunnelNumber ctn;
};
 
 
struct ChannelMessageIdentifier
{
  uint32_t mid GNUNET_PACKED;
};
 
 
struct GNUNET_CADET_ChannelAppDataMessage
{
  struct GNUNET_MessageHeader header;
 
  struct ChannelMessageIdentifier mid;
 
  struct GNUNET_CADET_ChannelTunnelNumber ctn;
 
};
 
 
struct GNUNET_CADET_ChannelDataAckMessage
{
  struct GNUNET_MessageHeader header;
 
  struct GNUNET_CADET_ChannelTunnelNumber ctn;
 
  uint64_t futures GNUNET_PACKED;
 
  struct ChannelMessageIdentifier mid;
};
 
 
GNUNET_NETWORK_STRUCT_END
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef CADET_PROTOCOL_H */
#endif
/* end of cadet_protocol.h */