src/include/gnunet_psyc_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012, 2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_psyc_service.h
  23  * @brief PSYC service; high-level access to the PSYC protocol
  24  *        note that clients of this API are NOT expected to
  25  *        understand the PSYC message format, only the semantics!
  26  *        Parsing (and serializing) the PSYC stream format is done
  27  *        within the implementation of the libgnunetpsyc library,
  28  *        and this API deliberately exposes as little as possible
  29  *        of the actual data stream format to the application!
  30  * @author Christian Grothoff
  31  * @author Gabor X Toth
  32  *
  33  * NOTE:
  34  * - this API does not know about psyc's "root" and "places";
  35  *   there is no 'root' in GNUnet-Psyc as we're decentralized;
  36  *   'places' and 'persons' are combined within the same
  37  *   abstraction, that of a "channel".  Channels are identified
  38  *   and accessed in this API using a public/private key.
  39  *   Higher-level applications should use NAMES within GNS
  40  *   to obtain public keys, and the distinction between
  41  *   'places' and 'persons' can then be made with the help
  42  *   of the naming system (and/or conventions).
  43  *   Channels are (as in PSYC) organized into a hierarchy; each
  44  *   channel master (the one with the private key) is then
  45  *   the operator of the multicast group (its Origin in
  46  *   the terminology of the multicast API).
  47  * - The API supports passing large amounts of data using
  48  *   'streaming' for the argument passed to a method.  State
  49  *   and variables must fit into memory and cannot be streamed
  50  *   (thus, no passing of 4 GB of data in a variable;
  51  *   once we implement this, we might want to create a
  52  *   @c \#define for the maximum size of a variable).
  53  * - PSYC defines standard variables, methods, etc.  This
  54  *   library deliberately abstracts over all of these; a
  55  *   higher-level API should combine the naming system (GNS)
  56  *   and standard methods (message, join, part, warn,
  57  *   fail, error) and variables (action, color, time,
  58  *   tag, etc.).  However, this API does take over the
  59  *   routing variables, specifically 'context' (channel),
  60  *   and 'source'.  We only kind-of support 'target', as
  61  *   the target is either everyone in the group or the
  62  *   origin, and never just a single member of the group;
  63  *   for such individual messages, an application needs to
  64  *   construct an 'inbox' channel where the master (only)
  65  *   receives messages (but never forwards; private responses
  66  *   would be transmitted by joining the senders 'inbox'
  67  *   channel -- or a inbox#bob subchannel).  The
  68  *   goal for all of this is to keep the abstractions in this
  69  *   API minimal: interaction with multicast, try \& slice,
  70  *   state/variable/channel management.  Higher-level
  71  *   operations belong elsewhere (so maybe this API should
  72  *   be called 'PSYC-low', whereas a higher-level API
  73  *   implementing defaults for standard methods and
  74  *   variables might be called 'PSYC-std' or 'PSYC-high'.
  75  */
  76
  77 #ifndef GNUNET_PSYC_SERVICE_H
  78 #define GNUNET_PSYC_SERVICE_H
  79
  80 #ifdef __cplusplus
  81 extern "C"
  82 {
  83 #if 0                           /* keep Emacsens' auto-indent happy */
  84 }
  85 #endif
  86 #endif
  87
  88 #include "gnunet_util_lib.h"
  89 #include "gnunet_env_lib.h"
  90 #include "gnunet_multicast_service.h"
  91
  92
  93 /**
  94  * Version number of GNUnet-PSYC API.
  95  */
  96 #define GNUNET_PSYC_VERSION 0x00000000
  97
  98
  99 /**
 100  * Policy flags for a channel.
 101  */
 102 enum GNUNET_PSYC_ChannelFlags
 103 {
 104   /**
 105    * Admission must be confirmed by the master.
 106    */
 107   GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL = 1 << 0,
 108
 109   /**
 110    * Past messages are only available to slaves who were admitted at the time
 111    * they were sent to the channel.
 112    */
 113   GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY = 1 << 1
 114 };
 115
 116
 117 /**
 118  * PSYC channel policies.
 119  */
 120 enum GNUNET_PSYC_Policy
 121 {
 122   /**
 123    * Anyone can join the channel, without announcing his presence;
 124    * all messages are always public and can be distributed freely.
 125    * Joins may be announced, but this is not required.
 126    */
 127   GNUNET_PSYC_CHANNEL_ANONYMOUS = 0,
 128
 129   /**
 130    * The master must approve membership to the channel, messages must only be
 131    * distributed to current channel slaves.  This includes the channel
 132    * state as well as transient messages.
 133    */
 134   GNUNET_PSYC_CHANNEL_PRIVATE
 135     = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL
 136     | GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY
 137
 138 #if IDEAS_FOR_FUTURE
 139   /**
 140    * Anyone can freely join the channel (no approval required);
 141    * however, messages must only be distributed to current channel
 142    * slaves, so the master must still acknowledge that the slave
 143    * joined before transient messages are delivered.  As approval is
 144    * guaranteed, the presistent channel state can be synchronized freely
 145    * immediately, prior to master confirmation.
 146    */
 147   GNUNET_PSYC_CHANNEL_OPEN
 148     = GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY,
 149
 150   /**
 151    * The master must approve joins to the channel, but past messages can be
 152    * freely distributed to slaves.
 153    */
 154   GNUNET_PSYC_CHANNEL_CLOSED
 155     = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL,
 156 #endif
 157 };
 158
 159
 160 enum GNUNET_PSYC_MessageFlags
 161 {
 162   /**
 163    * Historic message, retrieved from PSYCstore.
 164    */
 165   GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 0,
 166
 167   /**
 168    * Request from slave to master.
 169    */
 170   GNUNET_PSYC_MESSAGE_REQUEST = 1 << 1,
 171
 172   /**
 173    * Message can be delivered out of order.
 174    */
 175   GNUNET_PSYC_MESSAGE_ORDER_ANY = 1 << 2
 176 };
 177
 178
 179 /**
 180  * Values for the @a state_delta field of GNUNET_PSYC_MessageHeader.
 181  */
 182 enum GNUNET_PSYC_StateDeltaValues
 183 {
 184   GNUNET_PSYC_STATE_RESET = 0,
 185
 186   GNUNET_PSYC_STATE_NOT_MODIFIED = UINT64_MAX
 187 };
 188
 189
 190 GNUNET_NETWORK_STRUCT_BEGIN
 191
 192 /**
 193  * A PSYC message.
 194  *
 195  * Used for single-fragment messages e.g. in a join request or response.
 196  */
 197 struct GNUNET_PSYC_Message
 198 {
 199   /**
 200    * Message header with size and type information.
 201    */
 202   struct GNUNET_MessageHeader header;
 203
 204   /* Followed by concatenated PSYC message parts:
 205    * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
 206    */
 207 };
 208
 209
 210 /**
 211  * Header of a PSYC message.
 212  *
 213  * Only present when receiving a message.
 214  */
 215 struct GNUNET_PSYC_MessageHeader
 216 {
 217   /**
 218    * Generic message header with size and type information.
 219    */
 220   struct GNUNET_MessageHeader header;
 221
 222   /**
 223    * Flags for this message fragment.
 224    *
 225    * @see enum GNUNET_PSYC_MessageFlags
 226    */
 227   uint32_t flags GNUNET_PACKED;
 228
 229   /**
 230    * Number of the message this message part belongs to.
 231    * Monotonically increasing from 1.
 232    */
 233   uint64_t message_id GNUNET_PACKED;
 234
 235   /**
 236    * Byte offset of this @e fragment of the @e message.
 237    * FIXME: use data_offset instead
 238    */
 239   uint64_t fragment_offset GNUNET_PACKED;
 240
 241   /**
 242    * Sending slave's public key.
 243    * Not set if the message is from the master.
 244    */
 245   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 246
 247   /* Followed by concatenated PSYC message parts:
 248    * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
 249    */
 250 };
 251
 252
 253 /**
 254  * The method of a message.
 255  */
 256 struct GNUNET_PSYC_MessageMethod
 257 {
 258   /**
 259    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 260    */
 261   struct GNUNET_MessageHeader header;
 262
 263   /**
 264    * OR'ed GNUNET_PSYC_MasterTransmitFlags
 265    */
 266   uint32_t flags GNUNET_PACKED;
 267
 268   /**
 269    * Number of message IDs since the last message that contained state
 270    * operations. @see enum GNUNET_PSYC_StateDeltaValues
 271    */
 272   uint64_t state_delta GNUNET_PACKED;
 273
 274   /* Followed by NUL-terminated method name. */
 275 };
 276
 277
 278 /**
 279  * A modifier of a message.
 280  */
 281 struct GNUNET_PSYC_MessageModifier
 282 {
 283   /**
 284    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 285    */
 286   struct GNUNET_MessageHeader header;
 287
 288   /**
 289    * Size of value.
 290    */
 291   uint32_t value_size GNUNET_PACKED;
 292
 293   /**
 294    * Size of name, including NUL terminator.
 295    */
 296   uint16_t name_size GNUNET_PACKED;
 297
 298   /**
 299    * enum GNUNET_ENV_Operator
 300    */
 301   uint8_t oper;
 302
 303   /* Followed by NUL-terminated name, then the value. */
 304 };
 305
 306
 307 struct GNUNET_PSYC_CountersResultMessage
 308 {
 309   /**
 310    * Type: GNUNET_MESSAGE_TYPE_PSYC_RESULT_COUNTERS
 311    */
 312   struct GNUNET_MessageHeader header;
 313
 314   /**
 315    * Status code for the operation.
 316    */
 317   int32_t result_code GNUNET_PACKED;
 318
 319   /**
 320    * Last message ID sent to the channel.
 321    */
 322   uint64_t max_message_id;
 323 };
 324
 325
 326 /**
 327  * Join request sent to a PSYC master.
 328  */
 329 struct GNUNET_PSYC_JoinRequestMessage
 330 {
 331   /**
 332    * Type: GNUNET_MESSAGE_TYPE_PSYC_MASTER_JOIN_REQUEST
 333    */
 334   struct GNUNET_MessageHeader header;
 335   /**
 336    * Public key of the joining slave.
 337    */
 338   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 339
 340   /* Followed by struct GNUNET_MessageHeader join_request */
 341 };
 342
 343
 344 /**
 345  * Join decision sent in reply to a join request.
 346  */
 347 struct GNUNET_PSYC_JoinDecisionMessage
 348 {
 349   /**
 350    * Type: GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION
 351    */
 352   struct GNUNET_MessageHeader header;
 353
 354   /**
 355    * #GNUNET_YES if the slave was admitted.
 356    */
 357   int32_t is_admitted;
 358
 359   /**
 360    * Public key of the joining slave.
 361    * Only set when the master is sending the decision,
 362    * not set when a slave is receiving it.
 363    */
 364   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 365
 366   /* Followed by struct GNUNET_MessageHeader join_response */
 367 };
 368
 369 GNUNET_NETWORK_STRUCT_END
 370
 371
 372 #define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD        \
 373   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 374   - sizeof (struct GNUNET_PSYC_MessageModifier)
 375
 376 #define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD        \
 377   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 378   - sizeof (struct GNUNET_MessageHeader)
 379
 380 #define GNUNET_PSYC_DATA_MAX_PAYLOAD            \
 381   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 382   - sizeof (struct GNUNET_MessageHeader)
 383
 384
 385 /**
 386  * PSYC message part processing states.
 387  */
 388 enum GNUNET_PSYC_MessageState
 389 {
 390   GNUNET_PSYC_MESSAGE_STATE_START    = 0,
 391   GNUNET_PSYC_MESSAGE_STATE_HEADER   = 1,
 392   GNUNET_PSYC_MESSAGE_STATE_METHOD   = 2,
 393   GNUNET_PSYC_MESSAGE_STATE_MODIFIER = 3,
 394   GNUNET_PSYC_MESSAGE_STATE_MOD_CONT = 4,
 395   GNUNET_PSYC_MESSAGE_STATE_DATA     = 5,
 396   GNUNET_PSYC_MESSAGE_STATE_END      = 6,
 397   GNUNET_PSYC_MESSAGE_STATE_CANCEL   = 7,
 398   GNUNET_PSYC_MESSAGE_STATE_ERROR    = 8,
 399 };
 400
 401
 402 /**
 403  * Handle that identifies a join request.
 404  *
 405  * Used to match calls to #GNUNET_PSYC_JoinCallback to the
 406  * corresponding calls to GNUNET_PSYC_join_decision().
 407  */
 408 struct GNUNET_PSYC_JoinHandle;
 409
 410
 411 /**
 412  * Method called from PSYC upon receiving a message.
 413  *
 414  * @param cls  Closure.
 415  * @param message_id  Sequence number of the message.
 416  * @param flags  OR'ed GNUNET_PSYC_MessageFlags
 417  * @param msg  Message part, one of the following types:
 418  */
 419 typedef void
 420 (*GNUNET_PSYC_MessageCallback) (void *cls,
 421                                 uint64_t message_id,
 422                                 uint32_t flags,
 423                                 const struct GNUNET_PSYC_MessageHeader *msg);
 424
 425
 426 /**
 427  * Method called from PSYC upon receiving part of a message.
 428  *
 429  * @param cls  Closure.
 430  * @param message_id  Sequence number of the message.
 431  * @param data_offset  Byte offset of data, only set if @a msg has a type
 432  *                     #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
 433  * @param flags  OR'ed GNUNET_PSYC_MessageFlags
 434  * @param msg  Message part, one of the following types:
 435  * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
 436  * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 437  * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 438  * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
 439  * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
 440  * or NULL if an error occurred while receiving a message.
 441  */
 442 typedef void
 443 (*GNUNET_PSYC_MessagePartCallback) (void *cls,
 444                                     uint64_t message_id,
 445                                     uint64_t data_offset,
 446                                     uint32_t flags,
 447                                     const struct GNUNET_MessageHeader *msg);
 448
 449
 450 /**
 451  * Method called from PSYC upon receiving a join request.
 452  *
 453  * @param cls  Closure.
 454  * @param slave_key  Public key of the slave requesting join.
 455  * @param join_msg  Join message sent along with the request.
 456  * @param jh  Join handle to use with GNUNET_PSYC_join_decision()
 457  */
 458 typedef void
 459 (*GNUNET_PSYC_JoinRequestCallback) (void *cls,
 460                                     const struct GNUNET_PSYC_JoinRequestMessage *req,
 461                                     const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
 462                                     const struct GNUNET_PSYC_Message *join_msg,
 463                                     struct GNUNET_PSYC_JoinHandle *jh);
 464
 465
 466 /**
 467  * Function to call with the decision made for a join request.
 468  *
 469  * Must be called once and only once in response to an invocation of the
 470  * #GNUNET_PSYC_JoinCallback.
 471  *
 472  * @param jh  Join request handle.
 473  * @param is_admitted
 474  *   #GNUNET_YES    if the join is approved,
 475  *   #GNUNET_NO     if it is disapproved,
 476  *   #GNUNET_SYSERR if we cannot answer the request.
 477  * @param relay_count  Number of relays given.
 478  * @param relays  Array of suggested peers that might be useful relays to use
 479  *        when joining the multicast group (essentially a list of peers that
 480  *        are already part of the multicast group and might thus be willing
 481  *        to help with routing).  If empty, only this local peer (which must
 482  *        be the multicast origin) is a good candidate for building the
 483  *        multicast tree.  Note that it is unnecessary to specify our own
 484  *        peer identity in this array.
 485  * @param join_resp  Application-dependent join response message to send along
 486  *        with the decision.
 487  *
 488  * @return #GNUNET_OK on success,
 489  *         #GNUNET_SYSERR if @a join_resp is too large.
 490  */
 491 int
 492 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
 493                            int is_admitted,
 494                            uint32_t relay_count,
 495                            const struct GNUNET_PeerIdentity *relays,
 496                            const struct GNUNET_PSYC_Message *join_resp);
 497
 498
 499 /**
 500  * Handle for the master of a PSYC channel.
 501  */
 502 struct GNUNET_PSYC_Master;
 503
 504
 505 /**
 506  * Function called after the channel master started.
 507  *
 508  * @param cls Closure.
 509  * @param max_message_id Last message ID sent to the channel.
 510  */
 511 typedef void
 512 (*GNUNET_PSYC_MasterStartCallback) (void *cls, uint64_t max_message_id);
 513
 514
 515 /**
 516  * Start a PSYC master channel.
 517  *
 518  * Will start a multicast group identified by the given ECC key.  Messages
 519  * received from group members will be given to the respective handler methods.
 520  * If a new member wants to join a group, the "join" method handler will be
 521  * invoked; the join handler must then generate a "join" message to approve the
 522  * joining of the new member.  The channel can also change group membership
 523  * without explicit requests.  Note that PSYC doesn't itself "understand" join
 524  * or part messages, the respective methods must call other PSYC functions to
 525  * inform PSYC about the meaning of the respective events.
 526  *
 527  * @param cfg  Configuration to use (to connect to PSYC service).
 528  * @param channel_key  ECC key that will be used to sign messages for this
 529  *        PSYC session. The public key is used to identify the PSYC channel.
 530  *        Note that end-users will usually not use the private key directly, but
 531  *        rather look it up in GNS for places managed by other users, or select
 532  *        a file with the private key(s) when setting up their own channels
 533  *        FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
 534  *        one in the future.
 535  * @param policy  Channel policy specifying join and history restrictions.
 536  *        Used to automate join decisions.
 537  * @param master_start_cb  Function to invoke after the channel master started.
 538  * @param join_request_cb  Function to invoke when a slave wants to join.
 539  * @param message_cb  Function to invoke on message parts sent to the channel
 540  *        and received from slaves
 541  * @param cls  Closure for @a method and @a join_cb.
 542  *
 543  * @return Handle for the channel master, NULL on error.
 544  */
 545 struct GNUNET_PSYC_Master *
 546 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 547                           const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
 548                           enum GNUNET_PSYC_Policy policy,
 549                           GNUNET_PSYC_MasterStartCallback master_start_cb,
 550                           GNUNET_PSYC_JoinRequestCallback join_request_cb,
 551                           GNUNET_PSYC_MessageCallback message_cb,
 552                           GNUNET_PSYC_MessagePartCallback message_part_cb,
 553                           void *cls);
 554
 555
 556 /**
 557  * Function called to provide data for a transmission via PSYC.
 558  *
 559  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 560  * invalidates the respective transmission handle.
 561  *
 562  * @param cls Closure.
 563  * @param[in,out] data_size Initially set to the number of bytes available in
 564  *        @a data, should be set to the number of bytes written to data.
 565  * @param[out] data Where to write the body of the message to give to the
 566  *         method. The function must copy at most @a data_size bytes to @a data.
 567  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 568  *         #GNUNET_NO on success, if more data is to be transmitted later.
 569  *         Should be used if @a data_size was not big enough to take all the
 570  *         data.  If 0 is returned in @a data_size the transmission is paused,
 571  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 572  *         #GNUNET_YES if this completes the transmission (all data supplied)
 573  */
 574 typedef int
 575 (*GNUNET_PSYC_TransmitNotifyData) (void *cls,
 576                                    uint16_t *data_size,
 577                                    void *data);
 578
 579 /**
 580  * Function called to provide a modifier for a transmission via PSYC.
 581  *
 582  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 583  * invalidates the respective transmission handle.
 584  *
 585  * @param cls Closure.
 586  * @param[in,out] data_size  Initially set to the number of bytes available in
 587  *         @a data, should be set to the number of bytes written to data.
 588  * @param[out] data  Where to write the modifier's name and value.
 589  *         The function must copy at most @a data_size bytes to @a data.
 590  *         When this callback is first called for a modifier, @a data should
 591  *         contain: "name\0value".  If the whole value does not fit, subsequent
 592  *         calls to this function should write continuations of the value to
 593  *         @a data.
 594  * @param[out] oper  Where to write the operator of the modifier.
 595  *         Only needed during the first call to this callback at the beginning
 596  *         of the modifier.  In case of subsequent calls asking for value
 597  *         continuations @a oper is set to #NULL.
 598  * @param[out] full_value_size  Where to write the full size of the value.
 599  *         Only needed during the first call to this callback at the beginning
 600  *         of the modifier.  In case of subsequent calls asking for value
 601  *         continuations @a value_size is set to #NULL.
 602  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 603  *         #GNUNET_NO on success, if more data is to be transmitted later.
 604  *         Should be used if @a data_size was not big enough to take all the
 605  *         data for the modifier's value (the name must be always returned
 606  *         during the first call to this callback).
 607  *         If 0 is returned in @a data_size the transmission is paused,
 608  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 609  *         #GNUNET_YES if this completes the modifier (the whole value is supplied).
 610  */
 611 typedef int
 612 (*GNUNET_PSYC_TransmitNotifyModifier) (void *cls,
 613                                        uint16_t *data_size,
 614                                        void *data,
 615                                        uint8_t *oper,
 616                                        uint32_t *full_value_size);
 617
 618 /**
 619  * Flags for transmitting messages to a channel by the master.
 620  */
 621 enum GNUNET_PSYC_MasterTransmitFlags
 622 {
 623   GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
 624
 625   /**
 626    * Whether this message should reset the channel state,
 627    * i.e. remove all previously stored state variables.
 628    */
 629
 630   GNUNET_PSYC_MASTER_TRANSMIT_STATE_RESET = 1 << 0,
 631
 632   /**
 633    * Whether this message contains any state modifiers.
 634    */
 635   GNUNET_PSYC_MASTER_TRANSMIT_STATE_MODIFY = 1 << 1,
 636
 637   /**
 638    * Add PSYC header variable with the hash of the current channel state.
 639    */
 640   GNUNET_PSYC_MASTER_TRANSMIT_STATE_HASH = 1 << 2,
 641
 642   /**
 643    * Whether we need to increment the group generation counter after
 644    * transmitting this message.
 645    */
 646   GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 3
 647 };
 648
 649
 650 /**
 651  * Handle for a pending PSYC transmission operation.
 652  */
 653 struct GNUNET_PSYC_MasterTransmitHandle;
 654
 655
 656 /**
 657  * Send a message to call a method to all members in the PSYC channel.
 658  *
 659  * @param master Handle to the PSYC channel.
 660  * @param method_name Which method should be invoked.
 661  * @param notify_mod Function to call to obtain modifiers.
 662  * @param notify_data Function to call to obtain fragments of the data.
 663  * @param notify_cls Closure for @a notify_mod and @a notify_data.
 664  * @param flags Flags for the message being transmitted.
 665  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 666  */
 667 struct GNUNET_PSYC_MasterTransmitHandle *
 668 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
 669                              const char *method_name,
 670                              GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 671                              GNUNET_PSYC_TransmitNotifyData notify_data,
 672                              void *notify_cls,
 673                              enum GNUNET_PSYC_MasterTransmitFlags flags);
 674
 675
 676 /**
 677  * Resume transmission to the channel.
 678  *
 679  * @param th Handle of the request that is being resumed.
 680  */
 681 void
 682 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
 683
 684
 685 /**
 686  * Abort transmission request to channel.
 687  *
 688  * @param th Handle of the request that is being aborted.
 689  */
 690 void
 691 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
 692
 693
 694 /**
 695  * Stop a PSYC master channel.
 696  *
 697  * @param master
 698  *        PSYC channel master to stop.
 699  * @param keep_active
 700  *        Keep place active after last application disconnected.
 701  * @param stop_cb
 702  *        Function called after the master stopped
 703  *        and disconnected from the psyc service.
 704  * @param stop_cls
 705  *        Closure for @a part_cb.
 706  */
 707 void
 708 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master,
 709                          int keep_active,
 710                          GNUNET_ContinuationCallback stop_cb,
 711                          void *stop_cls);
 712
 713
 714 /**
 715  * Handle for a PSYC channel slave.
 716  */
 717 struct GNUNET_PSYC_Slave;
 718
 719
 720 /**
 721  * Function called after the slave connected to the PSYC service.
 722  *
 723  * @param cls Closure.
 724  * @param max_message_id Last message ID sent to the channel.
 725  */
 726 typedef void
 727 (*GNUNET_PSYC_SlaveConnectCallback) (void *cls, uint64_t max_message_id);
 728
 729
 730 /**
 731  * Method called to inform about the decision in response to a join request.
 732  *
 733  * If @a is_admitted is not #GNUNET_YES, then sending messages to the channel is
 734  * not possible, but earlier history can be still queried.
 735  *
 736  * @param cls  Closure.
 737  * @param is_admitted  #GNUNET_YES or #GNUNET_NO or #GNUNET_SYSERR
 738  * @param join_msg  Application-dependent join message from the origin.
 739  */
 740 typedef void
 741 (*GNUNET_PSYC_JoinDecisionCallback) (void *cls,
 742                                      const struct GNUNET_PSYC_JoinDecisionMessage *dcsn,
 743                                      int is_admitted,
 744                                      const struct GNUNET_PSYC_Message *join_msg);
 745
 746
 747 /**
 748  * Join a PSYC channel.
 749  *
 750  * The entity joining is always the local peer.  The user must immediately use
 751  * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
 752  * channel; if the join request succeeds, the channel state (and @e recent
 753  * method calls) will be replayed to the joining member.  There is no explicit
 754  * notification on failure (as the channel may simply take days to approve,
 755  * and disapproval is simply being ignored).
 756  *
 757  * @param cfg  Configuration to use.
 758  * @param channel_key  ECC public key that identifies the channel we wish to join.
 759  * @param slave_key  ECC private-public key pair that identifies the slave, and
 760  *        used by multicast to sign the join request and subsequent unicast
 761  *        requests sent to the master.
 762  * @param origin  Peer identity of the origin.
 763  * @param relay_count  Number of peers in the @a relays array.
 764  * @param relays  Peer identities of members of the multicast group, which serve
 765  *        as relays and used to join the group at.
 766  * @param message_cb  Function to invoke on message parts received from the
 767  *        channel, typically at least contains method handlers for @e join and
 768  *        @e part.
 769  * @param slave_connect_cb  Function invoked once we have connected to the
 770  *        PSYC service.
 771  * @param join_decision_cb  Function invoked once we have received a join
 772  *        decision.
 773  * @param cls  Closure for @a message_cb and @a slave_joined_cb.
 774  * @param method_name  Method name for the join request.
 775  * @param env  Environment containing transient variables for the request, or NULL.
 776  * @param data  Payload for the join message.
 777  * @param data_size  Number of bytes in @a data.
 778  *
 779  * @return Handle for the slave, NULL on error.
 780  */
 781 struct GNUNET_PSYC_Slave *
 782 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
 783                         const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 784                         const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_key,
 785                         const struct GNUNET_PeerIdentity *origin,
 786                         uint32_t relay_count,
 787                         const struct GNUNET_PeerIdentity *relays,
 788                         GNUNET_PSYC_MessageCallback message_cb,
 789                         GNUNET_PSYC_MessagePartCallback message_part_cb,
 790                         GNUNET_PSYC_SlaveConnectCallback slave_connect_cb,
 791                         GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
 792                         void *cls,
 793                         const struct GNUNET_PSYC_Message *join_msg);
 794
 795
 796 /**
 797  * Part a PSYC channel.
 798  *
 799  * Will terminate the connection to the PSYC service.  Polite clients should
 800  * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
 801  *
 802  * @param slave
 803  *        Slave handle.
 804  * @param keep_active
 805  *        Keep place active after last application disconnected.
 806  * @param part_cb
 807  *        Function called after the slave parted the channel
 808  *        and disconnected from the psyc service.
 809  * @param part_cls
 810  *        Closure for @a part_cb.
 811  */
 812 void
 813 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave,
 814                         int keep_active,
 815                         GNUNET_ContinuationCallback part_cb,
 816                         void *part_cls);
 817
 818
 819 /**
 820  * Flags for transmitting messages to the channel master by a slave.
 821  */
 822 enum GNUNET_PSYC_SlaveTransmitFlags
 823 {
 824   GNUNET_PSYC_SLAVE_TRANSMIT_NONE = 0
 825 };
 826
 827
 828 /**
 829  * Handle for a pending PSYC transmission operation.
 830  */
 831 struct GNUNET_PSYC_SlaveTransmitHandle;
 832
 833
 834 /**
 835  * Request a message to be sent to the channel master.
 836  *
 837  * @param slave Slave handle.
 838  * @param method_name Which (PSYC) method should be invoked (on host).
 839  * @param notify_mod Function to call to obtain modifiers.
 840  * @param notify_data Function to call to obtain fragments of the data.
 841  * @param notify_cls Closure for @a notify.
 842  * @param flags Flags for the message being transmitted.
 843  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 844  */
 845 struct GNUNET_PSYC_SlaveTransmitHandle *
 846 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
 847                             const char *method_name,
 848                             GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 849                             GNUNET_PSYC_TransmitNotifyData notify_data,
 850                             void *notify_cls,
 851                             enum GNUNET_PSYC_SlaveTransmitFlags flags);
 852
 853
 854 /**
 855  * Resume transmission to the master.
 856  *
 857  * @param th Handle of the request that is being resumed.
 858  */
 859 void
 860 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *th);
 861
 862
 863 /**
 864  * Abort transmission request to master.
 865  *
 866  * @param th Handle of the request that is being aborted.
 867  */
 868 void
 869 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
 870
 871
 872 /**
 873  * Handle to access PSYC channel operations for both the master and slaves.
 874  */
 875 struct GNUNET_PSYC_Channel;
 876
 877
 878 /**
 879  * Convert a channel @a master to a @e channel handle to access the @e channel
 880  * APIs.
 881  *
 882  * @param master Channel master handle.
 883  * @return Channel handle, valid for as long as @a master is valid.
 884  */
 885 struct GNUNET_PSYC_Channel *
 886 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
 887
 888
 889 /**
 890  * Convert @a slave to a @e channel handle to access the @e channel APIs.
 891  *
 892  * @param slave Slave handle.
 893  * @return Channel handle, valid for as long as @a slave is valid.
 894  */
 895 struct GNUNET_PSYC_Channel *
 896 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
 897
 898
 899 /**
 900  * Add a slave to the channel's membership list.
 901  *
 902  * Note that this will NOT generate any PSYC traffic, it will merely update the
 903  * local database to modify how we react to <em>membership test</em> queries.
 904  * The channel master still needs to explicitly transmit a @e join message to
 905  * notify other channel members and they then also must still call this function
 906  * in their respective methods handling the @e join message.  This way, how @e
 907  * join and @e part operations are exactly implemented is still up to the
 908  * application; for example, there might be a @e part_all method to kick out
 909  * everyone.
 910  *
 911  * Note that channel slaves are explicitly trusted to execute such methods
 912  * correctly; not doing so correctly will result in either denying other slaves
 913  * access or offering access to channel data to non-members.
 914  *
 915  * @param channel Channel handle.
 916  * @param slave_key Identity of channel slave to add.
 917  * @param announced_at ID of the message that announced the membership change.
 918  * @param effective_since Addition of slave is in effect since this message ID.
 919  */
 920 void
 921 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
 922                                const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
 923                                uint64_t announced_at,
 924                                uint64_t effective_since);
 925
 926
 927 /**
 928  * Remove a slave from the channel's membership list.
 929  *
 930  * Note that this will NOT generate any PSYC traffic, it will merely update the
 931  * local database to modify how we react to <em>membership test</em> queries.
 932  * The channel master still needs to explicitly transmit a @e part message to
 933  * notify other channel members and they then also must still call this function
 934  * in their respective methods handling the @e part message.  This way, how
 935  * @e join and @e part operations are exactly implemented is still up to the
 936  * application; for example, there might be a @e part_all message to kick out
 937  * everyone.
 938  *
 939  * Note that channel members are explicitly trusted to perform these
 940  * operations correctly; not doing so correctly will result in either
 941  * denying members access or offering access to channel data to
 942  * non-members.
 943  *
 944  * @param channel Channel handle.
 945  * @param slave_key Identity of channel slave to remove.
 946  * @param announced_at ID of the message that announced the membership change.
 947  */
 948 void
 949 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
 950                                   const struct GNUNET_CRYPTO_EcdsaPublicKey
 951                                   *slave_key,
 952                                   uint64_t announced_at);
 953
 954
 955 /**
 956  * Function called to inform a member about stored state values for a channel.
 957  *
 958  * @param cls Closure.
 959  * @param name Name of the state variable.  A NULL value indicates that there
 960  *        are no more state variables to be returned.
 961  * @param value Value of the state variable.
 962  * @param value_size Number of bytes in @a value.
 963  */
 964 typedef void
 965 (*GNUNET_PSYC_StateCallback) (void *cls,
 966                               const char *name,
 967                               const void *value,
 968                               size_t value_size);
 969
 970
 971 /**
 972  * Function called when a requested operation has finished.
 973  *
 974  * @param cls Closure.
 975  */
 976 typedef void
 977 (*GNUNET_PSYC_FinishCallback) (void *cls);
 978
 979
 980 /**
 981  * Handle to a story telling operation.
 982  */
 983 struct GNUNET_PSYC_Story;
 984
 985
 986 /**
 987  * Request to be told the message history of the channel.
 988  *
 989  * Historic messages (but NOT the state at the time) will be replayed (given to
 990  * the normal method handlers) if available and if access is permitted.
 991  *
 992  * To get the latest message, use 0 for both the start and end message ID.
 993  *
 994  * @param channel Which channel should be replayed?
 995  * @param start_message_id Earliest interesting point in history.
 996  * @param end_message_id Last (exclusive) interesting point in history.
 997  * @param message_cb Function to invoke on message parts received from the story.
 998  * @param finish_cb Function to call when the requested story has been fully
 999  *        told (counting message IDs might not suffice, as some messages
1000  *        might be secret and thus the listener would not know the story is
1001  *        finished without being told explicitly); once this function
1002  *        has been called, the client must not call
1003  *        GNUNET_PSYC_channel_story_tell_cancel() anymore.
1004  * @param cls Closure for the callbacks.
1005  * @return Handle to cancel story telling operation.
1006  */
1007 struct GNUNET_PSYC_Story *
1008 GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
1009                                 uint64_t start_message_id,
1010                                 uint64_t end_message_id,
1011                                 GNUNET_PSYC_MessageCallback message_cb,
1012                                 GNUNET_PSYC_MessagePartCallback message_part_cb,
1013                                 GNUNET_PSYC_FinishCallback finish_cb,
1014                                 void *cls);
1015
1016
1017 /**
1018  * Abort story telling.
1019  *
1020  * This function must not be called from within method handlers (as given to
1021  * GNUNET_PSYC_slave_join()) of the slave.
1022  *
1023  * @param story Story telling operation to stop.
1024  */
1025 void
1026 GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story);
1027
1028
1029 /**
1030  * Handle for a state query operation.
1031  */
1032 struct GNUNET_PSYC_StateQuery;
1033
1034
1035 /**
1036  * Retrieve the best matching channel state variable.
1037  *
1038  * If the requested variable name is not present in the state, the nearest
1039  * less-specific name is matched; for example, requesting "_a_b" will match "_a"
1040  * if "_a_b" does not exist.
1041  *
1042  * @param channel Channel handle.
1043  * @param full_name Full name of the requested variable, the actual variable
1044  *        returned might have a shorter name..
1045  * @param cb Function called once when a matching state variable is found.
1046  *        Not called if there's no matching state variable.
1047  * @param cb_cls Closure for the callbacks.
1048  * @return Handle that can be used to cancel the query operation.
1049  */
1050 struct GNUNET_PSYC_StateQuery *
1051 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
1052                                const char *full_name,
1053                                GNUNET_PSYC_StateCallback cb,
1054                                void *cb_cls);
1055
1056
1057 /**
1058  * Return all channel state variables whose name matches a given prefix.
1059  *
1060  * A name matches if it starts with the given @a name_prefix, thus requesting
1061  * the empty prefix ("") will match all values; requesting "_a_b" will also
1062  * return values stored under "_a_b_c".
1063  *
1064  * The @a state_cb is invoked on all matching state variables asynchronously, as
1065  * the state is stored in and retrieved from the PSYCstore,
1066  *
1067  * @param channel Channel handle.
1068  * @param name_prefix Prefix of the state variable name to match.
1069  * @param cb Function to call with the matching state variables.
1070  * @param cb_cls Closure for the callbacks.
1071  * @return Handle that can be used to cancel the query operation.
1072  */
1073 struct GNUNET_PSYC_StateQuery *
1074 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
1075                                       const char *name_prefix,
1076                                       GNUNET_PSYC_StateCallback cb,
1077                                       void *cb_cls);
1078
1079
1080 /**
1081  * Cancel a state query operation.
1082  *
1083  * @param query Handle for the operation to cancel.
1084  */
1085 void
1086 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateQuery *query);
1087
1088
1089 #if 0                           /* keep Emacsens' auto-indent happy */
1090 {
1091 #endif
1092 #ifdef __cplusplus
1093 }
1094 #endif
1095
1096 /* ifndef GNUNET_PSYC_SERVICE_H */
1097 #endif
1098 /* end of gnunet_psyc_service.h */