2 * This file is part of GNUnet
3 * Copyright (C) 2013 Christian Grothoff (and other contributing authors)
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * @file psyc/psyc_api.c
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 Gabor X Toth
36 #include "gnunet_util_lib.h"
37 #include "gnunet_env_lib.h"
38 #include "gnunet_multicast_service.h"
39 #include "gnunet_psyc_service.h"
40 #include "gnunet_psyc_util_lib.h"
43 #define LOG(kind,...) GNUNET_log_from (kind, "psyc-api",__VA_ARGS__)
47 * Handle to access PSYC channel operations for both the master and slaves.
49 struct GNUNET_PSYC_Channel
52 * Configuration to use.
54 const struct GNUNET_CONFIGURATION_Handle *cfg;
57 * Client connection to the service.
59 struct GNUNET_CLIENT_MANAGER_Connection *client;
62 * Transmission handle;
64 struct GNUNET_PSYC_TransmitHandle *tmit;
69 struct GNUNET_PSYC_ReceiveHandle *recv;
72 * Message to send on reconnect.
74 struct GNUNET_MessageHeader *connect_msg;
77 * Function called after disconnected from the service.
79 GNUNET_ContinuationCallback disconnect_cb;
82 * Closure for @a disconnect_cb.
87 * Are we polling for incoming messages right now?
92 * Is this a master or slave channel?
97 * Is this channel in the process of disconnecting from the service?
98 * #GNUNET_YES or #GNUNET_NO
100 uint8_t is_disconnecting;
105 * Handle for the master of a PSYC channel.
107 struct GNUNET_PSYC_Master
109 struct GNUNET_PSYC_Channel chn;
111 GNUNET_PSYC_MasterStartCallback start_cb;
114 * Join request callback.
116 GNUNET_PSYC_JoinRequestCallback join_req_cb;
119 * Closure for the callbacks.
126 * Handle for a PSYC channel slave.
128 struct GNUNET_PSYC_Slave
130 struct GNUNET_PSYC_Channel chn;
132 GNUNET_PSYC_SlaveConnectCallback connect_cb;
134 GNUNET_PSYC_JoinDecisionCallback join_dcsn_cb;
137 * Closure for the callbacks.
144 * Handle that identifies a join request.
146 * Used to match calls to #GNUNET_PSYC_JoinRequestCallback to the
147 * corresponding calls to GNUNET_PSYC_join_decision().
149 struct GNUNET_PSYC_JoinHandle
151 struct GNUNET_PSYC_Master *mst;
152 struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
157 * Handle for a pending PSYC transmission operation.
159 struct GNUNET_PSYC_SlaveTransmitHandle
165 struct GNUNET_PSYC_HistoryRequest
170 struct GNUNET_PSYC_Channel *chn;
180 struct GNUNET_PSYC_ReceiveHandle *recv;
183 * Function to call when the operation finished.
185 GNUNET_ResultCallback result_cb;
188 * Closure for @a result_cb.
194 struct GNUNET_PSYC_StateRequest
199 struct GNUNET_PSYC_Channel *chn;
207 * State variable result callback.
209 GNUNET_PSYC_StateVarCallback var_cb;
212 * Function to call when the operation finished.
214 GNUNET_ResultCallback result_cb;
217 * Closure for @a result_cb.
224 channel_send_connect_msg (struct GNUNET_PSYC_Channel *chn)
226 uint16_t cmsg_size = ntohs (chn->connect_msg->size);
227 struct GNUNET_MessageHeader * cmsg = GNUNET_malloc (cmsg_size);
228 memcpy (cmsg, chn->connect_msg, cmsg_size);
229 GNUNET_CLIENT_MANAGER_transmit_now (chn->client, cmsg);
234 channel_recv_disconnect (void *cls,
235 struct GNUNET_CLIENT_MANAGER_Connection *client,
236 const struct GNUNET_MessageHeader *msg)
238 struct GNUNET_PSYC_Channel *
239 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
240 GNUNET_CLIENT_MANAGER_reconnect (client);
241 channel_send_connect_msg (chn);
246 channel_recv_result (void *cls,
247 struct GNUNET_CLIENT_MANAGER_Connection *client,
248 const struct GNUNET_MessageHeader *msg)
250 struct GNUNET_PSYC_Channel *
251 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
253 const struct GNUNET_OperationResultMessage *
254 res = (const struct GNUNET_OperationResultMessage *) msg;
256 uint16_t size = ntohs (msg->size);
257 if (size < sizeof (*res))
258 { /* Error, message too small. */
263 uint16_t data_size = size - sizeof (*res);
264 const char *data = (0 < data_size) ? (void *) &res[1] : NULL;
265 GNUNET_CLIENT_MANAGER_op_result (chn->client, GNUNET_ntohll (res->op_id),
266 GNUNET_ntohll (res->result_code),
272 op_recv_history_result (void *cls, int64_t result,
273 const void *data, uint16_t data_size)
275 LOG (GNUNET_ERROR_TYPE_DEBUG,
276 "Received history replay result: %" PRId64 ".\n", result);
278 struct GNUNET_PSYC_HistoryRequest *hist = cls;
280 if (NULL != hist->result_cb)
281 hist->result_cb (hist->cls, result, data, data_size);
283 GNUNET_PSYC_receive_destroy (hist->recv);
289 op_recv_state_result (void *cls, int64_t result,
290 const void *data, uint16_t data_size)
292 LOG (GNUNET_ERROR_TYPE_DEBUG,
293 "Received state request result: %" PRId64 ".\n", result);
295 struct GNUNET_PSYC_StateRequest *sr = cls;
297 if (NULL != sr->result_cb)
298 sr->result_cb (sr->cls, result, data, data_size);
305 channel_recv_history_result (void *cls,
306 struct GNUNET_CLIENT_MANAGER_Connection *client,
307 const struct GNUNET_MessageHeader *msg)
309 struct GNUNET_PSYC_Channel *
310 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
312 const struct GNUNET_OperationResultMessage *
313 res = (const struct GNUNET_OperationResultMessage *) msg;
314 struct GNUNET_PSYC_MessageHeader *
315 pmsg = (struct GNUNET_PSYC_MessageHeader *) &res[1];
317 LOG (GNUNET_ERROR_TYPE_DEBUG,
318 "%p Received historic fragment for message #%" PRIu64 ".\n",
319 chn, GNUNET_ntohll (pmsg->message_id));
321 GNUNET_ResultCallback result_cb = NULL;
322 struct GNUNET_PSYC_HistoryRequest *hist = NULL;
324 if (GNUNET_YES != GNUNET_CLIENT_MANAGER_op_find (chn->client,
325 GNUNET_ntohll (res->op_id),
326 &result_cb, (void *) &hist))
327 { /* Operation not found. */
328 LOG (GNUNET_ERROR_TYPE_WARNING,
329 "%p Replay operation not found for historic fragment of message #%"
331 chn, GNUNET_ntohll (pmsg->message_id));
335 uint16_t size = ntohs (msg->size);
336 if (size < sizeof (*res) + sizeof (*pmsg))
337 { /* Error, message too small. */
342 GNUNET_PSYC_receive_message (hist->recv,
343 (const struct GNUNET_PSYC_MessageHeader *) pmsg);
348 channel_recv_state_result (void *cls,
349 struct GNUNET_CLIENT_MANAGER_Connection *client,
350 const struct GNUNET_MessageHeader *msg)
352 struct GNUNET_PSYC_Channel *
353 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
355 const struct GNUNET_OperationResultMessage *
356 res = (const struct GNUNET_OperationResultMessage *) msg;
358 GNUNET_ResultCallback result_cb = NULL;
359 struct GNUNET_PSYC_StateRequest *sr = NULL;
361 if (GNUNET_YES != GNUNET_CLIENT_MANAGER_op_find (chn->client,
362 GNUNET_ntohll (res->op_id),
363 &result_cb, (void *) &sr))
364 { /* Operation not found. */
368 const struct GNUNET_MessageHeader *
369 mod = (struct GNUNET_MessageHeader *) &res[1];
370 uint16_t mod_size = ntohs (mod->size);
371 if (ntohs (msg->size) - sizeof (*res) != mod_size)
376 switch (ntohs (mod->type))
378 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER:
380 const struct GNUNET_PSYC_MessageModifier *
381 pmod = (const struct GNUNET_PSYC_MessageModifier *) mod;
383 const char *name = (const char *) &pmod[1];
384 uint16_t name_size = ntohs (pmod->name_size);
385 if ('\0' != name[name_size - 1])
390 sr->var_cb (sr->cls, mod, name, name + name_size,
391 ntohs (pmod->header.size) - sizeof (*pmod),
392 ntohs (pmod->value_size));
396 case GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT:
397 sr->var_cb (sr->cls, mod, NULL, (const char *) &mod[1],
398 mod_size - sizeof (*mod), 0);
405 channel_recv_message (void *cls,
406 struct GNUNET_CLIENT_MANAGER_Connection *client,
407 const struct GNUNET_MessageHeader *msg)
409 struct GNUNET_PSYC_Channel *
410 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
411 GNUNET_PSYC_receive_message (chn->recv,
412 (const struct GNUNET_PSYC_MessageHeader *) msg);
417 channel_recv_message_ack (void *cls,
418 struct GNUNET_CLIENT_MANAGER_Connection *client,
419 const struct GNUNET_MessageHeader *msg)
421 struct GNUNET_PSYC_Channel *
422 chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
423 GNUNET_PSYC_transmit_got_ack (chn->tmit);
428 master_recv_start_ack (void *cls,
429 struct GNUNET_CLIENT_MANAGER_Connection *client,
430 const struct GNUNET_MessageHeader *msg)
432 struct GNUNET_PSYC_Master *
433 mst = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
434 sizeof (struct GNUNET_PSYC_Channel));
436 struct GNUNET_PSYC_CountersResultMessage *
437 cres = (struct GNUNET_PSYC_CountersResultMessage *) msg;
438 int32_t result = ntohl (cres->result_code);
439 if (GNUNET_OK != result && GNUNET_NO != result)
441 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not start master: %ld\n", result);
443 /* FIXME: disconnect */
445 if (NULL != mst->start_cb)
446 mst->start_cb (mst->cb_cls, result, GNUNET_ntohll (cres->max_message_id));
451 master_recv_join_request (void *cls,
452 struct GNUNET_CLIENT_MANAGER_Connection *client,
453 const struct GNUNET_MessageHeader *msg)
455 struct GNUNET_PSYC_Master *
456 mst = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
457 sizeof (struct GNUNET_PSYC_Channel));
458 if (NULL == mst->join_req_cb)
461 const struct GNUNET_PSYC_JoinRequestMessage *
462 req = (const struct GNUNET_PSYC_JoinRequestMessage *) msg;
463 const struct GNUNET_PSYC_Message *join_msg = NULL;
464 if (sizeof (*req) + sizeof (*join_msg) <= ntohs (req->header.size))
466 join_msg = (struct GNUNET_PSYC_Message *) &req[1];
467 LOG (GNUNET_ERROR_TYPE_ERROR,
468 "Received join_msg of type %u and size %u.\n",
469 ntohs (join_msg->header.type), ntohs (join_msg->header.size));
472 struct GNUNET_PSYC_JoinHandle *jh = GNUNET_malloc (sizeof (*jh));
474 jh->slave_key = req->slave_key;
476 if (NULL != mst->join_req_cb)
477 mst->join_req_cb (mst->cb_cls, req, &req->slave_key, join_msg, jh);
482 slave_recv_join_ack (void *cls,
483 struct GNUNET_CLIENT_MANAGER_Connection *client,
484 const struct GNUNET_MessageHeader *msg)
486 struct GNUNET_PSYC_Slave *
487 slv = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
488 sizeof (struct GNUNET_PSYC_Channel));
489 struct GNUNET_PSYC_CountersResultMessage *
490 cres = (struct GNUNET_PSYC_CountersResultMessage *) msg;
491 int32_t result = ntohl (cres->result_code);
492 if (GNUNET_YES != result && GNUNET_NO != result)
494 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not join slave.\n");
496 /* FIXME: disconnect */
498 if (NULL != slv->connect_cb)
499 slv->connect_cb (slv->cb_cls, result, GNUNET_ntohll (cres->max_message_id));
504 slave_recv_join_decision (void *cls,
505 struct GNUNET_CLIENT_MANAGER_Connection *client,
506 const struct GNUNET_MessageHeader *msg)
508 struct GNUNET_PSYC_Slave *
509 slv = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
510 sizeof (struct GNUNET_PSYC_Channel));
511 const struct GNUNET_PSYC_JoinDecisionMessage *
512 dcsn = (const struct GNUNET_PSYC_JoinDecisionMessage *) msg;
514 struct GNUNET_PSYC_Message *pmsg = NULL;
515 if (ntohs (dcsn->header.size) <= sizeof (*dcsn) + sizeof (*pmsg))
516 pmsg = (struct GNUNET_PSYC_Message *) &dcsn[1];
518 if (NULL != slv->join_dcsn_cb)
519 slv->join_dcsn_cb (slv->cb_cls, dcsn, ntohl (dcsn->is_admitted), pmsg);
523 static struct GNUNET_CLIENT_MANAGER_MessageHandler master_handlers[] =
525 { &channel_recv_message, NULL,
526 GNUNET_MESSAGE_TYPE_PSYC_MESSAGE,
527 sizeof (struct GNUNET_PSYC_MessageHeader), GNUNET_YES },
529 { &channel_recv_message_ack, NULL,
530 GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_ACK,
531 sizeof (struct GNUNET_MessageHeader), GNUNET_NO },
533 { &master_recv_start_ack, NULL,
534 GNUNET_MESSAGE_TYPE_PSYC_MASTER_START_ACK,
535 sizeof (struct GNUNET_PSYC_CountersResultMessage), GNUNET_NO },
537 { &master_recv_join_request, NULL,
538 GNUNET_MESSAGE_TYPE_PSYC_JOIN_REQUEST,
539 sizeof (struct GNUNET_PSYC_JoinRequestMessage), GNUNET_YES },
541 { &channel_recv_history_result, NULL,
542 GNUNET_MESSAGE_TYPE_PSYC_HISTORY_RESULT,
543 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
545 { &channel_recv_state_result, NULL,
546 GNUNET_MESSAGE_TYPE_PSYC_STATE_RESULT,
547 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
549 { &channel_recv_result, NULL,
550 GNUNET_MESSAGE_TYPE_PSYC_RESULT_CODE,
551 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
553 { &channel_recv_disconnect, NULL, 0, 0, GNUNET_NO },
555 { NULL, NULL, 0, 0, GNUNET_NO }
559 static struct GNUNET_CLIENT_MANAGER_MessageHandler slave_handlers[] =
561 { &channel_recv_message, NULL,
562 GNUNET_MESSAGE_TYPE_PSYC_MESSAGE,
563 sizeof (struct GNUNET_PSYC_MessageHeader), GNUNET_YES },
565 { &channel_recv_message_ack, NULL,
566 GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_ACK,
567 sizeof (struct GNUNET_MessageHeader), GNUNET_NO },
569 { &slave_recv_join_ack, NULL,
570 GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN_ACK,
571 sizeof (struct GNUNET_PSYC_CountersResultMessage), GNUNET_NO },
573 { &slave_recv_join_decision, NULL,
574 GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION,
575 sizeof (struct GNUNET_PSYC_JoinDecisionMessage), GNUNET_YES },
577 { &channel_recv_history_result, NULL,
578 GNUNET_MESSAGE_TYPE_PSYC_HISTORY_RESULT,
579 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
581 { &channel_recv_state_result, NULL,
582 GNUNET_MESSAGE_TYPE_PSYC_STATE_RESULT,
583 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
585 { &channel_recv_result, NULL,
586 GNUNET_MESSAGE_TYPE_PSYC_RESULT_CODE,
587 sizeof (struct GNUNET_OperationResultMessage), GNUNET_YES },
589 { &channel_recv_disconnect, NULL, 0, 0, GNUNET_NO },
591 { NULL, NULL, 0, 0, GNUNET_NO }
596 channel_cleanup (struct GNUNET_PSYC_Channel *chn)
598 GNUNET_PSYC_transmit_destroy (chn->tmit);
599 GNUNET_PSYC_receive_destroy (chn->recv);
600 GNUNET_free (chn->connect_msg);
601 if (NULL != chn->disconnect_cb)
602 chn->disconnect_cb (chn->disconnect_cls);
607 master_cleanup (void *cls)
609 struct GNUNET_PSYC_Master *mst = cls;
610 channel_cleanup (&mst->chn);
616 slave_cleanup (void *cls)
618 struct GNUNET_PSYC_Slave *slv = cls;
619 channel_cleanup (&slv->chn);
625 * Start a PSYC master channel.
627 * Will start a multicast group identified by the given ECC key. Messages
628 * received from group members will be given to the respective handler methods.
629 * If a new member wants to join a group, the "join" method handler will be
630 * invoked; the join handler must then generate a "join" message to approve the
631 * joining of the new member. The channel can also change group membership
632 * without explicit requests. Note that PSYC doesn't itself "understand" join
633 * or part messages, the respective methods must call other PSYC functions to
634 * inform PSYC about the meaning of the respective events.
636 * @param cfg Configuration to use (to connect to PSYC service).
637 * @param channel_key ECC key that will be used to sign messages for this
638 * PSYC session. The public key is used to identify the PSYC channel.
639 * Note that end-users will usually not use the private key directly, but
640 * rather look it up in GNS for places managed by other users, or select
641 * a file with the private key(s) when setting up their own channels
642 * FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
644 * @param policy Channel policy specifying join and history restrictions.
645 * Used to automate join decisions.
646 * @param message_cb Function to invoke on message parts received from slaves.
647 * @param join_request_cb Function to invoke when a slave wants to join.
648 * @param master_start_cb Function to invoke after the channel master started.
649 * @param cls Closure for @a method and @a join_cb.
651 * @return Handle for the channel master, NULL on error.
653 struct GNUNET_PSYC_Master *
654 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
655 const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
656 enum GNUNET_PSYC_Policy policy,
657 GNUNET_PSYC_MasterStartCallback start_cb,
658 GNUNET_PSYC_JoinRequestCallback join_request_cb,
659 GNUNET_PSYC_MessageCallback message_cb,
660 GNUNET_PSYC_MessagePartCallback message_part_cb,
663 struct GNUNET_PSYC_Master *mst = GNUNET_malloc (sizeof (*mst));
664 struct GNUNET_PSYC_Channel *chn = &mst->chn;
666 struct MasterStartRequest *req = GNUNET_malloc (sizeof (*req));
667 req->header.size = htons (sizeof (*req));
668 req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MASTER_START);
669 req->channel_key = *channel_key;
670 req->policy = policy;
672 chn->connect_msg = &req->header;
674 chn->is_master = GNUNET_YES;
676 mst->start_cb = start_cb;
677 mst->join_req_cb = join_request_cb;
680 chn->client = GNUNET_CLIENT_MANAGER_connect (cfg, "psyc", master_handlers);
681 GNUNET_CLIENT_MANAGER_set_user_context_ (chn->client, mst, sizeof (*chn));
683 chn->tmit = GNUNET_PSYC_transmit_create (chn->client);
684 chn->recv = GNUNET_PSYC_receive_create (message_cb, message_part_cb, cls);
686 channel_send_connect_msg (chn);
692 * Stop a PSYC master channel.
694 * @param master PSYC channel master to stop.
695 * @param keep_active FIXME
698 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *mst,
700 GNUNET_ContinuationCallback stop_cb,
703 struct GNUNET_PSYC_Channel *chn = &mst->chn;
705 /* FIXME: send msg to service */
707 chn->is_disconnecting = GNUNET_YES;
708 chn->disconnect_cb = stop_cb;
709 chn->disconnect_cls = stop_cls;
711 GNUNET_CLIENT_MANAGER_disconnect (mst->chn.client, GNUNET_YES,
712 &master_cleanup, mst);
717 * Function to call with the decision made for a join request.
719 * Must be called once and only once in response to an invocation of the
720 * #GNUNET_PSYC_JoinCallback.
722 * @param jh Join request handle.
723 * @param is_admitted #GNUNET_YES if the join is approved,
724 * #GNUNET_NO if it is disapproved,
725 * #GNUNET_SYSERR if we cannot answer the request.
726 * @param relay_count Number of relays given.
727 * @param relays Array of suggested peers that might be useful relays to use
728 * when joining the multicast group (essentially a list of peers that
729 * are already part of the multicast group and might thus be willing
730 * to help with routing). If empty, only this local peer (which must
731 * be the multicast origin) is a good candidate for building the
732 * multicast tree. Note that it is unnecessary to specify our own
733 * peer identity in this array.
734 * @param join_resp Application-dependent join response message.
736 * @return #GNUNET_OK on success,
737 * #GNUNET_SYSERR if the message is too large.
740 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
742 uint32_t relay_count,
743 const struct GNUNET_PeerIdentity *relays,
744 const struct GNUNET_PSYC_Message *join_resp)
746 struct GNUNET_PSYC_Channel *chn = &jh->mst->chn;
747 struct GNUNET_PSYC_JoinDecisionMessage *dcsn;
748 uint16_t join_resp_size
749 = (NULL != join_resp) ? ntohs (join_resp->header.size) : 0;
750 uint16_t relay_size = relay_count * sizeof (*relays);
752 if (GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD
753 < sizeof (*dcsn) + relay_size + join_resp_size)
754 return GNUNET_SYSERR;
756 dcsn = GNUNET_malloc (sizeof (*dcsn) + relay_size + join_resp_size);
757 dcsn->header.size = htons (sizeof (*dcsn) + relay_size + join_resp_size);
758 dcsn->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION);
759 dcsn->is_admitted = htonl (is_admitted);
760 dcsn->slave_key = jh->slave_key;
762 if (0 < join_resp_size)
763 memcpy (&dcsn[1], join_resp, join_resp_size);
765 GNUNET_CLIENT_MANAGER_transmit (chn->client, &dcsn->header);
772 * Send a message to call a method to all members in the PSYC channel.
774 * @param master Handle to the PSYC channel.
775 * @param method_name Which method should be invoked.
776 * @param notify_mod Function to call to obtain modifiers.
777 * @param notify_data Function to call to obtain fragments of the data.
778 * @param notify_cls Closure for @a notify_mod and @a notify_data.
779 * @param flags Flags for the message being transmitted.
781 * @return Transmission handle, NULL on error (i.e. more than one request queued).
783 struct GNUNET_PSYC_MasterTransmitHandle *
784 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *mst,
785 const char *method_name,
786 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
787 GNUNET_PSYC_TransmitNotifyData notify_data,
789 enum GNUNET_PSYC_MasterTransmitFlags flags)
792 == GNUNET_PSYC_transmit_message (mst->chn.tmit, method_name, NULL,
793 notify_mod, notify_data, notify_cls,
795 return (struct GNUNET_PSYC_MasterTransmitHandle *) mst->chn.tmit;
802 * Resume transmission to the channel.
804 * @param tmit Handle of the request that is being resumed.
807 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *tmit)
809 GNUNET_PSYC_transmit_resume ((struct GNUNET_PSYC_TransmitHandle *) tmit);
814 * Abort transmission request to the channel.
816 * @param tmit Handle of the request that is being aborted.
819 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *tmit)
821 GNUNET_PSYC_transmit_cancel ((struct GNUNET_PSYC_TransmitHandle *) tmit);
826 * Convert a channel @a master to a @e channel handle to access the @e channel
829 * @param master Channel master handle.
831 * @return Channel handle, valid for as long as @a master is valid.
833 struct GNUNET_PSYC_Channel *
834 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master)
841 * Join a PSYC channel.
843 * The entity joining is always the local peer. The user must immediately use
844 * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
845 * channel; if the join request succeeds, the channel state (and @e recent
846 * method calls) will be replayed to the joining member. There is no explicit
847 * notification on failure (as the channel may simply take days to approve,
848 * and disapproval is simply being ignored).
850 * @param cfg Configuration to use.
851 * @param channel_key ECC public key that identifies the channel we wish to join.
852 * @param slave_key ECC private-public key pair that identifies the slave, and
853 * used by multicast to sign the join request and subsequent unicast
854 * requests sent to the master.
855 * @param origin Peer identity of the origin.
856 * @param relay_count Number of peers in the @a relays array.
857 * @param relays Peer identities of members of the multicast group, which serve
858 * as relays and used to join the group at.
859 * @param message_cb Function to invoke on message parts received from the
860 * channel, typically at least contains method handlers for @e join and
862 * @param slave_connect_cb Function invoked once we have connected to the
864 * @param join_decision_cb Function invoked once we have received a join
866 * @param cls Closure for @a message_cb and @a slave_joined_cb.
867 * @param method_name Method name for the join request.
868 * @param env Environment containing transient variables for the request, or NULL.
869 * @param data Payload for the join message.
870 * @param data_size Number of bytes in @a data.
872 * @return Handle for the slave, NULL on error.
874 struct GNUNET_PSYC_Slave *
875 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
876 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
877 const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_key,
878 const struct GNUNET_PeerIdentity *origin,
879 uint32_t relay_count,
880 const struct GNUNET_PeerIdentity *relays,
881 GNUNET_PSYC_MessageCallback message_cb,
882 GNUNET_PSYC_MessagePartCallback message_part_cb,
883 GNUNET_PSYC_SlaveConnectCallback connect_cb,
884 GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
886 const struct GNUNET_PSYC_Message *join_msg)
888 struct GNUNET_PSYC_Slave *slv = GNUNET_malloc (sizeof (*slv));
889 struct GNUNET_PSYC_Channel *chn = &slv->chn;
890 uint16_t relay_size = relay_count * sizeof (*relays);
891 uint16_t join_msg_size;
892 struct SlaveJoinRequest *req;
894 if (NULL == join_msg)
897 join_msg_size = ntohs (join_msg->header.size);
898 req = GNUNET_malloc (sizeof (*req) + relay_size + join_msg_size);
899 req->header.size = htons (sizeof (*req) + relay_size + join_msg_size);
900 req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN);
901 req->channel_key = *channel_key;
902 req->slave_key = *slave_key;
903 req->origin = *origin;
904 req->relay_count = htonl (relay_count);
907 memcpy (&req[1], relays, relay_size);
909 if (NULL != join_msg)
910 memcpy ((char *) &req[1] + relay_size, join_msg, join_msg_size);
912 chn->connect_msg = &req->header;
914 chn->is_master = GNUNET_NO;
916 slv->connect_cb = connect_cb;
917 slv->join_dcsn_cb = join_decision_cb;
920 chn->client = GNUNET_CLIENT_MANAGER_connect (cfg, "psyc", slave_handlers);
921 GNUNET_CLIENT_MANAGER_set_user_context_ (chn->client, slv, sizeof (*chn));
923 chn->recv = GNUNET_PSYC_receive_create (message_cb, message_part_cb, cls);
924 chn->tmit = GNUNET_PSYC_transmit_create (chn->client);
926 channel_send_connect_msg (chn);
932 * Part a PSYC channel.
934 * Will terminate the connection to the PSYC service. Polite clients should
935 * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
937 * @param slave Slave handle.
940 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slv,
942 GNUNET_ContinuationCallback part_cb,
945 struct GNUNET_PSYC_Channel *chn = &slv->chn;
947 /* FIXME: send msg to service */
949 chn->is_disconnecting = GNUNET_YES;
950 chn->disconnect_cb = part_cb;
951 chn->disconnect_cls = part_cls;
953 GNUNET_CLIENT_MANAGER_disconnect (slv->chn.client, GNUNET_YES,
954 &slave_cleanup, slv);
959 * Request a message to be sent to the channel master.
961 * @param slave Slave handle.
962 * @param method_name Which (PSYC) method should be invoked (on host).
963 * @param notify_mod Function to call to obtain modifiers.
964 * @param notify_data Function to call to obtain fragments of the data.
965 * @param notify_cls Closure for @a notify.
966 * @param flags Flags for the message being transmitted.
968 * @return Transmission handle, NULL on error (i.e. more than one request
971 struct GNUNET_PSYC_SlaveTransmitHandle *
972 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slv,
973 const char *method_name,
974 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
975 GNUNET_PSYC_TransmitNotifyData notify_data,
977 enum GNUNET_PSYC_SlaveTransmitFlags flags)
981 == GNUNET_PSYC_transmit_message (slv->chn.tmit, method_name, NULL,
982 notify_mod, notify_data, notify_cls,
984 return (struct GNUNET_PSYC_SlaveTransmitHandle *) slv->chn.tmit;
991 * Resume transmission to the master.
993 * @param tmit Handle of the request that is being resumed.
996 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *tmit)
998 GNUNET_PSYC_transmit_resume ((struct GNUNET_PSYC_TransmitHandle *) tmit);
1003 * Abort transmission request to master.
1005 * @param tmit Handle of the request that is being aborted.
1008 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *tmit)
1010 GNUNET_PSYC_transmit_cancel ((struct GNUNET_PSYC_TransmitHandle *) tmit);
1015 * Convert @a slave to a @e channel handle to access the @e channel APIs.
1017 * @param slv Slave handle.
1019 * @return Channel handle, valid for as long as @a slave is valid.
1021 struct GNUNET_PSYC_Channel *
1022 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slv)
1029 * Add a slave to the channel's membership list.
1031 * Note that this will NOT generate any PSYC traffic, it will merely update the
1032 * local database to modify how we react to <em>membership test</em> queries.
1033 * The channel master still needs to explicitly transmit a @e join message to
1034 * notify other channel members and they then also must still call this function
1035 * in their respective methods handling the @e join message. This way, how @e
1036 * join and @e part operations are exactly implemented is still up to the
1037 * application; for example, there might be a @e part_all method to kick out
1040 * Note that channel slaves are explicitly trusted to execute such methods
1041 * correctly; not doing so correctly will result in either denying other slaves
1042 * access or offering access to channel data to non-members.
1047 * Identity of channel slave to add.
1048 * @param announced_at
1049 * ID of the message that announced the membership change.
1050 * @param effective_since
1051 * Addition of slave is in effect since this message ID.
1053 * Function to call with the result of the operation.
1054 * The @e result_code argument is #GNUNET_OK on success, or
1055 * #GNUNET_SYSERR on error. In case of an error, the @e data argument
1056 * can contain an optional error message.
1058 * Closure for @a result_cb.
1061 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *chn,
1062 const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
1063 uint64_t announced_at,
1064 uint64_t effective_since,
1065 GNUNET_ResultCallback result_cb,
1068 struct ChannelMembershipStoreRequest *req = GNUNET_malloc (sizeof (*req));
1069 req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_MEMBERSHIP_STORE);
1070 req->header.size = htons (sizeof (*req));
1071 req->slave_key = *slave_key;
1072 req->announced_at = GNUNET_htonll (announced_at);
1073 req->effective_since = GNUNET_htonll (effective_since);
1074 req->did_join = GNUNET_YES;
1075 req->op_id = GNUNET_htonll (GNUNET_CLIENT_MANAGER_op_add (chn->client,
1078 GNUNET_CLIENT_MANAGER_transmit (chn->client, &req->header);
1083 * Remove a slave from the channel's membership list.
1085 * Note that this will NOT generate any PSYC traffic, it will merely update the
1086 * local database to modify how we react to <em>membership test</em> queries.
1087 * The channel master still needs to explicitly transmit a @e part message to
1088 * notify other channel members and they then also must still call this function
1089 * in their respective methods handling the @e part message. This way, how
1090 * @e join and @e part operations are exactly implemented is still up to the
1091 * application; for example, there might be a @e part_all message to kick out
1094 * Note that channel members are explicitly trusted to perform these
1095 * operations correctly; not doing so correctly will result in either
1096 * denying members access or offering access to channel data to
1102 * Identity of channel slave to remove.
1103 * @param announced_at
1104 * ID of the message that announced the membership change.
1106 * Function to call with the result of the operation.
1107 * The @e result_code argument is #GNUNET_OK on success, or
1108 * #GNUNET_SYSERR on error. In case of an error, the @e data argument
1109 * can contain an optional error message.
1111 * Closure for @a result_cb.
1114 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *chn,
1115 const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
1116 uint64_t announced_at,
1117 GNUNET_ResultCallback result_cb,
1120 struct ChannelMembershipStoreRequest *req = GNUNET_malloc (sizeof (*req));
1121 req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_MEMBERSHIP_STORE);
1122 req->header.size = htons (sizeof (*req));
1123 req->slave_key = *slave_key;
1124 req->announced_at = GNUNET_htonll (announced_at);
1125 req->did_join = GNUNET_NO;
1126 req->op_id = GNUNET_htonll (GNUNET_CLIENT_MANAGER_op_add (chn->client,
1129 GNUNET_CLIENT_MANAGER_transmit (chn->client, &req->header);
1133 static struct GNUNET_PSYC_HistoryRequest *
1134 channel_history_replay (struct GNUNET_PSYC_Channel *chn,
1135 uint64_t start_message_id,
1136 uint64_t end_message_id,
1137 uint64_t message_limit,
1138 const char *method_prefix,
1140 GNUNET_PSYC_MessageCallback message_cb,
1141 GNUNET_PSYC_MessagePartCallback message_part_cb,
1142 GNUNET_ResultCallback result_cb,
1145 struct GNUNET_PSYC_HistoryRequestMessage *req;
1146 struct GNUNET_PSYC_HistoryRequest *hist = GNUNET_malloc (sizeof (*hist));
1148 hist->recv = GNUNET_PSYC_receive_create (message_cb, message_part_cb, cls);
1149 hist->result_cb = result_cb;
1151 hist->op_id = GNUNET_CLIENT_MANAGER_op_add (chn->client,
1152 &op_recv_history_result, hist);
1154 GNUNET_assert (NULL != method_prefix);
1155 uint16_t method_size = strnlen (method_prefix,
1156 GNUNET_SERVER_MAX_MESSAGE_SIZE
1157 - sizeof (*req)) + 1;
1158 GNUNET_assert ('\0' == method_prefix[method_size - 1]);
1159 req = GNUNET_malloc (sizeof (*req) + method_size);
1160 req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_HISTORY_REPLAY);
1161 req->header.size = htons (sizeof (*req) + method_size);
1162 req->start_message_id = GNUNET_htonll (start_message_id);
1163 req->end_message_id = GNUNET_htonll (end_message_id);
1164 req->message_limit = GNUNET_htonll (message_limit);
1165 req->flags = htonl (flags);
1166 req->op_id = GNUNET_htonll (hist->op_id);
1167 memcpy (&req[1], method_prefix, method_size);
1169 GNUNET_CLIENT_MANAGER_transmit (chn->client, &req->header);
1175 * Request to replay a part of the message history of the channel.
1177 * Historic messages (but NOT the state at the time) will be replayed and given
1178 * to the normal method handlers with a #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
1180 * Messages are retrieved from the local PSYCstore if available,
1181 * otherwise requested from the network.
1184 * Which channel should be replayed?
1185 * @param start_message_id
1186 * Earliest interesting point in history.
1187 * @param end_message_id
1188 * Last (inclusive) interesting point in history.
1189 * @param method_prefix
1190 * Retrieve only messages with a matching method prefix.
1192 * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
1194 * Function to call when the requested history has been fully replayed.
1196 * Closure for the callbacks.
1198 * @return Handle to cancel history replay operation.
1200 struct GNUNET_PSYC_HistoryRequest *
1201 GNUNET_PSYC_channel_history_replay (struct GNUNET_PSYC_Channel *chn,
1202 uint64_t start_message_id,
1203 uint64_t end_message_id,
1204 const char *method_prefix,
1206 GNUNET_PSYC_MessageCallback message_cb,
1207 GNUNET_PSYC_MessagePartCallback message_part_cb,
1208 GNUNET_ResultCallback result_cb,
1211 return channel_history_replay (chn, start_message_id, end_message_id, 0,
1212 method_prefix, flags,
1213 message_cb, message_part_cb, result_cb, cls);
1218 * Request to replay the latest messages from the message history of the channel.
1220 * Historic messages (but NOT the state at the time) will be replayed (given to
1221 * the normal method handlers) if available and if access is permitted.
1224 * Which channel should be replayed?
1225 * @param message_limit
1226 * Maximum number of messages to replay.
1227 * @param method_prefix
1228 * Retrieve only messages with a matching method prefix.
1229 * Use NULL or "" to retrieve all.
1231 * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
1233 * Function to call when the requested history has been fully replayed.
1235 * Closure for the callbacks.
1237 * @return Handle to cancel history replay operation.
1239 struct GNUNET_PSYC_HistoryRequest *
1240 GNUNET_PSYC_channel_history_replay_latest (struct GNUNET_PSYC_Channel *chn,
1241 uint64_t message_limit,
1242 const char *method_prefix,
1244 GNUNET_PSYC_MessageCallback message_cb,
1245 GNUNET_PSYC_MessagePartCallback message_part_cb,
1246 GNUNET_ResultCallback result_cb,
1249 return channel_history_replay (chn, 0, 0, message_limit, method_prefix, flags,
1250 message_cb, message_part_cb, result_cb, cls);
1255 GNUNET_PSYC_channel_history_replay_cancel (struct GNUNET_PSYC_Channel *channel,
1256 struct GNUNET_PSYC_HistoryRequest *hist)
1258 GNUNET_PSYC_receive_destroy (hist->recv);
1259 GNUNET_CLIENT_MANAGER_op_cancel (hist->chn->client, hist->op_id);
1265 * Retrieve the best matching channel state variable.
1267 * If the requested variable name is not present in the state, the nearest
1268 * less-specific name is matched; for example, requesting "_a_b" will match "_a"
1269 * if "_a_b" does not exist.
1274 * Full name of the requested variable.
1275 * The actual variable returned might have a shorter name.
1277 * Function called once when a matching state variable is found.
1278 * Not called if there's no matching state variable.
1280 * Function called after the operation finished.
1281 * (i.e. all state variables have been returned via @a state_cb)
1283 * Closure for the callbacks.
1285 static struct GNUNET_PSYC_StateRequest *
1286 channel_state_get (struct GNUNET_PSYC_Channel *chn,
1287 uint16_t type, const char *name,
1288 GNUNET_PSYC_StateVarCallback var_cb,
1289 GNUNET_ResultCallback result_cb, void *cls)
1291 struct StateRequest *req;
1292 struct GNUNET_PSYC_StateRequest *sr = GNUNET_malloc (sizeof (*sr));
1294 sr->var_cb = var_cb;
1295 sr->result_cb = result_cb;
1297 sr->op_id = GNUNET_CLIENT_MANAGER_op_add (chn->client,
1298 &op_recv_state_result, sr);
1300 GNUNET_assert (NULL != name);
1301 size_t name_size = strnlen (name, GNUNET_SERVER_MAX_MESSAGE_SIZE
1302 - sizeof (*req)) + 1;
1303 req = GNUNET_malloc (sizeof (*req) + name_size);
1304 req->header.type = htons (type);
1305 req->header.size = htons (sizeof (*req) + name_size);
1306 req->op_id = GNUNET_htonll (sr->op_id);
1307 memcpy (&req[1], name, name_size);
1309 GNUNET_CLIENT_MANAGER_transmit (chn->client, &req->header);
1315 * Retrieve the best matching channel state variable.
1317 * If the requested variable name is not present in the state, the nearest
1318 * less-specific name is matched; for example, requesting "_a_b" will match "_a"
1319 * if "_a_b" does not exist.
1324 * Full name of the requested variable.
1325 * The actual variable returned might have a shorter name.
1327 * Function called once when a matching state variable is found.
1328 * Not called if there's no matching state variable.
1330 * Function called after the operation finished.
1331 * (i.e. all state variables have been returned via @a state_cb)
1333 * Closure for the callbacks.
1335 struct GNUNET_PSYC_StateRequest *
1336 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *chn,
1337 const char *full_name,
1338 GNUNET_PSYC_StateVarCallback var_cb,
1339 GNUNET_ResultCallback result_cb,
1342 return channel_state_get (chn, GNUNET_MESSAGE_TYPE_PSYC_STATE_GET,
1343 full_name, var_cb, result_cb, cls);
1349 * Return all channel state variables whose name matches a given prefix.
1351 * A name matches if it starts with the given @a name_prefix, thus requesting
1352 * the empty prefix ("") will match all values; requesting "_a_b" will also
1353 * return values stored under "_a_b_c".
1355 * The @a state_cb is invoked on all matching state variables asynchronously, as
1356 * the state is stored in and retrieved from the PSYCstore,
1360 * @param name_prefix
1361 * Prefix of the state variable name to match.
1363 * Function called once when a matching state variable is found.
1364 * Not called if there's no matching state variable.
1366 * Function called after the operation finished.
1367 * (i.e. all state variables have been returned via @a state_cb)
1369 * Closure for the callbacks.
1371 struct GNUNET_PSYC_StateRequest *
1372 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *chn,
1373 const char *name_prefix,
1374 GNUNET_PSYC_StateVarCallback var_cb,
1375 GNUNET_ResultCallback result_cb,
1378 return channel_state_get (chn, GNUNET_MESSAGE_TYPE_PSYC_STATE_GET_PREFIX,
1379 name_prefix, var_cb, result_cb, cls);
1384 * Cancel a state request operation.
1387 * Handle for the operation to cancel.
1390 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateRequest *sr)
1392 GNUNET_CLIENT_MANAGER_op_cancel (sr->chn->client, sr->op_id);
1396 /* end of psyc_api.c */