src/reclaim/gnunet-service-reclaim_tickets.h

   1 /*
   2    This file is part of GNUnet.
   3    Copyright (C) 2012-2015 GNUnet e.V.
   4
   5    GNUnet is free software: you can redistribute it and/or modify it
   6    under the terms of the GNU Affero General Public License as published
   7    by the Free Software Foundation, either version 3 of the License,
   8    or (at your 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    Affero General Public License for more details.
  14
  15    You should have received a copy of the GNU Affero General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18    SPDX-License-Identifier: AGPL3.0-or-later
  19    */
  20
  21 /**
  22  * @author Martin Schanzenbach
  23  * @file src/reclaim/gnunet-service-reclaim_tickets.h
  24  * @brief reclaim tickets
  25  *
  26  */
  27
  28 #ifndef GNUNET_SERVICE_RECLAIM_TICKETS_H
  29 #define GNUNET_SERVICE_RECLAIM_TICKETS_H
  30
  31 #include "platform.h"
  32
  33 #include "gnunet_util_lib.h"
  34
  35 #include "gnunet_constants.h"
  36 #include "gnunet_gns_service.h"
  37 #include "gnunet_gnsrecord_lib.h"
  38 #include "gnunet_protocols.h"
  39 #include "gnunet_reclaim_attribute_lib.h"
  40 #include "gnunet_reclaim_service.h"
  41 #include "gnunet_signatures.h"
  42 #include "gnunet_statistics_service.h"
  43 #include "reclaim.h"
  44
  45 struct RECLAIM_TICKETS_Iterator;
  46 struct RECLAIM_TICKETS_ConsumeHandle;
  47 struct RECLAIM_TICKETS_RevokeHandle;
  48
  49
  50 struct TicketRecordsEntry
  51 {
  52   /**
  53    * DLL
  54    */
  55   struct TicketRecordsEntry *next;
  56
  57   /**
  58    * DLL
  59    */
  60   struct TicketRecordsEntry *prev;
  61
  62   /**
  63    * Record count
  64    */
  65   unsigned int rd_count;
  66
  67   /**
  68    * Data
  69    */
  70   char *data;
  71
  72   /**
  73    * Data size
  74    */
  75   size_t data_size;
  76
  77   /**
  78    * Label
  79    */
  80   char *label;
  81 };
  82
  83
  84 /**
  85  * Continuation called with ticket.
  86  *
  87  * @param cls closure
  88  * @param ticket the ticket
  89  */
  90 typedef void (*RECLAIM_TICKETS_TicketIter) (
  91     void *cls, struct GNUNET_RECLAIM_Ticket *ticket);
  92
  93
  94 /**
  95  * Continuation called with ticket.
  96  *
  97  * @param cls closure
  98  * @param ticket the ticket
  99  * @param success #GNUNET_SYSERR on failure (including timeout/queue
 100  * drop/failure to validate) #GNUNET_OK on success
 101  * @param emsg NULL on success, otherwise an error message
 102  */
 103 typedef void (*RECLAIM_TICKETS_TicketResult) (
 104     void *cls, struct GNUNET_RECLAIM_Ticket *ticket, int32_t success,
 105     const char *emsg);
 106
 107
 108 typedef void (*RECLAIM_TICKETS_ConsumeCallback) (
 109     void *cls, const struct GNUNET_CRYPTO_EcdsaPublicKey *identity,
 110     const struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *l, int32_t success,
 111     const char *emsg);
 112
 113
 114 typedef void (*RECLAIM_TICKETS_RevokeCallback) (void *cls, int32_t success);
 115
 116 struct RECLAIM_TICKETS_RevokeHandle *
 117 RECLAIM_TICKETS_revoke (const struct GNUNET_RECLAIM_Ticket *ticket,
 118                         const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 119                         RECLAIM_TICKETS_RevokeCallback cb, void *cb_cls);
 120
 121
 122 void
 123 RECLAIM_TICKETS_revoke_cancel (struct RECLAIM_TICKETS_RevokeHandle *rh);
 124
 125
 126 struct RECLAIM_TICKETS_ConsumeHandle *
 127 RECLAIM_TICKETS_consume (const struct GNUNET_CRYPTO_EcdsaPrivateKey *id,
 128                          const struct GNUNET_RECLAIM_Ticket *ticket,
 129                          RECLAIM_TICKETS_ConsumeCallback cb, void *cb_cls);
 130
 131 void
 132 RECLAIM_TICKETS_consume_cancel (struct RECLAIM_TICKETS_ConsumeHandle *cth);
 133
 134 void
 135 RECLAIM_TICKETS_issue (const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 136                        const struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs,
 137                        const struct GNUNET_CRYPTO_EcdsaPublicKey *audience,
 138                        RECLAIM_TICKETS_TicketResult cb, void *cb_cls);
 139
 140 void
 141 RECLAIM_TICKETS_iteration_next (struct RECLAIM_TICKETS_Iterator *iter);
 142
 143
 144 void
 145 RECLAIM_TICKETS_iteration_stop (struct RECLAIM_TICKETS_Iterator *iter);
 146
 147
 148 struct RECLAIM_TICKETS_Iterator *
 149 RECLAIM_TICKETS_iteration_start (
 150     const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 151     RECLAIM_TICKETS_TicketIter cb, void *cb_cls);
 152
 153
 154 int
 155 RECLAIM_TICKETS_init (const struct GNUNET_CONFIGURATION_Handle *c);
 156
 157 void
 158 RECLAIM_TICKETS_deinit (void);
 159 #endif