did_core.h File Reference

Core functionality for GNUNET Decentralized Identifier. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_namestore_service.h"
#include "gnunet_gns_service.h"
#include "gnunet_gnsrecord_lib.h"
#include "gnunet_identity_service.h"
#include "did_helper.h"
#include "jansson.h"

Include dependency graph for did_core.h:

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

Go to the source code of this file.

Macros
#define	DID_DOCUMENT_LABEL   "didd"
#define	DID_DOCUMENT_DEFAULT_EXPIRATION_TIME   "365d"

Typedefs
typedef void	DID_resolve_callback(enum GNUNET_GenericReturnValue status, char *did_document, void *cls)
	Signature of a callback function that is called after a did has been resolved. More...
typedef void	DID_action_callback(enum GNUNET_GenericReturnValue status, void *cls)
	Signature of a callback function that is called after a did has been removed status = 0 if action was sucessfull status = 1 if action failed. More...

Functions
enum GNUNET_GenericReturnValue	DID_resolve (const char *did, struct GNUNET_GNS_Handle *gns_handle, DID_resolve_callback *cont, void *cls)
	Resolve a DID. More...
enum GNUNET_GenericReturnValue	DID_remove (const struct GNUNET_IDENTITY_Ego *ego, struct GNUNET_CONFIGURATION_Handle *cfg_handle, struct GNUNET_NAMESTORE_Handle *namestore_handle, DID_action_callback *cont, void *cls)
	Removes the DID Document from namestore. More...
enum GNUNET_GenericReturnValue	DID_create (const struct GNUNET_IDENTITY_Ego *ego, const char *did_document, const struct GNUNET_TIME_Relative *expire_time, struct GNUNET_NAMESTORE_Handle *namestore_handle, DID_action_callback *cont, void *cls)
	Creates a DID and saves DID Document in Namestore. More...
enum GNUNET_GenericReturnValue	DID_replace (struct GNUNET_IDENTITY_Ego *ego, char *did_document, const struct GNUNET_CONFIGURATION_Handle *cfg_handle, struct GNUNET_IDENTITY_Handle *identity_handle, struct GNUNET_NAMESTORE_Handle *namestore_handle, DID_action_callback *cont, void *cls)
	Replace the DID Document of a DID. More...

Detailed Description

Core functionality for GNUNET Decentralized Identifier.

Author

Tristan Schwieren

Definition in file did_core.h.

Macro Definition Documentation

DID_DOCUMENT_LABEL

#define DID_DOCUMENT_LABEL   "didd"

Definition at line 37 of file did_core.h.

DID_DOCUMENT_DEFAULT_EXPIRATION_TIME

#define DID_DOCUMENT_DEFAULT_EXPIRATION_TIME   "365d"

Definition at line 38 of file did_core.h.

Typedef Documentation

DID_resolve_callback

typedef void DID_resolve_callback(enum GNUNET_GenericReturnValue status, char *did_document, void *cls)

Signature of a callback function that is called after a did has been resolved.

did_document contains an Error message if DID can not be resolved. Calls the given callback function with the resolved DID Document and the given closure. If the did can not be resolved did_document is NULL.

Parameters

status	Equals GNUNET_OK if DID Docuemnt has been resolved
did_document	resolved DID Document
cls	previsouly given closure

Definition at line 50 of file did_core.h.

DID_action_callback

typedef void DID_action_callback(enum GNUNET_GenericReturnValue status, void *cls)

Signature of a callback function that is called after a did has been removed status = 0 if action was sucessfull status = 1 if action failed.

Parameters

status	status of the perfermormed action.
cls	previsouly given closure

Definition at line 61 of file did_core.h.

Function Documentation

DID_resolve()

enum GNUNET_GenericReturnValue DID_resolve	(	const char *	did,
		struct GNUNET_GNS_Handle *	gns_handle,
		DID_resolve_callback *	cont,
		void *	cls
	)

Resolve a DID.

Calls the given callback function with the resolved DID Document and the given closure. If the did can not be resolved did_document is NULL.

Parameters

did	DID that is resolved
gns_handle	pointer to gns handle.
cont	callback function
cls	closure

Calls the given callback function with the resolved DID Document and the given closure. If the did can not be resolved did_document is NULL.

Parameters

did	DID that is resolve

Definition at line 59 of file did_core.c.

{
  struct GNUNET_IDENTITY_PublicKey pkey;
 
  // did, gns_handle and cont must me set
  if ((did == NULL) || (gns_handle == NULL) || (cont == NULL))
    return GNUNET_NO;
 
  if (GNUNET_OK != DID_did_to_pkey (did, &pkey))
    return GNUNET_NO;
 
  // Create closure for lookup callback
  struct DID_resolve_return *cls_gns_lookup_cb
    = malloc (sizeof(struct DID_resolve_return));
  cls_gns_lookup_cb->cb = cont;
  cls_gns_lookup_cb->cls = cls;
 
  GNUNET_GNS_lookup (gns_handle,
                     DID_DOCUMENT_LABEL,
                     &pkey,
                     GNUNET_GNSRECORD_TYPE_DID_DOCUMENT,
                     GNUNET_GNS_LO_DEFAULT,
                     &DID_resolve_gns_lookup_cb,
                     cls_gns_lookup_cb);
 
  return GNUNET_OK;
}

References DID_resolve_return::cb, DID_resolve_return::cls, data, GNUNET_GNSRECORD_TYPE_DID_DOCUMENT, GNUNET_NO, GNUNET_OK, rd, and rd_count.

Referenced by resolve_did().

Here is the caller graph for this function:

DID_remove()

enum GNUNET_GenericReturnValue DID_remove	(	const struct GNUNET_IDENTITY_Ego *	ego,
		struct GNUNET_CONFIGURATION_Handle *	cfg_handle,
		struct GNUNET_NAMESTORE_Handle *	namestore_handle,
		DID_action_callback *	cont,
		void *	cls
	)

Removes the DID Document from namestore.

Ego is not removed. Calls the callback function with status and the given closure.

Parameters

ego	ego which controlls the DID
cfg_handle	pointer to configuration handle
namestore_handle	pointer to namestore handle
cont	callback function
cls	closure

DID_create()

enum GNUNET_GenericReturnValue DID_create	(	const struct GNUNET_IDENTITY_Ego *	ego,
		const char *	did_document,
		const struct GNUNET_TIME_Relative *	expire_time,
		struct GNUNET_NAMESTORE_Handle *	namestore_handle,
		DID_action_callback *	cont,
		void *	cls
	)

Creates a DID and saves DID Document in Namestore.

Parameters

ego	ego for which the DID should be created.
did_document	did_document that should be saved in namestore. If did_document==NULL -> Default DID document is created.
expire_time
namestore_handle
cont	callback function
cls	closure
ego	ego for which the DID should be created.
did_document	did_document that should be saved in namestore. If did_document==NULL -> Default DID document is created.
namestore_handle
cont	callback function
cls	closure

Definition at line 152 of file did_core.c.

{
  struct GNUNET_IDENTITY_PublicKey pkey;
 
  // Ego, namestore_handle and cont must be set
  if ((ego == NULL) || (namestore_handle == NULL) || (cont == NULL))
    return GNUNET_NO;
 
  // Check if ego has EdDSA key
  GNUNET_IDENTITY_ego_get_public_key ((struct GNUNET_IDENTITY_Ego *) ego,
                                      &pkey);
  if (ntohl (pkey.type) != GNUNET_GNSRECORD_TYPE_EDKEY)
  {
    printf ("The EGO has to have an EdDSA key pair\n");
    return GNUNET_NO;
  }
 
  struct DID_action_return *ret
    = malloc (sizeof(struct DID_action_return));
  ret->cb = cont;
  ret->cls = cls;
 
  struct DID_create_namestore_lookup_closure *cls_name_store_lookup_cb
    = malloc (sizeof(struct DID_create_namestore_lookup_closure));
  cls_name_store_lookup_cb->did_document = did_document;
  cls_name_store_lookup_cb->expire_time = (*expire_time);
  cls_name_store_lookup_cb->namestore_handle = namestore_handle;
  cls_name_store_lookup_cb->ret = ret;
 
  // Check if ego already has a DID Document
  GNUNET_NAMESTORE_records_lookup (namestore_handle,
                                   GNUNET_IDENTITY_ego_get_private_key (ego),
                                   DID_DOCUMENT_LABEL,
                                   NULL,
                                   NULL,
                                   DID_create_namestore_lookup_cb,
                                   (void *) cls_name_store_lookup_cb);
 
  return GNUNET_OK;
}

References DID_action_return::cb, DID_action_return::cls, GNUNET_GNSRECORD_Data::data, GNUNET_GNSRECORD_Data::data_size, DID_create_did_store_cb(), DID_create_namestore_lookup_closure::did_document, DID_DOCUMENT_LABEL, DID_pkey_to_did_document(), GNUNET_GNSRECORD_Data::expiration_time, DID_create_namestore_lookup_closure::expire_time, GNUNET_GNSRECORD_Data::flags, GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION, GNUNET_GNSRECORD_typename_to_number(), GNUNET_IDENTITY_key_get_public(), GNUNET_NAMESTORE_records_store(), GNUNET_NO, namestore_handle, pkey, rd_count, GNUNET_GNSRECORD_Data::record_type, GNUNET_TIME_Relative::rel_value_us, and zone.

Referenced by create_did_ego_lockup_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_replace()

enum GNUNET_GenericReturnValue DID_replace	(	struct GNUNET_IDENTITY_Ego *	ego,
		char *	did_document,
		const struct GNUNET_CONFIGURATION_Handle *	cfg_handle,
		struct GNUNET_IDENTITY_Handle *	identity_handle,
		struct GNUNET_NAMESTORE_Handle *	namestore_handle,
		DID_action_callback *	cont,
		void *	cls
	)

Replace the DID Document of a DID.

Parameters

ego	ego for which the DID Document should be replaced
did_document	new DID Document
cfg_handle	pointer to configuration handle
identity_handle	pointer to configuration handle
namestore_handle	pointer to namestore handle
cont	callback function
cls	closure