gnunet-service-reclaim_tickets.h File Reference

reclaim tickets More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_constants.h"
#include "gnunet_gns_service.h"
#include "gnunet_gnsrecord_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_reclaim_lib.h"
#include "gnunet_reclaim_service.h"
#include "gnunet_signatures.h"
#include "gnunet_statistics_service.h"
#include "reclaim.h"

Include dependency graph for gnunet-service-reclaim_tickets.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	TicketRecordsEntry
	List of tickets. More...

Typedefs
typedef void(*	RECLAIM_TICKETS_TicketIter) (void *cls, struct GNUNET_RECLAIM_Ticket *ticket)
	Continuation called with ticket. More...
typedef void(*	RECLAIM_TICKETS_TicketResult) (void *cls, struct GNUNET_RECLAIM_Ticket *ticket, struct GNUNET_RECLAIM_PresentationList *presentations, int32_t success, const char *emsg)
	Continuation called with ticket. More...
typedef void(*	RECLAIM_TICKETS_ConsumeCallback) (void *cls, const struct GNUNET_IDENTITY_PublicKey *identity, const struct GNUNET_RECLAIM_AttributeList *attributes, const struct GNUNET_RECLAIM_PresentationList *presentations, int32_t success, const char *emsg)
	Consume callback. More...
typedef void(*	RECLAIM_TICKETS_RevokeCallback) (void *cls, int32_t success)
	Revocation callback. More...

Functions
struct RECLAIM_TICKETS_RevokeHandle *	RECLAIM_TICKETS_revoke (const struct GNUNET_RECLAIM_Ticket *ticket, const struct GNUNET_IDENTITY_PrivateKey *identity, RECLAIM_TICKETS_RevokeCallback cb, void *cb_cls)
	Revoke a ticket. More...
void	RECLAIM_TICKETS_revoke_cancel (struct RECLAIM_TICKETS_RevokeHandle *rh)
	Cancel a revocation. More...
struct RECLAIM_TICKETS_ConsumeHandle *	RECLAIM_TICKETS_consume (const struct GNUNET_IDENTITY_PrivateKey *id, const struct GNUNET_RECLAIM_Ticket *ticket, RECLAIM_TICKETS_ConsumeCallback cb, void *cb_cls)
	Consume a ticket. More...
void	RECLAIM_TICKETS_consume_cancel (struct RECLAIM_TICKETS_ConsumeHandle *cth)
	Cancel a consume operation. More...
void	RECLAIM_TICKETS_issue (const struct GNUNET_IDENTITY_PrivateKey *identity, const struct GNUNET_RECLAIM_AttributeList *attrs, const struct GNUNET_IDENTITY_PublicKey *audience, RECLAIM_TICKETS_TicketResult cb, void *cb_cls)
	Issue a new reclaim ticket, thereby authorizing the audience to access the set of provided attributes. More...
void	RECLAIM_TICKETS_iteration_next (struct RECLAIM_TICKETS_Iterator *iter)
	Continue ticket iteration. More...
void	RECLAIM_TICKETS_iteration_stop (struct RECLAIM_TICKETS_Iterator *iter)
	Stop a running ticket iteration. More...
struct RECLAIM_TICKETS_Iterator *	RECLAIM_TICKETS_iteration_start (const struct GNUNET_IDENTITY_PrivateKey *identity, RECLAIM_TICKETS_TicketIter cb, void *cb_cls)
	Iterate over all tickets issued by an identity. More...
int	RECLAIM_TICKETS_init (const struct GNUNET_CONFIGURATION_Handle *c)
	Initialize tickets component. More...
void	RECLAIM_TICKETS_deinit (void)
	Close handles and clean up. More...

Detailed Description

reclaim tickets

Author

Martin Schanzenbach

Definition in file gnunet-service-reclaim_tickets.h.

Typedef Documentation

RECLAIM_TICKETS_TicketIter

typedef void(* RECLAIM_TICKETS_TicketIter) (void *cls, struct GNUNET_RECLAIM_Ticket *ticket)

Continuation called with ticket.

Parameters

cls	closure
ticket	the ticket

Definition at line 106 of file gnunet-service-reclaim_tickets.h.

RECLAIM_TICKETS_TicketResult

typedef void(* RECLAIM_TICKETS_TicketResult) (void *cls, struct GNUNET_RECLAIM_Ticket *ticket, struct GNUNET_RECLAIM_PresentationList *presentations, int32_t success, const char *emsg)

Continuation called with ticket.

Parameters

cls	closure
ticket	the ticket
presentations	new presentations for ticket (NULL on error)
success	GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) GNUNET_OK on success
emsg	NULL on success, otherwise an error message

Definition at line 121 of file gnunet-service-reclaim_tickets.h.

RECLAIM_TICKETS_ConsumeCallback

typedef void(* RECLAIM_TICKETS_ConsumeCallback) (void *cls, const struct GNUNET_IDENTITY_PublicKey *identity, const struct GNUNET_RECLAIM_AttributeList *attributes, const struct GNUNET_RECLAIM_PresentationList *presentations, int32_t success, const char *emsg)

Consume callback.

Parameters

cls	closure
identity	the issuer of the ticket/attributes
attributes	attribute list retrieved through ticket
presentations	attribute presentations (may be NULL)
success	GNUNET_OK on success
emsg	error message (NULL on success)

Definition at line 139 of file gnunet-service-reclaim_tickets.h.

RECLAIM_TICKETS_RevokeCallback

typedef void(* RECLAIM_TICKETS_RevokeCallback) (void *cls, int32_t success)

Revocation callback.

Parameters

cls	closure
success	GNUNET_OK on success

Definition at line 154 of file gnunet-service-reclaim_tickets.h.

Function Documentation

RECLAIM_TICKETS_revoke()

struct RECLAIM_TICKETS_RevokeHandle* RECLAIM_TICKETS_revoke	(	const struct GNUNET_RECLAIM_Ticket *	ticket,
		const struct GNUNET_IDENTITY_PrivateKey *	identity,
		RECLAIM_TICKETS_RevokeCallback	cb,
		void *	cb_cls
	)

Revoke a ticket.

We start by looking up attribute references in order to change attribute IDs.

Parameters

ticket	ticket to revoke
identity	private key of issuer
cb	revocation status callback
cb_cls	callback closure

Returns

handle to the operation

Get shared attributes

Definition at line 910 of file gnunet-service-reclaim_tickets.c.

{
  struct RECLAIM_TICKETS_RevokeHandle *rvk;
  char *label;
 
  rvk = GNUNET_new (struct RECLAIM_TICKETS_RevokeHandle);
  rvk->cb = cb;
  rvk->cb_cls = cb_cls;
  rvk->identity = *identity;
  rvk->ticket = *ticket;
  GNUNET_IDENTITY_key_get_public (&rvk->identity, &rvk->ticket.identity);
  label = GNUNET_STRINGS_data_to_string_alloc (&ticket->rnd,
                                               sizeof(ticket->rnd));
  GNUNET_assert (NULL != label);
  rvk->ns_qe = GNUNET_NAMESTORE_records_lookup (nsh,
                                                identity,
                                                label,
                                                &rvk_attrs_err_cb,
                                                rvk,
                                                &revoke_attrs_cb,
                                                rvk);
  GNUNET_free (label);
  return rvk;
}

References RECLAIM_TICKETS_RevokeHandle::cb, RECLAIM_TICKETS_RevokeHandle::cb_cls, GNUNET_assert, GNUNET_free, GNUNET_IDENTITY_key_get_public(), GNUNET_NAMESTORE_records_lookup(), GNUNET_new, GNUNET_STRINGS_data_to_string_alloc(), identity, GNUNET_RECLAIM_Ticket::identity, RECLAIM_TICKETS_RevokeHandle::identity, RECLAIM_TICKETS_RevokeHandle::ns_qe, nsh, revoke_attrs_cb(), GNUNET_RECLAIM_Ticket::rnd, rvk_attrs_err_cb(), ticket, and RECLAIM_TICKETS_RevokeHandle::ticket.

Referenced by handle_revoke_ticket_message().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_revoke_cancel()

void RECLAIM_TICKETS_revoke_cancel

(

struct RECLAIM_TICKETS_RevokeHandle *

rh

)

Cancel a revocation.

Parameters

rh	handle to the operation

Definition at line 946 of file gnunet-service-reclaim_tickets.c.

{
  GNUNET_assert (NULL != rh);
  cleanup_rvk (rh);
}

References cleanup_rvk(), and GNUNET_assert.

Referenced by cleanup_client().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_consume()

struct RECLAIM_TICKETS_ConsumeHandle* RECLAIM_TICKETS_consume	(	const struct GNUNET_IDENTITY_PrivateKey *	id,
		const struct GNUNET_RECLAIM_Ticket *	ticket,
		RECLAIM_TICKETS_ConsumeCallback	cb,
		void *	cb_cls
	)

Consume a ticket.

We first looking attribute references under the label ticket.rnd in GNS.

Parameters

id	the audience of the ticket
ticket	the ticket to consume
cb	callback to call with attributes of ticket
cb_cls	callback closure

Returns

handle to the operation

Definition at line 1182 of file gnunet-service-reclaim_tickets.c.

{
  struct RECLAIM_TICKETS_ConsumeHandle *cth;
  char *label;
 
  cth = GNUNET_new (struct RECLAIM_TICKETS_ConsumeHandle);
 
  cth->identity = *id;
  GNUNET_IDENTITY_key_get_public (&cth->identity, &cth->identity_pub);
  cth->attrs = GNUNET_new (struct GNUNET_RECLAIM_AttributeList);
  cth->presentations = GNUNET_new (struct GNUNET_RECLAIM_PresentationList);
  cth->ticket = *ticket;
  cth->cb = cb;
  cth->cb_cls = cb_cls;
  label =
    GNUNET_STRINGS_data_to_string_alloc (&cth->ticket.rnd,
                                         sizeof(cth->ticket.rnd));
  char *str = GNUNET_IDENTITY_public_key_to_string (&cth->ticket.identity);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Looking for AuthZ info under %s in %s\n",
              label, str);
  GNUNET_free (str);
  cth->lookup_start_time = GNUNET_TIME_absolute_get ();
  cth->lookup_request =
    GNUNET_GNS_lookup (gns,
                       label,
                       &cth->ticket.identity,
                       GNUNET_GNSRECORD_TYPE_RECLAIM_ATTRIBUTE_REF,
                       GNUNET_GNS_LO_DEFAULT,
                       &lookup_authz_cb,
                       cth);
  GNUNET_free (label);
  return cth;
}

References RECLAIM_TICKETS_ConsumeHandle::attrs, RECLAIM_TICKETS_ConsumeHandle::cb, RECLAIM_TICKETS_ConsumeHandle::cb_cls, gns, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_GNS_LO_DEFAULT, GNUNET_GNS_lookup(), GNUNET_GNSRECORD_TYPE_RECLAIM_ATTRIBUTE_REF, GNUNET_IDENTITY_key_get_public(), GNUNET_IDENTITY_public_key_to_string(), GNUNET_log, GNUNET_new, GNUNET_STRINGS_data_to_string_alloc(), GNUNET_TIME_absolute_get(), id, GNUNET_RECLAIM_Ticket::identity, RECLAIM_TICKETS_ConsumeHandle::identity, RECLAIM_TICKETS_ConsumeHandle::identity_pub, lookup_authz_cb(), RECLAIM_TICKETS_ConsumeHandle::lookup_request, RECLAIM_TICKETS_ConsumeHandle::lookup_start_time, RECLAIM_TICKETS_ConsumeHandle::presentations, GNUNET_RECLAIM_Ticket::rnd, ticket, and RECLAIM_TICKETS_ConsumeHandle::ticket.

Referenced by handle_consume_ticket_message().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_consume_cancel()

void RECLAIM_TICKETS_consume_cancel

(

struct RECLAIM_TICKETS_ConsumeHandle *

cth

)

Cancel a consume operation.

Parameters

cth	the operation to cancel

Definition at line 1227 of file gnunet-service-reclaim_tickets.c.

{
  cleanup_cth (cth);
  return;
}

References cleanup_cth().

Referenced by cleanup_client().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_issue()

void RECLAIM_TICKETS_issue	(	const struct GNUNET_IDENTITY_PrivateKey *	identity,
		const struct GNUNET_RECLAIM_AttributeList *	attrs,
		const struct GNUNET_IDENTITY_PublicKey *	audience,
		RECLAIM_TICKETS_TicketResult	cb,
		void *	cb_cls
	)

Issue a new reclaim ticket, thereby authorizing the audience to access the set of provided attributes.

Parameters

identity	the issuer
attrs	the attributes to share
audience	the audience to share the attributes with
cb	the callback to call with the ticket result
cb_cls	the callback closure FIXME: Return handle??

Definition at line 1652 of file gnunet-service-reclaim_tickets.c.

{
  struct TicketIssueHandle *tih;
 
  tih = GNUNET_new (struct TicketIssueHandle);
  tih->cb = cb;
  tih->cb_cls = cb_cls;
  tih->attrs = GNUNET_RECLAIM_attribute_list_dup (attrs);
  tih->presentations = GNUNET_new (struct GNUNET_RECLAIM_PresentationList);
  tih->identity = *identity;
  tih->ticket.audience = *audience;
 
  // First check whether the ticket has already been issued
  tih->ns_it =
    GNUNET_NAMESTORE_zone_iteration_start (nsh,
                                           &tih->identity,
                                           &filter_tickets_error_cb,
                                           tih,
                                           &filter_tickets_cb,
                                           tih,
                                           &filter_tickets_finished_cb,
                                           tih);
}

References TicketIssueHandle::attrs, GNUNET_RECLAIM_Ticket::audience, TicketIssueHandle::cb, TicketIssueHandle::cb_cls, filter_tickets_cb(), filter_tickets_error_cb(), filter_tickets_finished_cb(), GNUNET_NAMESTORE_zone_iteration_start(), GNUNET_new, GNUNET_RECLAIM_attribute_list_dup(), identity, TicketIssueHandle::identity, TicketIssueHandle::ns_it, nsh, TicketIssueHandle::presentations, and TicketIssueHandle::ticket.

Referenced by handle_issue_ticket_message().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_iteration_next()

void RECLAIM_TICKETS_iteration_next

(

struct RECLAIM_TICKETS_Iterator *

iter

)

Continue ticket iteration.

Parameters

iter	the iteration to continue

Definition at line 1781 of file gnunet-service-reclaim_tickets.c.

{
  GNUNET_NAMESTORE_zone_iterator_next (iter->ns_it, 1);
}

References GNUNET_NAMESTORE_zone_iterator_next(), and RECLAIM_TICKETS_Iterator::ns_it.

Referenced by handle_ticket_iteration_next().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_iteration_stop()

void RECLAIM_TICKETS_iteration_stop

(

struct RECLAIM_TICKETS_Iterator *

iter

)

Stop a running ticket iteration.

Parameters

iter	iteration to cancel

Definition at line 1793 of file gnunet-service-reclaim_tickets.c.

{
  GNUNET_NAMESTORE_zone_iteration_stop (iter->ns_it);
  cleanup_iter (iter);
}

References cleanup_iter(), GNUNET_NAMESTORE_zone_iteration_stop(), and RECLAIM_TICKETS_Iterator::ns_it.

Referenced by cleanup_client(), and handle_ticket_iteration_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_iteration_start()

struct RECLAIM_TICKETS_Iterator* RECLAIM_TICKETS_iteration_start	(	const struct GNUNET_IDENTITY_PrivateKey *	identity,
		RECLAIM_TICKETS_TicketIter	cb,
		void *	cb_cls
	)

Iterate over all tickets issued by an identity.

Parameters

identity	the issuing identity
cb	ticket callback function
cb_cls	callback closure

Returns

a handle to the iteration

Definition at line 1809 of file gnunet-service-reclaim_tickets.c.

{
  struct RECLAIM_TICKETS_Iterator *iter;
 
  iter = GNUNET_new (struct RECLAIM_TICKETS_Iterator);
  iter->cb = cb;
  iter->cb_cls = cb_cls;
  iter->ns_it =
    GNUNET_NAMESTORE_zone_iteration_start (nsh,
                                           identity,
                                           &collect_tickets_error_cb,
                                           iter,
                                           &collect_tickets_cb,
                                           iter,
                                           &collect_tickets_finished_cb,
                                           iter);
  return iter;
}

References RECLAIM_TICKETS_Iterator::cb, RECLAIM_TICKETS_Iterator::cb_cls, collect_tickets_cb(), collect_tickets_error_cb(), collect_tickets_finished_cb(), GNUNET_NAMESTORE_zone_iteration_start(), GNUNET_new, identity, RECLAIM_TICKETS_Iterator::ns_it, and nsh.

Referenced by handle_ticket_iteration_start().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_init()

int RECLAIM_TICKETS_init

(

const struct GNUNET_CONFIGURATION_Handle *

c

)

Initialize tickets component.

Parameters

c	the configuration

Returns

GNUNET_SYSERR on error

Definition at line 1839 of file gnunet-service-reclaim_tickets.c.

{
  // Get ticket expiration time (relative) from config
  if (GNUNET_OK ==
      GNUNET_CONFIGURATION_get_value_time (c,
                                           "reclaim",
                                           "TICKET_REFRESH_INTERVAL",
                                           &ticket_refresh_interval))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Configured refresh interval for tickets: %s\n",
                GNUNET_STRINGS_relative_time_to_string (ticket_refresh_interval,
                                                        GNUNET_YES));
  }
  else
  {
    ticket_refresh_interval = DEFAULT_TICKET_REFRESH_INTERVAL;
  }
  // Connect to identity and namestore services
  nsh = GNUNET_NAMESTORE_connect (c);
  if (NULL == nsh)
  {
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
                         "error connecting to namestore");
    return GNUNET_SYSERR;
  }
  gns = GNUNET_GNS_connect (c);
  if (NULL == gns)
  {
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "error connecting to gns");
    return GNUNET_SYSERR;
  }
  stats = GNUNET_STATISTICS_create ("reclaim", c);
  return GNUNET_OK;
}

References DEFAULT_TICKET_REFRESH_INTERVAL, gns, GNUNET_CONFIGURATION_get_value_time(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_GNS_connect(), GNUNET_log, GNUNET_log_strerror, GNUNET_NAMESTORE_connect(), GNUNET_OK, GNUNET_STATISTICS_create(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_SYSERR, GNUNET_YES, nsh, stats, and ticket_refresh_interval.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

RECLAIM_TICKETS_deinit()

void RECLAIM_TICKETS_deinit

(

void

)

Close handles and clean up.

FIXME: cancel all pending operations (gns, ns etc)

Definition at line 1881 of file gnunet-service-reclaim_tickets.c.

{
  if (NULL != nsh)
    GNUNET_NAMESTORE_disconnect (nsh);
  nsh = NULL;
  if (NULL != gns)
    GNUNET_GNS_disconnect (gns);
  gns = NULL;
  if (NULL != stats)
  {
    GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
    stats = NULL;
  }
}

References gns, GNUNET_GNS_disconnect(), GNUNET_NAMESTORE_disconnect(), GNUNET_NO, GNUNET_STATISTICS_destroy(), nsh, and stats.

Referenced by cleanup().

Here is the call graph for this function:

Here is the caller graph for this function: