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_env_lib.h"
40 #include "gnunet_identity_service.h"
41 #include "gnunet_psyc_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 nym The sender of the message. NULL for the ego's own messages to the home.
77 * @param full_method_name Original method name from PSYC (may be more
78 * specific than the registered method name due to try-and-slice matching).
80 * @param message_id Unique message counter for this message
81 * (unique only in combination with the given sender for
83 * @param modifier_count Number of elements in the @a modifiers array.
84 * @param modifiers Modifiers present in the message. FIXME: use environment instead?
85 * @param data_offset Byte offset of @a data in the overall data of the method.
86 * @param data Data stream given to the method (might not be zero-terminated
88 * @param data_size Number of bytes in @a data.
89 * @param flags Message flags indicating fragmentation status.
92 (*GNUNET_SOCIAL_Method) (void *cls,
93 struct GNUNET_SOCIAL_Nym *nym,
94 const char *full_method_name,
96 size_t modifier_count,
97 struct GNUNET_ENV_Modifier *modifiers,
101 enum GNUNET_PSYC_MessageFlags flags);
105 * Create a try-and-slice instance.
107 * @return A new try-and-slice construct.
109 struct GNUNET_SOCIAL_Slicer *
110 GNUNET_SOCIAL_slicer_create (void);
114 * Add a method to the try-and-slice instance.
116 * A slicer processes messages and calls methods that match a message. A match
117 * happens whenever the method name of a message starts with the method_name
118 * parameter given here.
120 * @param slicer The try-and-slice instance to extend.
121 * @param method_name Name of the given method, use empty string for default.
122 * @param method Method to invoke.
123 * @param method_cls Closure for method.
126 GNUNET_SOCIAL_slicer_add (struct GNUNET_SOCIAL_Slicer *slicer,
127 const char *method_name,
128 GNUNET_SOCIAL_Method method,
133 * Remove a registered method from the try-and-slice instance.
135 * @param slicer The try-and-slice instance.
136 * @param method_name Name of the method to remove.
137 * @param method Method handler.
140 GNUNET_SOCIAL_slicer_remove (struct GNUNET_SOCIAL_Slicer *slicer,
141 const char *method_name,
142 GNUNET_SOCIAL_Method method);
145 * Destroy a given try-and-slice instance.
147 * @param slicer slicer to destroy
150 GNUNET_SOCIAL_slicer_destroy (struct GNUNET_SOCIAL_Slicer *slicer);
154 * Function called asking for nym to be admitted to the place.
156 * Should call either GNUNET_SOCIAL_home_admit() or
157 * GNUNET_SOCIAL_home_reject_entry() (possibly asynchronously). If this owner
158 * cannot decide, it is fine to call neither function, in which case hopefully
159 * some other owner of the home exists that will make the decision. The @a nym
160 * reference remains valid until the #GNUNET_SOCIAL_FarewellCallback is invoked
163 * @param cls Closure.
164 * @param nym Handle for the user who wants to enter.
165 * @param method_name Method name in the entry request.
166 * @param variable_count Number of elements in the @a variables array.
167 * @param variables Variables present in the message.
168 * @param data Payload given on enter (e.g. a password).
169 * @param data_size Number of bytes in @a data.
172 (*GNUNET_SOCIAL_AnswerDoorCallback) (void *cls,
173 struct GNUNET_SOCIAL_Nym *nym,
174 size_t variable_count,
175 const char *method_name,
176 struct GNUNET_ENV_Modifier *variables,
182 * Function called when a @a nym leaves the place.
184 * This is also called if the @a nym was never given permission to enter
185 * (i.e. the @a nym stopped asking to get in).
187 * @param cls Closure.
188 * @param nym Handle for the user who left.
189 * @param variable_count Number of elements in the @a variables array.
190 * @param variables Variables present in the message.
193 (*GNUNET_SOCIAL_FarewellCallback) (void *cls,
194 struct GNUNET_SOCIAL_Nym *nym,
195 size_t variable_count,
196 struct GNUNET_ENV_Modifier *variables);
200 * Enter a home where guests (nyms) can be hosted.
202 * A home is created upon first entering, and exists until
203 * GNUNET_SOCIAL_home_destroy() is called. It can also be left temporarily using
204 * GNUNET_SOCIAL_home_leave().
206 * @param cfg Configuration to contact the social service.
207 * @param home_keyfile File with the private-public key pair of the home,
208 * created if the file does not exist; pass NULL for ephemeral homes.
209 * @param policy Policy specifying entry and history restrictions of the home.
210 * @param ego Owner of the home (host).
211 * @param slicer Slicer to handle guests talking.
212 * @param listener_cb Function to handle new nyms that want to enter.
213 * @param farewell_cb Function to handle departing nyms.
214 * @param cls Closure for @a listener_cb and @a farewell_cb.
215 * @return Handle for a new home.
217 struct GNUNET_SOCIAL_Home *
218 GNUNET_SOCIAL_home_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
219 const char *home_keyfile,
220 enum GNUNET_PSYC_Policy policy,
221 struct GNUNET_IDENTITY_Ego *ego,
222 struct GNUNET_SOCIAL_Slicer *slicer,
223 GNUNET_SOCIAL_AnswerDoorCallback listener_cb,
224 GNUNET_SOCIAL_FarewellCallback farewell_cb,
229 * Admit @a nym to the @a home.
231 * The @a nym reference will remain valid until either the home is destroyed or
234 * @param home Home to allow @a nym to enter.
235 * @param nym Handle for the entity that wants to enter.
238 GNUNET_SOCIAL_home_admit (struct GNUNET_SOCIAL_Home *home,
239 struct GNUNET_SOCIAL_Nym *nym);
243 * Throw @a nym out of the @a home.
245 * The @a nym reference will remain valid until the
246 * #GNUNET_SOCIAL_FarewellCallback is invoked,
247 * which should be very soon after this call.
249 * @param home Home to eject @a nym from.
250 * @param nym Handle for the entity to be ejected.
253 GNUNET_SOCIAL_home_eject (struct GNUNET_SOCIAL_Home *home,
254 struct GNUNET_SOCIAL_Nym *nym);
258 * Refuse @a nym entry into the @a home.
260 * @param home Home to disallow @a nym to enter.
261 * @param nym Handle for the entity that wanted to enter.
262 * @param method_name Method name for the rejection message.
263 * @param env Environment containing variables for the message, or NULL.
264 * @param data Data for the rejection message to send back.
265 * @param data_size Number of bytes in @a data for method.
268 GNUNET_SOCIAL_home_reject_entry (struct GNUNET_SOCIAL_Home *home,
269 struct GNUNET_SOCIAL_Nym *nym,
270 const char *method_name,
271 const struct GNUNET_ENV_Environment *env,
277 * Get the public key of a nym.
279 * Suitable, for example, to be used with GNUNET_NAMESTORE_zone_to_name().
281 * @param nym Pseudonym to map to a cryptographic identifier.
282 * @param[out] nym_key Set to the public key of the nym.
285 GNUNET_SOCIAL_nym_get_key (struct GNUNET_SOCIAL_Nym *nym,
286 struct GNUNET_CRYPTO_EddsaPublicKey *nym_key);
290 * Obtain the private-public key pair of the home.
292 * @param home Home to get the key of.
293 * @param[out] home_key Set to the private-public key pair of the home. The public part is suitable for storing in GNS within a "PLACE" record, along with peer IDs to join at.
296 GNUNET_SOCIAL_home_get_key (struct GNUNET_SOCIAL_Home *home,
297 struct GNUNET_CRYPTO_EddsaPrivateKey *home_key);
301 * Advertise @a home under @a name in the GNS zone of the @e ego.
303 * @param home The home to advertise.
304 * @param name The name for the PLACE record to put in the zone.
305 * @param peer_count Number of elements in the @a peers array.
306 * @param peers List of peers in the PLACE record that can be used to send join
308 * @param expiration_time Expiration time of the record, use 0 to remove the record.
309 * @param password Password used to encrypt the record.
312 GNUNET_SOCIAL_home_advertise (struct GNUNET_SOCIAL_Home *home,
315 const struct GNUNET_PeerIdentity *peers,
316 struct GNUNET_TIME_Relative expiration_time,
317 const char *password);
321 * Flags for announcements in a home.
323 enum GNUNET_SOCIAL_AnnounceFlags
325 GNUNET_SOCIAL_ANNOUNCE_NONE = 0,
328 * Whether this announcement removes all objects from the home.
330 * New objects can be still added to the now empty home using the @e env
331 * parameter of the same announcement.
333 GNUNET_SOCIAL_ANNOUNCE_CLEAR_OBJECTS = 1 << 0
338 * Handle for an announcement request.
340 struct GNUNET_SOCIAL_Announcement;
344 * Send a message to all nyms that are present in the home.
346 * This function is restricted to the home owner. Nyms can only send requests
347 * to the home owner who can decide to relay it to other guests.
349 * @param home Home to address the announcement to.
350 * @param method_name Method to use for the announcement.
351 * @param env Environment containing variables for the message and operations on
352 * objects of the home, or NULL.
353 * @param notify Function to call to get the payload of the announcement.
354 * @param notify_cls Closure for @a notify.
355 * @param flags Flags for this announcement.
356 * @return NULL on error (announcement already in progress?).
358 struct GNUNET_SOCIAL_Announcement *
359 GNUNET_SOCIAL_home_announce (struct GNUNET_SOCIAL_Home *home,
360 const char *method_name,
361 const struct GNUNET_ENV_Environment *env,
362 GNUNET_CONNECTION_TransmitReadyNotify notify,
364 enum GNUNET_SOCIAL_AnnounceFlags flags);
368 * Cancel announcement.
370 * @param a The announcement to cancel.
373 GNUNET_SOCIAL_home_announce_cancel (struct GNUNET_SOCIAL_Announcement *a);
377 * Convert our home to a place so we can access it via the place API.
379 * @param home Handle for the home.
380 * @return Place handle for the same home, valid as long as @a home is valid;
381 * do NOT try to GNUNET_SOCIAL_place_leave() this place, it's your home!
383 struct GNUNET_SOCIAL_Place *
384 GNUNET_SOCIAL_home_get_place (struct GNUNET_SOCIAL_Home *home);
390 * Invalidates home handle.
391 * Guests will be disconnected until the home is restarted.
393 * @param home Home to leave.
394 * @param keep_active Keep home active after last application disconnected.
397 GNUNET_SOCIAL_home_leave (struct GNUNET_SOCIAL_Home *home, int keep_active);
400 * Request entry to a place (home hosted by someone else).
402 * @param cfg Configuration to contact the social service.
403 * @param ego Owner of the home (host).
404 * @param address GNS name of the place to enter. Either in the form of
405 * 'room.friend.gnu', or 'NYMPUBKEY.zkey'. This latter case refers to
406 * the 'PLACE' record of the empty label ("+") in the GNS zone with the
407 * nym's public key 'NYMPUBKEY', and can be used to request entry to a
408 * pseudonym's place directly.
409 * @param method_name Method name for the message.
410 * @param env Environment containing variables for the message, or NULL.
411 * @param data Payload for the message to give to the enter callback.
412 * @param data_size Number of bytes in @a data.
413 * @param slicer Slicer to use for processing incoming requests from guests.
414 * @return NULL on errors, otherwise handle to the place.
416 struct GNUNET_SOCIAL_Place *
417 GNUNET_SOCIAL_place_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
418 struct GNUNET_IDENTITY_Ego *ego,
420 const char *method_name,
421 const struct GNUNET_ENV_Environment *env,
424 struct GNUNET_SOCIAL_Slicer *slicer);
427 * Request entry to a place (home hosted by someone else).
429 * @param cfg Configuration to contact the social service.
430 * @param ego Owner of the home (host).
431 * @param crypto_address Public key of the place to enter.
432 * @param origin Peer identity of the origin of the underlying multicast group.
433 * @param relay_count Number of elements in the @a relays array.
434 * @param relays Relays for the underlying multicast group.
435 * @param method_name Method name for the message.
436 * @param env Environment containing variables for the message, or NULL.
437 * @param data Payload for the message to give to the enter callback.
438 * @param data_size Number of bytes in @a data.
439 * @param slicer Slicer to use for processing incoming requests from guests.
440 * @return NULL on errors, otherwise handle to the place.
442 struct GNUNET_SOCIAL_Place *
443 GNUNET_SOCIAL_place_enter2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
444 struct GNUNET_IDENTITY_Ego *ego,
445 struct GNUNET_CRYPTO_EddsaPublicKey *crypto_address,
446 struct GNUNET_PeerIdentity *origin,
448 struct GNUNET_PeerIdentity *relays,
449 const char *method_name,
450 const struct GNUNET_ENV_Environment *env,
453 struct GNUNET_SOCIAL_Slicer *slicer);
456 struct GNUNET_SOCIAL_WatchHandle;
459 * Watch a place for changed objects.
461 * @param place Place to watch.
462 * @param object_filter Object prefix to match.
463 * @param state_cb Function to call when an object/state changes.
464 * @param state_cb_cls Closure for callback.
466 * @return Handle that can be used to cancel watching.
468 struct GNUNET_SOCIAL_WatchHandle *
469 GNUNET_SOCIAL_place_watch (struct GNUNET_SOCIAL_Place *place,
470 const char *object_filter,
471 GNUNET_PSYC_StateCallback state_cb,
476 * Cancel watching a place for changed objects.
478 * @param wh Watch handle to cancel.
481 GNUNET_SOCIAL_place_watch_cancel (struct GNUNET_SOCIAL_WatchHandle *wh);
484 struct GNUNET_SOCIAL_LookHandle;
488 * Look at objects in the place with a matching name prefix.
490 * @param place The place to look its objects at.
491 * @param name_prefix Look at objects with names beginning with this value.
492 * @param state_cb Function to call for each object found.
493 * @param state_cb_cls Closure for callback function.
495 * @return Handle that can be used to stop looking at objects.
497 struct GNUNET_SOCIAL_LookHandle *
498 GNUNET_SOCIAL_place_look (struct GNUNET_SOCIAL_Place *place,
499 const char *name_prefix,
500 GNUNET_PSYC_StateCallback state_cb,
505 * Stop looking at objects.
507 * @param lh Look handle to stop.
510 GNUNET_SOCIAL_place_look_cancel (struct GNUNET_SOCIAL_LookHandle *lh);
515 * Look at a particular object in the place.
517 * The best matching object is returned (its name might be less specific than
518 * what was requested).
520 * @param place The place to look the object at.
521 * @param full_name Full name of the object.
522 * @param value_size Set to the size of the returned value.
523 * @return NULL if there is no such object at this place.
526 GNUNET_SOCIAL_place_look_at (struct GNUNET_SOCIAL_Place *place,
527 const char *full_name,
532 * Flags for talking to the host of a place.
534 enum GNUNET_SOCIAL_TalkFlags
536 GNUNET_SOCIAL_TALK_NONE = 0
543 struct GNUNET_SOCIAL_TalkRequest;
546 * Talk to the host of the place.
548 * @param place Place where we want to talk to the host.
549 * @param method_name Method to invoke on the host.
550 * @param env Environment containing variables for the message, or NULL.
551 * @param notify Function to use to get the payload for the method.
552 * @param notify_cls Closure for @a notify.
553 * @param flags Flags for the message being sent.
554 * @return NULL if we are already trying to talk to the host,
555 * otherwise handle to cancel the request.
557 struct GNUNET_SOCIAL_TalkRequest *
558 GNUNET_SOCIAL_place_talk (struct GNUNET_SOCIAL_Place *place,
559 const char *method_name,
560 const struct GNUNET_ENV_Environment *env,
561 GNUNET_CONNECTION_TransmitReadyNotify notify,
563 enum GNUNET_SOCIAL_TalkFlags flags);
567 * Cancel talking to the host of the place.
569 * @param tr Talk request to cancel.
572 GNUNET_SOCIAL_place_talk_cancel (struct GNUNET_SOCIAL_TalkRequest *tr);
578 struct GNUNET_SOCIAL_HistoryLesson;
581 * Learn about the history of a place.
583 * Sends messages through the slicer function of the place where
584 * start_message_id <= message_id <= end_message_id.
585 * The messages will have the #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
587 * To get the latest message, use 0 for both the start and end message ID.
589 * @param place Place we want to learn more about.
590 * @param start_message_id First historic message we are interested in.
591 * @param end_message_id Last historic message we are interested in (inclusive).
592 * @param slicer Slicer to use to process history. Can be the same as the
593 * slicer of the place, as the HISTORIC flag allows distinguishing
594 * old messages from fresh ones.
595 * @param finish_cb Function called after the last message in the history lesson
596 * is passed through the @a slicer. NULL if not needed.
597 * @param finish_cb_cls Closure for @a finish_cb.
598 * @return Handle to abort history lesson, never NULL (multiple lessons
599 * at the same time are allowed).
601 struct GNUNET_SOCIAL_HistoryLesson *
602 GNUNET_SOCIAL_place_get_history (struct GNUNET_SOCIAL_Place *place,
603 uint64_t start_message_id,
604 uint64_t end_message_id,
605 const struct GNUNET_SOCIAL_Slicer *slicer,
606 void (*finish_cb)(void *),
607 void *finish_cb_cls);
611 * Stop processing messages from the history lesson.
613 * Must not be called after the finish callback of the history lesson is called.
615 * @param hist History lesson to cancel.
618 GNUNET_SOCIAL_place_get_history_cancel (struct GNUNET_SOCIAL_HistoryLesson *hist);
622 * Leave a place permanently.
624 * Notifies the owner of the place about leaving, and destroys the place handle.
626 * @param place Place to leave permanently.
627 * @param keep_active Keep place active after last application disconnected.
630 GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place, int keep_active);
633 #if 0 /* keep Emacsens' auto-indent happy */
640 /* ifndef GNUNET_SOCIAL_SERVICE_H */
642 /* end of gnunet_social_service.h */