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  * Header of a PSYC message.
 194  *
 195  * Only present when receiving a message.
 196  */
 197 struct GNUNET_PSYC_MessageHeader
 198 {
 199   /**
 200    * Generic message header with size and type information.
 201    */
 202   struct GNUNET_MessageHeader header;
 203
 204   /**
 205    * Flags for this message fragment.
 206    *
 207    * @see enum GNUNET_PSYC_MessageFlags
 208    */
 209   uint32_t flags GNUNET_PACKED;
 210
 211   /**
 212    * Number of the message this message part belongs to.
 213    * Monotonically increasing from 1.
 214    */
 215   uint64_t message_id GNUNET_PACKED;
 216
 217   /**
 218    * Sending slave's public key.
 219    * Not set if the message is from the master.
 220    */
 221   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 222
 223   /* Followed by concatenated PSYC message parts:
 224    * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
 225    */
 226 };
 227
 228
 229 /**
 230  * The method of a message.
 231  */
 232 struct GNUNET_PSYC_MessageMethod
 233 {
 234   /**
 235    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 236    */
 237   struct GNUNET_MessageHeader header;
 238
 239   /**
 240    * OR'ed GNUNET_PSYC_MasterTransmitFlags
 241    */
 242   uint32_t flags GNUNET_PACKED;
 243
 244   /**
 245    * Number of message IDs since the last message that contained state
 246    * operations. @see enum GNUNET_PSYC_StateDeltaValues
 247    */
 248   uint64_t state_delta GNUNET_PACKED;
 249
 250   /* Followed by NUL-terminated method name. */
 251 };
 252
 253
 254 /**
 255  * A modifier of a message.
 256  */
 257 struct GNUNET_PSYC_MessageModifier
 258 {
 259   /**
 260    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 261    */
 262   struct GNUNET_MessageHeader header;
 263
 264   /**
 265    * Size of value.
 266    */
 267   uint32_t value_size GNUNET_PACKED;
 268
 269   /**
 270    * Size of name, including NUL terminator.
 271    */
 272   uint16_t name_size GNUNET_PACKED;
 273
 274   /**
 275    * enum GNUNET_ENV_Operator
 276    */
 277   uint8_t oper;
 278
 279   /* Followed by NUL-terminated name, then the value. */
 280 };
 281
 282
 283 struct GNUNET_PSYC_CountersResultMessage
 284 {
 285   /**
 286    * Type: GNUNET_MESSAGE_TYPE_PSYC_RESULT_COUNTERS
 287    */
 288   struct GNUNET_MessageHeader header;
 289
 290   /**
 291    * Status code for the operation.
 292    */
 293   int32_t result_code GNUNET_PACKED;
 294
 295   /**
 296    * Last message ID sent to the channel.
 297    */
 298   uint64_t max_message_id;
 299 };
 300
 301
 302 struct GNUNET_PSYC_JoinRequestMessage
 303 {
 304   /**
 305    * Type: GNUNET_MESSAGE_TYPE_PSYC_MASTER_JOIN_REQUEST
 306    */
 307   struct GNUNET_MessageHeader header;
 308   /**
 309    * Public key of the joining slave.
 310    */
 311   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 312
 313   /* Followed by struct GNUNET_MessageHeader join_request */
 314 };
 315
 316
 317 struct GNUNET_PSYC_JoinDecisionMessage
 318 {
 319   /**
 320    * Type: GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION
 321    */
 322   struct GNUNET_MessageHeader header;
 323
 324   /**
 325    * #GNUNET_YES if the slave was admitted.
 326    */
 327   int32_t is_admitted;
 328
 329   /**
 330    * Public key of the joining slave.
 331    * Only set when the master is sending the decision,
 332    * not set when a slave is receiving it.
 333    */
 334   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 335
 336   /* Followed by struct GNUNET_MessageHeader join_response */
 337 };
 338
 339 GNUNET_NETWORK_STRUCT_END
 340
 341
 342 #define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD        \
 343   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 344   - sizeof (struct GNUNET_PSYC_MessageModifier)
 345
 346 #define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD        \
 347   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 348   - sizeof (struct GNUNET_MessageHeader)
 349
 350 #define GNUNET_PSYC_DATA_MAX_PAYLOAD            \
 351   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 352   - sizeof (struct GNUNET_MessageHeader)
 353
 354
 355 /**
 356  * PSYC message part processing states.
 357  */
 358 enum GNUNET_PSYC_MessageState
 359 {
 360   GNUNET_PSYC_MESSAGE_STATE_START    = 0,
 361   GNUNET_PSYC_MESSAGE_STATE_HEADER   = 1,
 362   GNUNET_PSYC_MESSAGE_STATE_METHOD   = 2,
 363   GNUNET_PSYC_MESSAGE_STATE_MODIFIER = 3,
 364   GNUNET_PSYC_MESSAGE_STATE_MOD_CONT = 4,
 365   GNUNET_PSYC_MESSAGE_STATE_DATA     = 5,
 366   GNUNET_PSYC_MESSAGE_STATE_END      = 6,
 367   GNUNET_PSYC_MESSAGE_STATE_CANCEL   = 7,
 368   GNUNET_PSYC_MESSAGE_STATE_ERROR    = 8,
 369 };
 370
 371
 372 /**
 373  * Handle that identifies a join request.
 374  *
 375  * Used to match calls to #GNUNET_PSYC_JoinCallback to the
 376  * corresponding calls to GNUNET_PSYC_join_decision().
 377  */
 378 struct GNUNET_PSYC_JoinHandle;
 379
 380
 381 /**
 382  * Method called from PSYC upon receiving part of a message.
 383  *
 384  * @param cls  Closure.
 385  * @param message_id  Sequence number of the message.
 386  * @param flags  OR'ed GNUNET_PSYC_MessageFlags
 387  * @param msg  Message part, one of the following types:
 388  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
 389  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 390  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 391  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
 392  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
 393  */
 394 typedef void
 395 (*GNUNET_PSYC_MessageCallback) (void *cls,
 396                                 uint64_t message_id,
 397                                 uint32_t flags,
 398                                 const struct GNUNET_MessageHeader *msg);
 399
 400
 401 /**
 402  * Method called from PSYC upon receiving a join request.
 403  *
 404  * @param cls  Closure.
 405  * @param slave_key  Public key of the slave requesting join.
 406  * @param join_msg  Join message sent along with the request.
 407  * @param jh  Join handle to use with GNUNET_PSYC_join_decision()
 408  */
 409 typedef void
 410 (*GNUNET_PSYC_JoinRequestCallback) (void *cls,
 411                                     const struct
 412                                     GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
 413                                     const struct
 414                                     GNUNET_PSYC_MessageHeader *join_msg,
 415                                     struct GNUNET_PSYC_JoinHandle *jh);
 416
 417
 418 /**
 419  * Function to call with the decision made for a join request.
 420  *
 421  * Must be called once and only once in response to an invocation of the
 422  * #GNUNET_PSYC_JoinCallback.
 423  *
 424  * @param jh  Join request handle.
 425  * @param is_admitted
 426  *   #GNUNET_YES    if the join is approved,
 427  *   #GNUNET_NO     if it is disapproved,
 428  *   #GNUNET_SYSERR if we cannot answer the request.
 429  * @param relay_count  Number of relays given.
 430  * @param relays  Array of suggested peers that might be useful relays to use
 431  *        when joining the multicast group (essentially a list of peers that
 432  *        are already part of the multicast group and might thus be willing
 433  *        to help with routing).  If empty, only this local peer (which must
 434  *        be the multicast origin) is a good candidate for building the
 435  *        multicast tree.  Note that it is unnecessary to specify our own
 436  *        peer identity in this array.
 437  * @param join_resp  Application-dependent join response message to send along
 438  *        with the decision.
 439  *
 440  * @return #GNUNET_OK on success,
 441  *         #GNUNET_SYSERR if @a join_resp is too large.
 442  */
 443 int
 444 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
 445                            int is_admitted,
 446                            uint32_t relay_count,
 447                            const struct GNUNET_PeerIdentity *relays,
 448                            const struct GNUNET_PSYC_MessageHeader *join_resp);
 449
 450
 451 /**
 452  * Handle for the master of a PSYC channel.
 453  */
 454 struct GNUNET_PSYC_Master;
 455
 456
 457 /**
 458  * Function called after the channel master started.
 459  *
 460  * @param cls Closure.
 461  * @param max_message_id Last message ID sent to the channel.
 462  */
 463 typedef void
 464 (*GNUNET_PSYC_MasterStartCallback) (void *cls, uint64_t max_message_id);
 465
 466
 467 /**
 468  * Start a PSYC master channel.
 469  *
 470  * Will start a multicast group identified by the given ECC key.  Messages
 471  * received from group members will be given to the respective handler methods.
 472  * If a new member wants to join a group, the "join" method handler will be
 473  * invoked; the join handler must then generate a "join" message to approve the
 474  * joining of the new member.  The channel can also change group membership
 475  * without explicit requests.  Note that PSYC doesn't itself "understand" join
 476  * or part messages, the respective methods must call other PSYC functions to
 477  * inform PSYC about the meaning of the respective events.
 478  *
 479  * @param cfg  Configuration to use (to connect to PSYC service).
 480  * @param channel_key  ECC key that will be used to sign messages for this
 481  *        PSYC session. The public key is used to identify the PSYC channel.
 482  *        Note that end-users will usually not use the private key directly, but
 483  *        rather look it up in GNS for places managed by other users, or select
 484  *        a file with the private key(s) when setting up their own channels
 485  *        FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
 486  *        one in the future.
 487  * @param policy  Channel policy specifying join and history restrictions.
 488  *        Used to automate join decisions.
 489  * @param master_start_cb  Function to invoke after the channel master started.
 490  * @param join_request_cb  Function to invoke when a slave wants to join.
 491  * @param message_cb  Function to invoke on message parts sent to the channel
 492  *        and received from slaves
 493  * @param cls  Closure for @a method and @a join_cb.
 494  *
 495  * @return Handle for the channel master, NULL on error.
 496  */
 497 struct GNUNET_PSYC_Master *
 498 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 499                           const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
 500                           enum GNUNET_PSYC_Policy policy,
 501                           GNUNET_PSYC_MasterStartCallback master_start_cb,
 502                           GNUNET_PSYC_JoinRequestCallback join_request_cb,
 503                           GNUNET_PSYC_MessageCallback message_cb,
 504                           void *cls);
 505
 506
 507 /**
 508  * Function called to provide data for a transmission via PSYC.
 509  *
 510  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 511  * invalidates the respective transmission handle.
 512  *
 513  * @param cls Closure.
 514  * @param[in,out] data_size Initially set to the number of bytes available in
 515  *        @a data, should be set to the number of bytes written to data.
 516  * @param[out] data Where to write the body of the message to give to the
 517  *         method. The function must copy at most @a data_size bytes to @a data.
 518  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 519  *         #GNUNET_NO on success, if more data is to be transmitted later.
 520  *         Should be used if @a data_size was not big enough to take all the
 521  *         data.  If 0 is returned in @a data_size the transmission is paused,
 522  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 523  *         #GNUNET_YES if this completes the transmission (all data supplied)
 524  */
 525 typedef int
 526 (*GNUNET_PSYC_TransmitNotifyData) (void *cls,
 527                                    uint16_t *data_size,
 528                                    void *data);
 529
 530 /**
 531  * Function called to provide a modifier for a transmission via PSYC.
 532  *
 533  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 534  * invalidates the respective transmission handle.
 535  *
 536  * @param cls Closure.
 537  * @param[in,out] data_size  Initially set to the number of bytes available in
 538  *         @a data, should be set to the number of bytes written to data.
 539  * @param[out] data  Where to write the modifier's name and value.
 540  *         The function must copy at most @a data_size bytes to @a data.
 541  *         When this callback is first called for a modifier, @a data should
 542  *         contain: "name\0value".  If the whole value does not fit, subsequent
 543  *         calls to this function should write continuations of the value to
 544  *         @a data.
 545  * @param[out] oper  Where to write the operator of the modifier.
 546  *         Only needed during the first call to this callback at the beginning
 547  *         of the modifier.  In case of subsequent calls asking for value
 548  *         continuations @a oper is set to #NULL.
 549  * @param[out] full_value_size  Where to write the full size of the value.
 550  *         Only needed during the first call to this callback at the beginning
 551  *         of the modifier.  In case of subsequent calls asking for value
 552  *         continuations @a value_size is set to #NULL.
 553  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 554  *         #GNUNET_NO on success, if more data is to be transmitted later.
 555  *         Should be used if @a data_size was not big enough to take all the
 556  *         data for the modifier's value (the name must be always returned
 557  *         during the first call to this callback).
 558  *         If 0 is returned in @a data_size the transmission is paused,
 559  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 560  *         #GNUNET_YES if this completes the modifier (the whole value is supplied).
 561  */
 562 typedef int
 563 (*GNUNET_PSYC_TransmitNotifyModifier) (void *cls,
 564                                        uint16_t *data_size,
 565                                        void *data,
 566                                        uint8_t *oper,
 567                                        uint32_t *full_value_size);
 568
 569 /**
 570  * Flags for transmitting messages to a channel by the master.
 571  */
 572 enum GNUNET_PSYC_MasterTransmitFlags
 573 {
 574   GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
 575
 576   /**
 577    * Whether this message should reset the channel state,
 578    * i.e. remove all previously stored state variables.
 579    */
 580
 581   GNUNET_PSYC_MASTER_TRANSMIT_STATE_RESET = 1 << 0,
 582
 583   /**
 584    * Whether this message contains any state modifiers.
 585    */
 586   GNUNET_PSYC_MASTER_TRANSMIT_STATE_MODIFY = 1 << 1,
 587
 588   /**
 589    * Add PSYC header variable with the hash of the current channel state.
 590    */
 591   GNUNET_PSYC_MASTER_TRANSMIT_STATE_HASH = 1 << 2,
 592
 593   /**
 594    * Whether we need to increment the group generation counter after
 595    * transmitting this message.
 596    */
 597   GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 3
 598 };
 599
 600
 601 /**
 602  * Handle for a pending PSYC transmission operation.
 603  */
 604 struct GNUNET_PSYC_MasterTransmitHandle;
 605
 606
 607 /**
 608  * Send a message to call a method to all members in the PSYC channel.
 609  *
 610  * @param master Handle to the PSYC channel.
 611  * @param method_name Which method should be invoked.
 612  * @param notify_mod Function to call to obtain modifiers.
 613  * @param notify_data Function to call to obtain fragments of the data.
 614  * @param notify_cls Closure for @a notify_mod and @a notify_data.
 615  * @param flags Flags for the message being transmitted.
 616  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 617  */
 618 struct GNUNET_PSYC_MasterTransmitHandle *
 619 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
 620                              const char *method_name,
 621                              GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 622                              GNUNET_PSYC_TransmitNotifyData notify_data,
 623                              void *notify_cls,
 624                              enum GNUNET_PSYC_MasterTransmitFlags flags);
 625
 626
 627 /**
 628  * Resume transmission to the channel.
 629  *
 630  * @param th Handle of the request that is being resumed.
 631  */
 632 void
 633 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
 634
 635
 636 /**
 637  * Abort transmission request to channel.
 638  *
 639  * @param th Handle of the request that is being aborted.
 640  */
 641 void
 642 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
 643
 644
 645 /**
 646  * Stop a PSYC master channel.
 647  *
 648  * @param master PSYC channel master to stop.
 649  */
 650 void
 651 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master);
 652
 653
 654 /**
 655  * Handle for a PSYC channel slave.
 656  */
 657 struct GNUNET_PSYC_Slave;
 658
 659
 660 /**
 661  * Function called after the slave connected to the PSYC service.
 662  *
 663  * @param cls Closure.
 664  * @param max_message_id Last message ID sent to the channel.
 665  */
 666 typedef void
 667 (*GNUNET_PSYC_SlaveConnectCallback) (void *cls, uint64_t max_message_id);
 668
 669
 670 /**
 671  * Method called to inform about the decision in response to a join request.
 672  *
 673  * If @a is_admitted is not #GNUNET_YES, then sending messages to the channel is
 674  * not possible, but earlier history can be still queried.
 675  *
 676  * @param cls  Closure.
 677  * @param is_admitted  #GNUNET_YES or #GNUNET_NO or #GNUNET_SYSERR
 678  * @param join_msg  Application-dependent join message from the origin.
 679  */
 680 typedef void
 681 (*GNUNET_PSYC_JoinDecisionCallback) (void *cls,
 682                                      int is_admitted,
 683                                      const struct
 684                                      GNUNET_PSYC_MessageHeader *join_msg);
 685
 686
 687 /**
 688  * Join a PSYC channel.
 689  *
 690  * The entity joining is always the local peer.  The user must immediately use
 691  * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
 692  * channel; if the join request succeeds, the channel state (and @e recent
 693  * method calls) will be replayed to the joining member.  There is no explicit
 694  * notification on failure (as the channel may simply take days to approve,
 695  * and disapproval is simply being ignored).
 696  *
 697  * @param cfg  Configuration to use.
 698  * @param channel_key  ECC public key that identifies the channel we wish to join.
 699  * @param slave_key  ECC private-public key pair that identifies the slave, and
 700  *        used by multicast to sign the join request and subsequent unicast
 701  *        requests sent to the master.
 702  * @param origin  Peer identity of the origin.
 703  * @param relay_count  Number of peers in the @a relays array.
 704  * @param relays  Peer identities of members of the multicast group, which serve
 705  *        as relays and used to join the group at.
 706  * @param message_cb  Function to invoke on message parts received from the
 707  *        channel, typically at least contains method handlers for @e join and
 708  *        @e part.
 709  * @param slave_connect_cb  Function invoked once we have connected to the
 710  *        PSYC service.
 711  * @param join_decision_cb  Function invoked once we have received a join
 712  *        decision.
 713  * @param cls  Closure for @a message_cb and @a slave_joined_cb.
 714  * @param method_name  Method name for the join request.
 715  * @param env  Environment containing transient variables for the request, or NULL.
 716  * @param data  Payload for the join message.
 717  * @param data_size  Number of bytes in @a data.
 718  *
 719  * @return Handle for the slave, NULL on error.
 720  */
 721 struct GNUNET_PSYC_Slave *
 722 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
 723                         const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 724                         const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_key,
 725                         const struct GNUNET_PeerIdentity *origin,
 726                         uint32_t relay_count,
 727                         const struct GNUNET_PeerIdentity *relays,
 728                         GNUNET_PSYC_MessageCallback message_cb,
 729                         GNUNET_PSYC_SlaveConnectCallback slave_connect_cb,
 730                         GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
 731                         void *cls,
 732                         const struct GNUNET_MessageHeader *join_msg);
 733
 734
 735 /**
 736  * Part a PSYC channel.
 737  *
 738  * Will terminate the connection to the PSYC service.  Polite clients should
 739  * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
 740  *
 741  * @param slave Slave handle.
 742  */
 743 void
 744 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave);
 745
 746
 747 /**
 748  * Flags for transmitting messages to the channel master by a slave.
 749  */
 750 enum GNUNET_PSYC_SlaveTransmitFlags
 751 {
 752   GNUNET_PSYC_SLAVE_TRANSMIT_NONE = 0
 753 };
 754
 755
 756 /**
 757  * Handle for a pending PSYC transmission operation.
 758  */
 759 struct GNUNET_PSYC_SlaveTransmitHandle;
 760
 761
 762 /**
 763  * Request a message to be sent to the channel master.
 764  *
 765  * @param slave Slave handle.
 766  * @param method_name Which (PSYC) method should be invoked (on host).
 767  * @param notify_mod Function to call to obtain modifiers.
 768  * @param notify_data Function to call to obtain fragments of the data.
 769  * @param notify_cls Closure for @a notify.
 770  * @param flags Flags for the message being transmitted.
 771  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 772  */
 773 struct GNUNET_PSYC_SlaveTransmitHandle *
 774 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
 775                             const char *method_name,
 776                             GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 777                             GNUNET_PSYC_TransmitNotifyData notify_data,
 778                             void *notify_cls,
 779                             enum GNUNET_PSYC_SlaveTransmitFlags flags);
 780
 781
 782 /**
 783  * Resume transmission to the master.
 784  *
 785  * @param th Handle of the request that is being resumed.
 786  */
 787 void
 788 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *th);
 789
 790
 791 /**
 792  * Abort transmission request to master.
 793  *
 794  * @param th Handle of the request that is being aborted.
 795  */
 796 void
 797 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
 798
 799
 800 /**
 801  * Handle to access PSYC channel operations for both the master and slaves.
 802  */
 803 struct GNUNET_PSYC_Channel;
 804
 805
 806 /**
 807  * Convert a channel @a master to a @e channel handle to access the @e channel
 808  * APIs.
 809  *
 810  * @param master Channel master handle.
 811  * @return Channel handle, valid for as long as @a master is valid.
 812  */
 813 struct GNUNET_PSYC_Channel *
 814 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
 815
 816
 817 /**
 818  * Convert @a slave to a @e channel handle to access the @e channel APIs.
 819  *
 820  * @param slave Slave handle.
 821  * @return Channel handle, valid for as long as @a slave is valid.
 822  */
 823 struct GNUNET_PSYC_Channel *
 824 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
 825
 826
 827 /**
 828  * Add a slave to the channel's membership list.
 829  *
 830  * Note that this will NOT generate any PSYC traffic, it will merely update the
 831  * local database to modify how we react to <em>membership test</em> queries.
 832  * The channel master still needs to explicitly transmit a @e join message to
 833  * notify other channel members and they then also must still call this function
 834  * in their respective methods handling the @e join message.  This way, how @e
 835  * join and @e part operations are exactly implemented is still up to the
 836  * application; for example, there might be a @e part_all method to kick out
 837  * everyone.
 838  *
 839  * Note that channel slaves are explicitly trusted to execute such methods
 840  * correctly; not doing so correctly will result in either denying other slaves
 841  * access or offering access to channel data to non-members.
 842  *
 843  * @param channel Channel handle.
 844  * @param slave_key Identity of channel slave to add.
 845  * @param announced_at ID of the message that announced the membership change.
 846  * @param effective_since Addition of slave is in effect since this message ID.
 847  */
 848 void
 849 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
 850                                const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
 851                                uint64_t announced_at,
 852                                uint64_t effective_since);
 853
 854
 855 /**
 856  * Remove a slave from the channel's membership list.
 857  *
 858  * Note that this will NOT generate any PSYC traffic, it will merely update the
 859  * local database to modify how we react to <em>membership test</em> queries.
 860  * The channel master still needs to explicitly transmit a @e part message to
 861  * notify other channel members and they then also must still call this function
 862  * in their respective methods handling the @e part message.  This way, how
 863  * @e join and @e part operations are exactly implemented is still up to the
 864  * application; for example, there might be a @e part_all message to kick out
 865  * everyone.
 866  *
 867  * Note that channel members are explicitly trusted to perform these
 868  * operations correctly; not doing so correctly will result in either
 869  * denying members access or offering access to channel data to
 870  * non-members.
 871  *
 872  * @param channel Channel handle.
 873  * @param slave_key Identity of channel slave to remove.
 874  * @param announced_at ID of the message that announced the membership change.
 875  */
 876 void
 877 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
 878                                   const struct GNUNET_CRYPTO_EcdsaPublicKey
 879                                   *slave_key,
 880                                   uint64_t announced_at);
 881
 882
 883 /**
 884  * Function called to inform a member about stored state values for a channel.
 885  *
 886  * @param cls Closure.
 887  * @param name Name of the state variable.  A NULL value indicates that there
 888  *        are no more state variables to be returned.
 889  * @param value Value of the state variable.
 890  * @param value_size Number of bytes in @a value.
 891  */
 892 typedef void
 893 (*GNUNET_PSYC_StateCallback) (void *cls,
 894                               const char *name,
 895                               const void *value,
 896                               size_t value_size);
 897
 898
 899 /**
 900  * Function called when a requested operation has finished.
 901  *
 902  * @param cls Closure.
 903  */
 904 typedef void
 905 (*GNUNET_PSYC_FinishCallback) (void *cls);
 906
 907
 908 /**
 909  * Handle to a story telling operation.
 910  */
 911 struct GNUNET_PSYC_Story;
 912
 913
 914 /**
 915  * Request to be told the message history of the channel.
 916  *
 917  * Historic messages (but NOT the state at the time) will be replayed (given to
 918  * the normal method handlers) if available and if access is permitted.
 919  *
 920  * To get the latest message, use 0 for both the start and end message ID.
 921  *
 922  * @param channel Which channel should be replayed?
 923  * @param start_message_id Earliest interesting point in history.
 924  * @param end_message_id Last (exclusive) interesting point in history.
 925  * @param message_cb Function to invoke on message parts received from the story.
 926  * @param finish_cb Function to call when the requested story has been fully
 927  *        told (counting message IDs might not suffice, as some messages
 928  *        might be secret and thus the listener would not know the story is
 929  *        finished without being told explicitly); once this function
 930  *        has been called, the client must not call
 931  *        GNUNET_PSYC_channel_story_tell_cancel() anymore.
 932  * @param cls Closure for the callbacks.
 933  * @return Handle to cancel story telling operation.
 934  */
 935 struct GNUNET_PSYC_Story *
 936 GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
 937                                 uint64_t start_message_id,
 938                                 uint64_t end_message_id,
 939                                 GNUNET_PSYC_MessageCallback message_cb,
 940                                 GNUNET_PSYC_FinishCallback finish_cb,
 941                                 void *cls);
 942
 943
 944 /**
 945  * Abort story telling.
 946  *
 947  * This function must not be called from within method handlers (as given to
 948  * GNUNET_PSYC_slave_join()) of the slave.
 949  *
 950  * @param story Story telling operation to stop.
 951  */
 952 void
 953 GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story);
 954
 955
 956 /**
 957  * Handle for a state query operation.
 958  */
 959 struct GNUNET_PSYC_StateQuery;
 960
 961
 962 /**
 963  * Retrieve the best matching channel state variable.
 964  *
 965  * If the requested variable name is not present in the state, the nearest
 966  * less-specific name is matched; for example, requesting "_a_b" will match "_a"
 967  * if "_a_b" does not exist.
 968  *
 969  * @param channel Channel handle.
 970  * @param full_name Full name of the requested variable, the actual variable
 971  *        returned might have a shorter name..
 972  * @param cb Function called once when a matching state variable is found.
 973  *        Not called if there's no matching state variable.
 974  * @param cb_cls Closure for the callbacks.
 975  * @return Handle that can be used to cancel the query operation.
 976  */
 977 struct GNUNET_PSYC_StateQuery *
 978 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
 979                                const char *full_name,
 980                                GNUNET_PSYC_StateCallback cb,
 981                                void *cb_cls);
 982
 983
 984 /**
 985  * Return all channel state variables whose name matches a given prefix.
 986  *
 987  * A name matches if it starts with the given @a name_prefix, thus requesting
 988  * the empty prefix ("") will match all values; requesting "_a_b" will also
 989  * return values stored under "_a_b_c".
 990  *
 991  * The @a state_cb is invoked on all matching state variables asynchronously, as
 992  * the state is stored in and retrieved from the PSYCstore,
 993  *
 994  * @param channel Channel handle.
 995  * @param name_prefix Prefix of the state variable name to match.
 996  * @param cb Function to call with the matching state variables.
 997  * @param cb_cls Closure for the callbacks.
 998  * @return Handle that can be used to cancel the query operation.
 999  */
1000 struct GNUNET_PSYC_StateQuery *
1001 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
1002                                       const char *name_prefix,
1003                                       GNUNET_PSYC_StateCallback cb,
1004                                       void *cb_cls);
1005
1006
1007 /**
1008  * Cancel a state query operation.
1009  *
1010  * @param query Handle for the operation to cancel.
1011  */
1012 void
1013 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateQuery *query);
1014
1015
1016 #if 0                           /* keep Emacsens' auto-indent happy */
1017 {
1018 #endif
1019 #ifdef __cplusplus
1020 }
1021 #endif
1022
1023 /* ifndef GNUNET_PSYC_SERVICE_H */
1024 #endif
1025 /* end of gnunet_psyc_service.h */