aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_reclaim_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_reclaim_service.h')
-rw-r--r--src/include/gnunet_reclaim_service.h26
1 files changed, 16 insertions, 10 deletions
diff --git a/src/include/gnunet_reclaim_service.h b/src/include/gnunet_reclaim_service.h
index fc3d0f920..8d7babd7c 100644
--- a/src/include/gnunet_reclaim_service.h
+++ b/src/include/gnunet_reclaim_service.h
@@ -22,9 +22,10 @@
22 * @author Martin Schanzenbach 22 * @author Martin Schanzenbach
23 * 23 *
24 * @file 24 * @file
25 * Identity provider service; implements identity provider for GNUnet 25 * reclaim service; implements identity and personal data sharing
26 * for GNUnet
26 * 27 *
27 * @defgroup reclaim Identity Provider service 28 * @defgroup reclaim service
28 * @{ 29 * @{
29 */ 30 */
30#ifndef GNUNET_RECLAIM_SERVICE_H 31#ifndef GNUNET_RECLAIM_SERVICE_H
@@ -43,7 +44,7 @@ extern "C" {
43/** 44/**
44 * Version number of the re:claimID API. 45 * Version number of the re:claimID API.
45 */ 46 */
46#define GNUNET_RECLAIM_VERSION 0x00000000 47#define GNUNET_RECLAIM_VERSION 0x00000001
47 48
48/** 49/**
49 * Opaque handle to access the service. 50 * Opaque handle to access the service.
@@ -58,10 +59,10 @@ struct GNUNET_RECLAIM_Operation;
58 59
59 60
60/** 61/**
61 * The an authorization ticket. This ticket is meant to be transferred 62 * The authorization ticket. This ticket is meant to be transferred
62 * out of band the a relying party. 63 * out of band to a relying party.
63 * The contents of a ticket must be protected and should be treated as a 64 * The contents of a ticket must be protected and should be treated as a
64 * SHARED SECRET between user and relying party. 65 * shared secret between user and relying party.
65 */ 66 */
66struct GNUNET_RECLAIM_Ticket 67struct GNUNET_RECLAIM_Ticket
67{ 68{
@@ -84,8 +85,8 @@ struct GNUNET_RECLAIM_Ticket
84 85
85/** 86/**
86 * Method called when a token has been issued. 87 * Method called when a token has been issued.
87 * On success returns a ticket that can be given to the relying party to retrive 88 * On success returns a ticket that can be given to a relying party
88 * the token 89 * in order for it retrive identity attributes
89 * 90 *
90 * @param cls closure 91 * @param cls closure
91 * @param ticket the ticket 92 * @param ticket the ticket
@@ -133,7 +134,7 @@ GNUNET_RECLAIM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
133 * Store an attribute. If the attribute is already present, 134 * Store an attribute. If the attribute is already present,
134 * it is replaced with the new attribute. 135 * it is replaced with the new attribute.
135 * 136 *
136 * @param h handle to the re:claimID service 137 * @param h handle to the reclaim service
137 * @param pkey Private key of the identity to add an attribute to 138 * @param pkey Private key of the identity to add an attribute to
138 * @param attr The attribute 139 * @param attr The attribute
139 * @param exp_interval The relative expiration interval for the attribute 140 * @param exp_interval The relative expiration interval for the attribute
@@ -246,6 +247,7 @@ GNUNET_RECLAIM_ticket_issue (
246 const struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs, 247 const struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs,
247 GNUNET_RECLAIM_TicketCallback cb, void *cb_cls); 248 GNUNET_RECLAIM_TicketCallback cb, void *cb_cls);
248 249
250
249/** 251/**
250 * Revoked an issued ticket. The relying party will be unable to retrieve 252 * Revoked an issued ticket. The relying party will be unable to retrieve
251 * attributes. Other issued tickets remain unaffected. 253 * attributes. Other issued tickets remain unaffected.
@@ -286,6 +288,7 @@ GNUNET_RECLAIM_ticket_consume (
286 const struct GNUNET_RECLAIM_Ticket *ticket, 288 const struct GNUNET_RECLAIM_Ticket *ticket,
287 GNUNET_RECLAIM_AttributeResult cb, void *cb_cls); 289 GNUNET_RECLAIM_AttributeResult cb, void *cb_cls);
288 290
291
289/** 292/**
290 * Lists all tickets that have been issued to remote 293 * Lists all tickets that have been issued to remote
291 * identites (relying parties) 294 * identites (relying parties)
@@ -321,6 +324,7 @@ GNUNET_RECLAIM_ticket_iteration_start (
321void 324void
322GNUNET_RECLAIM_ticket_iteration_next (struct GNUNET_RECLAIM_TicketIterator *it); 325GNUNET_RECLAIM_ticket_iteration_next (struct GNUNET_RECLAIM_TicketIterator *it);
323 326
327
324/** 328/**
325 * Stops iteration and releases the handle for further calls. Must 329 * Stops iteration and releases the handle for further calls. Must
326 * be called on any iteration that has not yet completed prior to calling 330 * be called on any iteration that has not yet completed prior to calling
@@ -331,6 +335,7 @@ GNUNET_RECLAIM_ticket_iteration_next (struct GNUNET_RECLAIM_TicketIterator *it);
331void 335void
332GNUNET_RECLAIM_ticket_iteration_stop (struct GNUNET_RECLAIM_TicketIterator *it); 336GNUNET_RECLAIM_ticket_iteration_stop (struct GNUNET_RECLAIM_TicketIterator *it);
333 337
338
334/** 339/**
335 * Disconnect from identity provider service. 340 * Disconnect from identity provider service.
336 * 341 *
@@ -351,6 +356,7 @@ GNUNET_RECLAIM_disconnect (struct GNUNET_RECLAIM_Handle *h);
351void 356void
352GNUNET_RECLAIM_cancel (struct GNUNET_RECLAIM_Operation *op); 357GNUNET_RECLAIM_cancel (struct GNUNET_RECLAIM_Operation *op);
353 358
359
354#if 0 /* keep Emacsens' auto-indent happy */ 360#if 0 /* keep Emacsens' auto-indent happy */
355{ 361{
356#endif 362#endif
@@ -362,6 +368,6 @@ GNUNET_RECLAIM_cancel (struct GNUNET_RECLAIM_Operation *op);
362/* ifndef GNUNET_RECLAIM_SERVICE_H */ 368/* ifndef GNUNET_RECLAIM_SERVICE_H */
363#endif 369#endif
364 370
365/** @} */ /* end of group identity */ 371/** @} */ /* end of group reclaim */
366 372
367/* end of gnunet_reclaim_service.h */ 373/* end of gnunet_reclaim_service.h */