externalizing secushare logic

[oweals/gnunet.git] / src / include / gnunet_identity_service.h

diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h
index fe1e4d20614bf86a3d455da9a6cdd83329d74642..086f924d673e4f78fab5fc67f6d9448f17b04535 100644 (file)
--- a/src/include/gnunet_identity_service.h
+++ b/src/include/gnunet_identity_service.h
@@ -1,38 +1,42 @@
 /*
      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
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     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.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
- * @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
@@ -101,8 +105,7 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego,
 
 
 /**
- * Method called to inform about the egos of
- * this peer.
+ * Method called to inform about the egos of this peer.
  *
  * When used with #GNUNET_IDENTITY_connect, this function is
  * initially called for all egos and then again whenever a
@@ -135,10 +138,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,8 +160,7 @@ GNUNET_IDENTITY_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
 
 /**
- * Obtain the ego that is currently preferred/default
- * for a service.
+ * Obtain the ego that is currently preferred/default for a service.
  *
  * @param id identity service to query
  * @param service_name for which service is an identity wanted
@@ -179,8 +182,9 @@ 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);
 
 
 /**
@@ -280,8 +284,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 +326,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 */