did_helper.h File Reference

helper library for DID related functions More...

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

Go to the source code of this file.

Macros
#define	GNUNET_DID_METHOD_PREFIX   "did:gns:"
#define	MAX_DID_SPECIFIC_IDENTIFIER_LENGTH   59

Functions
char *	DID_pkey_to_did (struct GNUNET_CRYPTO_PublicKey *pkey)
	Return a DID for a given GNUNET public key. More...
char *	DID_identity_to_did (struct GNUNET_IDENTITY_Ego *ego)
	Generate a DID for a given gnunet EGO. More...
enum GNUNET_GenericReturnValue	DID_did_to_pkey (const char *did, struct GNUNET_CRYPTO_PublicKey *pkey)
	Return the public key of a DID. More...
char *	DID_key_convert_gnunet_to_multibase_base64 (struct GNUNET_CRYPTO_PublicKey *)
	Convert GNUNET key to a base 64 encoded public key. More...
char *	DID_pkey_to_did_document (struct GNUNET_CRYPTO_PublicKey *pkey)
	Generate the default DID document for a GNUNET public key. More...
char *	DID_identity_to_did_document (struct GNUNET_IDENTITY_Ego *ego)
	Generate the default DID document for a GNUNET ego. More...

Detailed Description

helper library for DID related functions

Author

Tristan Schwieren

Definition in file did_helper.h.

Macro Definition Documentation

GNUNET_DID_METHOD_PREFIX

#define GNUNET_DID_METHOD_PREFIX   "did:gns:"

Definition at line 27 of file did_helper.h.

MAX_DID_SPECIFIC_IDENTIFIER_LENGTH

#define MAX_DID_SPECIFIC_IDENTIFIER_LENGTH   59

Definition at line 28 of file did_helper.h.

Function Documentation

DID_pkey_to_did()

char * DID_pkey_to_did

(

struct GNUNET_CRYPTO_PublicKey *

pkey

)

Return a DID for a given GNUNET public key.

Return a DID for a given GNUNET public key.

Parameters

pkey

Returns

char* Returns the DID. Caller must free TODO: Check if EdDSA

Definition at line 45 of file did_helper.c.

{
  char *pkey_str;
  char *did_str;
 
  pkey_str = GNUNET_CRYPTO_public_key_to_string (pkey);
  GNUNET_asprintf (&did_str, "%s%s",
                   GNUNET_DID_METHOD_PREFIX,
                   pkey_str);
 
  GNUNET_free (pkey_str);
  return did_str;
}

References GNUNET_asprintf(), GNUNET_CRYPTO_public_key_to_string(), GNUNET_DID_METHOD_PREFIX, GNUNET_free, and pkey.

Referenced by DID_identity_to_did(), DID_identity_to_did_document(), and DID_pkey_to_did_document().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_identity_to_did()

char * DID_identity_to_did

(

struct GNUNET_IDENTITY_Ego *

ego

)

Generate a DID for a given gnunet EGO.

Parameters

ego

Returns

char * Returns the DID. Caller must free

Wrapper around GNUNET_DID_pkey_to_did

Parameters

ego

Returns

char* Returns the DID. Caller must free

Definition at line 67 of file did_helper.c.

{
  struct GNUNET_CRYPTO_PublicKey pkey;
 
  GNUNET_IDENTITY_ego_get_public_key (ego, &pkey);
  return DID_pkey_to_did (&pkey);
}

References DID_pkey_to_did(), GNUNET_IDENTITY_ego_get_public_key(), and pkey.

Referenced by create_did_ego_lockup_cb(), and process_dids().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_did_to_pkey()

enum GNUNET_GenericReturnValue DID_did_to_pkey	(	const char *	did,
		struct GNUNET_CRYPTO_PublicKey *	pkey
	)

Return the public key of a DID.

Definition at line 79 of file did_helper.c.

{
  char pkey_str[MAX_DID_SPECIFIC_IDENTIFIER_LENGTH + 1]; /* 0-term */
 
  if ((1 != (sscanf (did,
                     GNUNET_DID_METHOD_PREFIX "%"
                     STR (MAX_DID_SPECIFIC_IDENTIFIER_LENGTH)
                     "s", pkey_str))) ||
      (GNUNET_OK != GNUNET_CRYPTO_public_key_from_string (pkey_str, pkey)))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Could not decode given DID: %s\n",
                did);
    return GNUNET_NO;
  }
 
  return GNUNET_OK;
}

References did, GNUNET_CRYPTO_public_key_from_string(), GNUNET_DID_METHOD_PREFIX, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_NO, GNUNET_OK, MAX_DID_SPECIFIC_IDENTIFIER_LENGTH, pkey, and STR.

Referenced by DID_resolve().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_key_convert_gnunet_to_multibase_base64()

char * DID_key_convert_gnunet_to_multibase_base64

(

struct GNUNET_CRYPTO_PublicKey *

pkey

)

Convert GNUNET key to a base 64 encoded public key.

Definition at line 101 of file did_helper.c.

{
  struct GNUNET_CRYPTO_EddsaPublicKey pubkey = pkey->eddsa_key;
 
  // This is how to convert out pubkeys to W3c Ed25519-2020 multibase (base64url no padding)
  char *pkey_base_64;
  char *pkey_multibase;
  char pkx[34];
 
  pkx[0] = 0xed;
  pkx[1] = 0x01;
  memcpy (pkx + 2, &pubkey, sizeof (pubkey));
  GNUNET_STRINGS_base64url_encode (pkx, sizeof (pkx), &pkey_base_64);
  GNUNET_asprintf (&pkey_multibase, "u%s", pkey_base_64);
 
  GNUNET_free (pkey_base_64);
  return pkey_multibase;
}

References GNUNET_asprintf(), GNUNET_free, GNUNET_STRINGS_base64url_encode(), pkey, and pubkey.

Referenced by DID_pkey_to_did_document().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_pkey_to_did_document()

char * DID_pkey_to_did_document

(

struct GNUNET_CRYPTO_PublicKey *

pkey

)

Generate the default DID document for a GNUNET public key.

Generate the default DID document for a GNUNET public key.

Parameters

pkey

Returns

void* Return pointer to the DID Document

Definition at line 129 of file did_helper.c.

{
 
  /* FIXME-MSC: This is effectively creating a DID Document default template for
   * the initial document.
   * Maybe this can be refactored to generate such a template for an identity?
   * Even if higher layers add/modify it, there should probably still be a
   * GNUNET_DID_document_template_from_identity()
   */
 
  char *did_str;
  char *verify_id_str;
  char *pkey_multibase_str;
  char *didd_str;
  json_t *didd_json;
 
  did_str = DID_pkey_to_did (pkey);
  GNUNET_asprintf (&verify_id_str, "%s#key-1", did_str);
 
  pkey_multibase_str = DID_key_convert_gnunet_to_multibase_base64 (pkey);
 
  didd_json = json_pack (
    "{s:[ss], s:s, s:[{s:s, s:s, s:s, s:s}], s:[s], s:[s]}",
    "@context",
    "https://www.w3.org/ns/did/v1",
    "https://w3id.org/security/suites/ed25519-2020/v1",
    "id",
    did_str,
    "verificationMethod",
    "id",
    verify_id_str,
    "type",
    "Ed25519VerificationKey2020",
    "controller",
    did_str,
    "publicKeyMultibase",
    pkey_multibase_str,
    "authentication",
    "#key-1",
    "assertionMethod",
    "#key-1");
 
  // Encode DID Document as JSON string
  didd_str = json_dumps (didd_json, JSON_INDENT (2));
 
  // Free
  GNUNET_free (did_str);
  GNUNET_free (verify_id_str);
  GNUNET_free (pkey_multibase_str);
  json_decref (didd_json);
 
  return didd_str;
}

References DID_key_convert_gnunet_to_multibase_base64(), DID_pkey_to_did(), GNUNET_asprintf(), GNUNET_free, and pkey.

Referenced by DID_create_namestore_lookup_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

DID_identity_to_did_document()

char * DID_identity_to_did_document

(

struct GNUNET_IDENTITY_Ego *

ego

)

Generate the default DID document for a GNUNET ego.

Generate the default DID document for a GNUNET ego.

Definition at line 188 of file did_helper.c.

{
  struct GNUNET_CRYPTO_PublicKey pkey;
 
  GNUNET_IDENTITY_ego_get_public_key (ego, &pkey);
  return DID_pkey_to_did (&pkey);
}

References DID_pkey_to_did(), GNUNET_IDENTITY_ego_get_public_key(), and pkey.

Here is the call graph for this function: