X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_identity_service.h;h=e07951de7dbbd1b390f75515383c60fb978b751a;hb=bb5fe91d23b0938baa3c4f0e92a83df659df216a;hp=49b269604cbceaa23edd9cf1b3baefe55e43e328;hpb=9351b1e9bdf2b067b6db06562c26ba658cff42b8;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index 49b269604..e07951de7 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - (C) 2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2013 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -14,25 +14,29 @@ You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_identity_service.h - * @brief Identity service; implements identity management for GNUnet * @author Christian Grothoff * - * Identities in GNUnet are ECDSA keys. You assume an identity by - * using (signing with) a particular private key. As GNUnet users are - * expected to have many egos, we need an identity service to - * allow users to manage their egos. The identity service - * manages the egos (private keys) of the local user; it does - * NOT manage identities of other users (public keys). For giving - * names to other users and manage their public keys securely, we - * use GNS. + * @file + * Identity service; implements identity management for GNUnet + * + * @defgroup identity Identity service + * Identity management. + * + * Egos in GNUnet are ECDSA keys. You assume an ego by using (signing + * with) a particular private key. As GNUnet users are expected to + * have many egos, we need an identity service to allow users to + * manage their egos. The identity service manages the egos (private + * keys) of the local user; it does NOT manage egos of other users + * (public keys). For giving names to other users and manage their + * public keys securely, we use GNS. + * + * @see [Documentation](https://gnunet.org/identity-subsystem) * - * @defgroup identity identity management service * @{ */ #ifndef GNUNET_IDENTITY_SERVICE_H @@ -135,10 +139,11 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego, * NULL if the user just deleted the ego and it * must thus no longer be used */ -typedef void (*GNUNET_IDENTITY_Callback)(void *cls, - struct GNUNET_IDENTITY_Ego *ego, - void **ctx, - const char *name); +typedef void +(*GNUNET_IDENTITY_Callback)(void *cls, + struct GNUNET_IDENTITY_Ego *ego, + void **ctx, + const char *name); /** @@ -156,7 +161,7 @@ GNUNET_IDENTITY_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, /** - * Obtain the identity that is currently preferred/default + * Obtain the ego that is currently preferred/default * for a service. * * @param id identity service to query @@ -179,12 +184,13 @@ GNUNET_IDENTITY_get (struct GNUNET_IDENTITY_Handle *id, * @param cls closure * @param emsg NULL on success, otherwise an error message */ -typedef void (*GNUNET_IDENTITY_Continuation)(void *cls, - const char *emsg); +typedef void +(*GNUNET_IDENTITY_Continuation)(void *cls, + const char *emsg); /** - * Set the preferred/default identity for a service. + * Set the preferred/default ego for a service. * * @param id identity service to inform * @param service_name for which service is an identity set @@ -211,7 +217,7 @@ GNUNET_IDENTITY_disconnect (struct GNUNET_IDENTITY_Handle *h); /** - * Create a new identity with the given name. + * Create a new ego with the given name. * * @param id identity service to use * @param name desired name @@ -227,7 +233,7 @@ GNUNET_IDENTITY_create (struct GNUNET_IDENTITY_Handle *id, /** - * Renames an existing identity. + * Renames an existing ego. * * @param id identity service to use * @param old_name old name @@ -245,7 +251,7 @@ GNUNET_IDENTITY_rename (struct GNUNET_IDENTITY_Handle *id, /** - * Delete an existing identity. + * Delete an existing ego. * * @param id identity service to use * @param name name of the identity to delete @@ -280,8 +286,9 @@ GNUNET_IDENTITY_cancel (struct GNUNET_IDENTITY_Operation *op); * @param cls closure * @param ego NULL on error / ego not found */ -typedef void (*GNUNET_IDENTITY_EgoCallback)(void *cls, - const struct GNUNET_IDENTITY_Ego *ego); +typedef void +(*GNUNET_IDENTITY_EgoCallback)(void *cls, + const struct GNUNET_IDENTITY_Ego *ego); /** * Handle for ego lookup. @@ -321,8 +328,9 @@ GNUNET_IDENTITY_ego_lookup_cancel (struct GNUNET_IDENTITY_EgoLookup *el); } #endif -/** @} */ /* end of group identity */ - /* ifndef GNUNET_IDENTITY_SERVICE_H */ #endif + +/** @} */ /* end of group identity */ + /* end of gnunet_identity_service.h */