2 This file is part of GNUnet.
3 (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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_social_service.h
23 * @brief Social service; implements social functionality using the PSYC service.
24 * @author Gabor X Toth
25 * @author Christian Grothoff
27 #ifndef GNUNET_SOCIAL_SERVICE_H
28 #define GNUNET_SOCIAL_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_psyc_lib.h"
40 #include "gnunet_psyc_service.h"
41 #include "gnunet_multicast_service.h"
45 * Version number of GNUnet Social API.
47 #define GNUNET_SOCIAL_VERSION 0x00000000
51 * Handle for another user (who is likely pseudonymous) in the network.
53 struct GNUNET_SOCIAL_Nym;
56 * Handle for a place where social interactions happen.
58 struct GNUNET_SOCIAL_Place;
61 * Handle for a place that one of our egos hosts.
63 struct GNUNET_SOCIAL_Home;
66 * Handle to an implementation of try-and-slice.
68 struct GNUNET_SOCIAL_Slicer;
72 * Method called from SOCIAL upon receiving a message indicating a call
76 * @param full_method_name Original method name from PSYC (may be more
77 * specific than the registered method name due to try-and-slice matching).
79 * @param message_id Unique message counter for this message
80 * (unique only in combination with the given sender for
82 * @param modifier_count Number of elements in the @a modifiers array.
83 * @param modifiers Modifiers present in the message. FIXME: use environment instead?
84 * @param data_offset Byte offset of @a data in the overall data of the method.
85 * @param data_size Number of bytes in @a data.
86 * @param data Data stream given to the method (might not be zero-terminated
88 * @param flags Message flags indicating fragmentation status.
90 typedef int (*GNUNET_SOCIAL_Method)(void *cls,
91 const char *full_method_name,
93 size_t modifier_count,
94 GNUNET_PSYC_Modifier *modifiers,
98 enum GNUNET_PSYC_MessageFlags flags);
102 * Create a try-and-slice instance.
104 * @return A new try-and-slice construct.
106 struct GNUNET_SOCIAL_Slicer *
107 GNUNET_SOCIAL_slicer_create (void);
111 * Add a method to the try-and-slice instance.
113 * A slicer processes messages and calls methods that match a message. A match
114 * happens whenever the method name of a message starts with the method_name
115 * parameter given here.
117 * @param slicer The try-and-slice instance to extend.
118 * @param method_name Name of the given method, use empty string for default.
119 * @param method Method to invoke.
120 * @param method_cls Closure for method.
123 GNUNET_SOCIAL_slicer_add (struct GNUNET_SOCIAL_Slicer *slicer,
124 const char *method_name,
125 GNUNET_SOCIAL_Method method,
130 * Remove a registered method from the try-and-slice instance.
132 * @param slicer The try-and-slice instance.
133 * @param method_name Name of the method to remove.
134 * @param method Method handler.
137 GNUNET_SOCIAL_slicer_remove (struct GNUNET_SOCIAL_Slicer *slicer,
138 const char *method_name,
139 GNUNET_SOCIAL_Method method);
142 * Destroy a given try-and-slice instance.
144 * @param slicer slicer to destroy
147 GNUNET_SOCIAL_slicer_destroy (struct GNUNET_SOCIAL_Slicer *slicer);
151 * Function called asking for nym to be admitted to the place.
153 * Should call either GNUNET_SOCIAL_home_admit() or
154 * GNUNET_SOCIAL_home_reject_entry() (possibly asynchronously). If this owner
155 * cannot decide, it is fine to call neither function, in which case hopefully
156 * some other owner of the home exists that will make the decision. The @a nym
157 * reference remains valid until the #GNUNET_SOCIAL_FarewellCallback is invoked
160 * @param cls Closure.
161 * @param nym Handle for the user who wants to enter.
162 * @param method_name Method name in the entry request.
163 * @param variable_count Number of elements in the @a variables array.
164 * @param variables Variables present in the message.
165 * @param data_size Number of bytes in @a data.
166 * @param data Payload given on enter (e.g. a password).
168 typedef void (*GNUNET_SOCIAL_AnswerDoorCallback)(void *cls,
169 struct GNUNET_SOCIAL_Nym *nym,
170 size_t variable_count,
171 const char *method_name,
172 GNUNET_PSYC_Modifier *variables,
178 * Function called when a @a nym leaves the place.
180 * This is also called if the @a nym was never given permission to enter
181 * (i.e. the @a nym stopped asking to get in).
183 * @param cls Closure.
184 * @param nym Handle for the user who left.
185 * @param variable_count Number of elements in the @a variables array.
186 * @param variables Variables present in the message.
188 typedef void (*GNUNET_SOCIAL_FarewellCallback)(void *cls,
189 struct GNUNET_SOCIAL_Nym *nym,
190 size_t variable_count,
191 GNUNET_PSYC_Modifier *variables);
195 * Enter a home where guests (nyms) can be hosted.
197 * A home is created upon first entering, and exists until
198 * GNUNET_SOCIAL_home_destroy() is called. It can also be left temporarily using
199 * GNUNET_SOCIAL_home_leave().
201 * @param cfg Configuration to contact the social service.
202 * @param home_keyfile File with the private-public key pair of the home,
203 * created if the file does not exist; pass NULL for ephemeral homes.
204 * @param policy Policy specifying entry and history restrictions of the home.
205 * @param ego Owner of the home (host).
206 * @param slicer Slicer to handle guests talking.
207 * @param listener_cb Function to handle new nyms that want to enter.
208 * @param farewell_cb Function to handle departing nyms.
209 * @param cls Closure for @a listener_cb and @a farewell_cb.
210 * @return Handle for a new home.
212 struct GNUNET_SOCIAL_Home *
213 GNUNET_SOCIAL_home_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
214 const char *home_keyfile,
215 enum GNUNET_PSYC_Policy policy,
216 struct GNUNET_IDENTITY_Ego *ego,
217 struct GNUNET_SOCIAL_Slicer *slicer,
218 GNUNET_SOCIAL_AnswerDoorCallback listener_cb,
219 GNUNET_SOCIAL_FarewellCallback farewell_cb,
224 * Admit @a nym to the @a home.
226 * The @a nym reference will remain valid until either the home is destroyed or
229 * @param home Home to allow @a nym to enter.
230 * @param nym Handle for the entity that wants to enter.
233 GNUNET_SOCIAL_home_admit (struct GNUNET_SOCIAL_Home *home,
234 struct GNUNET_SOCIAL_Nym *nym);
238 * Throw @a nym out of the @a home.
240 * The @a nym reference will remain valid until the
241 * #GNUNET_SOCIAL_FarewellCallback is invoked,
242 * which should be very soon after this call.
244 * @param home Home to eject @a nym from.
245 * @param nym Handle for the entity to be ejected.
248 GNUNET_SOCIAL_home_eject (struct GNUNET_SOCIAL_Home *home,
249 struct GNUNET_SOCIAL_Nym *nym);
253 * Refuse @a nym entry into the @a home.
255 * @param home Home to disallow @a nym to enter.
256 * @param nym Handle for the entity that wanted to enter.
257 * @param method_name Method name for the rejection message.
258 * @param env Environment containing variables for the message, or NULL.
259 * @param data_size Number of bytes in @a data for method.
260 * @param data Data for the rejection message to send back.
263 GNUNET_SOCIAL_home_reject_entry (struct GNUNET_SOCIAL_Home *home,
264 struct GNUNET_SOCIAL_Nym *nym,
265 const char *method_name,
266 const struct GNUNET_ENV_Environment *env,
272 * Get the public key of a nym.
274 * Suitable, for example, to be used with GNUNET_NAMESTORE_zone_to_name().
276 * @param nym Pseudonym to map to a cryptographic identifier.
277 * @param[out] nym_key Set to the public key of the nym.
280 GNUNET_SOCIAL_nym_get_key (struct GNUNET_SOCIAL_Nym *nym,
281 struct GNUNET_CRYPTO_EccPublicKey *nym_key);
285 * Obtain the private-public key pair of the home.
287 * @param home Home to get the key of.
288 * @param[out] home_key Set to the private-public key pair of the home. The public part is suitable for storing in GADS within a "PLACE" record, along with peer IDs to join at.
291 GNUNET_SOCIAL_home_get_key (struct GNUNET_SOCIAL_Home *home,
292 struct GNUNET_CRYPTO_EccPrivateKey *home_key);
296 * Advertise @a home under @a name in the GADS zone of the @e ego.
298 * @param home The home to advertise.
299 * @param name The name for the PLACE record to put in the zone.
300 * @param peer_count Number of elements in the @a peers array.
301 * @param peers List of peers in the PLACE record that can be used to send join
303 * @param expiration_time Expiration time of the record, use 0 to remove the record.
304 * @param password Password used to encrypt the record.
307 GNUNET_SOCIAL_home_advertise (struct GNUNET_SOCIAL_Home *home,
310 const struct GNUNET_PeerIdentity *peers,
311 GNUNET_TIME_Relative expiration_time,
312 const char *password);
316 * Flags for announcements in a home.
318 enum GNUNET_PSYC_AnnouncementFlags
321 * Whether this announcement removes all objects from the home.
323 * New objects can be still added to the now empty home using the @e env
324 * parameter of the same announcement.
326 GNUNET_SOCIAL_ANNOUNCEMENT_CLEAR_OBJECTS = 1 << 0
331 * Handle for an announcement request.
333 struct GNUNET_SOCIAL_Announcement;
337 * Send a message to all nyms that are present in the home.
339 * This function is restricted to the home owner. Nyms can only send requests
340 * to the home owner who can decide to relay it to other guests.
342 * @param home Home to address the announcement to.
343 * @param method_name Method to use for the announcement.
344 * @param env Environment containing variables for the message and operations on
345 * objects of the home, or NULL.
346 * @param notify Function to call to get the payload of the announcement.
347 * @param notify_cls Closure for @a notify.
348 * @param flags Flags for this announcement.
349 * @return NULL on error (announcement already in progress?).
351 struct GNUNET_SOCIAL_Announcement *
352 GNUNET_SOCIAL_home_announce (struct GNUNET_SOCIAL_Home *home,
353 const char *method_name,
354 const struct GNUNET_ENV_Environment *env,
355 GNUNET_CONNECTION_TransmitReadyNotify notify,
357 GNUNET_SOCIAL_AnnouncementFlags flags);
361 * Cancel announcement.
363 * @param a The announcement to cancel.
366 GNUNET_SOCIAL_home_announce_cancel (struct GNUNET_SOCIAL_Announcement *a);
370 * Convert our home to a place so we can access it via the place API.
372 * @param home Handle for the home.
373 * @return Place handle for the same home, valid as long as @a home is valid;
374 * do NOT try to GNUNET_SOCIAL_place_leave() this place, it's your home!
376 struct GNUNET_SOCIAL_Place *
377 GNUNET_SOCIAL_home_get_place (struct GNUNET_SOCIAL_Home *home);
381 * Leave a home temporarily, visitors can stay.
383 * After leaving, handling of incoming messages are left to other clients of the
384 * social service, and stops after the last client exits.
386 * @param home Home to leave temporarily (handle becomes invalid).
389 GNUNET_SOCIAL_home_away (struct GNUNET_SOCIAL_Home *home);
395 * Invalidates home handle.
396 * Guests will be disconnected until the home is restarted.
398 * @param home Home to leave.
401 GNUNET_SOCIAL_home_leave (struct GNUNET_SOCIAL_Home *home);
404 * Request entry to a place (home hosted by someone else).
406 * @param cfg Configuration to contact the social service.
407 * @param ego Owner of the home (host).
408 * @param address GADS name of the place to enter. Either in the form of
409 * 'room.friend.gnu', or 'NYMPUBKEY.zkey'. This latter case refers to
410 * the 'PLACE' record of the empty label ("+") in the GADS zone with the
411 * nym's public key 'NYMPUBKEY', and can be used to request entry to a
412 * pseudonym's place directly.
413 * @param method_name Method name for the message.
414 * @param env Environment containing variables for the message, or NULL.
415 * @param data_size Number of bytes in @a data.
416 * @param data Payload for the message to give to the enter callback.
417 * @param slicer Slicer to use for processing incoming requests from guests.
418 * @return NULL on errors, otherwise handle to the place.
420 struct GNUNET_SOCIAL_Place *
421 GNUNET_SOCIAL_place_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
422 struct GNUNET_IDENTITY_Ego *ego,
424 const char *method_name,
425 const struct GNUNET_ENV_Environment *env,
428 struct GNUNET_SOCIAL_Slicer *slicer);
431 * Request entry to a place (home hosted by someone else).
433 * @param cfg Configuration to contact the social service.
434 * @param ego Owner of the home (host).
435 * @param crypto_address Public key of the place to enter.
436 * @param origin Peer identity of the origin of the underlying multicast group.
437 * @param relay_count Number of elements in the @a relays array.
438 * @param relays Relays for the underlying multicast group.
439 * @param method_name Method name for the message.
440 * @param env Environment containing variables for the message, or NULL.
441 * @param data_size Number of bytes in @a data.
442 * @param data Payload for the message to give to the enter callback.
443 * @param slicer Slicer to use for processing incoming requests from guests.
444 * @return NULL on errors, otherwise handle to the place.
446 struct GNUNET_SOCIAL_Place *
447 GNUNET_SOCIAL_place_enter2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
448 struct GNUNET_IDENTITY_Ego *ego,
449 struct GNUNET_CRYPTO_EccPublicKey *crypto_address,
450 struct GNUNET_PeerIdentity *origin,
452 struct GNUNET_PeerIdentity *relays,
453 const char *method_name,
454 const struct GNUNET_ENV_Environment *env,
457 struct GNUNET_SOCIAL_Slicer *slicer);
460 struct GNUNET_SOCIAL_WatchHandle;
463 * Watch a place for changed objects.
465 * @param place Place to watch.
466 * @param object_filter Object prefix to match.
467 * @param state_cb Function to call when an object/state changes.
468 * @param state_cb_cls Closure for callback.
470 * @return Handle that can be used to cancel watching.
472 struct GNUNET_SOCIAL_WatchHandle *
473 GNUNET_SOCIAL_place_watch (struct GNUNET_SOCIAL_Place *place,
474 const char *object_filter,
475 GNUNET_PSYC_StateCallback state_cb,
480 * Cancel watching a place for changed objects.
482 * @param wh Watch handle to cancel.
485 GNUNET_SOCIAL_place_watch_cancel (struct GNUNET_SOCIAL_WatchHandle *wh);
488 struct GNUNET_SOCIAL_LookHandle;
491 * Look at all objects in the place.
493 * @param place The place to look its objects at.
494 * @param state_cb Function to call for each object found.
495 * @param state_cb_cls Closure for callback function.
497 * @return Handle that can be used to stop looking at objects.
499 struct GNUNET_SOCIAL_LookHandle *
500 GNUNET_SOCIAL_place_look (struct GNUNET_SOCIAL_Place *place,
501 GNUNET_PSYC_StateCallback state_cb,
506 * Look at matching objects in the place.
508 * @param place The place to look its objects at.
509 * @param object_filter Only look at objects with names beginning with this filter value.
510 * @param state_cb Function to call for each object found.
511 * @param state_cb_cls Closure for callback function.
513 * @return Handle that can be used to stop looking at objects.
515 struct GNUNET_SOCIAL_LookHandle *
516 GNUNET_SOCIAL_place_look_for (struct GNUNET_SOCIAL_Place *place,
517 const char *object_filter,
518 GNUNET_PSYC_StateCallback state_cb,
523 * Stop looking at objects.
525 * @param lh Look handle to stop.
528 GNUNET_SOCIAL_place_look_cancel (struct GNUNET_SOCIAL_LookHandle *lh);
533 * Look at a particular object in the place.
535 * @param place The place to look the object at.
536 * @param object_name Full name of the object.
537 * @param value_size Set to the size of the returned value.
538 * @return NULL if there is no such object at this place.
541 GNUNET_SOCIAL_place_look_at (struct GNUNET_SOCIAL_Place *place,
542 const char *object_name,
547 * Flags for talking to the host of a place.
549 enum GNUNET_SOCIAL_TalkFlags;
555 struct GNUNET_SOCIAL_TalkRequest;
558 * Talk to the host of the place.
560 * @param place Place where we want to talk to the host.
561 * @param method_name Method to invoke on the host.
562 * @param env Environment containing variables for the message, or NULL.
563 * @param notify Function to use to get the payload for the method.
564 * @param notify_cls Closure for @a notify.
565 * @param flags Flags for the message being sent.
566 * @return NULL if we are already trying to talk to the host,
567 * otherwise handle to cancel the request.
569 struct GNUNET_SOCIAL_TalkRequest *
570 GNUNET_SOCIAL_place_talk (struct GNUNET_SOCIAL_Place *place,
571 const char *method_name,
572 const struct GNUNET_ENV_Environment *env,
573 GNUNET_CONNECTION_TransmitReadyNotify notify,
575 GNUNET_SOCIAL_TalkFlags flags);
579 * Cancel talking to the host of the place.
581 * @param tr Talk request to cancel.
584 GNUNET_SOCIAL_place_talk_cancel (struct GNUNET_SOCIAL_TalkRequest *tr);
590 struct GNUNET_SOCIAL_HistoryLesson;
593 * Learn about the history of a place.
595 * Sends messages through the slicer function of the place where
596 * start_message_id <= message_id <= end_message_id.
597 * The messages will have the #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
599 * To get the latest message, use 0 for both the start and end message ID.
601 * @param place Place we want to learn more about.
602 * @param start_message_id First historic message we are interested in.
603 * @param end_message_id Last historic message we are interested in (inclusive).
604 * @param slicer Slicer to use to process history. Can be the same as the
605 * slicer of the place, as the HISTORIC flag allows distinguishing
606 * old messages from fresh ones.
607 * @param finish_cb Function called after the last message if the history lesson
608 * is passed through the @a slicer. NULL if not needed.
609 * @param finish_cb_cls Closure for @a finish_cb.
610 * @return Handle to abort history lesson, never NULL (multiple lessons
611 * at the same time are allowed).
613 struct GNUNET_SOCIAL_HistoryLesson *
614 GNUNET_SOCIAL_place_get_history (struct GNUNET_SOCIAL_Place *place,
615 uint64_t start_message_id,
616 uint64_t end_message_id,
617 const struct GNUNET_SOCIAL_Slicer *slicer,
618 void (*finish_cb)(void *),
619 void *finish_cb_cls);
623 * Stop processing messages from the history lesson.
625 * Must not be called after the finish callback of the history lesson is called.
627 * @param hist History lesson to cancel.
630 GNUNET_SOCIAL_place_get_history_cancel (struct GNUNET_SOCIAL_HistoryLesson *hist);
634 * Leave a place permanently.
636 * Notifies the owner of the place about leaving, and destroys the place handle.
638 * @param place Place to leave permanently.
641 GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place);
645 * Leave a place temporarily.
647 * Stop following the conversation for the @a place and destroy the @a place
648 * handle. Only affects the application calling this function, other clients of
649 * the service continue receiving the messages.
651 * @param place Place to leave temporarily.
654 GNUNET_SOCIAL_place_away (struct GNUNET_SOCIAL_Place *place);
657 #if 0 /* keep Emacsens' auto-indent happy */
664 /* ifndef GNUNET_SOCIAL_SERVICE_H */
666 /* end of gnunet_social_service.h */