gnunet_core_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-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 GNUNET_CORE_SERVICE_H
#define GNUNET_CORE_SERVICE_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
#define GNUNET_CORE_SVC_INFO_LEN 64
 
enum GNUNET_CORE_PeerClass
{
  GNUNET_CORE_CLASS_UNKNOWN,
 
  GNUNET_CORE_CLASS_UNWILLING,
 
  GNUNET_CORE_CLASS_MOBILE,
 
  GNUNET_CORE_CLASS_DESKTOP,
 
  GNUNET_CORE_CLASS_ROUTER,
 
  GNUNET_CORE_CLASS_SERVER
};
 
 
enum GNUNET_CORE_Service
{
  GNUNET_CORE_SERVICE_CADET,
 
  GNUNET_CORE_SERVICE_FS,
 
  GNUNET_CORE_SERVICE_DHT,
 
  GNUNET_CORE_SERVICE_NSE,
 
  GNUNET_CORE_SERVICE_REVOCATION,
 
  GNUNET_CORE_SERVICE_HOSTLIST,
 
  GNUNET_CORE_SERVICE_TOPOLOGY,
 
  GNUNET_CORE_SERVICE_RPS,
 
  // Note: Services using core need to define their own Identifier here
 
  GNUNET_CORE_SERVICE_TEST
};
 
struct GNUNET_CORE_ServiceVersion
{
  uint32_t major;
 
  uint32_t minor;
 
  // uint32_t patch;
};
 
 
struct GNUNET_CORE_ServiceInfo
{
  enum GNUNET_CORE_Service service;
 
  struct GNUNET_CORE_ServiceVersion version;
 
  struct GNUNET_CORE_ServiceVersion version_max;
 
  struct GNUNET_CORE_ServiceVersion version_min;
};
 
 
#define GNUNET_CORE_VERSION 0x00000001
#define CONG_CRYPTO_ENABLED 0
 
GNUNET_NETWORK_STRUCT_BEGIN
 
 
struct EphemeralKeyMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t sender_status GNUNET_PACKED;
 
  struct GNUNET_CRYPTO_EddsaSignature signature;
 
  struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 
  struct GNUNET_TIME_AbsoluteNBO creation_time;
 
  struct GNUNET_TIME_AbsoluteNBO expiration_time;
 
  struct GNUNET_CRYPTO_EcdhePublicKey ephemeral_key;
 
  struct GNUNET_PeerIdentity origin_identity;
};
 
#if CONG_CRYPTO_ENABLED
struct PingMessage
{
  struct GNUNET_MessageHeader header;
 
  unsigned char nonce[crypto_aead_xchacha20poly1305_ietf_NPUBBYTES];
 
  unsigned char tag[crypto_aead_xchacha20poly1305_ietf_ABYTES];
 
  struct GNUNET_PeerIdentity target;
 
  uint32_t challenge GNUNET_PACKED;
};
 
 
struct PongMessage
{
  struct GNUNET_MessageHeader header;
 
  unsigned char nonce[crypto_aead_xchacha20poly1305_ietf_NPUBBYTES];
 
  unsigned char tag[crypto_aead_xchacha20poly1305_ietf_ABYTES];
 
 
  uint32_t challenge GNUNET_PACKED;
 
  uint32_t reserved;
 
  struct GNUNET_PeerIdentity target;
 
  enum GNUNET_CORE_PeerClass peer_class;
};
 
#else
 
struct PingMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t iv_seed GNUNET_PACKED;
 
  struct GNUNET_PeerIdentity target;
 
  uint32_t challenge GNUNET_PACKED;
};
 
 
struct PongMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t iv_seed GNUNET_PACKED;
 
  uint32_t challenge GNUNET_PACKED;
 
  uint32_t reserved;
 
  struct GNUNET_PeerIdentity target;
 
  enum GNUNET_CORE_PeerClass peer_class;
};
 
#endif
 
GNUNET_NETWORK_STRUCT_END
 
struct GNUNET_CORE_Handle;
 
 
typedef void *(*GNUNET_CORE_ConnectEventHandler) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  struct GNUNET_MQ_Handle *mq,
  enum GNUNET_CORE_PeerClass class);
 
 
typedef void (*GNUNET_CORE_DisconnectEventHandler) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  void *peer_cls);
 
 
typedef void (*GNUNET_CORE_StartupCallback) (
  void *cls,
  const struct GNUNET_PeerIdentity *my_identity);
 
 
struct GNUNET_CORE_Handle *
GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                     void *cls,
                     GNUNET_CORE_StartupCallback init,
                     GNUNET_CORE_ConnectEventHandler connects,
                     GNUNET_CORE_DisconnectEventHandler disconnects,
                     const struct GNUNET_MQ_MessageHandler *handlers,
                     struct GNUNET_CORE_ServiceInfo *service_info);
 
 
void
GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 
 
struct GNUNET_MQ_Handle *
GNUNET_CORE_get_mq (const struct GNUNET_CORE_Handle *h,
                    const struct GNUNET_PeerIdentity *pid);
 
 
struct GNUNET_CORE_MonitorHandle;
 
 
enum GNUNET_CORE_KxState
{
  GNUNET_CORE_KX_STATE_DOWN = 0,
 
  GNUNET_CORE_KX_STATE_INITIATOR_HELLO_SENT,
 
  GNUNET_CORE_KX_STATE_AWAIT_INITIATION,
 
  GNUNET_CORE_KX_STATE_INITIATOR_HELLO_RECEIVED,
 
  GNUNET_CORE_KX_STATE_RESPONDER_HELLO_SENT,
 
  GNUNET_CORE_KX_STATE_RESPONDER_HELLO_RECEIVED,
 
  GNUNET_CORE_KX_STATE_INITIATOR_DONE_SENT,
 
  GNUNET_CORE_KX_STATE_INITIATOR_CONNECTED,
 
  GNUNET_CORE_KX_STATE_RESPONDER_CONNECTED,
 
  GNUNET_CORE_KX_STATE_REKEY_SENT,
 
  GNUNET_CORE_KX_PEER_DISCONNECT,
 
  GNUNET_CORE_KX_ITERATION_FINISHED,
 
  GNUNET_CORE_KX_CORE_DISCONNECT
};
 
 
typedef void (*GNUNET_CORE_MonitorCallback) (
  void *cls,
  const struct GNUNET_PeerIdentity *pid,
  enum GNUNET_CORE_KxState state,
  struct GNUNET_TIME_Absolute timeout);
 
 
struct GNUNET_CORE_MonitorHandle *
GNUNET_CORE_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
                           GNUNET_CORE_MonitorCallback peer_cb,
                           void *peer_cb_cls);
 
 
void
GNUNET_CORE_monitor_stop (struct GNUNET_CORE_MonitorHandle *mh);
 
 
int
GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
                                    const struct GNUNET_PeerIdentity *pid);
 
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_CORE_SERVICE_H */
#endif
 /* end of group core */
 /* end of backbone addition */
 
/* end of gnunet_core_service.h */